# rich

## Tag panelMenu

- Description:

    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

- Component Information
  Info | Value
  --- | ---
  Component Type | `org.richfaces.PanelMenu`
  Handler Class | `org.richfaces.view.facelets.html.PanelMenuTagHandler`
  Renderer Type | `org.richfaces.PanelMenuRenderer`
  Description | 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` | `javax.el.ValueExpression` (must evaluate to `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.el.ValueExpression` (must evaluate to `javax.faces.component.UIComponent`) | The value binding expression used to wire up this component to a component property of a JavaBean class
  `bubbleSelection` | `false` | `javax.el.ValueExpression` (must evaluate to `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` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The mouse event used for collapsing.
  `converter` | `false` | `javax.el.ValueExpression` (must evaluate to `javax.faces.convert.Converter`) | Converter instance registered with this component.
  `disabled` | `false` | `javax.el.ValueExpression` (must evaluate to `boolean`) | Flag indicating that this element must never receive focus or be included in a subsequent submit. Default value - "false"
  `expandEvent` | `false` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The mouse event used for expansion.
  `expandSingle` | `false` | `javax.el.ValueExpression` (must evaluate to `boolean`) | If true (default), only one group can be expanded at the time. If false, many groups can be expanded.
  `groupClass` | `false` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Space-separated list of CSS style class(es) to be applied to panel menu groups
  `groupCollapsedLeftIcon` | `false` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The left icon for collapsed panel menu groups
  `groupCollapsedRightIcon` | `false` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The right icon for collapsed panel menu groups
  `groupDisabledClass` | `false` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Space-separated list of CSS style class(es) to be applied to disabled panel menu groups
  `groupDisabledLeftIcon` | `false` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The left icon for disabled panel menu groups
  `groupDisabledRightIcon` | `false` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The right icon for disabled panel menu groups
  `groupExpandedLeftIcon` | `false` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The left icon for expanded panel menu groups
  `groupExpandedRightIcon` | `false` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The right icon for expanded panel menu groups
  `groupMode` | `false` | `javax.el.ValueExpression` (must evaluate to `org.richfaces.PanelMenuMode`) | Mode used for expanding/collapsing groups: client (default), ajax, server
  `id` | `false` | `javax.el.ValueExpression` (must evaluate to `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` | `javax.el.ValueExpression` (must evaluate to `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 the Invoke Application phase.
  `itemChangeListener` | `false` | `javax.el.ValueExpression` (must evaluate to `javax.el.MethodExpression`) | Method expression referencing a method that will be called when an ItemChangeEvent has been broadcast for the listener.
  `itemClass` | `false` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Space-separated list of CSS style class(es) to be applied to the panel menu items.
  `itemDisabledClass` | `false` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Space-separated list of CSS style class(es) to be applied to disables panel menu items.
  `itemDisabledLeftIcon` | `false` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The left icon for disabled panel menu items
  `itemDisabledRightIcon` | `false` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The right icon for panel menu items
  `itemLeftIcon` | `false` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The left icon for panel menu items
  `itemMode` | `false` | `javax.el.ValueExpression` (must evaluate to `org.richfaces.PanelMenuMode`) | The mode user for selecting items: client, ajax (default), server
  `itemRightIcon` | `false` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The left icon for right menu items
  `onclick` | `false` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Javascript code executed when a pointer button is clicked over this element.
  `ondblclick` | `false` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Javascript code executed when a pointer button is double clicked over this element.
  `onmousedown` | `false` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Javascript code executed when a pointer button is pressed down over this element.
  `onmousemove` | `false` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Javascript code executed when a pointer button is moved within this element.
  `onmouseout` | `false` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Javascript code executed when a pointer button is moved away from this element.
  `onmouseover` | `false` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Javascript code executed when a pointer button is moved onto this element.
  `onmouseup` | `false` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Javascript code executed when a pointer button is released over this element.
  `rendered` | `false` | `javax.el.ValueExpression` (must evaluate to `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` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | CSS style(s) to be applied when this component is rendered.
  `styleClass` | `false` | `javax.el.ValueExpression` (must evaluate to `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` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Space-separated list of CSS style class(es) to be applied to top-level panel menu groups
  `topGroupCollapsedLeftIcon` | `false` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The left icon for collapsed top-level panel menu groups
  `topGroupCollapsedRightIcon` | `false` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The right icon for collapsed top-level panel menu groups
  `topGroupDisabledClass` | `false` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Space-separated list of CSS style class(es) to be applied to disabled top-level panel menu groups
  `topGroupDisabledLeftIcon` | `false` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The left icon for disabled top-level panel menu groups
  `topGroupDisabledRightIcon` | `false` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The right icon for disabled top-level panel menu groups
  `topGroupExpandedLeftIcon` | `false` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The left icon for expanded top-level panel menu groups
  `topGroupExpandedRightIcon` | `false` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The right icon for expanded top-level panel menu groups
  `topItemClass` | `false` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Space-separated list of CSS style class(es) to be applied to top-level panel menu items
  `topItemDisabledClass` | `false` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Space-separated list of CSS style class(es) to be applied to disabled top-level panel menu items
  `topItemDisabledLeftIcon` | `false` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The left icon for disabled top-level panel menu items
  `topItemDisabledRightIcon` | `false` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The right icon for disabled top-level panel menu items
  `topItemLeftIcon` | `false` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The left icon for top-level panel menu items
  `topItemRightIcon` | `false` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The right icon for top-level panel menu items
  `width` | `false` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The width of the panel menu in pixels.

Output generated by Vdldoc View Declaration Language Documentation Generator.