public class UISelectBoolean extends UIInput
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.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COMPONENT_FAMILY
The standard component family for this component.
|
static java.lang.String |
COMPONENT_TYPE
The standard component type for this component.
|
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
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 and Description |
---|
UISelectBoolean()
Create a new
UISelectBoolean instance with default property values. |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getFamily()
Return the identifier of the component family to which this component belongs. |
ValueBinding |
getValueBinding(java.lang.String name)
Deprecated.
This has been replaced by
getValueExpression(java.lang.String) . |
ValueExpression |
getValueExpression(java.lang.String name)
Return any
ValueExpression set for value if a ValueExpression for selected
is requested; otherwise, perform the default superclass processing for this method. |
boolean |
isSelected()
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(java.lang.String name,
ValueBinding binding)
Deprecated.
This has been replaced by
setValueExpression(java.lang.String, jakarta.el.ValueExpression) . |
void |
setValueExpression(java.lang.String name,
ValueExpression binding)
Store any
ValueExpression specified for selected under value instead; otherwise,
perform the default superclass processing for this method. |
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
getConverter, getLocalValue, setConverter
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
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, visitTree
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getConverter, getLocalValue, setConverter
public static final java.lang.String COMPONENT_TYPE
The standard component type for this component.
public static final java.lang.String COMPONENT_FAMILY
The standard component family for this component.
public UISelectBoolean()
Create a new UISelectBoolean
instance with default property values.
public java.lang.String getFamily()
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 appropriate Renderer
for this
component instance. Note this method should NOT return null
public boolean isSelected()
Return the local value of the selected state of this component. This method is a typesafe alias for
getValue()
.
public void setSelected(boolean selected)
Set the local value of the selected state of this component. This method is a typesafe alias for
setValue()
.
selected
- The new selected statepublic ValueExpression getValueExpression(java.lang.String name)
Return any ValueExpression
set for value
if a ValueExpression
for selected
is requested; otherwise, perform the default superclass processing for this method.
getValueExpression
in class UIComponent
name
- Name of the attribute or property for which to retrieve a ValueExpression
null
.java.lang.NullPointerException
- if name
is null
public void setValueExpression(java.lang.String name, ValueExpression binding)
Store any ValueExpression
specified for selected
under value
instead; otherwise,
perform the default superclass processing for this method.
setValueExpression
in class UIComponent
name
- Name of the attribute or property for which to set a ValueExpression
binding
- The ValueExpression
to set, or null
to remove any currently set
ValueExpression
java.lang.NullPointerException
- if name
is null
@Deprecated public ValueBinding getValueBinding(java.lang.String name)
getValueExpression(java.lang.String)
.
Return any ValueBinding
set for value
if a ValueBinding
for selected
is
requested; otherwise, perform the default superclass processing for this method.
Rely on the superclass implementation to wrap the returned ValueExpression
in a
ValueBinding
.
getValueBinding
in class UIComponentBase
name
- Name of the attribute or property for which to retrieve a ValueBinding
java.lang.NullPointerException
- if name
is null
@Deprecated public void setValueBinding(java.lang.String name, ValueBinding binding)
setValueExpression(java.lang.String, jakarta.el.ValueExpression)
.
Store any ValueBinding
specified for selected
under value
instead; otherwise,
perform the default superclass processing for this method.
Rely on the superclass implementation to wrap the argument ValueBinding
in a
ValueExpression
.
setValueBinding
in class UIComponentBase
name
- Name of the attribute or property for which to set a ValueBinding
binding
- The ValueBinding
to set, or null
to remove any currently set ValueBinding
java.lang.NullPointerException
- if name
is null