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.UIXCommand

All Implemented Interfaces:

ActionSource, DialogSource, StateHolder

Direct Known Subclasses:

CoreCommandButton, CoreCommandLink, CoreCommandMenuItem

public class UIXCommand

extends UIXComponentBase

implements ActionSource, DialogSource

UIXCommand is a base abstraction for components that implement ActionSource and DialogSource.

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.
oracle.adf.view.faces.event.ReturnEvent	Apply Request Values	Event delivered when the dialog has completed successfully.
oracle.adf.view.faces.event.LaunchEvent	Invoke Application Apply Request Values	Event delivered to prompt the command to launch a dialog.

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 PropertyKey	LAUNCH_LISTENER_KEY
static PropertyKey	RETURN_LISTENER_KEY
static FacesBean.Type	TYPE

Fields inherited from class oracle.adf.view.faces.component.UIXComponentBase

BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

Constructor Summary

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

Method Summary

void	addActionListener(ActionListener listener)
void	addLaunchListener(LaunchListener listener) Add a LaunchListener.
void	addReturnListener(ReturnListener listener) Add a ReturnListener.
void	broadcast(FacesEvent event)
MethodBinding	getAction() Gets a reference to an action method sent by the command component, or the static outcome of an action
MethodBinding	getActionListener() Gets a method reference to an action listener
ActionListener[]	getActionListeners()
protected FacesBean.Type	getBeanType()
java.lang.String	getFamily()
MethodBinding	getLaunchListener() Gets a method reference to a launch listener
LaunchListener[]	getLaunchListeners() Launch all added LaunchListeners.
MethodBinding	getReturnListener() Gets a method reference to an return listener
ReturnListener[]	getReturnListeners() Return all added ReturnListeners.
boolean	isImmediate() Gets whether or not data validation - client-side or server-side - should take place when events are generated by this component.
void	queueEvent(FacesEvent e) Intercept queueEvent and mark the phaseId for the event to be PhaseId.APPLY_REQUEST_VALUES if the immediate flag is true, PhaseId.INVOKE_APPLICATION otherwise.
void	removeActionListener(ActionListener listener)
void	removeLaunchListener(LaunchListener listener) Remove a LaunchListener.
void	removeReturnListener(ReturnListener listener) Remove a ReturnListener.
void	setAction(MethodBinding action) Sets a reference to an action method sent by the command component, or the static outcome of an action
void	setActionListener(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.
void	setLaunchListener(MethodBinding launchListener) Sets a method reference to a launch listener
void	setReturnListener(MethodBinding returnListener) Sets a method reference to an return listener

Methods inherited from class oracle.adf.view.faces.component.UIXComponentBase

addAttributeChange, addAttributeChange, addAttributeChangeListener, addFacesListener, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getLocalClientId, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeAttributeChangeListener, removeFacesListener, restoreState, saveState, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, toString, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl

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

RETURN_LISTENER_KEY

public static final PropertyKey RETURN_LISTENER_KEY

LAUNCH_LISTENER_KEY

public static final PropertyKey LAUNCH_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.

UIXCommand

protected UIXCommand(java.lang.String rendererType)

Construct an instance of the UIXCommand.

Method Detail

addActionListener

public void addActionListener(ActionListener listener)

Specified by:

addActionListener in interface ActionSource

removeActionListener

public void removeActionListener(ActionListener listener)

Specified by:

removeActionListener in interface ActionSource

getActionListeners

public ActionListener[] getActionListeners()

Specified by:

getActionListeners in interface ActionSource

addReturnListener

public void addReturnListener(ReturnListener listener)

Add a ReturnListener.

Specified by:

addReturnListener in interface DialogSource

removeReturnListener

public void removeReturnListener(ReturnListener listener)

Remove a ReturnListener.

Specified by:

removeReturnListener in interface DialogSource

getReturnListeners

public ReturnListener[] getReturnListeners()

Return all added ReturnListeners.

Specified by:

getReturnListeners in interface DialogSource

addLaunchListener

public void addLaunchListener(LaunchListener listener)

Add a LaunchListener.

Specified by:

addLaunchListener in interface DialogSource

removeLaunchListener

public void removeLaunchListener(LaunchListener listener)

Remove a LaunchListener.

Specified by:

removeLaunchListener in interface DialogSource

getLaunchListeners

public LaunchListener[] getLaunchListeners()

Launch all added LaunchListeners.

Specified by:

getLaunchListeners in interface DialogSource

queueEvent

public void queueEvent(FacesEvent e)

Intercept queueEvent and mark the phaseId for the event to be PhaseId.APPLY_REQUEST_VALUES if the immediate flag is true, PhaseId.INVOKE_APPLICATION otherwise.

Overrides:

queueEvent in class UIXComponentBase

broadcast

public void broadcast(FacesEvent event)
               throws AbortProcessingException

Overrides:

broadcast in class UIXComponentBase

Throws:

AbortProcessingException

getAction

public final MethodBinding getAction()

Gets a reference to an action method sent by the command component, or the static outcome of an action

Specified by:

getAction in interface ActionSource

setAction

public final void setAction(MethodBinding action)

Sets a reference to an action method sent by the command component, or the static outcome of an action

Specified by:

setAction in interface ActionSource

getActionListener

public final MethodBinding getActionListener()

Gets a method reference to an action listener

Specified by:

getActionListener in interface ActionSource

setActionListener

public final void setActionListener(MethodBinding actionListener)

Sets a method reference to an action listener

Specified by:

setActionListener in interface ActionSource

getReturnListener

public final MethodBinding getReturnListener()

Gets a method reference to an return listener

Specified by:

getReturnListener in interface DialogSource

setReturnListener

public final void setReturnListener(MethodBinding returnListener)

Sets a method reference to an return listener

Specified by:

setReturnListener in interface DialogSource

getLaunchListener

public final MethodBinding getLaunchListener()

Gets a method reference to a launch listener

Specified by:

getLaunchListener in interface DialogSource

setLaunchListener

public final void setLaunchListener(MethodBinding launchListener)

Sets a method reference to a launch listener

Specified by:

setLaunchListener in interface DialogSource

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.

Specified by:

isImmediate in interface ActionSource

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.

Specified by:

setImmediate in interface ActionSource

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class UIXComponentBase

getBeanType

protected FacesBean.Type getBeanType()

Overrides:

getBeanType in class UIXComponentBase