Class UISelectBooleanToggle
java.lang.Object
jakarta.faces.component.UIComponent
jakarta.faces.component.UIComponentBase
jakarta.faces.component.UIOutput
jakarta.faces.component.UIInput
jakarta.faces.component.UISelectBoolean
org.apache.myfaces.tobago.internal.component.AbstractUISelectBoolean
org.apache.myfaces.tobago.internal.component.AbstractUISelectBooleanToggle
org.apache.myfaces.tobago.component.UISelectBooleanToggle
- All Implemented Interfaces:
- jakarta.faces.component.behavior.ClientBehaviorHolder,- jakarta.faces.component.EditableValueHolder,- jakarta.faces.component.PartialStateHolder,- jakarta.faces.component.StateHolder,- jakarta.faces.component.TransientStateHolder,- jakarta.faces.component.ValueHolder,- jakarta.faces.event.ComponentSystemEventListener,- jakarta.faces.event.FacesListener,- jakarta.faces.event.SystemEventListenerHolder,- EventListener,- SupportFieldId,- SupportsAccessKey,- SupportsAutoSpacing,- SupportsDecorationPosition,- SupportsHelp,- SupportsLabelLayout,- Visual
@Generated("component.stg")
public class UISelectBooleanToggle
extends AbstractUISelectBooleanToggle
Renders a checkbox as toggle.
 UIComponent class, generated from template 
component.stg with class
 SelectBooleanToggleTagDeclaration.- 
Field SummaryFieldsFields inherited from class jakarta.faces.component.UIInputALWAYS_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_NAMEFields inherited from class jakarta.faces.component.UIComponentATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEY
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionThe access key of this control.Automatically add spacing (margins/paddings) to the component for better positioning.Sets a CSS class in its parent, if the parent supports it.getHelp()Text value to display as a help.Defines the position and the appearance of a help message on a component.Image to be displayed to the user for this option.Label to be displayed to the user for this option.getLabel()A localized user presentable label for this component.Defines the position of the label relative to the field.Defines the position and the appearance of additional faces messages (like error message or help message) on a component.Controls the navigation of the focus through the input controls on a page with the Tab-Key.getTip()Text value to display as tooltip.booleanFlag indicating that this element is disabled.booleanisFocus()Flag indicating this component should receive the focus.booleanFlag indicating that this component will prohibit changes by the user.voidrestoreState(jakarta.faces.context.FacesContext context, Object state) voidsetAccessKey(Character accessKey) voidsetAutoSpacing(Boolean autoSpacing) voidsetCustomClass(CustomClass customClass) voidsetDisabled(boolean disabled) voidsetFocus(boolean focus) voidvoidsetHelpPosition(DecorationPosition helpPosition) voidsetItemImage(String itemImage) voidsetItemLabel(String itemLabel) voidvoidsetLabelLayout(LabelLayout labelLayout) voidvoidsetMessagePosition(DecorationPosition messagePosition) voidsetReadonly(boolean readonly) voidsetTabIndex(Integer tabIndex) voidMethods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUISelectBooleangetFieldId, isError, isLabelLayoutSkip, isNextToRenderIsLabel, isSelected, setNextToRenderIsLabel, validateValueMethods inherited from class jakarta.faces.component.UISelectBooleangetValue, getValueExpression, setSelected, setValueExpressionMethods inherited from class jakarta.faces.component.UIInputaddValidator, addValueChangeListener, broadcast, clearInitialState, compareValues, decode, getConvertedValue, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidatorMessage, getValidators, getValueChangeListeners, isEmpty, isImmediate, isLocalValueSet, isRequired, isValid, markInitialState, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, resetValue, saveState, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidatorMessage, setValue, updateModel, validateMethods inherited from class jakarta.faces.component.UIOutputgetConverter, getLocalValue, setConverterMethods inherited from class jakarta.faces.component.UIComponentBaseaddClientBehavior, addFacesListener, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, 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, visitTreeMethods inherited from class jakarta.faces.component.UIComponentgetClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, subscribeToEvent, unsubscribeFromEventMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface jakarta.faces.component.behavior.ClientBehaviorHolderaddClientBehavior, getClientBehaviorsMethods inherited from interface org.apache.myfaces.tobago.component.SupportsAutoSpacinggetAutoSpacingMethods inherited from interface jakarta.faces.component.ValueHoldergetConverter, getLocalValue, setConverterMethods inherited from interface org.apache.myfaces.tobago.component.VisualgetRendererType, isPlain
- 
Field Details- 
COMPONENT_TYPE
- 
COMPONENT_FAMILY- See Also:
 
 
- 
- 
Constructor Details- 
UISelectBooleanTogglepublic UISelectBooleanToggle()
 
- 
- 
Method Details- 
getEventNames- Specified by:
- getEventNamesin interface- jakarta.faces.component.behavior.ClientBehaviorHolder
- Overrides:
- getEventNamesin class- jakarta.faces.component.UIComponentBase
 
- 
getDefaultEventName- Specified by:
- getDefaultEventNamein interface- jakarta.faces.component.behavior.ClientBehaviorHolder
- Overrides:
- getDefaultEventNamein class- jakarta.faces.component.UIComponentBase
 
- 
getFamily- Overrides:
- getFamilyin class- jakarta.faces.component.UISelectBoolean
 
- 
getMarkup
- 
setMarkup
- 
getLabelLayoutDefines the position of the label relative to the field. The default is flexLeft, if the label is set, or none, if the label isn't set. Set to 'skip' to avoid surrounding label container. Hint for tc:out: set also compact=true to render only text (without html tags).
- 
setLabelLayout
- 
getMessagePositionDefines the position and the appearance of additional faces messages (like error message or help message) on a component. The default is popoverRight.
- 
setMessagePosition
- 
isFocuspublic boolean isFocus()Flag indicating this component should receive the focus.
 Default:false- Specified by:
- isFocusin class- AbstractUISelectBoolean
 
- 
setFocuspublic void setFocus(boolean focus) 
- 
getTabIndexControls the navigation of the focus through the input controls on a page with the Tab-Key. The navigation starts from the element with the lowest tabIndex value to the element with the highest value. Elements that have identical tabIndex values should be navigated in the order they appear in the character stream Elements that are disabled or with a negative tabIndex do not participate in the tabbing order.- Specified by:
- getTabIndexin class- AbstractUISelectBoolean
 
- 
setTabIndex
- 
getLabelA localized user presentable label for this component.- Specified by:
- getLabelin interface- SupportsAccessKey
- Specified by:
- getLabelin class- AbstractUISelectBoolean
 
- 
setLabel
- 
getItemLabelLabel to be displayed to the user for this option.- Specified by:
- getItemLabelin class- AbstractUISelectBoolean
 
- 
setItemLabel- Specified by:
- setItemLabelin class- AbstractUISelectBoolean
 
- 
getItemImageImage to be displayed to the user for this option.- Specified by:
- getItemImagein class- AbstractUISelectBoolean
 
- 
setItemImage
- 
getHelpText value to display as a help.
- 
setHelp
- 
getAutoSpacingAutomatically add spacing (margins/paddings) to the component for better positioning. Default is 'true' except the component is inside a: - header - footer - bar - sheet - tree - link group - button group - before facet - after facet - label facet - bar facet
- 
setAutoSpacing
- 
isReadonlypublic boolean isReadonly()Flag indicating that this component will prohibit changes by the user.
 Default:false- Specified by:
- isReadonlyin class- AbstractUISelectBoolean
 
- 
setReadonlypublic void setReadonly(boolean readonly) 
- 
getHelpPositionDefines the position and the appearance of a help message on a component. The default is popoverRight.
- 
setHelpPosition
- 
getAccessKeyThe access key of this control.
- 
setAccessKey
- 
getCustomClassSets a CSS class in its parent, if the parent supports it. Which this feature it is possible to put a CSS class name into a component with the <tc:style> tag. Example:<tc:in> <tc:style customClass="my-emphasized"/> </tc:in>One capability is, to used external CSS libs.
 This feature should not be used imprudent. Because it might be unstable against changes in the renderered HTML code.
- 
setCustomClass
- 
isDisabledpublic boolean isDisabled()Flag indicating that this element is disabled.
 Default:false- Specified by:
- isDisabledin class- AbstractUISelectBoolean
 
- 
setDisabledpublic void setDisabled(boolean disabled) 
- 
getTipText value to display as tooltip.
- 
setTip
- 
restoreState- Specified by:
- restoreStatein interface- jakarta.faces.component.StateHolder
- Overrides:
- restoreStatein class- jakarta.faces.component.UIInput
 
 
-