javax.faces.component: public class: UIParameter

javax.faces.component
public class: UIParameter [javadoc | source]

java.lang.Object
   javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
         javax.faces.component.UIParameter

All Implemented Interfaces:
PartialStateHolder, ComponentSystemEventListener, SystemEventListenerHolder

UIParameter is a UIComponent that represents an optionally named configuration parameter for a parent component.

Parent components should retrieve the value of a parameter by calling getValue(). In this way, the parameter value can be set directly on the component (via setValue()), or retrieved indirectly via the value binding expression.

In some scenarios, it is necessary to provide a parameter name, in addition to the parameter value that is accessible via the getValue() method. javax.faces.render.Renderer s that support parameter names on their nested UIParameter child components should document their use of this property.

Nested Class Summary:
enum class	UIParameter.PropertyKeys

Field Summary
public static final String	COMPONENT_TYPE	The standard component type for this component.
public static final String	COMPONENT_FAMILY	The standard component family for this component.

Fields inherited from javax.faces.component.UIComponent:
CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, BEANINFO_KEY, FACETS_KEY, VIEW_LOCATION_KEY, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, attributesThatAreSet, stateHelper, compositeParent, bindings, initialState, listenersByEventClass

Constructor:
public UIParameter() { super(); setRendererType(null); } Create a new UIParameter instance with default property values.

Constructor:

 public UIParameter() {
        super();
        setRendererType(null);
}

Create a new UIParameter instance with default property values.

Method from javax.faces.component.UIParameter Summary:
getFamily, getName, getValue, isDisable, setDisable, setName, setValue

Methods from javax.faces.component.UIComponentBase:
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getDescriptorMap, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods from javax.faces.component.UIComponentBase:

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getDescriptorMap, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods from javax.faces.component.UIComponent:
addFacesListener, broadcast, clearInitialState, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getFamily, getId, getListenersForEventClass, getNamingContainer, getParent, getRenderer, getRendererType, getRendersChildren, getResourceBundleMap, getStateHelper, getStateHelper, getValueBinding, getValueExpression, initialStateMarked, invokeOnComponent, isCompositeComponent, isInView, isRendered, isVisitable, markInitialState, popComponentFromEL, processDecodes, processEvent, processRestoreState, processSaveState, processUpdates, processValidators, pushComponentToEL, queueEvent, removeFacesListener, setId, setInView, setParent, setRendered, setRendererType, setValueBinding, setValueExpression, subscribeToEvent, unsubscribeFromEvent, visitTree

Methods from javax.faces.component.UIComponent:

addFacesListener, broadcast, clearInitialState, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getFamily, getId, getListenersForEventClass, getNamingContainer, getParent, getRenderer, getRendererType, getRendersChildren, getResourceBundleMap, getStateHelper, getStateHelper, getValueBinding, getValueExpression, initialStateMarked, invokeOnComponent, isCompositeComponent, isInView, isRendered, isVisitable, markInitialState, popComponentFromEL, processDecodes, processEvent, processRestoreState, processSaveState, processUpdates, processValidators, pushComponentToEL, queueEvent, removeFacesListener, setId, setInView, setParent, setRendered, setRendererType, setValueBinding, setValueExpression, subscribeToEvent, unsubscribeFromEvent, visitTree

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

Method from javax.faces.component.UIParameter Detail:
public String getFamily() { return (COMPONENT_FAMILY); }
public String getName() { return (String) getStateHelper().eval(PropertyKeys.name); } Return the optional parameter name for this parameter.
public Object getValue() { return getStateHelper().eval(PropertyKeys.value); } Returns the `value` property of the `UIParameter`.
public boolean isDisable() { return (Boolean) getStateHelper().eval(PropertyKeys.disble, false); } Return the value of the `disable` directive for this component. This directive determines whether the parameter value should be disabled by assigning it a null value. If true, the `value` set on this component is ignored.
public void setDisable(boolean disable) { getStateHelper().put(PropertyKeys.disble, disable); } Sets the `disable` property of the `UIParameter`.
public void setName(String name) { getStateHelper().put(PropertyKeys.name, name); } Set the optional parameter name for this parameter.
public void setValue(Object value) { getStateHelper().put(PropertyKeys.value, value); } Sets the `value` property of the\ `UIParameter`.

Method from javax.faces.component.UIParameter Detail:

 public String getFamily() {
        return (COMPONENT_FAMILY);
}

 public String getName() {
        return (String) getStateHelper().eval(PropertyKeys.name);
}

Return the optional parameter name for this parameter.

 public Object getValue() {
        return getStateHelper().eval(PropertyKeys.value);
}

Returns the value property of the UIParameter.

 public boolean isDisable() {
        return (Boolean) getStateHelper().eval(PropertyKeys.disble, false);
}

Return the value of the disable directive for this component. This directive determines whether the parameter value should be disabled by assigning it a null value. If true, the value set on this component is ignored.

 public  void setDisable(boolean disable) {
        getStateHelper().put(PropertyKeys.disble, disable);
}

Sets the disable property of the UIParameter.

 public  void setName(String name) {
        getStateHelper().put(PropertyKeys.name, name);
}

Set the optional parameter name for this parameter.

 public  void setValue(Object value) {
        getStateHelper().put(PropertyKeys.value, value);
}

Sets the value property of the\ UIParameter.