JavaServer Faces

Name

UIParameter

Synopsis

This class represents a parameter component. A parameter component provides a, possibly named, parameter value to its parent, such as a link component. The parameter component’s value is rendered by its parent.

Class name:	javax.faces.component.UIParameter
Extends:	javax.faces.component.UIComponentBase
Implements:	javax.faces.component.StateHolder

Fields

public static String COMPONENT_FAMILY

The component family: javax.faces.Parameter.

public static String COMPONENT_TYPE

The component family: javax.faces.Parameter.

Constructor

public UIParameter()

Creates a new instance.

Methods

public String getFamily()

Returns the component family ID.

public String getName()

Returns the parameter name or null if it doesn’t have a name.

public Object getValue()

Returns the parameter value.

public void restoreState(javax.faces.context.FacesContext context, Object state)

Restores the state for this instance from the provided value; an Object previously returned by the saveState() method.

public Object saveState(javax.faces.context.FacesContext context)

Returns the state for this instance as an Object to be passed to the restoreState() method when the instance is restored for the next request.

public void setName(String name)

Sets the parameter name.

public void setValue(Object value)

Sets the parameter value.