|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.component.UIComponent
org.apache.myfaces.trinidad.component.UIXComponent
org.apache.myfaces.trinidad.component.UIXComponentBase
org.apache.myfaces.trinidad.component.UIXSingleStep
public class UIXSingleStep
UIXSingleStep is a base abstraction for components
that implement ActionSource and
navigate back and forth through a sequence of known steps.
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.
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.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 event might include the width of a column that supported client-side resizing. |
Field Summary | |
---|---|
static String |
COMPONENT_FAMILY
|
static String |
COMPONENT_TYPE
|
static PropertyKey |
MAX_STEP_KEY
|
static PropertyKey |
NEXT_ACTION_KEY
|
static PropertyKey |
NEXT_ACTION_LISTENER_KEY
|
static Object |
NEXT_ACTION_TYPE
|
static PropertyKey |
PREVIOUS_ACTION_KEY
|
static PropertyKey |
PREVIOUS_ACTION_LISTENER_KEY
|
static Object |
PREVIOUS_ACTION_TYPE
|
static PropertyKey |
SELECTED_STEP_KEY
|
static FacesBean.Type |
TYPE
|
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 |
---|
BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY |
Constructor Summary | |
---|---|
|
UIXSingleStep()
Construct an instance of the UIXSingleStep. |
protected |
UIXSingleStep(String rendererType)
Construct an instance of the UIXSingleStep. |
Method Summary | |
---|---|
void |
addActionListener(javax.faces.event.ActionListener listener)
Adds a action listener. |
void |
broadcast(javax.faces.event.FacesEvent event)
|
javax.faces.el.MethodBinding |
getAction()
|
javax.faces.el.MethodBinding |
getActionListener()
|
javax.faces.event.ActionListener[] |
getActionListeners()
Returns an array of attached action listeners. |
Object |
getActionType()
|
protected FacesBean.Type |
getBeanType()
|
String |
getFamily()
|
int |
getMaxStep()
Gets the last possible step. |
javax.faces.el.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. |
javax.faces.el.MethodBinding |
getNextActionListener()
Gets a method reference to an action listener that will be called when the singleStep component navigates to the next step. |
javax.faces.el.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. |
javax.faces.el.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. |
boolean |
isImmediate()
returns true if the actionType is PREVIOUS_ACTION_TYPE |
void |
queueEvent(javax.faces.event.FacesEvent e)
|
void |
removeActionListener(javax.faces.event.ActionListener listener)
Removes a action listener. |
Object |
saveState(javax.faces.context.FacesContext context)
|
void |
setAction(javax.faces.el.MethodBinding action)
|
void |
setActionListener(javax.faces.el.MethodBinding listener)
|
void |
setActionType(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(javax.faces.el.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(javax.faces.el.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(javax.faces.el.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(javax.faces.el.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. |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, setInView |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final FacesBean.Type TYPE
public static final PropertyKey SELECTED_STEP_KEY
public static final PropertyKey MAX_STEP_KEY
public static final PropertyKey PREVIOUS_ACTION_LISTENER_KEY
public static final PropertyKey NEXT_ACTION_LISTENER_KEY
public static final PropertyKey NEXT_ACTION_KEY
public static final PropertyKey PREVIOUS_ACTION_KEY
public static final String COMPONENT_FAMILY
public static final String COMPONENT_TYPE
public static final Object NEXT_ACTION_TYPE
public static final Object PREVIOUS_ACTION_TYPE
Constructor Detail |
---|
public UIXSingleStep()
protected UIXSingleStep(String rendererType)
Method Detail |
---|
public void queueEvent(javax.faces.event.FacesEvent e)
queueEvent
in class UIXComponentBase
public Object getActionType()
public void setActionType(Object actionType)
public Object saveState(javax.faces.context.FacesContext context)
saveState
in interface javax.faces.component.StateHolder
saveState
in class UIXComponentBase
public void broadcast(javax.faces.event.FacesEvent event) throws javax.faces.event.AbortProcessingException
broadcast
in class UIXComponentBase
javax.faces.event.AbortProcessingException
public javax.faces.el.MethodBinding getAction()
getAction
in interface javax.faces.component.ActionSource
public void setAction(javax.faces.el.MethodBinding action)
setAction
in interface javax.faces.component.ActionSource
public javax.faces.el.MethodBinding getActionListener()
getActionListener
in interface javax.faces.component.ActionSource
public void setActionListener(javax.faces.el.MethodBinding listener)
setActionListener
in interface javax.faces.component.ActionSource
public boolean isImmediate()
isImmediate
in interface javax.faces.component.ActionSource
public void setImmediate(boolean immediate)
setImmediate
in interface javax.faces.component.ActionSource
public final int getSelectedStep()
public final void setSelectedStep(int selectedStep)
selectedStep
- the new selectedStep valuepublic final void setSelectedStep(long selectedStep)
selectedStep
- the new selectedStep valuepublic final int getMaxStep()
public final void setMaxStep(int maxStep)
maxStep
- the new maxStep valuepublic final void setMaxStep(long maxStep)
maxStep
- the new maxStep valuepublic final javax.faces.el.MethodBinding getPreviousActionListener()
public final void setPreviousActionListener(javax.faces.el.MethodBinding previousActionListener)
previousActionListener
- the new previousActionListener valuepublic final javax.faces.el.MethodBinding getNextActionListener()
public final void setNextActionListener(javax.faces.el.MethodBinding nextActionListener)
nextActionListener
- the new nextActionListener valuepublic final javax.faces.el.MethodBinding getNextAction()
public final void setNextAction(javax.faces.el.MethodBinding nextAction)
nextAction
- the new nextAction valuepublic final javax.faces.el.MethodBinding getPreviousAction()
public final void setPreviousAction(javax.faces.el.MethodBinding previousAction)
previousAction
- the new previousAction valuepublic final void addActionListener(javax.faces.event.ActionListener listener)
addActionListener
in interface javax.faces.component.ActionSource
listener
- the action listener to addpublic final void removeActionListener(javax.faces.event.ActionListener listener)
removeActionListener
in interface javax.faces.component.ActionSource
listener
- the action listener to removepublic final javax.faces.event.ActionListener[] getActionListeners()
getActionListeners
in interface javax.faces.component.ActionSource
public String getFamily()
getFamily
in class UIXComponentBase
protected FacesBean.Type getBeanType()
getBeanType
in class UIXComponentBase
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |