Package jakarta.faces.component

Class UISelectBoolean

java.lang.Object

jakarta.faces.component.UIComponent

jakarta.faces.component.UIComponentBase

jakarta.faces.component.UIOutput

jakarta.faces.component.UIInput

jakarta.faces.component.UISelectBoolean

All Implemented Interfaces:

EditableValueHolder, PartialStateHolder, StateHolder, TransientStateHolder, ValueHolder, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder, EventListener

Direct Known Subclasses:

HtmlSelectBooleanCheckbox

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.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMPONENT_FAMILY	The standard component family for this component.
static final String	COMPONENT_TYPE	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, FACETS_KEY, VIEW_LOCATION_KEY

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
String	getFamily()	Return the identifier of the component family to which this component belongs.
ValueExpression	getValueExpression(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	setValueExpression(String name, ValueExpression binding)	Store any ValueExpression specified for selected under value 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, getValidatorMessage, getValidators, getValue, getValueChangeListeners, isEmpty, isImmediate, isLocalValueSet, isRequired, isValid, markInitialState, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, resetValue, restoreState, saveState, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidatorMessage, setValue, 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

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 Details

UISelectBoolean

public UISelectBoolean()

Create a new UISelectBoolean instance with default property values.

Method Details

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 appropriate Renderer for this component instance. Note this method should NOT return null

Overrides:

getFamily in class UIInput

Returns:

the component family (not null).

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

public ValueExpression getValueExpression(String name)

Return any ValueExpression set for value if a ValueExpression for selected is requested; otherwise, perform the default superclass processing for this method.

Overrides:

getValueExpression in class UIComponent

Parameters:

name - Name of the attribute or property for which to retrieve a ValueExpression

Returns:

the value expression, or null.

Throws:

NullPointerException - if name is null

Since:

1.2

setValueExpression

public void setValueExpression(String name,
 ValueExpression binding)

Store any ValueExpression specified for selected under value instead; otherwise, perform the default superclass processing for this method.

Overrides:

setValueExpression in class UIComponent

Parameters:

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

Throws:

NullPointerException - if name is null

Since:

1.2