- java.lang.Object
-
- javax.faces.component.UIComponent
-
- javax.faces.component.UIComponentBase
-
- javax.faces.component.UIParameter
-
- All Implemented Interfaces:
- EventListener, PartialStateHolder, StateHolder, TransientStateHolder, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder
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 (viasetValue()
), 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.Renderer
s that support parameter names on their nestedUIParameter
child components should document their use of this property.
-
-
Field Summary
Fields Modifier and Type Field and Description static String
COMPONENT_FAMILY
The standard component family for this component.static String
COMPONENT_TYPE
The standard component type for this component.-
Fields inherited from class javax.faces.component.UIComponent
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY
-
-
Constructor Summary
Constructors Constructor and Description UIParameter()
Create a newUIParameter
instance with default property values.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description String
getFamily()
Return the identifier of the component family to which this component belongs.String
getName()
Return the optional parameter name for this parameter.Object
getValue()
Returns thevalue
property of theUIParameter
.boolean
isDisable()
Return the value of the
disable
directive for this component.void
setDisable(boolean disable)
Sets thedisable
property of theUIParameter
.void
setName(String name)
Set the optional parameter name for this parameter.void
setValue(Object value)
Sets thevalue
property of the\UIParameter
.-
Methods inherited from class javax.faces.component.UIComponentBase
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, 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, subscribeToEvent, unsubscribeFromEvent
-
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree
-
-
-
-
Field Detail
-
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
-
-
Constructor Detail
-
UIParameter
public UIParameter()
Create a new
UIParameter
instance with default property values.
-
-
Method Detail
-
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 appropriateRenderer
for this component instance.- Specified by:
getFamily
in classUIComponent
-
getName
public String getName()
Return the optional parameter name for this parameter.
-
setName
public void setName(String name)
Set the optional parameter name for this parameter.
- Parameters:
name
- The new parameter name, ornull
for no name
-
getValue
public Object getValue()
Returns the
value
property of theUIParameter
.
-
setValue
public void setValue(Object value)
Sets the
value
property of the\UIParameter
.- Parameters:
value
- the new value
-
isDisable
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, thevalue
set on this component is ignored.- Since:
- 2.0
-
setDisable
public void setDisable(boolean disable)
Sets the
disable
property of theUIParameter
.- Parameters:
disable
-- Since:
- 2.0
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
21/08/2025 13:05:24 Cette version de la page est en cache (à la date du 21/08/2025 13:05:24) afin d'accélérer le traitement.Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la version plus récente de la page.
Document créé le 24/12/2007, dernière modification le 18/08/2025
Source du document imprimé : https://www.gaudry.be/java-api-javaee-rf-javax/faces/component/UIParameter.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.