Oracle Fusion Middleware Tag Reference for Oracle ADF Faces 12c (12.2.1.2) E76720-01 |
af:commandMenuItem commandMenuItem command menu item
UIComponent class: oracle.adf.view.rich.component.rich.nav.RichCommandMenuItem
Component type: oracle.adf.RichCommandMenuItem
Unsupported agents: pda
The commandMenuItem component creates a menu item in a menu or on a menuBar. It is required to be used inside a menu or menuBar and cannot be used on its own. This component will be excluded when the page is being displayed in emailable and printable modes.
<af:menubar> <af:menu text="New"> <af:commandMenuItem text="Navigator Window"/> <af:commandMenuItem text="Navigator Tab"/> </af:menu> <af:commandMenuItem text="Open Web Location..."/> </af:menubar>
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 event 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. Note that when a menu item with an accelerator is placed in a menu or popup that has lazy content delivery, the accelerator will not be available until the menu or popup's content (including the menu item) has been delivered to the page. Because of this, if you want your menu item's accelerators to be functional immediately after initial page load, you should make sure the menu item is not contained in menus or popups with lazy content delivery. |
accessKey | char | Yes | a character used to gain quick access to this button.
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 will set focus when you press Alt+<accessKey>. Firefox sets focus on some operating systems when you press Alt+Shift+<accessKey>. Firefox on other operating systems sets focus when you press Control+<accessKey>. Refer to your browser's documentation for how it treats access keys. 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.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 | Default Value: false 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. For the components outputText and outputFormatted, setting the clientComponent to true will render id attribute for the html DOM. This ID attribute can alternatively be generated by setting oracle.adf.view.rich.SUPPRESS_IDS to "auto" in web.xml. |
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 | Default Value: false whether the item should be disabled. |
icon | String | Yes | the URI of an image to be displayed on the menu item. This attribute supports these various types of URIs:
|
id | String | No | the identifier for the component. Every component may be named by a component identifier that must conform to the following rules:
|
immediate | boolean | Yes | Default Value: false 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. Be aware that because of browser CSS precedence rules, CSS rendered on a DOM element takes precedence over external stylesheets like the skin file. Therefore skins will not be able to override what you set on this attribute. 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 | Default Value: true whether the action should be done through a partial page submit or not. To re-render specific components on your page in response to the partial page submit, you have to tell ADF Faces. The easiest way to do this is with the partialTriggers attribute. |
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 | Default Value: true 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). If you want to change a component's rendered attribute from false to true using PPR, set the partialTrigger attribute of its parent component so the parent refreshes and in turn will render this component. |
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 | Default Value: false 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. The shortDesc text may be used in two different ways, depending on the component.
For components with images, the shortDesc is often used to render an HTML alt attribute for the image. Please see the accessibility guidelines section for correct alt text usage of the shortDesc attribute. shortDesc is also commonly used to render an HTML title attribute, which is used by user agents to display tooltip help text. In this 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. For components that support the helpTopicId attribute and are not using the shortDesc as image alt text, it is recommended that helpTopicId is used instead of shortDesc as it is more flexible and provides more accessible descriptive text than the use of the title attribute. |
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. Radio menu items that are part of the same set should be grouped together either in their own group or menu container. 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. Please note that if you have a commandMenuItem of type antonym on a menuBar, you should set a partialTrigger on the menuBar that points to the commandMenuItem. This way, when the antonym type commandMenuItem is selected and its text changes, the menuBar will rerender and correctly handle any size changes that effect what fits into overflow. |
unsecure | java.util.Set | Yes | A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client. Currently, this is supported only for the "disabled" attribute. Note that when you are able to set a property on the client, you will be allowed to by using the the .setProperty('attribute', newValue) method, but not the .setXXXAttribute(newValue) method. For example, if you have unsecure="disabled", then on the client you can use the method .setProperty('disabled', false), while the method .setDisabled(false) will not work and will provide a javascript error that setDisabled is not a function. |
useWindow | boolean | Yes | Default Value: false 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 | Default Value: true 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 |
windowEmbedStyle | String | Yes | Valid Values: window, inlineDocument Default Value: window Controls the embedded style of launched window. The "window" option will indicate a new browser window. The "inlineDocument" option will indicate an inline popup window. The default value is "window". |
windowHeight | int | Yes | the height of the window, if this command is used to launch a window. |
windowModalityType | String | Yes | Valid Values: applicationModal, modeless Default Value: modeless Controls the modality of the launched Dialog. The default is modeless. |
windowWidth | int | Yes | the width of the window, if this command is used to launch a window. |