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

6.78.  < rich:panelMenuItem >

The <rich:panelMenuItem> component is used to define a single item inside popup list.


Table 6.442. rich : panelMenuItem attributes

Attribute NameDescription
actionMethodBinding pointing at the application action to be invoked, if this UIComponent is activated by you, during the Apply Request Values or Invoke Application phase of the request processing lifecycle, depending on the value of the immediate property
actionListenerMethodBinding pointing at method accepting an ActionEvent with return type void
ajaxSingleboolean attribute which provides possibility to limit JSF tree processing(decoding, conversion/validation, value applying) to the component which send the request only
bindingThe attribute takes a value-binding expression for a component property of a backing bean
bypassUpdatesIf "true", after process validations phase it skips updates of model beans on a force render response. It can be used for validating components input
dataSerialized (on default with JSON) data passed on the client by a developer on AJAX request. It's accessible via "data.foo" syntax
disabledIf true sets state of the item to disabled state. Default value is "false".
disabledClassClass to be applied to disabled items.
disabledStyleCSS style rules to be applied to disabled items.
eventsQueueName of requests queue to avoid send next request before complete other from same event. Can be used to reduce number of requests of frequently events (key press, mouse move etc.)
focusid of element to set focus after request completed on client side
hoverClassClass to be applied to hovered items.
hoverStyleCSS style rules to be applied to hovered items.
iconPath to the icon or the default one name to be displayed for the enabled item state. You can also use predefined icons, setting the attribute to one of these possible values: "triangle", "triangleUp", "triangleDown", "disc", "chevron", "chevronUp", "chevronDown", "grid". Default value is "grid".
iconClassClass to be applied to icon element.
iconDisabledPath to the icon to be displayed for the disabled item state. You can also use predefined icons, setting the attribute to one of these possible values: "triangle", "triangleUp", "triangleDown", "disc", "chevron", "chevronUp", "chevronDown", "grid". Default value is "grid".
iconStyleCSS style rules to be applied
idEvery component may have a unique id that is automatically created if omitted
ignoreDupResponsesAttribute allows to ignore an Ajax Response produced by a request if the newest 'similar' request is in a queue already. ignoreDupResponses="true" does not cancel the request while it is processed on the server, but just allows to avoid unnecessary updates on the client side if the response isn't actual now
immediateTrue means, that the default ActionListener should be executed immediately (i.e. during Apply Request Values phase of the request processing lifecycle), rather than waiting until the Invoke Application phase
labelDefines representation text for menuItem.
limitToListIf "true", then of all AJAX-rendered on the page components only those will be updated, which ID's are passed to the "reRender" attribute of the describable component. "false"-the default value-means that all components with ajaxRendered="true" will be updated.
modeSet the submission mode. Possible values are "ajax", "server", "none". Default value is "none".
name'selectedChild' attribute of PanelMenu refers to group/item with the same name. Default value is "getId()".
onbeforedomupdateJavaScript code for call before DOM has been updated on client side
onclickHTML: a script expression; a pointer button is clicked
oncompleteJavaScript code for call after request completed on client side
ondblclickHTML: a script expression; a pointer button is double-clicked
onkeydownHTML: a script expression; a key is pressed down
onkeypressHTML: a script expression; a key is pressed and released
onkeyupHTML: a script expression; a key is released
onmousedownHTML: script expression; a pointer button is pressed down
onmousemoveHTML: a script expression; a pointer is moved within
onmouseoutHTML: a script expression; a pointer is moved away
onmouseoverHTML: a script expression; a pointer is moved onto
onmouseupHTML: script expression; a pointer button is released
processId['s] (in format of call UIComponent.findComponent()) of components, processed at the phases 2-5 in case of AjaxRequest caused by this component. Can be single id, comma-separated list of Id's, or EL Expression with array or Collection
renderedIf "false", this component is not rendered
requestDelayAttribute defines the time (in ms.) that the request will be wait in the queue before it is ready to send. When the delay time is over, the request will be sent to the server or removed if the newest 'similar' request is in a queue already
reRenderId['s] (in format of call UIComponent.findComponent()) of components, rendered in case of AjaxRequest caused by this component. Can be single id, comma-separated list of Id's, or EL Expression with array or Collection
similarityGroupingIdIf there are any component requests with identical IDs then these requests will be grouped.
statusID (in format of call UIComponent.findComponent()) of Request status component
styleCSS style(s) is/are to be applied when this component is rendered
styleClassCorresponds to the HTML class attribute
targetTarget frame for action to execute.
timeoutResponse waiting time on a particular request. If a response is not received during this time, the request is aborted
valueThe current value for this component

Table 6.443. Component identification parameters

NameValue
component-typeorg.richfaces.PanelMenuItem
component-classorg.richfaces.component.html.HtmlPanelMenuItem
component-familyorg.richfaces.PanelMenuItem
renderer-typeorg.richfaces.PanelMenuItemRenderer
tag-classorg.richfaces.taglib.PanelMenuItemTag

To create the simplest variant on a page use the following syntax:

Example:


...
      <rich:panelMenu>
             ...
            <rich:panelMenuItem value="Item1"/>
            ... 
      </rich:panelMenu>
...

Example:

import org.richfaces.component.html.HtmlPanelMenuItem;  

...
HtmlPanelMenuItem myPanelMenuItem = new HtmlPanelMenuItem();
...

All attributes except "label" are optional. The "label" attribute defines text to be represented.

The "mode" attribute could be used with three possible parameters:

Regular form submission request is used.

Ajax submission is used for switching.

"Action" and "actionListener" attributes are ignored. Items don't fire any submits itself. Behavior is fully defined by the components nested into items.

Here is an example for value "none":

Example:


...
      <rich:panelMenu>
            ...
            <rich:panelMenuItem mode="none" onclick="document.location.href='http://labs.jboss.com/jbossrichfaces/">
                  <h:outputLink value="http://labs.jboss.com/jbossrichfaces/">
                        <h:outputText value="RichFaces Home Page"></h:outputText>
                  </h:outputLink>
            </rich:panelMenuItem>
            ...
      </rich:panelMenu>
...

There are two icon-related attributes. The "icon" attribute defines an icon. The "iconDisabled" attribute defines an icon for a disabled item.

Default icons are shown on the picture below:


Here is an example:

Example:


...
      <rich:panelMenu>
            ...
            <rich:panelMenuItem value="Item 1.1" icon="chevronUp" />
            ... 
      </rich:panelMenu>
...

As the result the picture is shown below:


It's also possible to define a path to the icon. Simple code is placed below.


...
      <rich:panelMenu>
            ...
            <rich:panelMenuItem value="Item 1.1" icon="\images\img1.png" />
            ... 
      </rich:panelMenu>
...

Information about the "process" attribute usage you can find here.

For skinnability implementation, the components use a style class redefinition method. Default style classes are mapped on skin parameters.

There are two ways to redefine the appearance of all <rich:panelMenuItem> components at once:



On the screenshot there are classes names that define styles for component elements.






In order to redefine styles for all <rich:panelMenuItem> components on a page using CSS, it's enough to create classes with the same names (possible classes could be found in the tables above) and define necessary properties in them.

Example:


...
.rich-pmenu-hovered-element {
  
background-color: #ff7800;
}
...

This is a result:


In the example a hovered element background color was changed.

Also it's possible to change styles of particular <rich:panelMenuItem> component. In this case you should create own style classes and use them in corresponding <rich:panelMenuItem> styleClass attributes. An example is placed below:

Example:


...
.myClass {
        
color: #a0a0a0;
}
...

The "disabledClass" attribute for <rich:panelMenuItem> is defined as it's shown in the example below:

Example:


<rich:panelMenuItem ... disabledClass="myClass"/>

This is a result:


As it could be seen on the picture above, the text color for disabled item was changed.

Some additional information about usage of component can be found on this LiveDemo page.