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

Modifier and Type	Class and Description
pack-priv static enum	UIParameter.PropertyKeys

Field Summary

Modifier and Type	Field and Description
public static final String	COMPONENT_FAMILY The standard component family for this component.
public static final String	COMPONENT_TYPE The standard component type for this component.

Constructor Summary

Access	Constructor and Description
public	UIParameter() Create a new `UIParameter` instance with default property values.

Method Summary

Modifier and Type	Method and Description
public String	getFamily() Implements abstract javax.faces.component.UIComponent.getFamily. Return the identifier of the component family to which this component belongs.
public String	Returns: the name. getName() Return the optional parameter name for this parameter.
public Object	Returns: the value. getValue() Returns the `value` property of the `UIParameter`.
public boolean	Returns: `true` if disabled, `false` otherwise. isDisable() Return the value of the `disable` directive for this component.
public void	setDisable(boolean the value for the disable flag. disable) Sets the `disable` property of the `UIParameter`.
public void	setName(String The new parameter name, or `null` for no name name) Set the optional parameter name for this parameter.
public void	setValue(Object the new value value) Sets the `value` property of the\ `UIParameter`.

Field Detail

COMPONENT_FAMILY	back to summary
public static final String COMPONENT_FAMILY The standard component family for this component.

COMPONENT_TYPE	back to summary
public static final String COMPONENT_TYPE The standard component type for this component.

Constructor Detail

UIParameter	back to summary
public UIParameter() Create a new `UIParameter` instance with default property values.

Method Detail

getFamily back to summary

getFamily	back to summary
public String getFamily() Implements abstract javax.faces.component.UIComponent.getFamily. Doc from javax.faces.component.UIComponent.getFamily. 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. Note this method should NOT return `null` Returns:String the component family (not null). Annotations @Override

public String getFamily()

Implements abstract javax.faces.component.UIComponent.getFamily.

Doc from javax.faces.component.UIComponent.getFamily.

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. Note this method should NOT return null

Returns:String

the component family (not null).

Annotations

@Override

getName	back to summary
public String getName() Return the optional parameter name for this parameter. Returns:String the name.

getName

back to summary

public String getName()

Return the optional parameter name for this parameter.

Returns:String: the name.

getValue back to summary

getValue	back to summary
public Object getValue() Returns the `value` property of the `UIParameter`. Returns:Object the value.

public Object getValue()

Returns the value property of the UIParameter.

Returns:Object: the value.

isDisable back to summary

isDisable	back to summary
public boolean isDisable() 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. Returns:boolean `true` if disabled, `false` otherwise. Since 2.0

public boolean isDisable()

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.

Returns:boolean: true if disabled, false otherwise.
Since: 2.0

setDisable back to summary

setDisable	back to summary
public void setDisable(boolean disable) Sets the `disable` property of the `UIParameter`. Parameters disable:boolean the value for the disable flag. Since 2.0

public void setDisable(boolean disable)

Sets the disable property of the UIParameter.

Parameters

disable:boolean: the value for the disable flag.

Since

2.0

setName back to summary

setName	back to summary
public void setName(String name) Set the optional parameter name for this parameter. Parameters name:String The new parameter name, or `null` for no name

public void setName(String name)

Set the optional parameter name for this parameter.

Parameters

name:String: The new parameter name, or null for no name

setValue back to summary

setValue	back to summary
public void setValue(Object value) Sets the `value` property of the\ `UIParameter`. Parameters value:Object the new value

public void setValue(Object value)

Sets the value property of the\ UIParameter.

Parameters

value:Object: the new value

javax.faces.component back to summary

pack-priv final Enum UIParameter.PropertyKeys

Class Inheritance

extends Enum<UIParameter.PropertyKeys>

java.lang.Object
java.lang.Enum
javax.faces.component.UIParameter.PropertyKeys

Field Summary

Modifier and Type	Field and Description
public static final UIParameter.PropertyKeys	disable
public static final UIParameter.PropertyKeys	name Hides java.lang.Enum.name.
public static final UIParameter.PropertyKeys	value

Constructor Summary

Access	Constructor and Description
private	PropertyKeys()

Method Summary

Modifier and Type	Method and Description
public static UIParameter.PropertyKeys	valueOf(String name)
public static UIParameter.PropertyKeys[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

disable	back to summary
public static final UIParameter.PropertyKeys disable

name	back to summary
public static final UIParameter.PropertyKeys name Hides java.lang.Enum.name.

value	back to summary
public static final UIParameter.PropertyKeys value

Constructor Detail

PropertyKeys	back to summary
private PropertyKeys()

Method Detail

valueOf	back to summary
public static UIParameter.PropertyKeys valueOf(String name)

values	back to summary
public static UIParameter.PropertyKeys[] values()

public Class UIParameter

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Enum UIParameter.PropertyKeys

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail