|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UICommand
org.apache.myfaces.orchestra.conversation.jsf.components.AbstractConversationComponent
org.apache.myfaces.orchestra.conversation.jsf.components.UIEndConversation
public class UIEndConversation
Can be used to end a manual-scope conversation, and optionally handles exceptions thrown by action methods.
When nested within a UICommand component (eg a commandLink or commandButton) the specified conversation will be ended after the method invoked by the parent component is executed.
<h:commandLink action="#{backing.saveAction}"> <orchestra:endConversation name="conversation1" onOutcome="success" /> </h:commandLink>
The "name" attribute is mandatory, and specifies which conversation is to be ended. The optional attributes are:
Field Summary | |
---|---|
static java.lang.String |
COMPONENT_TYPE
|
Fields inherited from class org.apache.myfaces.orchestra.conversation.jsf.components.AbstractConversationComponent |
---|
COMPONENT_FAMILY |
Fields inherited from class javax.faces.component.UIComponent |
---|
bindings |
Constructor Summary | |
---|---|
UIEndConversation()
|
Method Summary | |
---|---|
void |
encodeBegin(javax.faces.context.FacesContext context)
|
java.lang.String |
getErrorOutcome()
|
java.lang.String |
getOnOutcome()
|
void |
restoreState(javax.faces.context.FacesContext context,
java.lang.Object state)
|
java.lang.Object |
saveState(javax.faces.context.FacesContext context)
|
void |
setErrorOutcome(java.lang.String errorOutcome)
|
void |
setOnOutcome(java.lang.String onOutcome)
|
Methods inherited from class org.apache.myfaces.orchestra.conversation.jsf.components.AbstractConversationComponent |
---|
getFamily, getName, setName |
Methods inherited from class javax.faces.component.UICommand |
---|
addActionListener, broadcast, getAction, getActionExpression, getActionListener, getActionListeners, getValue, isImmediate, queueEvent, removeActionListener, setAction, setActionExpression, setActionListener, setImmediate, setValue |
Methods inherited from class javax.faces.component.UIComponentBase |
---|
addFacesListener, decode, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll, getContainerClientId, getValueExpression, setValueExpression |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String COMPONENT_TYPE
Constructor Detail |
---|
public UIEndConversation()
Method Detail |
---|
public void encodeBegin(javax.faces.context.FacesContext context) throws java.io.IOException
encodeBegin
in class javax.faces.component.UIComponentBase
java.io.IOException
public void restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class AbstractConversationComponent
public java.lang.Object saveState(javax.faces.context.FacesContext context)
saveState
in interface javax.faces.component.StateHolder
saveState
in class AbstractConversationComponent
public java.lang.String getOnOutcome()
public void setOnOutcome(java.lang.String onOutcome)
public java.lang.String getErrorOutcome()
public void setErrorOutcome(java.lang.String errorOutcome)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |