UIParameter (Java EE 5)

UIParameter 是表示父组件配置参数的 UIComponent,可以选择命名参数。

父组件应通过调用 getValue() 来获取参数的值。通过这种方法，可以直接在组件上设置参数值（通过 setValue()），也可以通过值绑定表达式间接获取。

在某些情况下，除了提供通过 getValue() 方法访问的参数值外，还要提供参数名称。支持其嵌入 UIParameter 子组件上的参数名称的 javax.faces.render.Renderer 应记录此属性的使用。

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. Renderers that support parameter names on their nested UIParameter child components should document their use of this property.

英文文档：

COMPONENT_TYPE

public static final String COMPONENT_TYPE

The standard component type for this component.

See Also:

Constant Field Values

英文文档：

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

The standard component family for this component.

See Also:

Constant Field Values

public UIParameter()

使用默认属性值创建新的 UIParameter 实例。

英文文档：

UIParameter

public UIParameter()

Create a new UIParameter instance with default property values.

public String getFamily()

英文文档：

getFamily

public String getFamily()

Description copied from class: UIComponent

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.

Specified by:

getFamily in class UIComponent

public String getName()

返回此参数的可选参数名称。

英文文档：

getName

public String getName()

Return the optional parameter name for this parameter.

public void setName(String name)

设置此参数的可选参数名称。

name	新的参数名称，或如果没有名称，则为 null

英文文档：

setName

public void setName(String name)

Set the optional parameter name for this parameter.

Parameters:

name - The new parameter name, or null for no name

public Object getValue()

返回 UIParameter 的 value 属性。

英文文档：

getValue

public Object getValue()

Returns the value property of the UIParameter.

public void setValue(Object value)

设置 UIParameter 的 value 属性。

value

新值

英文文档：

setValue

public void setValue(Object value)

Sets the value property of the\ UIParameter.

Parameters:

value - the new value

public Object saveState(FacesContext context)

英文文档：

saveState

public Object saveState(FacesContext context)

Description copied from interface: StateHolder

Gets the state of the instance as a Serializable Object.

If the class that implements this interface has references to instances that implement StateHolder (such as a UIComponent with event handlers, validators, etc.) this method must call the StateHolder.saveState(javax.faces.context.FacesContext) method on all those instances as well. This method must not save the state of children and facets. That is done via the StateManager

This method must not alter the state of the implementing object. In other words, after executing this code:

 Object state = component.saveState(facesContext);
 

component should be the same as before executing it.

The return from this method must be Serializable

Specified by:

saveState in interface StateHolder

Overrides:

saveState in class UIComponentBase

public void restoreState(FacesContext context,
                         Object state)