oracle.adf.view.faces.component
Class UIXSingleStep

java.lang.Object
  javax.faces.component.UIComponent
      oracle.adf.view.faces.component.UIXComponent
          oracle.adf.view.faces.component.UIXComponentBase
              oracle.adf.view.faces.component.UIXSingleStep

All Implemented Interfaces:

ActionSource, StateHolder

Direct Known Subclasses:

CoreSingleStepButtonBar

public class UIXSingleStep

extends UIXComponentBase

implements ActionSource

UIXSingleStep is a base abstraction for components that implement ActionSource and navigate back and forth through a sequence of known steps.

Events and Listeners

UIXSingleStep implements javax.faces.component.ActionSource, which means it is a source of javax.faces.event.ActionEvents. The ActionEvent is delivered during the Apply Request Values phase when navigating back, and during the Invoke Application phase when navigating forward. The nextAction/previousAction attributes are of type MethodBinding and must (if non-null) point to an action method. The nextAction method will be called when navigating forward, and the previousAction method will be called when navigating back with a singleStep component. JSF has a default javax.faces.event.ActionListener that passes the nextAction or previousAction outcome to the NavigationHandler. The nextActionListener/previousActionListener attributes are of type MethodBinding and must (in non-null) point to a method accepting an ActionEvent, with a return type of void. When navigating to the previous step, then the previousActionListener method is called. When navigating to the next step, the nextActionListener method is called.

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 java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static PropertyKey	MAX_STEP_KEY
static PropertyKey	NEXT_ACTION_KEY
static PropertyKey	NEXT_ACTION_LISTENER_KEY
static java.lang.Object	NEXT_ACTION_TYPE
static PropertyKey	PREVIOUS_ACTION_KEY
static PropertyKey	PREVIOUS_ACTION_LISTENER_KEY
static java.lang.Object	PREVIOUS_ACTION_TYPE
static PropertyKey	SELECTED_STEP_KEY
static PropertyKey	TEXT_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

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

Method Summary

void	addActionListener(ActionListener listener)
void	broadcast(FacesEvent event)
MethodBinding	getAction()
MethodBinding	getActionListener()
ActionListener[]	getActionListeners()
java.lang.Object	getActionType()
protected FacesBean.Type	getBeanType()
java.lang.String	getFamily()
int	getMaxStep() Gets the last possible step.
MethodBinding	getNextAction() Gets a reference to an action method that will be called when the singleStep component navigates to the next step, or the static outcome of the action.
MethodBinding	getNextActionListener() Gets a method reference to an action listener that will be called when the singleStep component navigates to the next step.
MethodBinding	getPreviousAction() Gets a reference to an action method that will be called when the singleStep component navigates to the previous step, or the static outcome of the action.
MethodBinding	getPreviousActionListener() Gets a method reference to an action listener that will be called when the singleStep component navigates to the previous step.
int	getSelectedStep() Gets the current step.
java.lang.String	getText() Gets the text description of items being navigated.
boolean	isImmediate() returns true if the actionType is PREVIOUS_ACTION_TYPE
void	queueEvent(FacesEvent e)
void	removeActionListener(ActionListener listener)
java.lang.Object	saveState(FacesContext context)
void	setAction(MethodBinding action)
void	setActionListener(MethodBinding listener)
void	setActionType(java.lang.Object actionType)
void	setImmediate(boolean immediate) no-op.
void	setMaxStep(int maxStep) Sets the last possible step.
void	setMaxStep(long maxStep) Sets the last possible step.
void	setNextAction(MethodBinding nextAction) Sets a reference to an action method that will be called when the singleStep component navigates to the next step, or the static outcome of the action.
void	setNextActionListener(MethodBinding nextActionListener) Sets a method reference to an action listener that will be called when the singleStep component navigates to the next step.
void	setPreviousAction(MethodBinding previousAction) Sets a reference to an action method that will be called when the singleStep component navigates to the previous step, or the static outcome of the action.
void	setPreviousActionListener(MethodBinding previousActionListener) Sets a method reference to an action listener that will be called when the singleStep component navigates to the previous step.
void	setSelectedStep(int selectedStep) Sets the current step.
void	setSelectedStep(long selectedStep) Sets the current step.
void	setText(java.lang.String text) Sets the text description of items being navigated.

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, 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

SELECTED_STEP_KEY

public static final PropertyKey SELECTED_STEP_KEY

MAX_STEP_KEY

public static final PropertyKey MAX_STEP_KEY

TEXT_KEY

public static final PropertyKey TEXT_KEY

PREVIOUS_ACTION_LISTENER_KEY

public static final PropertyKey PREVIOUS_ACTION_LISTENER_KEY

NEXT_ACTION_LISTENER_KEY

public static final PropertyKey NEXT_ACTION_LISTENER_KEY

NEXT_ACTION_KEY

public static final PropertyKey NEXT_ACTION_KEY

PREVIOUS_ACTION_KEY

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

NEXT_ACTION_TYPE

public static final java.lang.Object NEXT_ACTION_TYPE

PREVIOUS_ACTION_TYPE

public static final java.lang.Object PREVIOUS_ACTION_TYPE

Constructor Detail

UIXSingleStep

public UIXSingleStep()

Construct an instance of the UIXSingleStep.

UIXSingleStep

protected UIXSingleStep(java.lang.String rendererType)

Construct an instance of the UIXSingleStep.

Method Detail

queueEvent

public void queueEvent(FacesEvent e)

Overrides:

queueEvent in class UIXComponentBase

getActionType

public java.lang.Object getActionType()

setActionType

public void setActionType(java.lang.Object actionType)

saveState

public java.lang.Object saveState(FacesContext context)

Specified by:

saveState in interface StateHolder

Overrides:

saveState in class UIXComponentBase

broadcast

public void broadcast(FacesEvent event)
               throws AbortProcessingException

Overrides:

broadcast in class UIXComponentBase

Throws:

AbortProcessingException

getAction

public MethodBinding getAction()

Specified by:

getAction in interface ActionSource

setAction

public void setAction(MethodBinding action)

Specified by:

setAction in interface ActionSource

getActionListener

public MethodBinding getActionListener()

Specified by:

getActionListener in interface ActionSource

setActionListener

public void setActionListener(MethodBinding listener)

Specified by:

setActionListener in interface ActionSource

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

isImmediate

public boolean isImmediate()

returns true if the actionType is PREVIOUS_ACTION_TYPE

Specified by:

isImmediate in interface ActionSource

setImmediate

public void setImmediate(boolean immediate)

no-op. For UIXSingleStep components, even though it implements ActionSource, we do no have an immediate attribute. By default, if actionType is PREVIOUS_ACTION_TYPE, we set the phase to PhaseId.APPLY_REQUEST_VALUES, else we set the phase to PhaseId.INVOKE_APPLICATION.

Specified by:

setImmediate in interface ActionSource

getSelectedStep

public final int getSelectedStep()

Gets the current step. The valid range is 1 to maxStep. It defaults to 1.

setSelectedStep

public final void setSelectedStep(int selectedStep)

Sets the current step. The valid range is 1 to maxStep. It defaults to 1.

setSelectedStep

public final void setSelectedStep(long selectedStep)

Sets the current step. The valid range is 1 to maxStep. It defaults to 1.

getMaxStep

public final int getMaxStep()

Gets the last possible step. If this value is not known, it should be set to MAX_VALUE_UNKNOWN (-1), which is also the default value. If maxStep is MAX_VALUE_UNKNOWN, then no text is rendered between the Back/Next buttons. When maxStep is 2 and selectedStep is 1, then only a Continue button is rendered.

setMaxStep

public final void setMaxStep(int maxStep)

Sets the last possible step. If this value is not known, it should be set to MAX_VALUE_UNKNOWN (-1), which is also the default value. If maxStep is MAX_VALUE_UNKNOWN, then no text is rendered between the Back/Next buttons. When maxStep is 2 and selectedStep is 1, then only a Continue button is rendered.

setMaxStep

public final void setMaxStep(long maxStep)

Sets the last possible step. If this value is not known, it should be set to MAX_VALUE_UNKNOWN (-1), which is also the default value. If maxStep is MAX_VALUE_UNKNOWN, then no text is rendered between the Back/Next buttons. When maxStep is 2 and selectedStep is 1, then only a Continue button is rendered.

getText

public final java.lang.String getText()

Gets the text description of items being navigated. The default is "Step".

setText

public final void setText(java.lang.String text)

Sets the text description of items being navigated. The default is "Step".

getPreviousActionListener

public final MethodBinding getPreviousActionListener()

Gets a method reference to an action listener that will be called when the singleStep component navigates to the previous step.

setPreviousActionListener

public final void setPreviousActionListener(MethodBinding previousActionListener)

Sets a method reference to an action listener that will be called when the singleStep component navigates to the previous step.

getNextActionListener

public final MethodBinding getNextActionListener()

Gets a method reference to an action listener that will be called when the singleStep component navigates to the next step.

setNextActionListener

public final void setNextActionListener(MethodBinding nextActionListener)

Sets a method reference to an action listener that will be called when the singleStep component navigates to the next step.

getNextAction

public final MethodBinding getNextAction()

Gets a reference to an action method that will be called when the singleStep component navigates to the next step, or the static outcome of the action.

setNextAction

public final void setNextAction(MethodBinding nextAction)

Sets a reference to an action method that will be called when the singleStep component navigates to the next step, or the static outcome of the action.

getPreviousAction

public final MethodBinding getPreviousAction()

Gets a reference to an action method that will be called when the singleStep component navigates to the previous step, or the static outcome of the action.

setPreviousAction

public final void setPreviousAction(MethodBinding previousAction)

Sets a reference to an action method that will be called when the singleStep component navigates to the previous step, or the static outcome of the action.

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class UIXComponentBase

getBeanType

protected FacesBean.Type getBeanType()

Overrides:

getBeanType in class UIXComponentBase