Package jakarta.faces.component
Class UIViewAction
- java.lang.Object
- 
- jakarta.faces.component.UIComponent
- 
- jakarta.faces.component.UIComponentBase
- 
- jakarta.faces.component.UIViewAction
 
 
 
- 
- All Implemented Interfaces:
- ActionSource,- ActionSource2,- PartialStateHolder,- StateHolder,- TransientStateHolder,- ComponentSystemEventListener,- FacesListener,- SystemEventListenerHolder,- EventListener
 
 @JSFComponent(name="f:viewAction") public class UIViewAction extends UIComponentBase implements ActionSource2 - Since:
- 2.2
 
- 
- 
Field SummaryFields Modifier and Type Field Description static StringCOMPONENT_FAMILYstatic StringCOMPONENT_TYPE- 
Fields inherited from class jakarta.faces.component.UIComponentATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEY
 
- 
 - 
Constructor SummaryConstructors Constructor Description UIViewAction()
 - 
Method SummaryAll 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.jakarta.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(jakarta.el.MethodExpression actionExpression)voidsetImmediate(boolean immediate)voidsetOnPostback(boolean onPostback)voidsetPhase(String phase)voidsetRendered(boolean condition)- 
Methods inherited from class jakarta.faces.component.UIComponentBaseaddClientBehavior, 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 jakarta.faces.component.UIComponentgetClientId, 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_FAMILYpublic static final String COMPONENT_FAMILY - See Also:
- Constant Field Values
 
 - 
COMPONENT_TYPEpublic static final String COMPONENT_TYPE - See Also:
- Constant Field Values
 
 
- 
 - 
Method Detail- 
isRenderedpublic boolean isRendered() Description copied from class:UIComponentBaseA boolean value that indicates whether this component should be rendered. Default value: true.- Overrides:
- isRenderedin class- UIComponentBase
 
 - 
setRenderedpublic void setRendered(boolean condition) - Overrides:
- setRenderedin class- UIComponentBase
 
 - 
broadcastpublic 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 class- UIComponentBase
- Parameters:
- event- must not be null.
- Throws:
- AbortProcessingException
 
 - 
decodepublic 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 class- UIComponentBase
 
 - 
isImmediate@JSFProperty public boolean isImmediate() - Specified by:
- isImmediatein interface- ActionSource
 
 - 
setImmediatepublic void setImmediate(boolean immediate) - Specified by:
- setImmediatein interface- ActionSource
 
 - 
getActionExpression@JSFProperty(stateHolder=true, returnSignature="java.lang.Object", clientEvent="action") public jakarta.el.MethodExpression getActionExpression()- Specified by:
- getActionExpressionin interface- ActionSource2
 
 - 
setActionExpressionpublic void setActionExpression(jakarta.el.MethodExpression actionExpression) - Specified by:
- setActionExpressionin interface- ActionSource2
 
 - 
addActionListenerpublic void addActionListener(ActionListener listener) - Specified by:
- addActionListenerin interface- ActionSource
 
 - 
removeActionListenerpublic void removeActionListener(ActionListener listener) - Specified by:
- removeActionListenerin interface- ActionSource
 
 - 
getActionListeners@JSFListener(event="jakarta.faces.event.ActionEvent", phases="Invoke Application, Apply Request Values") public ActionListener[] getActionListeners()- Specified by:
- getActionListenersin interface- ActionSource
 
 - 
getPhase@JSFProperty public String getPhase() 
 - 
setPhasepublic void setPhase(String phase) 
 - 
isOnPostback@JSFProperty public boolean isOnPostback() 
 - 
setOnPostbackpublic void setOnPostback(boolean onPostback) 
 - 
isProcessingBroadcastpublic static boolean isProcessingBroadcast(FacesContext context) 
 - 
getFamilypublic String getFamily() - Specified by:
- getFamilyin class- UIComponent
 
 
- 
 
-