Package org.primefaces.component.toggleswitch

Class ToggleSwitchBase

java.lang.Object
javax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UIOutput
javax.faces.component.UIInput
org.primefaces.component.toggleswitch.ToggleSwitchBase
All Implemented Interfaces:
EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.EditableValueHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.component.ValueHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, InputHolder, PrimeClientBehaviorHolder, Widget
Direct Known Subclasses:
ToggleSwitch
public abstract class ToggleSwitchBase extends javax.faces.component.UIInput implements Widget, javax.faces.component.behavior.ClientBehaviorHolder, PrimeClientBehaviorHolder, InputHolder

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    ToggleSwitchBase.PropertyKeys
     

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    COMPONENT_FAMILY
     
    static final String
    DEFAULT_RENDERER
     

    Fields inherited from class javax.faces.component.UIInput

    ALWAYS_PERFORM_VALIDATION_WHEN_REQUIRED_IS_TRUE, COMPONENT_TYPE, CONVERSION_MESSAGE_ID, EMPTY_STRING_AS_NULL_PARAM_NAME, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID, VALIDATE_EMPTY_FIELDS_PARAM_NAME

    Fields inherited from class javax.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

    Fields inherited from interface org.primefaces.component.api.Widget

    ATTR_WIDGET_VAR_PATTERN, CALLBACK_POST_CONSTRUCT, CALLBACK_POST_REFRESH, CALLBACK_PRE_DESTROY

  • Constructor Summary

    Constructors
    Constructor
    Description
    ToggleSwitchBase()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAriaLabel()
     
    String
    getFamily()
     
    String
    getInputClientId()
     
    String
    getLabel()
     
    String
    getLabelledBy()
     
    String
    getOffIcon()
     
    String
    getOnblur()
     
    String
    getOnchange()
     
    String
    getOnfocus()
     
    String
    getOnIcon()
     
    String
    getStyle()
     
    String
    getStyleClass()
     
    String
    getTabindex()
     
    String
    getValidatableInputClientId()
     
    String
    getWidgetVar()
     
    boolean
    isDisabled()
     
    void
    setAriaLabel(String ariaLabel)
     
    void
    setDisabled(boolean disabled)
     
    void
    setLabel(String label)
     
    void
    setLabelledBy(String labelledBy)
    Sets the id of the label for aria.
    void
    setOffIcon(String offIcon)
     
    void
    setOnblur(String onblur)
     
    void
    setOnchange(String onchange)
     
    void
    setOnfocus(String onfocus)
     
    void
    setOnIcon(String onIcon)
     
    void
    setStyle(String style)
     
    void
    setStyleClass(String styleClass)
     
    void
    setTabindex(String tabindex)
     
    void
    setWidgetVar(String widgetVar)
     

    Methods inherited from class javax.faces.component.UIInput

    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

    Methods inherited from class javax.faces.component.UIOutput

    getConverter, getLocalValue, setConverter

    Methods inherited from class javax.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, getValueBinding, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

    Methods inherited from class javax.faces.component.UIComponent

    encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree

    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.behavior.ClientBehaviorHolder

    addClientBehavior, getClientBehaviors, getDefaultEventName, getEventNames

    Methods inherited from interface org.primefaces.component.api.PrimeClientBehaviorHolder

    getBehaviorEventMapping

    Methods inherited from interface javax.faces.component.ValueHolder

    getConverter, getLocalValue, setConverter

    Methods inherited from interface org.primefaces.component.api.Widget

    resolveWidgetVar, resolveWidgetVar

  • Field Details

  • Constructor Details

    • ToggleSwitchBase

      public ToggleSwitchBase()

  • Method Details

    • getFamily

      public String getFamily()
      Overrides:
      getFamily in class javax.faces.component.UIInput

    • getWidgetVar

      public String getWidgetVar()

    • setWidgetVar

      public void setWidgetVar(String widgetVar)

    • getLabel

      public String getLabel()

    • setLabel

      public void setLabel(String label)

    • getAriaLabel

      public String getAriaLabel()

    • setAriaLabel

      public void setAriaLabel(String ariaLabel)

    • isDisabled

      public boolean isDisabled()

    • setDisabled

      public void setDisabled(boolean disabled)

    • getOnchange

      public String getOnchange()

    • setOnchange

      public void setOnchange(String onchange)

    • getStyle

      public String getStyle()

    • setStyle

      public void setStyle(String style)

    • getStyleClass

      public String getStyleClass()

    • setStyleClass

      public void setStyleClass(String styleClass)

    • getTabindex

      public String getTabindex()

    • setTabindex

      public void setTabindex(String tabindex)

    • getOnfocus

      public String getOnfocus()

    • setOnfocus

      public void setOnfocus(String onfocus)

    • getOnblur

      public String getOnblur()

    • setOnblur

      public void setOnblur(String onblur)

    • getOnIcon

      public String getOnIcon()

    • setOnIcon

      public void setOnIcon(String onIcon)

    • getOffIcon

      public String getOffIcon()

    • setOffIcon

      public void setOffIcon(String offIcon)

    • getInputClientId

      public String getInputClientId()
      Specified by:
      getInputClientId in interface InputHolder
      Returns:
      Client id of the input element

    • getValidatableInputClientId

      public String getValidatableInputClientId()
      Specified by:
      getValidatableInputClientId in interface InputHolder
      Returns:
      Client id of the validatable input element

    • getLabelledBy

      public String getLabelledBy()
      Specified by:
      getLabelledBy in interface InputHolder
      Returns:
      Client id of the label for aria

    • setLabelledBy

      public void setLabelledBy(String labelledBy)
      Description copied from interface: InputHolder
      Sets the id of the label for aria.
      Specified by:
      setLabelledBy in interface InputHolder
      Parameters:
      labelledBy - the id