Class UISelectBoolean
- All Implemented Interfaces:
EditableValueHolder
,PartialStateHolder
,StateHolder
,TransientStateHolder
,ValueHolder
,ComponentSystemEventListener
,FacesListener
,SystemEventListenerHolder
,EventListener
- Direct Known Subclasses:
HtmlSelectBooleanCheckbox
UISelectBoolean is a UIComponent
that represents a single boolean (true
or
false
) value. It is most commonly rendered as a checkbox.
By default, the rendererType
property must be set to "jakarta.faces.Checkbox
". This value
can be changed by calling the setRendererType()
method.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The standard component family for this component.static final String
The standard component type for this component.Fields inherited from class jakarta.faces.component.UIInput
ALWAYS_PERFORM_VALIDATION_WHEN_REQUIRED_IS_TRUE, CONVERSION_MESSAGE_ID, EMPTY_STRING_AS_NULL_PARAM_NAME, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID, VALIDATE_EMPTY_FIELDS_PARAM_NAME
Fields inherited from class jakarta.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
-
Method Summary
Modifier and TypeMethodDescriptionReturn the identifier of the component family to which this component belongs.getValueBinding
(String name) Deprecated.getValueExpression
(String name) Return anyValueExpression
set forvalue
if aValueExpression
forselected
is requested; otherwise, perform the default superclass processing for this method.boolean
Return the local value of the selected state of this component.void
setSelected
(boolean selected) Set the local value of the selected state of this component.void
setValueBinding
(String name, ValueBinding binding) Deprecated.This has been replaced bysetValueExpression(java.lang.String, jakarta.el.ValueExpression)
.void
setValueExpression
(String name, ValueExpression binding) Store anyValueExpression
specified forselected
undervalue
instead; otherwise, perform the default superclass processing for this method.Methods inherited from class jakarta.faces.component.UIInput
addValidator, addValueChangeListener, clearInitialState, compareValues, decode, getConvertedValue, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidator, getValidatorMessage, getValidators, getValue, getValueChangeListener, getValueChangeListeners, isEmpty, isImmediate, isLocalValueSet, isRequired, isValid, markInitialState, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, resetValue, restoreState, saveState, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidator, setValidatorMessage, setValue, setValueChangeListener, updateModel, validate, validateValue
Methods inherited from class jakarta.faces.component.UIOutput
getConverter, getLocalValue, setConverter
Methods inherited from class jakarta.faces.component.UIComponentBase
addClientBehavior, addFacesListener, broadcast, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, subscribeToEvent, unsubscribeFromEvent
Methods inherited from class jakarta.faces.component.UIComponent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, visitTree
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface jakarta.faces.component.ValueHolder
getConverter, getLocalValue, setConverter
-
Field Details
-
COMPONENT_TYPE
The standard component type for this component.
- See Also:
-
COMPONENT_FAMILY
The standard component family for this component.
- See Also:
-
-
Constructor Details
-
UISelectBoolean
public UISelectBoolean()Create a new
UISelectBoolean
instance with default property values.
-
-
Method Details
-
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. Note this method should NOT returnnull
-
isSelected
public boolean isSelected()Return the local value of the selected state of this component. This method is a typesafe alias for
getValue()
.- Returns:
- true if selected, false otherwise.
-
setSelected
public void setSelected(boolean selected) Set the local value of the selected state of this component. This method is a typesafe alias for
setValue()
.- Parameters:
selected
- The new selected state
-
getValueExpression
Return any
ValueExpression
set forvalue
if aValueExpression
forselected
is requested; otherwise, perform the default superclass processing for this method.- Overrides:
getValueExpression
in classUIComponent
- Parameters:
name
- Name of the attribute or property for which to retrieve aValueExpression
- Returns:
- the value expression, or
null
. - Throws:
NullPointerException
- ifname
isnull
- Since:
- 1.2
-
setValueExpression
Store any
ValueExpression
specified forselected
undervalue
instead; otherwise, perform the default superclass processing for this method.- Overrides:
setValueExpression
in classUIComponent
- Parameters:
name
- Name of the attribute or property for which to set aValueExpression
binding
- TheValueExpression
to set, ornull
to remove any currently setValueExpression
- Throws:
NullPointerException
- ifname
isnull
- Since:
- 1.2
-
getValueBinding
Deprecated.This has been replaced bygetValueExpression(java.lang.String)
.Return any
ValueBinding
set forvalue
if aValueBinding
forselected
is requested; otherwise, perform the default superclass processing for this method.Rely on the superclass implementation to wrap the returned
ValueExpression
in aValueBinding
.- Overrides:
getValueBinding
in classUIComponentBase
- Parameters:
name
- Name of the attribute or property for which to retrieve aValueBinding
- Returns:
- the value binding.
- Throws:
NullPointerException
- ifname
isnull
-
setValueBinding
Deprecated.This has been replaced bysetValueExpression(java.lang.String, jakarta.el.ValueExpression)
.Store any
ValueBinding
specified forselected
undervalue
instead; otherwise, perform the default superclass processing for this method.Rely on the superclass implementation to wrap the argument
ValueBinding
in aValueExpression
.- Overrides:
setValueBinding
in classUIComponentBase
- Parameters:
name
- Name of the attribute or property for which to set aValueBinding
binding
- TheValueBinding
to set, ornull
to remove any currently setValueBinding
- Throws:
NullPointerException
- ifname
isnull
-
getValueExpression(java.lang.String)
.