Package javax.faces.component
Class UIViewAction
- java.lang.Object
-
- javax.faces.component.UIComponent
-
- javax.faces.component.UIComponentBase
-
- javax.faces.component.UIViewAction
-
- All Implemented Interfaces:
EventListener,ActionSource,ActionSource2,PartialStateHolder,StateHolder,TransientStateHolder,ComponentSystemEventListener,FacesListener,SystemEventListenerHolder
@JSFComponent(name="f:viewAction") public class UIViewAction extends UIComponentBase implements ActionSource2
- Since:
- 2.2
-
-
Field Summary
Fields Modifier and Type Field Description static StringCOMPONENT_FAMILYstatic StringCOMPONENT_TYPE-
Fields inherited from class javax.faces.component.UIComponent
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY
-
-
Constructor Summary
Constructors Constructor Description UIViewAction()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddActionListener(ActionListener listener)voidbroadcast(FacesEvent event)Invoke any listeners attached to this object which are listening for an event whose type matches the specified event's runtime type.voiddecode(FacesContext context)Check the submitted form parameters for data associated with this component.javax.el.MethodExpressiongetActionExpression()ActionListener[]getActionListeners()StringgetFamily()StringgetPhase()booleanisImmediate()booleanisOnPostback()static booleanisProcessingBroadcast(FacesContext context)booleanisRendered()A boolean value that indicates whether this component should be rendered.voidremoveActionListener(ActionListener listener)voidsetActionExpression(javax.el.MethodExpression actionExpression)voidsetImmediate(boolean immediate)voidsetOnPostback(boolean onPostback)voidsetPhase(String phase)voidsetRendered(boolean condition)-
Methods inherited from class javax.faces.component.UIComponentBase
addClientBehavior, addFacesListener, clearInitialState, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, invokeOnComponent, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendererType, setTransient, visitTree
-
Methods inherited from class javax.faces.component.UIComponent
getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent
-
-
-
-
Field Detail
-
COMPONENT_FAMILY
public static final String COMPONENT_FAMILY
- See Also:
- Constant Field Values
-
COMPONENT_TYPE
public static final String COMPONENT_TYPE
- See Also:
- Constant Field Values
-
-
Method Detail
-
isRendered
public boolean isRendered()
Description copied from class:UIComponentBaseA boolean value that indicates whether this component should be rendered. Default value: true.- Overrides:
isRenderedin classUIComponentBase
-
setRendered
public void setRendered(boolean condition)
- Overrides:
setRenderedin classUIComponentBase
-
broadcast
public void broadcast(FacesEvent event) throws AbortProcessingException
Description copied from class:UIComponentBaseInvoke any listeners attached to this object which are listening for an event whose type matches the specified event's runtime type.This method does not propagate the event up to parent components, ie listeners attached to parent components don't automatically get called.
If any of the listeners throws AbortProcessingException then that exception will prevent any further listener callbacks from occurring, and the exception propagates out of this method without alteration.
ActionEvent events are typically queued by the renderer associated with this component in its decode method; ValueChangeEvent events by the component's validate method. In either case the event's source property references a component. At some later time the UIViewRoot component iterates over its queued events and invokes the broadcast method on each event's source object.
- Overrides:
broadcastin classUIComponentBase- Parameters:
event- must not be null.- Throws:
AbortProcessingException
-
decode
public void decode(FacesContext context)
Description copied from class:UIComponentBaseCheck the submitted form parameters for data associated with this component. This default implementation delegates to this component's renderer if there is one, and otherwise ignores the call.- Overrides:
decodein classUIComponentBase
-
isImmediate
@JSFProperty public boolean isImmediate()
- Specified by:
isImmediatein interfaceActionSource
-
setImmediate
public void setImmediate(boolean immediate)
- Specified by:
setImmediatein interfaceActionSource
-
getActionExpression
@JSFProperty(stateHolder=true, returnSignature="java.lang.Object", jspName="action", clientEvent="action") public javax.el.MethodExpression getActionExpression()- Specified by:
getActionExpressionin interfaceActionSource2
-
setActionExpression
public void setActionExpression(javax.el.MethodExpression actionExpression)
- Specified by:
setActionExpressionin interfaceActionSource2
-
addActionListener
public void addActionListener(ActionListener listener)
- Specified by:
addActionListenerin interfaceActionSource
-
removeActionListener
public void removeActionListener(ActionListener listener)
- Specified by:
removeActionListenerin interfaceActionSource
-
getActionListeners
@JSFListener(event="javax.faces.event.ActionEvent", phases="Invoke Application, Apply Request Values") public ActionListener[] getActionListeners()- Specified by:
getActionListenersin interfaceActionSource
-
getPhase
@JSFProperty public String getPhase()
-
setPhase
public void setPhase(String phase)
-
isOnPostback
@JSFProperty public boolean isOnPostback()
-
setOnPostback
public void setOnPostback(boolean onPostback)
-
isProcessingBroadcast
public static boolean isProcessingBroadcast(FacesContext context)
-
getFamily
public String getFamily()
- Specified by:
getFamilyin classUIComponent
-
-