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 Details

    • COMPONENT_TYPE

      public static final String COMPONENT_TYPE

      The standard component type for this component.

      See Also:

    • COMPONENT_FAMILY

      public static final String 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

      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

    • getValueBinding

      @Deprecated public ValueBinding getValueBinding(String name)
      Deprecated.
      This has been replaced by 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.

      Overrides:
      getValueBinding in class UIComponentBase
      Parameters:
      name - Name of the attribute or property for which to retrieve a ValueBinding
      Returns:
      the value binding.
      Throws:
      NullPointerException - if name is null

    • setValueBinding

      @Deprecated public void setValueBinding(String name, ValueBinding binding)
      Deprecated.
      This has been replaced by 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.

      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:
      NullPointerException - if name is null