Create new RichFaces Documentation Jira issue
This will launch the RichFaces Jira page - to complete your feedback please login if needed, and submit the Jira.
JBoss.orgCommunity Documentation
The <rich:menuItem> component is used for the definition of a single item inside a pop-up list.
This component can be used not only within <rich:dropDownMenu> and <rich:contextMenu> , but also it can used as a standalone component. For example, you can use it as nested component of the <rich:toolBar> .
Highly customizable look-and-feel
Different submission modes
Support for disabling
Custom content support
The "value" attribute defines the text representation for an item element.
There are two icon-related attributes. The "icon" attribute defines an icon. The "iconDisabled" attribute defines an icon for a disabled item. Also you can use the "icon" and "iconDisabled" facets. If the facets are defined, the corresponding "icon" and "iconDisabled" attributes are ignored and the facets content is shown as an icon. It could be used for an item check box implementation.
Here is an example:
...
<f:facet name="icon">
<h:selectBooleanCheckbox value="#{bean.property}"/>
</f:facet>
...
The <rich:menuItem> "submitMode" attribute can be set to three possible parameters:
Server (default)
Regular form submission request is used.
Ajax
Ajax submission is used for switching.
None
The "action" and "actionListener" item's attributes are ignored. Menu items don' fire any submits themselves. The behavior is fully defined by the components nested into items.
For example, you can put any content into an item, but, in this case, you should set the "submitMode" attribute as "none" .
Here is an example:
...
<rich:dropDownMenu>
...
<rich:menuItem submitMode="none">
<h:outputLink value="www.jboss.org"/>
</rich:menuItem>
...
<rich:dropDownMenu>
...
You can use the "disabled" attribute to set the item state.
Here is an example:
...
<rich:dropDownMenu>
<rich:menuItem value="Disable" disabled="true"/>
<rich:dropDownMenu>
...
The <rich:menuItem> component was designed to be used only for pop-up menu list creation.
Information about the "process" attribute usage you can find RichFaces Developer Guide section about "process" attribute .
Table of <rich:menuItem> attributes.
Table 6.85. Component Identification Parameters
| Name | Value |
|---|---|
| component-type | org.richfaces.MenuItem |
| component-class | org.richfaces.component.html.HtmlMenuItem |
| component-family | org.richfaces.DropDownMenu |
| renderer-type | org.richfaces.MenuItemRenderer |
| tag-class | org.richfaces.taglib.MenuItemTag |
Table 6.86. Facets
| Facet | Description |
|---|---|
| icon | Redefines the icon for the enabled item state. Related attribute is "icon" |
| iconDisabled | Redefines the folder icon the disabled item state. Related attribute is "iconDisabled" |
Table 6.87. Classes names that define an appearance of item elements
| Class name | Description |
|---|---|
| rich-menu-item | Defines styles for a wrapper <div> element for an item |
| rich-menu-item-label | Defines styles for a label of an item |
| rich-menu-item-icon | Defines styles for the left icon of an item |
Table 6.88. Classes names that define different states
| Class name | Description |
|---|---|
| rich-menu-item-disabled | Defines styles for a wrapper <div> element of an item |
| rich-menu-item-enabled | Defines styles for a wrapper <div> element of an enabled item |
| rich-menu-item-hover | Defines styles for a wrapper <div> element of a hover item |
| rich-menu-item-label-disabled | Defines styles for a label of a disabled item |
| rich-menu-item-icon-disabled | Defines styles for the left icon of a disabled item |
| rich-menu-item-label-enabled | Defines styles for a label of an enabled item |
| rich-menu-item-icon-enabled | Defines styles for the left icon of an enabled item |
| rich-menu-item-label-selected | Defines styles for a label of a selected item |
| rich-menu-item-icon-selected | Defines styles for the left icon of a selected item |
On the component LiveDemo page you can see the example of <rich:menuItem> usage and sources for the given example.
