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.
@author akolonitsky
| Attributes |
| Name |
Required |
Type |
Description |
| activeItem |
false |
java.lang.String |
Holds the active panel name. This name is a reference to the name identifier of the active child <rich:panelMenuItem>
or <rich:panelMenuGroup> component.
|
| binding |
false |
javax.faces.component.UIComponent |
The value binding expression used to wire up this component to a component property of a JavaBean class |
| bubbleSelection |
false |
boolean |
If true (default), selection of any item of group will cause selection of groups - predecessors - in the hierarchy. If false,
only given item is selected.
|
| collapseEvent |
false |
java.lang.String |
The mouse event used for collapsing. |
| converter |
false |
javax.faces.convert.Converter |
Converter instance registered with this component. |
| disabled |
false |
boolean |
Disables all panel menu items and groups. |
| expandEvent |
false |
java.lang.String |
The mouse event used for expansion. |
| expandSingle |
false |
boolean |
If true (default), only one group can be expanded at the time. If false, many groups can be expanded. |
| groupClass |
false |
java.lang.String |
Space-separated list of CSS style class(es) to be applied to panel menu groups |
| groupCollapsedLeftIcon |
false |
java.lang.String |
The left icon for collapsed panel menu groups |
| groupCollapsedRightIcon |
false |
java.lang.String |
The right icon for collapsed panel menu groups |
| groupDisabledClass |
false |
java.lang.String |
Space-separated list of CSS style class(es) to be applied to disabled panel menu groups |
| groupDisabledLeftIcon |
false |
java.lang.String |
The left icon for disabled panel menu groups |
| groupDisabledRightIcon |
false |
java.lang.String |
The right icon for disabled panel menu groups |
| groupExpandedLeftIcon |
false |
java.lang.String |
The left icon for expanded panel menu groups |
| groupExpandedRightIcon |
false |
java.lang.String |
The right icon for expanded panel menu groups |
| groupMode |
false |
org.richfaces.PanelMenuMode |
Mode used for expanding/collapsing groups: client (default), ajax, server |
| id |
false |
java.lang.String |
The component identifier for this component. This value must be unique within the closest parent component that is a naming
container.
|
| immediate |
false |
boolean |
Flag indicating that, if this component is activated by the user, notifications should be delivered to interested listeners
and actions immediately (that is, during Apply Request Values phase) rather than waiting until Invoke Application phase.
|
| itemChangeListener |
false |
javax.el.MethodExpression |
MethodExpression representing an panel menu item selection method that will be notified when the panel menu item is selected.
The expression must evaluate to a public method that takes an ItemChangeEvent parameter, with a return type of void, or to
a public method that takes no arguments with a return type of void. In the latter case, the method has no way of easily knowing
where the event came from, but this can be useful in cases where a notification is needed that "some action happened".
|
| itemClass |
false |
java.lang.String |
Space-separated list of CSS style class(es) to be applied to the panel menu items. |
| itemDisabledClass |
false |
java.lang.String |
Space-separated list of CSS style class(es) to be applied to disables panel menu items. |
| itemDisabledLeftIcon |
false |
java.lang.String |
The left icon for disabled panel menu items |
| itemDisabledRightIcon |
false |
java.lang.String |
The right icon for panel menu items |
| itemLeftIcon |
false |
java.lang.String |
The left icon for panel menu items |
| itemMode |
false |
org.richfaces.PanelMenuMode |
The mode user for selecting items: client, ajax (default), server |
| itemRightIcon |
false |
java.lang.String |
The left icon for right menu items |
| onclick |
false |
java.lang.String |
Javascript code executed when a pointer button is clicked over this element. |
| ondblclick |
false |
java.lang.String |
Javascript code executed when a pointer button is double clicked over this element. |
| onmousedown |
false |
java.lang.String |
Javascript code executed when a pointer button is pressed down over this element. |
| onmousemove |
false |
java.lang.String |
Javascript code executed when a pointer button is moved within this element. |
| onmouseout |
false |
java.lang.String |
Javascript code executed when a pointer button is moved away from this element. |
| onmouseover |
false |
java.lang.String |
Javascript code executed when a pointer button is moved onto this element. |
| onmouseup |
false |
java.lang.String |
Javascript code executed when a pointer button is released over this element. |
| rendered |
false |
boolean |
Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent
form submit. The default value for this property is true.
|
| style |
false |
java.lang.String |
CSS style(s) to be applied when this component is rendered. |
| styleClass |
false |
java.lang.String |
Space-separated list of CSS style class(es) to be applied when this element is rendered. This value must be passed through
as the "class" attribute on generated markup.
|
| topGroupClass |
false |
java.lang.String |
Space-separated list of CSS style class(es) to be applied to top-level panel menu groups |
| topGroupCollapsedLeftIcon |
false |
java.lang.String |
The left icon for collapsed top-level panel menu groups |
| topGroupCollapsedRightIcon |
false |
java.lang.String |
The right icon for collapsed top-level panel menu groups |
| topGroupDisabledClass |
false |
java.lang.String |
Space-separated list of CSS style class(es) to be applied to disabled top-level panel menu groups |
| topGroupDisabledLeftIcon |
false |
java.lang.String |
The left icon for disabled top-level panel menu groups |
| topGroupDisabledRightIcon |
false |
java.lang.String |
The right icon for disabled top-level panel menu groups |
| topGroupExpandedLeftIcon |
false |
java.lang.String |
The left icon for expanded top-level panel menu groups |
| topGroupExpandedRightIcon |
false |
java.lang.String |
The right icon for expanded top-level panel menu groups |
| topItemClass |
false |
java.lang.String |
Space-separated list of CSS style class(es) to be applied to top-level panel menu items |
| topItemDisabledClass |
false |
java.lang.String |
Space-separated list of CSS style class(es) to be applied to disabled top-level panel menu items |
| topItemDisabledLeftIcon |
false |
java.lang.String |
The left icon for disabled top-level panel menu items |
| topItemDisabledRightIcon |
false |
java.lang.String |
The right icon for disabled top-level panel menu items |
| topItemLeftIcon |
false |
java.lang.String |
The left icon for top-level panel menu items |
| topItemRightIcon |
false |
java.lang.String |
The right icon for top-level panel menu items |
| width |
false |
java.lang.String |
The width of the panel menu in pixels. |