Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	UIViewAction.InstrumentedFacesContext A FacesContext delegator that gives us the necessary controls over the FacesContext to allow the execution of the lifecycle to accomodate the UIViewAction sequence.
pack-priv static enum	UIViewAction.PropertyKeys Properties that are tracked by state saving.

Field Summary

Modifier and Type	Field and Description
public static final String	COMPONENT_FAMILY The standard component family for this component.
public static final String	COMPONENT_TYPE The standard component type for this component.
private static final String	UIVIEWACTION_BROADCAST
private static final String	UIVIEWACTION_EVENT_COUNT

Constructor Summary

Access	Constructor and Description
public	UIViewAction() Create a new `UIViewAction` instance with default property values.

Method Summary

Modifier and Type	Method and Description
public void	addActionListener(final ActionListener The `ActionListener` to be added listener) Implements jakarta.faces.component.ActionSource.addActionListener. Add a new `ActionListener` to the set of listeners interested in being notified when `ActionEvent`s occur.
public void	broadcast(final FacesEvent `FacesEvent` to be broadcast event) Overrides jakarta.faces.component.UIComponentBase.broadcast. Enable the method invocation specified by this component instance to return a value that performs navigation, similar in spirit to `UICommand#broadcast`.
public void	decode(final FacesContext `FacesContext` for the request we are processing context) Overrides jakarta.faces.component.UIComponentBase.decode. Override behavior from the superclass to queue an `ActionEvent` that may result in the invocation of the `action` or any `actionListener`s that may be associated with this instance.
private boolean	decrementEventCountAndReturnTrueIfZero(FacesContext context)
public MethodExpression	getActionExpression() Overrides default jakarta.faces.component.ActionSource.getActionExpression. Return the `MethodExpression` pointing at the application action to be invoked, if this `UIComponent` is activated by the user, during the Apply Request Values or Invoke Application phase of the request processing lifecycle, depending on the value of the `immediate` property.
public ActionListener[]	getActionListeners() Implements jakarta.faces.component.ActionSource.getActionListeners. Return the set of registered `ActionListener`s for this `ActionSource` instance.
public String	getFamily() Implements abstract jakarta.faces.component.UIComponent.getFamily. Return the identifier of the component family to which this component belongs.
public String	Returns: the phase (as string). getPhase() Returns the name of the lifecycle phase in which the action is to be queued.
private PhaseId	getPhaseId()
private UIViewRoot	getViewRootOf(final FacesEvent e)
private void	incrementEventCount(FacesContext context)
public boolean	isImmediate() Implements jakarta.faces.component.ActionSource.isImmediate. If the value of the component's `immediate` attribute is `true`, the action will be invoked during the Apply Request Values Jakarta Faces lifecycle phase.
public boolean	Returns: `true` if operating upon postback, `false` otherwise. isOnPostback() If `true` this component will operate on postback.
public static boolean	Returns: `true` is currently processing broadcast, `false` otherwise. isProcessingBroadcast(FacesContext `FacesContext` for the current request context) Returns `true` if the current request processing lifecycle is in the midst of processing the broadcast of an event queued during a call to `decode`.
public boolean	Returns: `true` if it should take the actions, `false` otherwise. isRendered() Overrides jakarta.faces.component.UIComponentBase.isRendered. Returns the `if` property of this component.
public void	removeActionListener(final ActionListener The `ActionListener` to be removed listener) Implements jakarta.faces.component.ActionSource.removeActionListener. Remove an existing `ActionListener` (if any) from the set of listeners interested in being notified when `ActionEvent`s occur.
public void	setActionExpression(final MethodExpression the action expression. actionExpression) Overrides default jakarta.faces.component.ActionSource.setActionExpression. Set the `MethodExpression` pointing at the appication action to be invoked, if this `UIComponent` is activated by the user, during the Apply Request Values or Invoke Application phase of the request processing lifecycle, depending on the value of the `immediate` property.
public void	setImmediate(final boolean The new immediate execution flag immediate) Implements jakarta.faces.component.ActionSource.setImmediate. Set the "immediate execution" flag for this `UIComponent`.
private void	setIsProcessingUIViewActionBroadcast(FacesContext context, boolean value)
public void	setOnPostback(final boolean the onPostback flag. onPostback) Controls whether or not this component operates on postback.
public void	setPhase(final String the phase id (as string value). phase) Attempt to set the lifecycle phase in which this instance will queue its `ActionEvent`.
public void	setRendered(final boolean the new value of the property. condition) Overrides jakarta.faces.component.UIComponentBase.setRendered. Sets the `if` property of this component.

Field Detail

COMPONENT_FAMILY	back to summary
public static final String COMPONENT_FAMILY The standard component family for this component.

COMPONENT_TYPE	back to summary
public static final String COMPONENT_TYPE The standard component type for this component.

UIVIEWACTION_BROADCAST	back to summary
private static final String UIVIEWACTION_BROADCAST

UIVIEWACTION_EVENT_COUNT	back to summary
private static final String UIVIEWACTION_EVENT_COUNT

Constructor Detail

UIViewAction	back to summary
public UIViewAction() Create a new `UIViewAction` instance with default property values.

Method Detail

addActionListener back to summary

addActionListener	back to summary
public void addActionListener(final ActionListener listener) Implements jakarta.faces.component.ActionSource.addActionListener. Doc from jakarta.faces.component.ActionSource.addActionListener. Add a new `ActionListener` to the set of listeners interested in being notified when `ActionEvent`s occur. Parameters listener:ActionListener The `ActionListener` to be added Annotations @Override Since 2.2

public void addActionListener(final ActionListener listener)

Implements jakarta.faces.component.ActionSource.addActionListener.

Doc from jakarta.faces.component.ActionSource.addActionListener.

Add a new ActionListener to the set of listeners interested in being notified when ActionEvents occur.

Parameters

listener:ActionListener: The ActionListener to be added

Annotations

@Override

Since

2.2

broadcast back to summary

broadcast	back to summary
public void broadcast(final FacesEvent event) throws AbortProcessingException Overrides jakarta.faces.component.UIComponentBase.broadcast. Enable the method invocation specified by this component instance to return a value that performs navigation, similar in spirit to `UICommand#broadcast`. Take no action and return immediately if any of the following conditions are true. The response has already been marked as complete. The current `UIViewRoot` is different from the event's source's `UIViewRoot`. Save a local reference to the viewId of the current `UIViewRoot`. For discussion, let this reference be viewIdBeforeAction. Obtain the `ActionListener` from the `jakarta.faces.application.Application`. Wrap the current `FacesContext` in an implementation of `jakarta.faces.context.FacesContextWrapper` that overrides the `FacesContext#renderResponse` method such that it takes no action. Set the current `FacesContext` to be the `FacesContextWrapper` instance. Make it so a call to `isProcessingBroadcast` on the current FacesContext will return `true`. This is necessary because the `jakarta.faces.application.NavigationHandler` will call this method to determine if the navigation is happening as the result of a `UIViewAction`. Invoke `ActionListener#processAction`. In a `finally` block, restore the original `FacesContext`, make it so a call to `isProcessingBroadcast` on the current context will return `false` and discard the wrapper. If the response has been marked as complete during the invocation of `processAction()`, take no further action and return. Otherwise, compare viewIdBeforeAction with the viewId of the `UIViewRoot` on the `FacesContext` after the invocation of `processAction()`. If the two viewIds are the same and no more `UIViewAction` events have been queued by a call to `decode`, call `FacesContext#renderResponse` and return. It is possible to detect the case where no more `UIViewAction` events have been queued because the number of such events queued has been noted in the specification for `decode`. Otherwise, execute the lifecycle on the new `UIViewRoot`. Parameters event:FacesEvent `FacesEvent` to be broadcast Annotations @Override Exceptions AbortProcessingException: Signal the Jakarta Faces implementation that no further processing on the current event should be performed IllegalArgumentException: if the implementation class of this `FacesEvent` is not supported by this component NullPointerException: if `event` is `null` Since 2.2

public void broadcast(final FacesEvent event) throws AbortProcessingException

Overrides jakarta.faces.component.UIComponentBase.broadcast.

Enable the method invocation specified by this component instance to return a value that performs navigation, similar in spirit to UICommand#broadcast.

Take no action and return immediately if any of the following conditions are true.

The response has already been marked as complete.
The current UIViewRoot is different from the event's source's UIViewRoot.

Save a local reference to the viewId of the current UIViewRoot. For discussion, let this reference be viewIdBeforeAction.

Obtain the ActionListener from the jakarta.faces.application.Application. Wrap the current FacesContext in an implementation of jakarta.faces.context.FacesContextWrapper that overrides the FacesContext#renderResponse method such that it takes no action. Set the current FacesContext to be the FacesContextWrapper instance. Make it so a call to isProcessingBroadcast on the current FacesContext will return true. This is necessary because the jakarta.faces.application.NavigationHandler will call this method to determine if the navigation is happening as the result of a UIViewAction. Invoke ActionListener#processAction. In a finally block, restore the original FacesContext, make it so a call to isProcessingBroadcast on the current context will return false and discard the wrapper.

If the response has been marked as complete during the invocation of processAction(), take no further action and return. Otherwise, compare viewIdBeforeAction with the viewId of the UIViewRoot on the FacesContext after the invocation of processAction(). If the two viewIds are the same and no more UIViewAction events have been queued by a call to decode, call FacesContext#renderResponse and return. It is possible to detect the case where no more UIViewAction events have been queued because the number of such events queued has been noted in the specification for decode. Otherwise, execute the lifecycle on the new UIViewRoot.

Parameters

event:FacesEvent: FacesEvent to be broadcast

Annotations

@Override

Exceptions

AbortProcessingException:: Signal the Jakarta Faces implementation that no further processing on the current event should be performed
IllegalArgumentException:: if the implementation class of this FacesEvent is not supported by this component
NullPointerException:: if event is null

Since

2.2

decode back to summary

decode	back to summary
public void decode(final FacesContext context) Overrides jakarta.faces.component.UIComponentBase.decode. Override behavior from the superclass to queue an `ActionEvent` that may result in the invocation of the `action` or any `actionListener`s that may be associated with this instance. Take no action if any of the following conditions are true: The current request is a postback and the instance has been configured to not operate on postback. See `isOnPostback`. The condition stated in the `if` property evaluates to `false`. See `isRendered` . Instantiate an `ActionEvent`, passing this component instance as the source. Set the `phaseId` property of the `ActionEvent` as follows. If this component instance has been configured with a specific lifecycle phase with a call to `setPhase` use that as the `phaseId` If the value of the `immediate` property is true, use `PhaseId#APPLY_REQUEST_VALUES`. Otherwise, use `PhaseId#INVOKE_APPLICATION`. Queue the event with a call to `queueEvent`. Keep track of the number of events that are queued in this way on this run through the lifecycle. This information is necessary during processing in `broadcast`. Parameters context:FacesContext Doc from jakarta.faces.component.UIComponent.decode. `FacesContext` for the request we are processing Annotations @Override Since 2.2

public void decode(final FacesContext context)

Overrides jakarta.faces.component.UIComponentBase.decode.

Override behavior from the superclass to queue an ActionEvent that may result in the invocation of the action or any actionListeners that may be associated with this instance.

Take no action if any of the following conditions are true:

The current request is a postback and the instance has been configured to not operate on postback. See isOnPostback.
The condition stated in the if property evaluates to false. See isRendered
.

Instantiate an ActionEvent, passing this component instance as the source. Set the phaseId property of the ActionEvent as follows.

If this component instance has been configured with a specific lifecycle phase with a call to setPhase use that as the phaseId
If the value of the immediate property is true, use PhaseId#APPLY_REQUEST_VALUES.
Otherwise, use PhaseId#INVOKE_APPLICATION.

Queue the event with a call to queueEvent. Keep track of the number of events that are queued in this way on this run through the lifecycle. This information is necessary during processing in broadcast.

Parameters

context:FacesContext

Doc from jakarta.faces.component.UIComponent.decode.

FacesContext for the request we are processing

Annotations

@Override

Since

2.2

decrementEventCountAndReturnTrueIfZero	back to summary
private boolean decrementEventCountAndReturnTrueIfZero(FacesContext context)

getActionExpression back to summary

getActionExpression	back to summary
public MethodExpression getActionExpression() Overrides default jakarta.faces.component.ActionSource.getActionExpression. Doc from jakarta.faces.component.ActionSource.getActionExpression. Return the `MethodExpression` pointing at the application action to be invoked, if this `UIComponent` is activated by the user, during the Apply Request Values or Invoke Application phase of the request processing lifecycle, depending on the value of the `immediate` property. The default implementation throws `UnsupportedOperationException` and is provided for the sole purpose of not breaking existing applications that extend `ActionSource`. Historically this method was declared in `ActionSource2` for precisely this reason but default methods in interfaces weren't supported. Returns:MethodExpression the action expression. Annotations @Override Since 2.2

public MethodExpression getActionExpression()

Overrides default jakarta.faces.component.ActionSource.getActionExpression.

Doc from jakarta.faces.component.ActionSource.getActionExpression.

Return the MethodExpression pointing at the application action to be invoked, if this UIComponent is activated by the user, during the Apply Request Values or Invoke Application phase of the request processing lifecycle, depending on the value of the immediate property.

The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend ActionSource. Historically this method was declared in ActionSource2 for precisely this reason but default methods in interfaces weren't supported.

Returns:MethodExpression

the action expression.

Annotations

@Override

Since

2.2

getActionListeners back to summary

getActionListeners	back to summary
public ActionListener[] getActionListeners() Implements jakarta.faces.component.ActionSource.getActionListeners. Doc from jakarta.faces.component.ActionSource.getActionListeners. Return the set of registered `ActionListener`s for this `ActionSource` instance. If there are no registered listeners, a zero-length array is returned. Returns:ActionListener[] the action listeners, or a zero-length array. Annotations @Override Since 2.2

public ActionListener[] getActionListeners()

Implements jakarta.faces.component.ActionSource.getActionListeners.

Doc from jakarta.faces.component.ActionSource.getActionListeners.

Return the set of registered ActionListeners for this ActionSource instance. If there are no registered listeners, a zero-length array is returned.

Returns:ActionListener[]

the action listeners, or a zero-length array.

Annotations

@Override

Since

2.2

getFamily back to summary

getFamily	back to summary
public String getFamily() Implements abstract jakarta.faces.component.UIComponent.getFamily. Doc from jakarta.faces.component.UIComponent.getFamily. Return the identifier of the component family to which this component belongs. This identifier, in conjunction with the value of the `rendererType` property, may be used to select the appropriate `Renderer` for this component instance. Note this method should NOT return `null` Returns:String the component family (not null). Annotations @Override

public String getFamily()

Implements abstract jakarta.faces.component.UIComponent.getFamily.

Doc from jakarta.faces.component.UIComponent.getFamily.

Return the identifier of the component family to which this component belongs. This identifier, in conjunction with the value of the rendererType property, may be used to select the appropriate Renderer for this component instance. Note this method should NOT return null

Returns:String

the component family (not null).

Annotations

@Override

getPhase	back to summary
public String getPhase() Returns the name of the lifecycle phase in which the action is to be queued. Returns:String the phase (as string). Since 2.2

getPhase

back to summary

public String getPhase()

Returns the name of the lifecycle phase in which the action is to be queued.

Returns:String: the phase (as string).
Since: 2.2

getPhaseId	back to summary
private PhaseId getPhaseId()

getViewRootOf	back to summary
private UIViewRoot getViewRootOf(final FacesEvent e)

incrementEventCount	back to summary
private void incrementEventCount(FacesContext context)

isImmediate back to summary

isImmediate	back to summary
public boolean isImmediate() Implements jakarta.faces.component.ActionSource.isImmediate. If the value of the component's `immediate` attribute is `true`, the action will be invoked during the Apply Request Values Jakarta Faces lifecycle phase. Otherwise, the action will be invoked during the Invoke Application phase, the default behavior. The phase can be set explicitly in the `phase` attribute, which takes precedence over the `immediate` attribute. Returns:boolean Doc from jakarta.faces.component.ActionSource.isImmediate. `true` if immediate, `false` otherwise. Annotations @Override Since 2.2

public boolean isImmediate()

Implements jakarta.faces.component.ActionSource.isImmediate.

If the value of the component's immediate attribute is true, the action will be invoked during the Apply Request Values Jakarta Faces lifecycle phase. Otherwise, the action will be invoked during the Invoke Application phase, the default behavior. The phase can be set explicitly in the phase attribute, which takes precedence over the immediate attribute.

Returns:boolean

Doc from jakarta.faces.component.ActionSource.isImmediate.

true if immediate, false otherwise.

Annotations

@Override

Since

2.2

isOnPostback back to summary

isOnPostback	back to summary
public boolean isOnPostback() If `true` this component will operate on postback. Returns:boolean `true` if operating upon postback, `false` otherwise. Since 2.2

public boolean isOnPostback()

If true this component will operate on postback.

Returns:boolean: true if operating upon postback, false otherwise.
Since: 2.2

isProcessingBroadcast back to summary

isProcessingBroadcast	back to summary
public static boolean isProcessingBroadcast(FacesContext context) Returns `true` if the current request processing lifecycle is in the midst of processing the broadcast of an event queued during a call to `decode`. The implementation of `broadcast` is responsible for ensuring that calls to this method accurately reflect this fact. Parameters context:FacesContext `FacesContext` for the current request Returns:boolean `true` is currently processing broadcast, `false` otherwise. Since 2.2

public static boolean isProcessingBroadcast(FacesContext context)

Returns true if the current request processing lifecycle is in the midst of processing the broadcast of an event queued during a call to decode. The implementation of broadcast is responsible for ensuring that calls to this method accurately reflect this fact.

Parameters

context:FacesContext: FacesContext for the current request

Returns:boolean

true is currently processing broadcast, false otherwise.

Since

2.2

isRendered back to summary

isRendered	back to summary
public boolean isRendered() Overrides jakarta.faces.component.UIComponentBase.isRendered. Returns the `if` property of this component. If `true` then this component should take the actions specified in the `decode` method. Returns:boolean `true` if it should take the actions, `false` otherwise. Annotations @Override Since 2.2

public boolean isRendered()

Overrides jakarta.faces.component.UIComponentBase.isRendered.

Returns the if property of this component. If true then this component should take the actions specified in the decode method.

Returns:boolean

true if it should take the actions, false otherwise.

Annotations

@Override

Since

2.2

removeActionListener back to summary

removeActionListener	back to summary
public void removeActionListener(final ActionListener listener) Implements jakarta.faces.component.ActionSource.removeActionListener. Doc from jakarta.faces.component.ActionSource.removeActionListener. Remove an existing `ActionListener` (if any) from the set of listeners interested in being notified when `ActionEvent`s occur. Parameters listener:ActionListener The `ActionListener` to be removed Annotations @Override Since 2.2

public void removeActionListener(final ActionListener listener)

Implements jakarta.faces.component.ActionSource.removeActionListener.

Doc from jakarta.faces.component.ActionSource.removeActionListener.

Remove an existing ActionListener (if any) from the set of listeners interested in being notified when ActionEvents occur.

Parameters

listener:ActionListener: The ActionListener to be removed

Annotations

@Override

Since

2.2

setActionExpression back to summary

setActionExpression	back to summary
public void setActionExpression(final MethodExpression actionExpression) Overrides default jakarta.faces.component.ActionSource.setActionExpression. Doc from jakarta.faces.component.ActionSource.setActionExpression. Set the `MethodExpression` pointing at the appication action to be invoked, if this `UIComponent` is activated by the user, during the Apply Request Values or Invoke Application phase of the request processing lifecycle, depending on the value of the `immediate` property. Any method referenced by such an expression must be public, with a return type of `String`, and accept no parameters. The default implementation throws `UnsupportedOperationException` and is provided for the sole purpose of not breaking existing applications that extend `ActionSource`. Historically this method was declared in `ActionSource2` for precisely this reason but default methods in interfaces weren't supported. Parameters actionExpression:MethodExpression the action expression. Annotations @Override Since 2.2

public void setActionExpression(final MethodExpression actionExpression)

Overrides default jakarta.faces.component.ActionSource.setActionExpression.

Doc from jakarta.faces.component.ActionSource.setActionExpression.

Set the MethodExpression pointing at the appication action to be invoked, if this UIComponent is activated by the user, during the Apply Request Values or Invoke Application phase of the request processing lifecycle, depending on the value of the immediate property.

Any method referenced by such an expression must be public, with a return type of String, and accept no parameters.

Parameters

actionExpression:MethodExpression: the action expression.

Annotations

@Override

Since

2.2

setImmediate back to summary

setImmediate	back to summary
public void setImmediate(final boolean immediate) Implements jakarta.faces.component.ActionSource.setImmediate. Doc from jakarta.faces.component.ActionSource.setImmediate. Set the "immediate execution" flag for this `UIComponent`. Parameters immediate:boolean The new immediate execution flag Annotations @Override Since 2.2

public void setImmediate(final boolean immediate)

Implements jakarta.faces.component.ActionSource.setImmediate.

Doc from jakarta.faces.component.ActionSource.setImmediate.

Set the "immediate execution" flag for this UIComponent.

Parameters

immediate:boolean: The new immediate execution flag

Annotations

@Override

Since

2.2

setIsProcessingUIViewActionBroadcast	back to summary
private void setIsProcessingUIViewActionBroadcast(FacesContext context, boolean value)

setOnPostback	back to summary
public void setOnPostback(final boolean onPostback) Controls whether or not this component operates on postback. Parameters onPostback:boolean the onPostback flag. Since 2.2

setOnPostback

back to summary

public void setOnPostback(final boolean onPostback)

Controls whether or not this component operates on postback.

Parameters

onPostback:boolean: the onPostback flag.

Since

2.2

setPhase back to summary

setPhase	back to summary
public void setPhase(final String phase) Attempt to set the lifecycle phase in which this instance will queue its `ActionEvent`. Pass the argument `phase` to `PhaseId#phaseIdValueOf`. If the result is not one of the following values, `FacesException` must be thrown. `PhaseId#APPLY_REQUEST_VALUES` `PhaseId#PROCESS_VALIDATIONS` `PhaseId#UPDATE_MODEL_VALUES` `PhaseId#INVOKE_APPLICATION` If set, this value takes precedence over the immediate flag. Parameters phase:String the phase id (as string value). Since 2.2

public void setPhase(final String phase)

Attempt to set the lifecycle phase in which this instance will queue its ActionEvent. Pass the argument phase to PhaseId#phaseIdValueOf. If the result is not one of the following values, FacesException must be thrown.

If set, this value takes precedence over the immediate flag.

Parameters

phase:String: the phase id (as string value).

Since

2.2

setRendered back to summary

setRendered	back to summary
public void setRendered(final boolean condition) Overrides jakarta.faces.component.UIComponentBase.setRendered. Sets the `if` property of this component. Parameters condition:boolean the new value of the property. Annotations @Override Since 2.2

public void setRendered(final boolean condition)

Overrides jakarta.faces.component.UIComponentBase.setRendered.

Sets the if property of this component.

Parameters

condition:boolean: the new value of the property.

Annotations

@Override

Since

2.2

jakarta.faces.component back to summary

private Class UIViewAction.InstrumentedFacesContext

Class Inheritance

extends FacesContextWrapper

java.lang.Object
jakarta.faces.context.FacesContext
jakarta.faces.context.FacesContextWrapper
jakarta.faces.component.UIViewAction.InstrumentedFacesContext

A FacesContext delegator that gives us the necessary controls over the FacesContext to allow the execution of the lifecycle to accomodate the UIViewAction sequence.

Field Summary

Modifier and Type	Field and Description
private Boolean	postback
private boolean	renderedResponseControlDisabled
private boolean	viewRootCleared

Constructor Summary

Access	Constructor and Description
public	InstrumentedFacesContext(final FacesContext wrapped)

Method Summary

Modifier and Type	Method and Description
public UIViewAction.InstrumentedFacesContext	clearPostback()
public UIViewAction.InstrumentedFacesContext	clearViewRoot()
public UIViewAction.InstrumentedFacesContext	disableRenderResponseControl()
public UIViewRoot	getViewRoot() Overrides jakarta.faces.context.FacesContextWrapper.getViewRoot. The default behavior of this method is to call `FacesContext#getViewRoot()` on the wrapped `FacesContext` object.
public boolean	isPostback() Overrides jakarta.faces.context.FacesContextWrapper.isPostback. The default behavior of this method is to call `FacesContext#isPostback()` on the wrapped `FacesContext` object.
public UIViewAction.InstrumentedFacesContext	pushViewIntoRequestMap() Make it look like we have dispatched a request using the include method.
public void	renderResponse() Overrides jakarta.faces.context.FacesContextWrapper.renderResponse. The default behavior of this method is to call `FacesContext#renderResponse()` on the wrapped `FacesContext` object.
public void	restore()
public void	set()
public void	setViewRoot(final UIViewRoot The new component `UIViewRoot` component viewRoot) Overrides jakarta.faces.context.FacesContextWrapper.setViewRoot. The default behavior of this method is to call `FacesContext#setViewRoot(UIViewRoot)` on the wrapped `FacesContext` object.

Field Detail

postback	back to summary
private Boolean postback

renderedResponseControlDisabled	back to summary
private boolean renderedResponseControlDisabled

viewRootCleared	back to summary
private boolean viewRootCleared

Constructor Detail

InstrumentedFacesContext	back to summary
public InstrumentedFacesContext(final FacesContext wrapped)

Method Detail

clearPostback	back to summary
public UIViewAction.InstrumentedFacesContext clearPostback()

clearViewRoot	back to summary
public UIViewAction.InstrumentedFacesContext clearViewRoot()

disableRenderResponseControl	back to summary
public UIViewAction.InstrumentedFacesContext disableRenderResponseControl()

getViewRoot back to summary

getViewRoot	back to summary
public UIViewRoot getViewRoot() Overrides jakarta.faces.context.FacesContextWrapper.getViewRoot. Doc from jakarta.faces.context.FacesContextWrapper.getViewRoot. The default behavior of this method is to call `FacesContext#getViewRoot()` on the wrapped `FacesContext` object. Returns:UIViewRoot Doc from jakarta.faces.context.FacesContext.getViewRoot. `UIViewRoot` instance. Annotations @Override

public UIViewRoot getViewRoot()

Overrides jakarta.faces.context.FacesContextWrapper.getViewRoot.

Doc from jakarta.faces.context.FacesContextWrapper.getViewRoot.

The default behavior of this method is to call FacesContext#getViewRoot() on the wrapped FacesContext object.

Returns:UIViewRoot

Doc from jakarta.faces.context.FacesContext.getViewRoot.

UIViewRoot instance.

Annotations

@Override

isPostback back to summary

isPostback	back to summary
public boolean isPostback() Overrides jakarta.faces.context.FacesContextWrapper.isPostback. Doc from jakarta.faces.context.FacesContextWrapper.isPostback. The default behavior of this method is to call `FacesContext#isPostback()` on the wrapped `FacesContext` object. Returns:boolean Doc from jakarta.faces.context.FacesContext.isPostback. the boolean indicating whether this request is a post one. Annotations @Override

public boolean isPostback()

Overrides jakarta.faces.context.FacesContextWrapper.isPostback.

Doc from jakarta.faces.context.FacesContextWrapper.isPostback.

The default behavior of this method is to call FacesContext#isPostback() on the wrapped FacesContext object.

Returns:boolean

Doc from jakarta.faces.context.FacesContext.isPostback.

the boolean indicating whether this request is a post one.

Annotations

@Override

pushViewIntoRequestMap	back to summary
public UIViewAction.InstrumentedFacesContext pushViewIntoRequestMap() Make it look like we have dispatched a request using the include method.

renderResponse back to summary

renderResponse	back to summary
public void renderResponse() Overrides jakarta.faces.context.FacesContextWrapper.renderResponse. Doc from jakarta.faces.context.FacesContextWrapper.renderResponse. The default behavior of this method is to call `FacesContext#renderResponse()` on the wrapped `FacesContext` object. Annotations @Override

public void renderResponse()

Overrides jakarta.faces.context.FacesContextWrapper.renderResponse.

Doc from jakarta.faces.context.FacesContextWrapper.renderResponse.

The default behavior of this method is to call FacesContext#renderResponse() on the wrapped FacesContext object.

Annotations

@Override

restore	back to summary
public void restore()

set	back to summary
public void set()

setViewRoot back to summary

setViewRoot	back to summary
public void setViewRoot(final UIViewRoot viewRoot) Overrides jakarta.faces.context.FacesContextWrapper.setViewRoot. Doc from jakarta.faces.context.FacesContextWrapper.setViewRoot. The default behavior of this method is to call `FacesContext#setViewRoot(UIViewRoot)` on the wrapped `FacesContext` object. Parameters viewRoot:UIViewRoot Doc from jakarta.faces.context.FacesContext.setViewRoot. The new component `UIViewRoot` component Annotations @Override

public void setViewRoot(final UIViewRoot viewRoot)

Overrides jakarta.faces.context.FacesContextWrapper.setViewRoot.

Doc from jakarta.faces.context.FacesContextWrapper.setViewRoot.

The default behavior of this method is to call FacesContext#setViewRoot(UIViewRoot) on the wrapped FacesContext object.

Parameters

viewRoot:UIViewRoot

Doc from jakarta.faces.context.FacesContext.setViewRoot.

The new component UIViewRoot component

Annotations

@Override

Field Summary

Modifier and Type	Field and Description
public static final UIViewAction.PropertyKeys	actionExpression
public static final UIViewAction.PropertyKeys	immediate
private String	name Hides java.lang.Enum.name.
public static final UIViewAction.PropertyKeys	onPostback
public static final UIViewAction.PropertyKeys	phase
public static final UIViewAction.PropertyKeys	renderedAttr

Constructor Summary

Access	Constructor and Description
private	PropertyKeys()
private	PropertyKeys(final String name)

Method Summary

Modifier and Type	Method and Description
public String	toString() Overrides java.lang.Enum.toString. Returns the name of this enum constant, as contained in the declaration.
public static UIViewAction.PropertyKeys	valueOf(String name)
public static UIViewAction.PropertyKeys[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal valueOf

Field Detail

actionExpression	back to summary
public static final UIViewAction.PropertyKeys actionExpression

immediate	back to summary
public static final UIViewAction.PropertyKeys immediate

name	back to summary
private String name Hides java.lang.Enum.name.

onPostback	back to summary
public static final UIViewAction.PropertyKeys onPostback

phase	back to summary
public static final UIViewAction.PropertyKeys phase

renderedAttr	back to summary
public static final UIViewAction.PropertyKeys renderedAttr

Constructor Detail

PropertyKeys	back to summary
private PropertyKeys()

PropertyKeys	back to summary
private PropertyKeys(final String name)

Method Detail

toString

back to summary

public String toString()

Overrides java.lang.Enum.toString.

Doc from java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum class should override this method when a more "programmer-friendly" string form exists.

Returns:String

the name of this enum constant

Annotations

@Override

valueOf	back to summary
public static UIViewAction.PropertyKeys valueOf(String name)

values	back to summary
public static UIViewAction.PropertyKeys[] values()

public Class UIViewAction

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class UIViewAction.InstrumentedFacesContext

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Enum UIViewAction.PropertyKeys

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail