Module jakarta.faces

Package jakarta.faces.component

Class UIViewParameter.Reference

java.lang.Object

jakarta.faces.component.UIViewParameter.Reference

Enclosing class:

UIViewParameter

public static class UIViewParameter.Reference
extends Object

Inner class to encapsulate a UIViewParameter instance so that it may be safely referenced regardless of whether or not the current view is the same as the view in which this UIViewParameter resides.

Since:

2.0

Constructor Summary

Constructors

Constructor	Description
Reference(FacesContext context, UIViewParameter param, int indexInParent, String viewIdAtTimeOfConstruction)	Construct a reference to a UIViewParameter.

Method Summary

Modifier and Type	Method	Description
UIViewParameter	getUIViewParameter(FacesContext context)	Return the UIViewParameter to which this instance refers.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Reference

public Reference(FacesContext context,
 UIViewParameter param,
 int indexInParent,
 String viewIdAtTimeOfConstruction)

Construct a reference to a UIViewParameter. This constructor cause the StateHolder.saveState(jakarta.faces.context.FacesContext) method to be called on argument UIViewParameter.

Parameters:

context - the FacesContextfor this request

param - the UIViewParameter.

indexInParent - the index of the UIViewParameter in its parent UIPanel.

viewIdAtTimeOfConstruction - the viewId of the view in which the UIViewParameter is included. This may not be the same as the viewId from the context argument.

Since:

2.0

Method Details

getUIViewParameter

public UIViewParameter getUIViewParameter(FacesContext context)

Return the UIViewParameter to which this instance refers. If the current viewId is the same as the viewId passed to our constructor, use the index passed to the constructor to find the actual UIViewParameter instance and return it. Otherwise, call StateHolder.restoreState(jakarta.faces.context.FacesContext, java.lang.Object) on the saved state and return the result.

Parameters:

context - the FacesContextfor this request

Returns:

the UIViewParameter.

Since:

2.0