javax.faces.component
Class UISelectBoolean

java.lang.Object
  |
  +--javax.faces.component.UIComponent
        |
        +--javax.faces.component.UIComponentBase
              |
              +--javax.faces.component.UIOutput
                    |
                    +--javax.faces.component.UIInput
                          |
                          +--javax.faces.component.UISelectBoolean

All Implemented Interfaces:

EditableValueHolder, StateHolder, ValueHolder

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 "javax.faces.Checkbox". This value can be changed by calling the setRendererType() method.

Field Summary

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.

Fields inherited from class javax.faces.component.UIInput

CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID

Constructor Summary

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

Method Summary

java.lang.String	getFamily() Return the identifier of the component family to which this component belongs.
javax.faces.el.ValueBinding	getValueBinding(java.lang.String name) Return any ValueBinding set for value if a ValueBinding 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, javax.faces.el.ValueBinding binding) Store any ValueBinding specified for selected under value instead; otherwise, perform the default superclass processing for this method.

Methods inherited from class javax.faces.component.UIInput

addValidator, addValueChangeListener, broadcast, compareValues, decode, getConvertedValue, getSubmittedValue, getValidator, getValidators, getValueChangeListener, getValueChangeListeners, isImmediate, isLocalValueSet, isRequired, isValid, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, restoreState, saveState, setImmediate, setLocalValueSet, setRequired, setSubmittedValue, setValid, setValidator, setValue, setValueChangeListener, updateModel, validate, validateValue

Methods inherited from class javax.faces.component.UIOutput

getConverter, getLocalValue, getValue, setConverter

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.faces.component.ValueHolder

getConverter, getLocalValue, getValue, setConverter

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

The standard component type for this component.

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

The standard component family for this component.

See Also:

Constant Field Values

Constructor Detail

UISelectBoolean

public UISelectBoolean()

Create a new UISelectBoolean instance with default property values.

Method Detail

getFamily

public java.lang.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.

Overrides:

getFamily in class UIInput

isSelected

public boolean isSelected()

Return the local value of the selected state of this component. This method is a typesafe alias for getValue().

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

getValueBinding

public javax.faces.el.ValueBinding getValueBinding(java.lang.String name)

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

Overrides:

getValueBinding in class UIComponentBase

Parameters:

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

Throws:

java.lang.NullPointerException - if name is null

setValueBinding

public void setValueBinding(java.lang.String name,
                            javax.faces.el.ValueBinding binding)

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

Overrides:

setValueBinding in class UIComponentBase

Parameters:

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

Throws:

java.lang.NullPointerException - if name is null