| Name |
Type |
Supports EL? |
Description |
|---|
| accessKey |
char |
Yes |
character used to gain quick access to this item.
For accessibility reasons, this functionality is not supported
in screen reader mode.
If the same access key appears in multiple locations 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 text attribute of this item instance.
If it does not, the user will receive no visual indication of
the existence of the accessKey. The easiest, and most convenient
way to specify both the text and the mnemonic together is to use
textAndAccessKey.
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.
|
| action |
javax.el.MethodExpression |
Yes |
a reference to an action method sent by the command component,
or the static outcome of an action |
| 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.RichActiveCommandToolbarButton |
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 |
The id used to locate this component when applying persistent customizations.
Components without a customizationId set can not save customizations to the persistent store. Instead, any
customizations will at most only apply to the current Session. Each customizationId must be unique in the
document. |
| depressedIcon |
String |
Yes |
the URI of the image displayed with this toolbar button when the mouse has pressed the button. |
| disabled |
boolean |
Yes |
whether the component is interactive or not. The default value is "false" and component assumes its expected behavior. |
| disabledIcon |
String |
Yes |
the URI of the image displayed with this toolbar button when the button is disabled. |
| hoverIcon |
String |
Yes |
the URI of the image displayed with this toolbar button when the mouse is hovering over the button. |
| icon |
String |
Yes |
a URI specifying the location of a toolbar image. |
| id |
String |
No |
the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
- Must not be a zero-length String.
- First character must be an ASCII letter (A-Za-z) or an underscore ('_').
- Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').
|
| 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. The default is true for activeCommandToolBarButton, so be sure to specify partialTriggers if content needs to be updated. |
| 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, 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,
or multiple colons to move up through the NamingContainers - "::" will
search from the parent naming container, ":::" will search
from the grandparent naming container, etc. |
| rendered |
boolean |
Yes |
whether the component is rendered. When set to false, no output
will be delivered for this component. |
| returnListener |
javax.el.MethodExpression |
Only EL |
a method reference to an return listener |
| selected |
boolean |
Yes |
whether the item is selected, for buttons of type radio or check.
For radio buttons, there is no server model implemented for handling mutual exclusivity. If
a user clicks a new button, the old selection will be unselected. If you programatically
call setSelected(true) from code, you must call setSelected(false) on the prior
selection as well. |
| shortDesc |
String |
Yes |
the short description of the component. This text is commonly used by user agents to display tooltip help text. For form components, this is displayed in the note window. |
| styleClass |
String |
Yes |
a CSS style class to use for this component. |
| text |
String |
Yes |
the text displayed in the toolbar item. |
| type |
String |
Yes |
Valid Values:
default, check, radio
the type of the toolbar button. |
| useWindow |
boolean |
Yes |
whether processes launched by this command
should be launched in a secondary dialog window. 'useWindow' works
only in the case of dialogs i.e, if the "action" starts with a
"dialog:". Set useWindow to 'false' for the dialog to be opened in
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.
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. |
Bookmark
