|
||||||||||
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
org.apache.myfaces.trinidad.component.core.nav.CoreSingleStepButtonBar
public class CoreSingleStepButtonBar
SingleStepButtonBar renders a Previous button,
text indicating the current step and the maximum steps, and a Next button.
SingleStepButtonBar is used to navigate forward and back in
a series of steps, like steps in a checkout process.
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 |
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 |
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 java.lang.String |
COMPONENT_FAMILY
|
static java.lang.String |
COMPONENT_TYPE
|
static PropertyKey |
INLINE_STYLE_KEY
|
static PropertyKey |
ONCLICK_KEY
|
static PropertyKey |
ONDBLCLICK_KEY
|
static PropertyKey |
ONKEYDOWN_KEY
|
static PropertyKey |
ONKEYPRESS_KEY
|
static PropertyKey |
ONKEYUP_KEY
|
static PropertyKey |
ONMOUSEDOWN_KEY
|
static PropertyKey |
ONMOUSEMOVE_KEY
|
static PropertyKey |
ONMOUSEOUT_KEY
|
static PropertyKey |
ONMOUSEOVER_KEY
|
static PropertyKey |
ONMOUSEUP_KEY
|
static PropertyKey |
PARTIAL_TRIGGERS_KEY
|
static PropertyKey |
SHORT_DESC_KEY
|
static PropertyKey |
STYLE_CLASS_KEY
|
static PropertyKey |
TEXT_KEY
|
static FacesBean.Type |
TYPE
|
Fields inherited from class org.apache.myfaces.trinidad.component.UIXSingleStep |
---|
MAX_STEP_KEY, NEXT_ACTION_KEY, NEXT_ACTION_LISTENER_KEY, NEXT_ACTION_TYPE, PREVIOUS_ACTION_KEY, PREVIOUS_ACTION_LISTENER_KEY, PREVIOUS_ACTION_TYPE, SELECTED_STEP_KEY |
Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase |
---|
BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY |
Constructor Summary | |
---|---|
|
CoreSingleStepButtonBar()
Construct an instance of the CoreSingleStepButtonBar. |
protected |
CoreSingleStepButtonBar(java.lang.String rendererType)
Construct an instance of the CoreSingleStepButtonBar. |
Method Summary | |
---|---|
protected FacesBean.Type |
getBeanType()
|
java.lang.String |
getFamily()
|
java.lang.String |
getInlineStyle()
Gets the CSS styles to use for this component. |
java.lang.String |
getOnclick()
Gets an onclick Javascript handler. |
java.lang.String |
getOndblclick()
Gets an ondblclick Javascript handler. |
java.lang.String |
getOnkeydown()
Gets an onkeydown Javascript handler. |
java.lang.String |
getOnkeypress()
Gets an onkeypress Javascript handler. |
java.lang.String |
getOnkeyup()
Gets an onkeyup Javascript handler. |
java.lang.String |
getOnmousedown()
Gets an onmousedown Javascript handler. |
java.lang.String |
getOnmousemove()
Gets an onmousemove Javascript handler. |
java.lang.String |
getOnmouseout()
Gets an onmouseout Javascript handler. |
java.lang.String |
getOnmouseover()
Gets an onmouseover Javascript handler. |
java.lang.String |
getOnmouseup()
Gets an onmouseup Javascript handler. |
java.lang.String[] |
getPartialTriggers()
Gets the IDs of the components that should trigger a partial update. |
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 description of items being navigated. |
void |
setInlineStyle(java.lang.String inlineStyle)
Sets the CSS styles to use for this component. |
void |
setOnclick(java.lang.String onclick)
Sets an onclick Javascript handler. |
void |
setOndblclick(java.lang.String ondblclick)
Sets an ondblclick Javascript handler. |
void |
setOnkeydown(java.lang.String onkeydown)
Sets an onkeydown Javascript handler. |
void |
setOnkeypress(java.lang.String onkeypress)
Sets an onkeypress Javascript handler. |
void |
setOnkeyup(java.lang.String onkeyup)
Sets an onkeyup Javascript handler. |
void |
setOnmousedown(java.lang.String onmousedown)
Sets an onmousedown Javascript handler. |
void |
setOnmousemove(java.lang.String onmousemove)
Sets an onmousemove Javascript handler. |
void |
setOnmouseout(java.lang.String onmouseout)
Sets an onmouseout Javascript handler. |
void |
setOnmouseover(java.lang.String onmouseover)
Sets an onmouseover Javascript handler. |
void |
setOnmouseup(java.lang.String onmouseup)
Sets an onmouseup Javascript handler. |
void |
setPartialTriggers(java.lang.String[] partialTriggers)
Sets the IDs of the components that should trigger a partial update. |
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 description of items being navigated. |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXSingleStep |
---|
addActionListener, broadcast, getAction, getActionListener, getActionListeners, getActionType, getMaxStep, getNextAction, getNextActionListener, getPreviousAction, getPreviousActionListener, getSelectedStep, isImmediate, queueEvent, removeActionListener, saveState, setAction, setActionListener, setActionType, setImmediate, setMaxStep, setMaxStep, setNextAction, setNextActionListener, setPreviousAction, setPreviousActionListener, setSelectedStep, setSelectedStep |
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 TEXT_KEY
public static final PropertyKey INLINE_STYLE_KEY
public static final PropertyKey STYLE_CLASS_KEY
public static final PropertyKey SHORT_DESC_KEY
public static final PropertyKey PARTIAL_TRIGGERS_KEY
public static final PropertyKey ONCLICK_KEY
public static final PropertyKey ONDBLCLICK_KEY
public static final PropertyKey ONMOUSEDOWN_KEY
public static final PropertyKey ONMOUSEUP_KEY
public static final PropertyKey ONMOUSEOVER_KEY
public static final PropertyKey ONMOUSEMOVE_KEY
public static final PropertyKey ONMOUSEOUT_KEY
public static final PropertyKey ONKEYPRESS_KEY
public static final PropertyKey ONKEYDOWN_KEY
public static final PropertyKey ONKEYUP_KEY
public static final java.lang.String COMPONENT_FAMILY
public static final java.lang.String COMPONENT_TYPE
Constructor Detail |
---|
public CoreSingleStepButtonBar()
protected CoreSingleStepButtonBar(java.lang.String rendererType)
Method Detail |
---|
public final java.lang.String getText()
public final void setText(java.lang.String text)
public final java.lang.String getInlineStyle()
public final void setInlineStyle(java.lang.String inlineStyle)
public final java.lang.String getStyleClass()
public final void setStyleClass(java.lang.String styleClass)
public final java.lang.String getShortDesc()
public final void setShortDesc(java.lang.String shortDesc)
public final java.lang.String[] getPartialTriggers()
public final void setPartialTriggers(java.lang.String[] partialTriggers)
public final java.lang.String getOnclick()
public final void setOnclick(java.lang.String onclick)
public final java.lang.String getOndblclick()
public final void setOndblclick(java.lang.String ondblclick)
public final java.lang.String getOnmousedown()
public final void setOnmousedown(java.lang.String onmousedown)
public final java.lang.String getOnmouseup()
public final void setOnmouseup(java.lang.String onmouseup)
public final java.lang.String getOnmouseover()
public final void setOnmouseover(java.lang.String onmouseover)
public final java.lang.String getOnmousemove()
public final void setOnmousemove(java.lang.String onmousemove)
public final java.lang.String getOnmouseout()
public final void setOnmouseout(java.lang.String onmouseout)
public final java.lang.String getOnkeypress()
public final void setOnkeypress(java.lang.String onkeypress)
public final java.lang.String getOnkeydown()
public final void setOnkeydown(java.lang.String onkeydown)
public final java.lang.String getOnkeyup()
public final void setOnkeyup(java.lang.String onkeyup)
public java.lang.String getFamily()
getFamily
in class UIXSingleStep
protected FacesBean.Type getBeanType()
getBeanType
in class UIXSingleStep
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |