@Generated(value={"RichFaces CDK","4.5.0-SNAPSHOT"}) public class UIPanelMenu extends AbstractPanelMenu implements javax.faces.component.behavior.ClientBehaviorHolder, DisabledProps, EventsMouseProps, ImmediateProps, StyleClassProps, StyleProps, ItemChangeSource
The <rich:panelMenu> component is used in conjunction with <rich:panelMenuItem> and <rich:panelMenuGroup> to create an expanding, hierarchical menu. The <rich:panelMenu> component's appearance can be highly customized, and the hierarchy can stretch to any number of sub-levels.
| Modifier and Type | Class and Description |
|---|---|
protected static class |
UIPanelMenu.Properties |
| Modifier and Type | Field and Description |
|---|---|
static String |
COMPONENT_FAMILY |
static String |
COMPONENT_TYPE |
| Constructor and Description |
|---|
UIPanelMenu() |
| Modifier and Type | Method and Description |
|---|---|
String |
getCollapseEvent()
The mouse event used for collapsing.
|
String |
getDefaultEventName() |
Collection<String> |
getEventNames() |
String |
getExpandEvent()
The mouse event used for expansion.
|
String |
getFamily() |
String |
getGroupClass()
Space-separated list of CSS style class(es) to be applied to panel menu groups
|
String |
getGroupDisabledClass()
Space-separated list of CSS style class(es) to be applied to disabled panel menu groups
|
PanelMenuMode |
getGroupMode()
Mode used for expanding/collapsing groups: client (default), ajax, server
|
javax.el.MethodExpression |
getItemChangeListener()
Method expression referencing a method that will be called when an ItemChangeEvent has been broadcast for the listener.
|
String |
getItemClass()
Space-separated list of CSS style class(es) to be applied to the panel menu items.
|
String |
getItemDisabledClass()
Space-separated list of CSS style class(es) to be applied to disables panel menu items.
|
PanelMenuMode |
getItemMode()
The mode user for selecting items: client, ajax (default), server
|
String |
getOnclick()
Javascript code executed when a pointer button is clicked over this element.
|
String |
getOndblclick()
Javascript code executed when a pointer button is double clicked over this element.
|
String |
getOnmousedown()
Javascript code executed when a pointer button is pressed down over this element.
|
String |
getOnmousemove()
Javascript code executed when a pointer button is moved within this element.
|
String |
getOnmouseout()
Javascript code executed when a pointer button is moved away from this element.
|
String |
getOnmouseover()
Javascript code executed when a pointer button is moved onto this element.
|
String |
getOnmouseup()
Javascript code executed when a pointer button is released over this element.
|
String |
getStyle()
CSS style(s) to be applied when this component is rendered.
|
String |
getStyleClass()
Space-separated list of CSS style class(es) to be applied when this element is rendered.
|
String |
getTopGroupClass()
Space-separated list of CSS style class(es) to be applied to top-level panel menu groups
|
String |
getTopGroupDisabledClass()
Space-separated list of CSS style class(es) to be applied to disabled top-level panel menu groups
|
String |
getTopItemClass()
Space-separated list of CSS style class(es) to be applied to top-level panel menu items
|
String |
getTopItemDisabledClass()
Space-separated list of CSS style class(es) to be applied to disabled top-level panel menu items
|
String |
getWidth()
The width of the panel menu in pixels.
|
boolean |
isBubbleSelection()
If true (default), selection of any item of group will cause selection of groups - predecessors - in the hierarchy.
|
boolean |
isDisabled()
Flag indicating that this element must never receive focus or be included in a subsequent submit.
|
boolean |
isExpandSingle()
If true (default), only one group can be expanded at the time.
|
void |
setBubbleSelection(boolean bubbleSelection) |
void |
setCollapseEvent(String collapseEvent) |
void |
setDisabled(boolean disabled) |
void |
setExpandEvent(String expandEvent) |
void |
setExpandSingle(boolean expandSingle) |
void |
setGroupClass(String groupClass) |
void |
setGroupDisabledClass(String groupDisabledClass) |
void |
setGroupMode(PanelMenuMode groupMode) |
void |
setItemChangeListener(javax.el.MethodExpression itemChangeListener) |
void |
setItemClass(String itemClass) |
void |
setItemDisabledClass(String itemDisabledClass) |
void |
setItemMode(PanelMenuMode itemMode) |
void |
setOnclick(String onclick) |
void |
setOndblclick(String ondblclick) |
void |
setOnmousedown(String onmousedown) |
void |
setOnmousemove(String onmousemove) |
void |
setOnmouseout(String onmouseout) |
void |
setOnmouseover(String onmouseover) |
void |
setOnmouseup(String onmouseup) |
void |
setStyle(String style) |
void |
setStyleClass(String styleClass) |
void |
setTopGroupClass(String topGroupClass) |
void |
setTopGroupDisabledClass(String topGroupDisabledClass) |
void |
setTopItemClass(String topItemClass) |
void |
setTopItemDisabledClass(String topItemDisabledClass) |
void |
setWidth(String width) |
addItemChangeListener, broadcast, getActiveItem, getGroupCollapsedLeftIcon, getGroupCollapsedRightIcon, getGroupDisabledLeftIcon, getGroupDisabledRightIcon, getGroupExpandedLeftIcon, getGroupExpandedRightIcon, getItem, getItemChangeListeners, getItemDisabledLeftIcon, getItemDisabledRightIcon, getItemLeftIcon, getItemRightIcon, getSubmittedActiveItem, getTopGroupCollapsedLeftIcon, getTopGroupCollapsedRightIcon, getTopGroupDisabledLeftIcon, getTopGroupDisabledRightIcon, getTopGroupExpandedLeftIcon, getTopGroupExpandedRightIcon, getTopItemDisabledLeftIcon, getTopItemDisabledRightIcon, getTopItemLeftIcon, getTopItemRightIcon, getValue, isImmediate, processDecodes, queueEvent, removeItemChangeListener, setActiveItem, setEventPhase, setGroupCollapsedLeftIcon, setGroupCollapsedRightIcon, setGroupDisabledLeftIcon, setGroupDisabledRightIcon, setGroupExpandedLeftIcon, setGroupExpandedRightIcon, setImmediate, setItemDisabledLeftIcon, setItemDisabledRightIcon, setItemLeftIcon, setItemRightIcon, setSubmittedActiveItem, setTopGroupCollapsedLeftIcon, setTopGroupCollapsedRightIcon, setTopGroupDisabledLeftIcon, setTopGroupDisabledRightIcon, setTopGroupExpandedLeftIcon, setTopGroupExpandedRightIcon, setTopItemDisabledLeftIcon, setTopItemDisabledRightIcon, setTopItemLeftIcon, setTopItemRightIcon, setValue, setValueExpressionclearInitialState, getConverter, getLocalValue, markInitialState, resetValue, restoreState, saveState, setConverteraddClientBehavior, addFacesListener, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEventencodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, visitTreeclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitaddClientBehavior, getClientBehaviorsisImmediateaddItemChangeListener, getItemChangeListeners, removeItemChangeListenerpublic static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
public String getFamily()
getFamily in class AbstractPanelMenupublic Collection<String> getEventNames()
getEventNames in interface javax.faces.component.behavior.ClientBehaviorHoldergetEventNames in class javax.faces.component.UIComponentBasepublic String getDefaultEventName()
getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHoldergetDefaultEventName in class javax.faces.component.UIComponentBasepublic boolean isBubbleSelection()
AbstractPanelMenuisBubbleSelection in class AbstractPanelMenupublic void setBubbleSelection(boolean bubbleSelection)
public String getCollapseEvent()
AbstractPanelMenugetCollapseEvent in class AbstractPanelMenupublic void setCollapseEvent(String collapseEvent)
public boolean isDisabled()
DisabledPropsisDisabled in interface DisabledPropspublic void setDisabled(boolean disabled)
public String getExpandEvent()
AbstractPanelMenugetExpandEvent in class AbstractPanelMenupublic void setExpandEvent(String expandEvent)
public boolean isExpandSingle()
AbstractPanelMenuisExpandSingle in class AbstractPanelMenupublic void setExpandSingle(boolean expandSingle)
public String getGroupClass()
AbstractPanelMenugetGroupClass in class AbstractPanelMenupublic void setGroupClass(String groupClass)
public String getGroupDisabledClass()
AbstractPanelMenugetGroupDisabledClass in class AbstractPanelMenupublic void setGroupDisabledClass(String groupDisabledClass)
public PanelMenuMode getGroupMode()
AbstractPanelMenugetGroupMode in class AbstractPanelMenupublic void setGroupMode(PanelMenuMode groupMode)
public javax.el.MethodExpression getItemChangeListener()
AbstractPanelMenugetItemChangeListener in class AbstractPanelMenupublic void setItemChangeListener(javax.el.MethodExpression itemChangeListener)
public String getItemClass()
AbstractPanelMenugetItemClass in class AbstractPanelMenupublic void setItemClass(String itemClass)
public String getItemDisabledClass()
AbstractPanelMenugetItemDisabledClass in class AbstractPanelMenupublic void setItemDisabledClass(String itemDisabledClass)
public PanelMenuMode getItemMode()
AbstractPanelMenugetItemMode in class AbstractPanelMenupublic void setItemMode(PanelMenuMode itemMode)
public String getOnclick()
EventsMousePropsgetOnclick in interface EventsMousePropspublic void setOnclick(String onclick)
public String getOndblclick()
EventsMousePropsgetOndblclick in interface EventsMousePropspublic void setOndblclick(String ondblclick)
public String getOnmousedown()
EventsMousePropsgetOnmousedown in interface EventsMousePropspublic void setOnmousedown(String onmousedown)
public String getOnmousemove()
EventsMousePropsgetOnmousemove in interface EventsMousePropspublic void setOnmousemove(String onmousemove)
public String getOnmouseout()
EventsMousePropsgetOnmouseout in interface EventsMousePropspublic void setOnmouseout(String onmouseout)
public String getOnmouseover()
EventsMousePropsgetOnmouseover in interface EventsMousePropspublic void setOnmouseover(String onmouseover)
public String getOnmouseup()
EventsMousePropsgetOnmouseup in interface EventsMousePropspublic void setOnmouseup(String onmouseup)
public String getStyle()
StylePropsgetStyle in interface StylePropspublic void setStyle(String style)
public String getStyleClass()
StyleClassPropsgetStyleClass in interface StyleClassPropspublic void setStyleClass(String styleClass)
public String getTopGroupClass()
AbstractPanelMenugetTopGroupClass in class AbstractPanelMenupublic void setTopGroupClass(String topGroupClass)
public String getTopGroupDisabledClass()
AbstractPanelMenugetTopGroupDisabledClass in class AbstractPanelMenupublic void setTopGroupDisabledClass(String topGroupDisabledClass)
public String getTopItemClass()
AbstractPanelMenugetTopItemClass in class AbstractPanelMenupublic void setTopItemClass(String topItemClass)
public String getTopItemDisabledClass()
AbstractPanelMenugetTopItemDisabledClass in class AbstractPanelMenupublic void setTopItemDisabledClass(String topItemDisabledClass)
public String getWidth()
AbstractPanelMenugetWidth in class AbstractPanelMenupublic void setWidth(String width)
Copyright © 2014 JBoss by Red Hat. All Rights Reserved.