UIComponent class: oracle.adf.view.rich.component.rich.nav.RichCommandMenuItem
Component type: oracle.adf.RichCommandMenuItem
Unsupported agents: pda
The commandMenuItem creates an item in a menu. It is normally used inside of a menu and cannot be used on its own. commandMenuItems are not rendered on printable pages.
| Type | Phases | Description |
|---|---|---|
| javax.faces.event.ActionEvent | Invoke Application, Apply Request Values |
Event delivered when the "action" of the component has been invoked; for example, by clicking on a button. The action may result in page navigation. |
| org.apache.myfaces.trinidad.event.ReturnEvent | Apply Request Values | Event delivered when the dialog has completed successfully. |
| org.apache.myfaces.trinidad.event.LaunchEvent | Invoke Application, Apply Request Values |
Event delivered to prompt the command to launch a dialog. |
| org.apache.myfaces.trinidad.event.AttributeChangeEvent | Invoke Application, Apply Request Values |
Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing. |
| Name | Type | Supports EL? | Description |
|---|---|---|---|
| accelerator | java.awt.AWTKeyStroke | Yes | the keystroke that will activate this command. This keystroke will be converted into a textual representation and displayed as the accelerator label for this menu item. |
| accessKey | char | Yes | a character used to gain quick access to this button. For accessibility reasons, this functionality is not supported in screen reader mode.
If the same access key appears in multiple input fields in the same page of output, the rendering user agent will cycle among the elements accessed by the similar keys. Note that user agents are inconsistent about dealing with two links having same access key, and so the cycling behavior is dependent on what the user agent provides. This attribute is sometimes referred to as the "mnemonic". The character specified by this attribute must exist in the Note that the accessKey is triggered by browser-specific and platform-specific modifier keys. It even has browser-specific meaning. For example, Internet Explorer 7.0 will set focus when you press Alt+<accessKey>. Firefox 2.0 on some operating systems you press Alt+Shift+<accessKey>. Firefox 2.0 on other operating systems you press Control+<accessKey>. Refer to your browser's documentation for how it treats accessKey. Beyond normal type menu access key behavior, menus and commandMenuItems support menu-type access key behavior when the focus is currently in a menu or menuBar. Menu-type access key behavior allows access to contained menus, submenus, and commandMenuItems without the need for any keyboard modifiers. When the focus is inside a menu or menuBar, you can simply press the accessKey, without modifiers, for a menu or commandMenuItem accessible within the menu or menuBar to immediately move focus to that menu item. |
| action | javax.el.MethodExpression | Yes | a reference to an action method sent by the command component, or the static outcome of an action. If the action starts with "dialog:", useWindow attribute must be set to true. |
| actionListener | javax.faces.el.MethodBinding | Only EL | a method reference to an action listener |
| attributeChangeListener | javax.el.MethodExpression | Only EL | a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing. |
| binding | oracle.adf.view.rich.component.<wbr/>rich.nav.RichCommandMenuItem | Only EL | an EL reference that will store the component instance on a bean. This can be used to give programmatic access to a component from a backing bean, or to move creation of the component to a backing bean. |
| clientComponent | boolean | Yes | whether a client-side component will be generated. A component may be generated whether or not this flag is set, but if client Javascript requires the component object, this must be set to true to guarantee the component's presence. Client component objects that are generated today by default may not be present in the future; setting this flag is the only way to guarantee a component's presence, and clients cannot rely on implicit behavior. However, there is a performance cost to setting this flag, so clients should avoid turning on client components unless absolutely necessary. |
| customizationId | String | Yes | This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release. |
| disabled | boolean | Yes | whether the item should be disabled. |
| icon | String | Yes | a URI specifying the location of a target image. |
| id | String | No | the identifier for the component. The identifier must follow a subset of the syntax allowed in HTML:
|
| immediate | boolean | Yes | whether data validation - client-side or server-side - will be skipped when events are generated by this component. When immediate is true, the command's action and ActionListeners, including the default ActionListener provided by the JavaServer Faces implementation, will be executed during Apply Request Values phase of the request processing lifecycle, rather than waiting until the Invoke Application phase. Because validation runs during Process Validators (after Apply Request Values, but before Invoke Application), setting immediate to true will skip validation. |
| inlineStyle | String | Yes | the CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. If the inlineStyle's CSS properties do not affect the DOM element you want affected, then you will have to create a skin and use the skinning keys which are meant to target particular DOM elements, like ::label or ::icon-style. |
| launchListener | javax.el.MethodExpression | Only EL | a method reference to a launch listener |
| partialSubmit | boolean | Yes | whether the action should be done through a partial page submit or not. Default is true: commandMenuItems use partial submissions by default. |
| partialTriggers | String[] | Yes | the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too. Identifiers are relative to the source component (this component), and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root of the page, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, etc. |
| rendered | boolean | Yes | whether the component is rendered. When set to false, no output will be delivered for this component (the component will not in any way be rendered, and cannot be made visible on the client). |
| returnListener | javax.el.MethodExpression | Only EL | a method reference to a return listener.This method is used to process dialog returnEvents which are generated as a result of either calling org.apache.myfaces.trinidad.context.RequestContext.returnFromDialog directly or declaratively through the use of a returnActionListener tag. |
| selected | boolean | Yes | whether the item is selected. |
| selectedText | String | Yes | the alternate text shown when a type antonym menu item is selected. |
| shortDesc | String | Yes | the short description of the component. This text is commonly used by user agents to display tooltip help text, in which case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window. |
| styleClass | String | Yes | a CSS style class to use for this component. The style class can be defined in your jspx page or in a skinning CSS file, for example, or you can use one of our public style classes, like 'AFInstructionText'. |
| text | String | Yes | the text of the item |
| textAndAccessKey | String | Yes | an attribute that will simultaneously set both the "text" and "accessKey" attributes from a single value, using conventional ampersand ('&') notation.
For example, setting this attribute to "T&ext" will set the text to "Text" and the access key to 'e'. |
| type | String | Yes | Valid Values: default, check, radio, antonym the type of menu item. The default type is a normal menu item, while the other types provide special behavior. The check type displays a check mark next to it when it is selected. It is useful to represent a boolean toggle. The radio type displays a radio button next to it when it is selected. It is useful to represent a multiple choice toggle. Radio type menu items are considered part of the same group by their container, either menu or group. When a radio type menu item is selected, other radio type menu items in the same group are unselected. The antonym type displays different text depending on its selection state. When it is not selected, it displays its text value. When it is selected, it displays its selectedText value. |
| useWindow | boolean | Yes | whether processes launched by this command should be launched in a secondary browser dialog window. 'useWindow' requires that the "action" attribute start with "dialog:". Set useWindow to 'false' for the outcome of the action to be targeted to the existing window. |
| visible | boolean | Yes | the visibility of the component. If it is "false", the component will be hidden on the client. Unlike "rendered", this does not affect the lifecycle on the server - the component may have its bindings executed, etc. - and the visibility of the component can be toggled on and off on the client, or toggled with PPR. When "rendered" is false, the component will not in any way be rendered, and cannot be made visible on the client. In most cases, use the "rendered" property instead of the "visible" property. Not supported on the following renderkits: org.apache.myfaces.trinidad.core |
| windowHeight | int | Yes | the height of the window, if this command is used to launch a window. |
| windowWidth | int | Yes | the width of the window, if this command is used to launch a window. |