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

@JSFComponent(defaultRendererType="jakarta.faces.Checkbox")
public class UISelectBoolean
extends UIInput

A component that allows the user to select or unselect an object.

This can also be used to choose between two states such as true/false or on/off.

See the javadoc for this class in the JSF Specification for further details.

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE

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

Constructors

Constructor and Description
UISelectBoolean()

Method Summary

Modifier and Type	Method and Description
String	getFamily()
Object	getValue() Return the current value of this component.
ValueBinding	getValueBinding(String name) Deprecated. Use getValueExpression instead
jakarta.el.ValueExpression	getValueExpression(String name)
boolean	isSelected()
void	setSelected(boolean selected)
void	setValueBinding(String name, ValueBinding binding) Deprecated. Use setValueExpression instead
void	setValueExpression(String name, jakarta.el.ValueExpression binding)

Methods inherited from class jakarta.faces.component.UIInput

addValidator, addValueChangeListener, broadcast, clearInitialState, compareValues, decode, getConvertedValue, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidator, getValidatorMessage, getValidators, 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, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, visitTree

Methods inherited from class jakarta.faces.component.UIComponent

getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, subscribeToEvent, unsubscribeFromEvent

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 Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

Constructor Detail

UISelectBoolean

public UISelectBoolean()

Method Detail

getFamily

public String getFamily()

Overrides:

getFamily in class UIInput

setSelected

public void setSelected(boolean selected)

isSelected

public boolean isSelected()

getValueBinding

public ValueBinding getValueBinding(String name)

Deprecated. Use getValueExpression instead

Description copied from class: UIComponentBase

Get the named value-binding associated with this component.

Value-bindings are stored in a map associated with the component, though there is commonly a property (setter/getter methods) of the same name defined on the component itself which evaluates the value-binding when called.

Overrides:

getValueBinding in class UIComponentBase

setValueBinding

public void setValueBinding(String name,
                            ValueBinding binding)

Deprecated. Use setValueExpression instead

Description copied from class: UIComponentBase

Put the provided value-binding into a map of value-bindings associated with this component.

Overrides:

setValueBinding in class UIComponentBase

getValueExpression

public jakarta.el.ValueExpression getValueExpression(String name)

Overrides:

getValueExpression in class UIComponent

setValueExpression

public void setValueExpression(String name,
                               jakarta.el.ValueExpression binding)

Overrides:

setValueExpression in class UIComponent

getValue

@JSFProperty(deferredValueType="java.lang.Boolean")
public Object getValue()

Description copied from class: UIInput

Return the current value of this component.

If a submitted value has been converted but not yet pushed into the model, then return that locally-cached value (see isLocalValueSet).

Otherwise, evaluate an EL expression to fetch a value from the model.

Specified by:

getValue in interface ValueHolder

Overrides:

getValue in class UIInput

Returns:

the new value value