oracle.adf.view.faces.component
Class UIXCommand

java.lang.Object
  |
  +--javax.faces.component.UIComponent
        |
        +--oracle.adf.view.faces.component.UIXComponent
              |
              +--oracle.adf.view.faces.component.UIXComponentBase
                    |
                    +--oracle.adf.view.faces.component.CommandBase
                          |
                          +--oracle.adf.view.faces.component.UIXCommand
All Implemented Interfaces:
javax.faces.component.ActionSource, javax.faces.component.StateHolder
Direct Known Subclasses:
CoreCommandButton, CoreCommandGlobalButton, CoreCommandLink, CoreCommandOption

public class UIXCommand
extends CommandBase

UIXCommand is a base abstraction for components that implement ActionSource.

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.


Field Summary
static PropertyKey ACTION_KEY
           
static PropertyKey ACTION_LISTENER_KEY
           
static java.lang.String COMPONENT_FAMILY
           
static java.lang.String COMPONENT_TYPE
           
static PropertyKey IMMEDIATE_KEY
           
static FacesBean.Type TYPE
           
 
Fields inherited from class oracle.adf.view.faces.component.UIXComponentBase
ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY
 
Constructor Summary
UIXCommand()
          Construct an instance of the UIXCommand.
 
Method Summary
 javax.faces.el.MethodBinding getAction()
          Gets a reference to an action method sent by the command component, or the static outcome of an action
 javax.faces.el.MethodBinding getActionListener()
          Gets a method reference to an action listener
protected  FacesBean.Type getBeanType()
           
 java.lang.String getFamily()
           
 boolean isImmediate()
          Gets whether or not data validation - client-side or server-side - should take place when events are generated by this component.
 void setAction(javax.faces.el.MethodBinding action)
          Sets a reference to an action method sent by the command component, or the static outcome of an action
 void setActionListener(javax.faces.el.MethodBinding actionListener)
          Sets a method reference to an action listener
 void setImmediate(boolean immediate)
          Sets whether or not data validation - client-side or server-side - should take place when events are generated by this component.
 
Methods inherited from class oracle.adf.view.faces.component.CommandBase
addActionListener, broadcast, getActionListeners, queueEvent, removeActionListener
 
Methods inherited from class oracle.adf.view.faces.component.UIXComponentBase
addFacesListener, createFacesBean, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttribute, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getIntProperty, getLocalClientId, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreState, saveState, setAttribute, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

TYPE

public static final FacesBean.Type TYPE

ACTION_KEY

public static final PropertyKey ACTION_KEY

ACTION_LISTENER_KEY

public static final PropertyKey ACTION_LISTENER_KEY

IMMEDIATE_KEY

public static final PropertyKey IMMEDIATE_KEY

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

UIXCommand

public UIXCommand()
Construct an instance of the UIXCommand.

Method Detail

getAction

public final javax.faces.el.MethodBinding getAction()
Gets a reference to an action method sent by the command component, or the static outcome of an action


setAction

public final void setAction(javax.faces.el.MethodBinding action)
Sets a reference to an action method sent by the command component, or the static outcome of an action


getActionListener

public final javax.faces.el.MethodBinding getActionListener()
Gets a method reference to an action listener

Specified by:
getActionListener in interface javax.faces.component.ActionSource
Specified by:
getActionListener in class CommandBase

setActionListener

public final void setActionListener(javax.faces.el.MethodBinding actionListener)
Sets a method reference to an action listener


isImmediate

public final boolean isImmediate()
Gets whether or not data validation - client-side or server-side - should take place when events are generated by this component. When immediate is true, the default ActionListener provided by the JavaServer Faces implementation should be executed during Apply Request Values phase of the request processing lifecycle, rather than waiting until the Invoke Application phase.


setImmediate

public final void setImmediate(boolean immediate)
Sets whether or not data validation - client-side or server-side - should take place when events are generated by this component. When immediate is true, the default ActionListener provided by the JavaServer Faces implementation should be executed during Apply Request Values phase of the request processing lifecycle, rather than waiting until the Invoke Application phase.


getFamily

public java.lang.String getFamily()
Specified by:
getFamily in class UIXComponentBase

getBeanType

protected FacesBean.Type getBeanType()
Overrides:
getBeanType in class UIXComponentBase


Copyright © 2003-2004 Oracle Corporation. All Rights Reserved.