javax.faces.component: public static class: UIViewParameter.Reference

javax.faces.component
public static class: UIViewParameter.Reference [javadoc | source]

java.lang.Object
   javax.faces.component.UIViewParameter$Reference

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:

Constructor:
public Reference(FacesContext context, UIViewParameter param, int indexInParent, String viewIdAtTimeOfConstruction) { this.saver = new StateHolderSaver(context, param); this.indexInParent = indexInParent; this.viewIdAtTimeOfConstruction = viewIdAtTimeOfConstruction; } Construct a reference to a `UIViewParameter`. This constructor cause the StateHolder#saveState method to be called on argument `UIViewParameter`. Parameters: `context` - the `FacesContext`for this request `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` -

 public Reference(FacesContext context,
    UIViewParameter param,
    int indexInParent,
    String viewIdAtTimeOfConstruction) {
            this.saver = new StateHolderSaver(context, param);
            this.indexInParent = indexInParent;
            this.viewIdAtTimeOfConstruction = viewIdAtTimeOfConstruction;
}

Construct a reference to a UIViewParameter. This constructor cause the StateHolder#saveState method to be called on argument UIViewParameter.

Parameters:

context - the FacesContextfor this request

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 from javax.faces.component.UIViewParameter$Reference Summary:
getUIViewParameter

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from javax.faces.component.UIViewParameter$Reference Detail:
public UIViewParameter getUIViewParameter(FacesContext context) { UIViewParameter result = null; UIViewRoot root = context.getViewRoot(); // If the view root is the same as when we were constructed... if (this.viewIdAtTimeOfConstruction.equals(root.getViewId())) { // get the actual view parameter from the tree... UIComponent metadataFacet = root.getFacet(UIViewRoot.METADATA_FACET_NAME); result = (UIViewParameter) metadataFacet.getChildren().get(indexInParent); } else { // otherwise, use the saved one result = (UIViewParameter) this.saver.restore(context); } return result; } 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 on the saved state and return the result.

Method from javax.faces.component.UIViewParameter$Reference Detail:

 public UIViewParameter getUIViewParameter(FacesContext context) {
            UIViewParameter result = null;
            UIViewRoot root = context.getViewRoot();
            // If the view root is the same as when we were constructed...
            if (this.viewIdAtTimeOfConstruction.equals(root.getViewId())) {
                // get the actual view parameter from the tree...
                UIComponent metadataFacet = root.getFacet(UIViewRoot.METADATA_FACET_NAME);
                result = (UIViewParameter) metadataFacet.getChildren().get(indexInParent);
            } else {
                // otherwise, use the saved one
                result = (UIViewParameter) this.saver.restore(context);
            }
            return result;
}

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 on the saved state and return the result.