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 Summary
Fields Modifier and Type Field Description static String
COMPONENT_FAMILY
static String
COMPONENT_TYPE
-
Fields inherited from class jakarta.faces.component.UIComponent
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEY
-
-
Constructor Summary
Constructors Constructor Description UIViewAction()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addActionListener(ActionListener listener)
void
broadcast(FacesEvent event)
Invoke any listeners attached to this object which are listening for an event whose type matches the specified event's runtime type.void
decode(FacesContext context)
Check the submitted form parameters for data associated with this component.jakarta.el.MethodExpression
getActionExpression()
ActionListener[]
getActionListeners()
String
getFamily()
String
getPhase()
boolean
isImmediate()
boolean
isOnPostback()
static boolean
isProcessingBroadcast(FacesContext context)
boolean
isRendered()
A boolean value that indicates whether this component should be rendered.void
removeActionListener(ActionListener listener)
void
setActionExpression(jakarta.el.MethodExpression actionExpression)
void
setImmediate(boolean immediate)
void
setOnPostback(boolean onPostback)
void
setPhase(String phase)
void
setRendered(boolean condition)
-
Methods inherited from class jakarta.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 jakarta.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:UIComponentBase
A boolean value that indicates whether this component should be rendered. Default value: true.- Overrides:
isRendered
in classUIComponentBase
-
setRendered
public void setRendered(boolean condition)
- Overrides:
setRendered
in classUIComponentBase
-
broadcast
public void broadcast(FacesEvent event) throws AbortProcessingException
Description copied from class:UIComponentBase
Invoke 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:
broadcast
in classUIComponentBase
- Parameters:
event
- must not be null.- Throws:
AbortProcessingException
-
decode
public void decode(FacesContext context)
Description copied from class:UIComponentBase
Check 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:
decode
in classUIComponentBase
-
isImmediate
@JSFProperty public boolean isImmediate()
- Specified by:
isImmediate
in interfaceActionSource
-
setImmediate
public void setImmediate(boolean immediate)
- Specified by:
setImmediate
in interfaceActionSource
-
getActionExpression
@JSFProperty(stateHolder=true, returnSignature="java.lang.Object", clientEvent="action") public jakarta.el.MethodExpression getActionExpression()
- Specified by:
getActionExpression
in interfaceActionSource2
-
setActionExpression
public void setActionExpression(jakarta.el.MethodExpression actionExpression)
- Specified by:
setActionExpression
in interfaceActionSource2
-
addActionListener
public void addActionListener(ActionListener listener)
- Specified by:
addActionListener
in interfaceActionSource
-
removeActionListener
public void removeActionListener(ActionListener listener)
- Specified by:
removeActionListener
in interfaceActionSource
-
getActionListeners
@JSFListener(event="jakarta.faces.event.ActionEvent", phases="Invoke Application, Apply Request Values") public ActionListener[] getActionListeners()
- Specified by:
getActionListeners
in 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:
getFamily
in classUIComponent
-
-