# r

## Tag contextMenu

- Description:

    The <r:contextMenu> component is used for creating a hierarchical context menu that are activated on events like onmouseover, onclick etc. The component can be applied to any element on the page.

    @author Brian Leathem

- Component Information
  Info | Value
  --- | ---
  Component Type | `org.richfaces.ui.ContextMenu`
  Display Name | None
  Handler Class | None
  Renderer Type | `org.richfaces.ui.ContextMenuRenderer`
  Description | The <r:contextMenu> component is used for creating a hierarchical context menu that are activated on events like onmouseover, onclick etc. The component can be applied to any element on the page. @author Brian Leathem

- Attributes
  Name | Required | Type | Description
  --- | --- | --- | ---
  `attached` | `false` | `javax.el.ValueExpression` (must evaluate to `boolean`) | If the value of the 'attached' attribute is true, the component is attached to the component, specified in the 'target' attribute or to the parent component, if 'target' is not defined. Default value is 'true'.
  `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
  `dir` | `false` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left).
  `direction` | `false` | `javax.el.ValueExpression` (must evaluate to `org.richfaces.ui.common.Positioning`) | Set the direction of the popup. Possible values are: AA (auto), LT (topLeft), RT (topRight), LB (bottomLeft), RB (bottomRight, LA (autoLeft),RA (autoRight), AT (topAuto), AB (bottomAuto) Default value is auto
  `disabled` | `false` | `javax.el.ValueExpression` (must evaluate to `boolean`) | Disables the menu component, so it will not activate/expand
  `hideDelay` | `false` | `javax.el.ValueExpression` (must evaluate to `int`) | Delay (in ms) between losing focus and menu closing Default value is "300"
  `horizontalOffset` | `false` | `javax.el.ValueExpression` (must evaluate to `int`) | Sets the horizontal offset between popup element and the conjunction point Default value is 0
  `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.
  `lang` | `false` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Code describing the language used in the generated markup for this component.
  `mode` | `false` | `javax.el.ValueExpression` (must evaluate to `org.richfaces.ui.common.Mode`) | Sets the submission mode for all menu items of the menu except those where this attribute redefined. Possible value are 'ajax','client' and 'server' Default value is 'server'
  `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.
  `ongrouphide` | `false` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called when a child menuGroup is hidden
  `ongroupshow` | `false` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called when a child menuGroup is expanded
  `onhide` | `false` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called when this menu component is hidden
  `onitemclick` | `false` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called when a menu item is clicked
  `onkeydown` | `false` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Javascript code executed when a key is pressed down over this element.
  `onkeypress` | `false` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Javascript code executed when a key is pressed and released over this element.
  `onkeyup` | `false` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Javascript code executed when a key is released 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.
  `onshow` | `false` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The client-side script method to be called when this menu component is shown
  `popupWidth` | `false` | `javax.el.ValueExpression` (must evaluate to `int`) | Sets minimum width for all lists that will appear.
  `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.
  `showDelay` | `false` | `javax.el.ValueExpression` (must evaluate to `int`) | Delay (in ms) between observing the showEvent and menu opening Default value is "50"
  `showEvent` | `false` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Defines an event on the parent element to display the menu Default value is 'contextmenu'
  `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.
  `target` | `false` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Client identifier of the component or id of the existing DOM element that is a source for a given event. If target is defined, the event is attached on the client. If both attached and target attributes are defined, and attribute attached has value 'false', it is considered to have higher priority.
  `targetSelector` | `false` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The jQuery selector used to filter which child DOM elements of the target/parent to which the contextMenu will be attached.
  `title` | `false` | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Advisory title information about markup elements generated for this component.
  `verticalOffset` | `false` | `javax.el.ValueExpression` (must evaluate to `int`) | Sets the vertical offset between popup element and the conjunction point Default value is 0

Output generated by Vdldoc View Declaration Language Documentation Generator.