Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 1 (11.1.1.6.0)
E10684-07


oracle.adf.view.rich.component.rich.nav
Class RichActiveCommandToolbarButton

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by org.apache.myfaces.trinidad.component.UIXComponent
          extended by org.apache.myfaces.trinidad.component.UIXComponentBase
              extended by org.apache.myfaces.trinidad.component.UIXCommand
                  extended by oracle.adf.view.rich.component.rich.nav.RichActiveCommandToolbarButton

All Implemented Interfaces:
javax.faces.component.ActionSource, javax.faces.component.ActionSource2, javax.faces.component.StateHolder, org.apache.myfaces.trinidad.component.DialogSource

public class RichActiveCommandToolbarButton
extends org.apache.myfaces.trinidad.component.UIXCommand

The activeCommandToolbarButton creates a button in a toolbar. It is normally used inside of a <af:toolbar> component. activeCommandToolbarButtons are not rendered on printable pages. Due to performance overhead compared to <af:commandToolbarButton>, you should only use this component if you plan to support changing the visible attribute through active data, otherwise you should use the <af:commandToolbarButton> component.

Events:

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.

Field Summary
static org.apache.myfaces.trinidad.bean.PropertyKey ACCESS_KEY_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_ATTRIBUTES_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_COMPONENT_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_LISTENERS_KEY
           
static java.lang.String COMPONENT_FAMILY
           
static java.lang.String COMPONENT_TYPE
           
static org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY
          Deprecated. 
static org.apache.myfaces.trinidad.bean.PropertyKey DEPRESSED_ICON_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey DISABLED_ICON_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey DISABLED_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey HOVER_ICON_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey ICON_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_SUBMIT_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY
           
static java.lang.String POPUP_FACET
           
static org.apache.myfaces.trinidad.bean.PropertyKey SELECTED_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey TEXT_KEY
           
static org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
           
static java.lang.String TYPE_CHECK
           
static java.lang.String TYPE_DEFAULT
           
static org.apache.myfaces.trinidad.bean.PropertyKey TYPE_KEY
           
static java.lang.String TYPE_RADIO
           
static org.apache.myfaces.trinidad.bean.PropertyKey UNSECURE_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey USE_WINDOW_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey VISIBLE_KEY
           
static java.lang.String WINDOW_EMBED_STYLE_INLINE_DOCUMENT
           
static org.apache.myfaces.trinidad.bean.PropertyKey WINDOW_EMBED_STYLE_KEY
           
static java.lang.String WINDOW_EMBED_STYLE_WINDOW
           
static org.apache.myfaces.trinidad.bean.PropertyKey WINDOW_HEIGHT_KEY
           
static java.lang.String WINDOW_MODALITY_TYPE_APPLICATION_MODAL
           
static org.apache.myfaces.trinidad.bean.PropertyKey WINDOW_MODALITY_TYPE_KEY
           
static java.lang.String WINDOW_MODALITY_TYPE_MODELESS
           
static org.apache.myfaces.trinidad.bean.PropertyKey WINDOW_WIDTH_KEY
           

 

Fields inherited from class org.apache.myfaces.trinidad.component.UIXCommand
ACTION_EXPRESSION_KEY, ACTION_LISTENER_KEY, IMMEDIATE_KEY, LAUNCH_LISTENER_KEY, RETURN_LISTENER_KEY

 

Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase
BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

 

Fields inherited from class javax.faces.component.UIComponent
bindings

 

Constructor Summary
  RichActiveCommandToolbarButton()
          Construct an instance of the RichActiveCommandToolbarButton.
protected RichActiveCommandToolbarButton(java.lang.String rendererType)
          Construct an instance of the RichActiveCommandToolbarButton.

 

Method Summary
 char getAccessKey()
          Gets character used to gain quick access to this item.
protected  org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
           
 java.util.Set getClientAttributes()
          Gets a set of client attribute names.
 ClientListenerSet getClientListeners()
          Gets a set of client listeners.
 java.lang.String getCustomizationId()
          Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
 java.lang.String getDepressedIcon()
          Gets The URI of an image to be displayed on the toolbar button when the mouse has pressed the button.
 java.lang.String getDisabledIcon()
          Gets The URI of an image to be displayed on the toolbar button when the button is disabled.
 java.lang.String getFamily()
           
 java.lang.String getHoverIcon()
          Gets the URI of an image to be displayed on the toolbar button when the mouse is hovering over the button.
 java.lang.String getIcon()
          Gets The URI of an image to be displayed on the toolbar button.
 java.lang.String getInlineStyle()
          Gets the CSS styles to use for this component.
 java.lang.String[] getPartialTriggers()
          Gets the IDs of the components that should trigger a partial update.
 javax.faces.component.UIComponent getPopup()
          The popup displayed by this toolbar button.
 java.lang.String getShortDesc()
          Gets the short description of the component.
 java.lang.String getStyleClass()
          Gets a CSS style class to use for this component.
 java.lang.String getText()
          Gets the text displayed in the toolbar item.
 java.lang.String getType()
          Gets the type of the toolbar button.
 java.util.Set<java.lang.String> getUnsecure()
          Gets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client.
 java.lang.String getWindowEmbedStyle()
          Gets Controls the embedded style of launched window.
 int getWindowHeight()
          Gets the height of the window, if this command is used to launch a window.
 java.lang.String getWindowModalityType()
          Gets Controls the modality of the launched Dialog.
 int getWindowWidth()
          Gets the width of the window, if this command is used to launch a window.
 boolean isClientComponent()
          Gets whether a client-side component will be generated.
 boolean isDisabled()
          Gets whether the component is interactive or not.
 boolean isPartialSubmit()
          Gets whether the action should be done through a partial page submit or not.
 boolean isSelected()
          Gets whether the item is selected, for buttons of type radio or check.
 boolean isUseWindow()
          Gets whether processes launched by this command should be launched in a secondary browser dialog window.
 boolean isVisible()
          Gets the visibility of the component.
 void setAccessKey(char accessKey)
          Sets character used to gain quick access to this item.
 void setClientAttributes(java.util.Set clientAttributes)
          Sets a set of client attribute names.
 void setClientComponent(boolean clientComponent)
          Sets whether a client-side component will be generated.
 void setClientListeners(ClientListenerSet clientListeners)
          Sets a set of client listeners.
 void setCustomizationId(java.lang.String customizationId)
          Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
 void setDepressedIcon(java.lang.String depressedIcon)
          Sets The URI of an image to be displayed on the toolbar button when the mouse has pressed the button.
 void setDisabled(boolean disabled)
          Sets whether the component is interactive or not.
 void setDisabledIcon(java.lang.String disabledIcon)
          Sets The URI of an image to be displayed on the toolbar button when the button is disabled.
 void setHoverIcon(java.lang.String hoverIcon)
          Sets the URI of an image to be displayed on the toolbar button when the mouse is hovering over the button.
 void setIcon(java.lang.String icon)
          Sets The URI of an image to be displayed on the toolbar button.
 void setInlineStyle(java.lang.String inlineStyle)
          Sets the CSS styles to use for this component.
 void setPartialSubmit(boolean partialSubmit)
          Sets whether the action should be done through a partial page submit or not.
 void setPartialTriggers(java.lang.String[] partialTriggers)
          Sets the IDs of the components that should trigger a partial update.
 void setPopup(javax.faces.component.UIComponent popupFacet)
          The popup displayed by this toolbar button.
 void setSelected(boolean selected)
          Sets whether the item is selected, for buttons of type radio or check.
 void setShortDesc(java.lang.String shortDesc)
          Sets the short description of the component.
 void setStyleClass(java.lang.String styleClass)
          Sets a CSS style class to use for this component.
 void setText(java.lang.String text)
          Sets the text displayed in the toolbar item.
 void setType(java.lang.String type)
          Sets the type of the toolbar button.
 void setUnsecure(java.util.Set<java.lang.String> unsecure)
          Sets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client.
 void setUseWindow(boolean useWindow)
          Sets whether processes launched by this command should be launched in a secondary browser dialog window.
 void setVisible(boolean visible)
          Sets the visibility of the component.
 void setWindowEmbedStyle(java.lang.String windowEmbedStyle)
          Sets Controls the embedded style of launched window.
 void setWindowHeight(int windowHeight)
          Sets the height of the window, if this command is used to launch a window.
 void setWindowModalityType(java.lang.String windowModalityType)
          Sets Controls the modality of the launched Dialog.
 void setWindowWidth(int windowWidth)
          Sets the width of the window, if this command is used to launch a window.

 

Methods inherited from class org.apache.myfaces.trinidad.component.UIXCommand
addActionListener, addLaunchListener, addReturnListener, broadcast, getAction, getActionExpression, getActionListener, getActionListeners, getLaunchListener, getLaunchListeners, getReturnListener, getReturnListeners, isImmediate, queueEvent, removeActionListener, removeLaunchListener, removeReturnListener, setAction, setActionExpression, setActionListener, setImmediate, setLaunchListener, setLaunchListener, setReturnListener, setReturnListener

 

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeAttributeChangeListener, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, toString, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl

 

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent
addPartialTarget, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setUpEncodingContext, setupVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitTree, visitTree

 

Methods inherited from class javax.faces.component.UIComponent
encodeAll, getContainerClientId

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Field Detail

WINDOW_MODALITY_TYPE_APPLICATION_MODAL

public static final java.lang.String WINDOW_MODALITY_TYPE_APPLICATION_MODAL
See Also:
Constant Field Values

WINDOW_MODALITY_TYPE_MODELESS

public static final java.lang.String WINDOW_MODALITY_TYPE_MODELESS
See Also:
Constant Field Values

WINDOW_EMBED_STYLE_WINDOW

public static final java.lang.String WINDOW_EMBED_STYLE_WINDOW
See Also:
Constant Field Values

WINDOW_EMBED_STYLE_INLINE_DOCUMENT

public static final java.lang.String WINDOW_EMBED_STYLE_INLINE_DOCUMENT
See Also:
Constant Field Values

TYPE_DEFAULT

public static final java.lang.String TYPE_DEFAULT
See Also:
Constant Field Values

TYPE_CHECK

public static final java.lang.String TYPE_CHECK
See Also:
Constant Field Values

TYPE_RADIO

public static final java.lang.String TYPE_RADIO
See Also:
Constant Field Values

TYPE

public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE

INLINE_STYLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY

STYLE_CLASS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY

SHORT_DESC_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY

UNSECURE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey UNSECURE_KEY

VISIBLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey VISIBLE_KEY

CUSTOMIZATION_ID_KEY

@Deprecated
public static final org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY
Deprecated. 

CLIENT_COMPONENT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_COMPONENT_KEY

CLIENT_ATTRIBUTES_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_ATTRIBUTES_KEY

PARTIAL_TRIGGERS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY

CLIENT_LISTENERS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_LISTENERS_KEY

USE_WINDOW_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey USE_WINDOW_KEY

WINDOW_MODALITY_TYPE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey WINDOW_MODALITY_TYPE_KEY

WINDOW_EMBED_STYLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey WINDOW_EMBED_STYLE_KEY

WINDOW_HEIGHT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey WINDOW_HEIGHT_KEY

WINDOW_WIDTH_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey WINDOW_WIDTH_KEY

ACCESS_KEY_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey ACCESS_KEY_KEY

PARTIAL_SUBMIT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_SUBMIT_KEY

DISABLED_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey DISABLED_KEY

DEPRESSED_ICON_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey DEPRESSED_ICON_KEY

HOVER_ICON_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey HOVER_ICON_KEY

DISABLED_ICON_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey DISABLED_ICON_KEY

ICON_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey ICON_KEY

TEXT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey TEXT_KEY

TYPE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey TYPE_KEY

SELECTED_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SELECTED_KEY

POPUP_FACET

public static final java.lang.String POPUP_FACET
See Also:
Constant Field Values

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY
See Also:
Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE
See Also:
Constant Field Values

Constructor Detail

RichActiveCommandToolbarButton

public RichActiveCommandToolbarButton()
Construct an instance of the RichActiveCommandToolbarButton.

RichActiveCommandToolbarButton

protected RichActiveCommandToolbarButton(java.lang.String rendererType)
Construct an instance of the RichActiveCommandToolbarButton.

Method Detail

getPopup

public final javax.faces.component.UIComponent getPopup()
The popup displayed by this toolbar button.

setPopup

public final void setPopup(javax.faces.component.UIComponent popupFacet)
The popup displayed by this toolbar button.

getInlineStyle

public final java.lang.String getInlineStyle()
Gets 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.
Returns:
the new inlineStyle value

setInlineStyle

public final void setInlineStyle(java.lang.String inlineStyle)
Sets 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.
Parameters:
inlineStyle - the new inlineStyle value

getStyleClass

public final java.lang.String getStyleClass()
Gets 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'.
Returns:
the new styleClass value

setStyleClass

public final void setStyleClass(java.lang.String styleClass)
Sets 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'.
Parameters:
styleClass - the new styleClass value

getShortDesc

public final java.lang.String getShortDesc()
Gets 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. For components that support the helpTopicId attribute it is recommended that helpTopicId is used as it is more flexible and is more accessibility-compliant.
Returns:
the new shortDesc value

setShortDesc

public final void setShortDesc(java.lang.String shortDesc)
Sets 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. For components that support the helpTopicId attribute it is recommended that helpTopicId is used as it is more flexible and is more accessibility-compliant.
Parameters:
shortDesc - the new shortDesc value

getUnsecure

public final java.util.Set<java.lang.String> getUnsecure()
Gets 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.
Returns:
the new unsecure value

setUnsecure

public final void setUnsecure(java.util.Set<java.lang.String> unsecure)
Sets 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.
Parameters:
unsecure - the new unsecure value

isVisible

public final boolean isVisible()
Gets 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.
Returns:
the new visible value

setVisible

public final void setVisible(boolean visible)
Sets 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.
Parameters:
visible - the new visible value

getCustomizationId

@Deprecated
public final java.lang.String getCustomizationId()
Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
Gets This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.
Returns:
the new customizationId value

setCustomizationId

@Deprecated
public final void setCustomizationId(java.lang.String customizationId)
Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
Sets This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.
Parameters:
customizationId - the new customizationId value

isClientComponent

public final boolean isClientComponent()
Gets 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.
Returns:
the new clientComponent value

setClientComponent

public final void setClientComponent(boolean clientComponent)
Sets 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.
Parameters:
clientComponent - the new clientComponent value

getClientAttributes

public final java.util.Set getClientAttributes()
Gets a set of client attribute names.
Returns:
the new clientAttributes value

setClientAttributes

public final void setClientAttributes(java.util.Set clientAttributes)
Sets a set of client attribute names.
Parameters:
clientAttributes - the new clientAttributes value

getPartialTriggers

public final java.lang.String[] getPartialTriggers()
Gets 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.
Returns:
the new partialTriggers value

setPartialTriggers

public final void setPartialTriggers(java.lang.String[] partialTriggers)
Sets 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.
Parameters:
partialTriggers - the new partialTriggers value

getClientListeners

public final ClientListenerSet getClientListeners()
Gets a set of client listeners.
Returns:
the new clientListeners value

setClientListeners

public final void setClientListeners(ClientListenerSet clientListeners)
Sets a set of client listeners.
Parameters:
clientListeners - the new clientListeners value

isUseWindow

public final boolean isUseWindow()
Gets 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.
Returns:
the new useWindow value

setUseWindow

public final void setUseWindow(boolean useWindow)
Sets 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.
Parameters:
useWindow - the new useWindow value

getWindowModalityType

public final java.lang.String getWindowModalityType()
Gets Controls the modality of the launched Dialog. The default is modeless.
Returns:
the new windowModalityType value

setWindowModalityType

public final void setWindowModalityType(java.lang.String windowModalityType)
Sets Controls the modality of the launched Dialog. The default is modeless.
Parameters:
windowModalityType - the new windowModalityType value

getWindowEmbedStyle

public final java.lang.String getWindowEmbedStyle()
Gets 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".
Returns:
the new windowEmbedStyle value

setWindowEmbedStyle

public final void setWindowEmbedStyle(java.lang.String windowEmbedStyle)
Sets 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".
Parameters:
windowEmbedStyle - the new windowEmbedStyle value

getWindowHeight

public final int getWindowHeight()
Gets the height of the window, if this command is used to launch a window.
Returns:
the new windowHeight value

setWindowHeight

public final void setWindowHeight(int windowHeight)
Sets the height of the window, if this command is used to launch a window.
Parameters:
windowHeight - the new windowHeight value

getWindowWidth

public final int getWindowWidth()
Gets the width of the window, if this command is used to launch a window.
Returns:
the new windowWidth value

setWindowWidth

public final void setWindowWidth(int windowWidth)
Sets the width of the window, if this command is used to launch a window.
Parameters:
windowWidth - the new windowWidth value

getAccessKey

public final char getAccessKey()
Gets 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.

Returns:
the new accessKey value

setAccessKey

public final void setAccessKey(char accessKey)
Sets 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.

Parameters:
accessKey - the new accessKey value

isPartialSubmit

public final boolean isPartialSubmit()
Gets 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.
Returns:
the new partialSubmit value

setPartialSubmit

public final void setPartialSubmit(boolean partialSubmit)
Sets 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.
Parameters:
partialSubmit - the new partialSubmit value

isDisabled

public final boolean isDisabled()
Gets whether the component is interactive or not. The default value is "false" and component assumes its expected behavior.
Returns:
the new disabled value

setDisabled

public final void setDisabled(boolean disabled)
Sets whether the component is interactive or not. The default value is "false" and component assumes its expected behavior.
Parameters:
disabled - the new disabled value

getDepressedIcon

public final java.lang.String getDepressedIcon()
Gets The URI of an image to be displayed on the toolbar button when the mouse has pressed the button. This attribute supports the same URI types described for the icon attribute.

As depressedIcon does not allow alternative text to be provided for the image, in order to create an accessible product depressedIcon must only be used when its use is purely decorative.
Returns:
the new depressedIcon value

setDepressedIcon

public final void setDepressedIcon(java.lang.String depressedIcon)
Sets The URI of an image to be displayed on the toolbar button when the mouse has pressed the button. This attribute supports the same URI types described for the icon attribute.

As depressedIcon does not allow alternative text to be provided for the image, in order to create an accessible product depressedIcon must only be used when its use is purely decorative.
Parameters:
depressedIcon - the new depressedIcon value

getHoverIcon

public final java.lang.String getHoverIcon()
Gets the URI of an image to be displayed on the toolbar button when the mouse is hovering over the button. This attribute supports the same URI types described for the icon attribute.

As hoverIcon does not allow alternative text to be provided for the image, in order to create an accessible product hoverIcon must only be used when its use is purely decorative.
Returns:
the new hoverIcon value

setHoverIcon

public final void setHoverIcon(java.lang.String hoverIcon)
Sets the URI of an image to be displayed on the toolbar button when the mouse is hovering over the button. This attribute supports the same URI types described for the icon attribute.

As hoverIcon does not allow alternative text to be provided for the image, in order to create an accessible product hoverIcon must only be used when its use is purely decorative.
Parameters:
hoverIcon - the new hoverIcon value

getDisabledIcon

public final java.lang.String getDisabledIcon()
Gets The URI of an image to be displayed on the toolbar button when the button is disabled. This attribute supports the same URI types described for the icon attribute.

As disabledIcon does not allow alternative text to be provided for the image, in order to create an accessible product disabledIcon must only be used when its use is purely decorative.
Returns:
the new disabledIcon value

setDisabledIcon

public final void setDisabledIcon(java.lang.String disabledIcon)
Sets The URI of an image to be displayed on the toolbar button when the button is disabled. This attribute supports the same URI types described for the icon attribute.

As disabledIcon does not allow alternative text to be provided for the image, in order to create an accessible product disabledIcon must only be used when its use is purely decorative.
Parameters:
disabledIcon - the new disabledIcon value

getIcon

public final java.lang.String getIcon()
Gets The URI of an image to be displayed on the toolbar button. This attribute supports these various types of URIs: As icon does not allow alternative text to be provided for the image, in order to create an accessible product icon must only be used when its use is purely decorative.
Returns:
the new icon value

setIcon

public final void setIcon(java.lang.String icon)
Sets The URI of an image to be displayed on the toolbar button. This attribute supports these various types of URIs: As icon does not allow alternative text to be provided for the image, in order to create an accessible product icon must only be used when its use is purely decorative.
Parameters:
icon - the new icon value

getText

public final java.lang.String getText()
Gets the text displayed in the toolbar item.
Returns:
the new text value

setText

public final void setText(java.lang.String text)
Sets the text displayed in the toolbar item.
Parameters:
text - the new text value

getType

public final java.lang.String getType()
Gets the type of the toolbar button.
Returns:
the new type value

setType

public final void setType(java.lang.String type)
Sets the type of the toolbar button.
Parameters:
type - the new type value

isSelected

public final boolean isSelected()
Gets 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.
Returns:
the new selected value

setSelected

public final void setSelected(boolean selected)
Sets 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.
Parameters:
selected - the new selected value

getFamily

public java.lang.String getFamily()
Overrides:
getFamily in class org.apache.myfaces.trinidad.component.UIXCommand

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
Overrides:
getBeanType in class org.apache.myfaces.trinidad.component.UIXCommand

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 1 (11.1.1.6.0)
E10684-07


Copyright (c) 1998, 2011, Oracle and/or its affiliates. All rights reserved.