Class Hierarchy All Classes All Fields and Methods

 

Class javax.faces.component.UIParameter

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

public class UIParameter
extends UIComponentBase

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.

Field Index

Field	Description
COMPONENT_FAMILY	The standard component family for this component.
COMPONENT_TYPE	The standard component type for this component.

Constructor Index

Constructor	Description
UIParameter()	Create a new UIParameter instance with default property values.

Method Index

Method	Description
String getFamily()
String getName()	Return the optional parameter name for this parameter.
Object getValue()	Returns the value property of the UIParameter.
void restoreState(FacesContext, Object)
Object saveState(FacesContext)
void setName(String)	Set the optional parameter name for this parameter.
void setValue(Object)	Sets the value property of the\ UIParameter.

 

Fields

 

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

The standard component family for this component.

 

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

The standard component type for this component.

 

Constructors

 

UIParameter

public UIParameter() 

Create a new UIParameter instance with default property values.

 

Methods

 

getFamily

public String getFamily() 

 

getName

public String getName() 

Return the optional parameter name for this parameter.

 

getValue

public Object getValue() 

Returns the value property of the UIParameter.

 

restoreState

public void restoreState(FacesContext context,
                         Object state) 

 

saveState

public Object saveState(FacesContext context) 

 

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

 

setValue

public void setValue(Object value) 

Sets the value property of the\ UIParameter.

• Parameters

  • value - the new value

Class Hierarchy All Classes All Fields and Methods