Class UISelectBooleanToggle
java.lang.Object
javax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UIOutput
javax.faces.component.UIInput
javax.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:
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
,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 Summary
FieldsFields inherited from class javax.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 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
-
Constructor Summary
Constructors -
Method Summary
Modifier 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.boolean
Flag indicating that this element is disabled.boolean
isFocus()
Flag indicating this component should receive the focus.boolean
Flag indicating that this component will prohibit changes by the user.void
restoreState
(javax.faces.context.FacesContext context, Object state) void
setAccessKey
(Character accessKey) void
setAutoSpacing
(Boolean autoSpacing) void
setCustomClass
(CustomClass customClass) void
setDisabled
(boolean disabled) void
setFocus
(boolean focus) void
void
setHelpPosition
(DecorationPosition helpPosition) void
setItemImage
(String itemImage) void
setItemLabel
(String itemLabel) void
void
setLabelLayout
(LabelLayout labelLayout) void
void
setMessagePosition
(DecorationPosition messagePosition) void
setReadonly
(boolean readonly) void
setTabIndex
(Integer tabIndex) void
Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUISelectBoolean
getFieldId, isError, isLabelLayoutSkip, isNextToRenderIsLabel, isSelected, setNextToRenderIsLabel, validateValue
Methods inherited from class javax.faces.component.UISelectBoolean
getValue, getValueBinding, getValueExpression, setSelected, setValueBinding, setValueExpression
Methods inherited from class javax.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, saveState, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidator, setValidatorMessage, setValue, setValueChangeListener, updateModel, validate
Methods inherited from class javax.faces.component.UIOutput
getConverter, getLocalValue, setConverter
Methods inherited from class javax.faces.component.UIComponentBase
addClientBehavior, 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, visitTree
Methods inherited from class javax.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 javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviors
Methods inherited from interface org.apache.myfaces.tobago.component.SupportsAutoSpacing
getAutoSpacing
Methods inherited from interface javax.faces.component.ValueHolder
getConverter, getLocalValue, setConverter
Methods inherited from interface org.apache.myfaces.tobago.component.Visual
getRendererType, isPlain
-
Field Details
-
COMPONENT_TYPE
-
COMPONENT_FAMILY
- See Also:
-
-
Constructor Details
-
UISelectBooleanToggle
public UISelectBooleanToggle()
-
-
Method Details
-
getEventNames
- Specified by:
getEventNames
in interfacejavax.faces.component.behavior.ClientBehaviorHolder
- Overrides:
getEventNames
in classjavax.faces.component.UIComponentBase
-
getDefaultEventName
- Specified by:
getDefaultEventName
in interfacejavax.faces.component.behavior.ClientBehaviorHolder
- Overrides:
getDefaultEventName
in classjavax.faces.component.UIComponentBase
-
getFamily
- Overrides:
getFamily
in classjavax.faces.component.UISelectBoolean
-
getMarkup
-
setMarkup
-
getLabelLayout
Defines 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
-
getMessagePosition
Defines the position and the appearance of additional faces messages (like error message or help message) on a component. The default is popoverRight. -
setMessagePosition
-
isFocus
public boolean isFocus()Flag indicating this component should receive the focus.
Default:false
- Specified by:
isFocus
in classAbstractUISelectBoolean
-
setFocus
public void setFocus(boolean focus) -
getTabIndex
Controls 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:
getTabIndex
in classAbstractUISelectBoolean
-
setTabIndex
-
getLabel
A localized user presentable label for this component.- Specified by:
getLabel
in interfaceSupportsAccessKey
- Specified by:
getLabel
in classAbstractUISelectBoolean
-
setLabel
-
getItemLabel
Label to be displayed to the user for this option.- Specified by:
getItemLabel
in classAbstractUISelectBoolean
-
setItemLabel
- Specified by:
setItemLabel
in classAbstractUISelectBoolean
-
getItemImage
Image to be displayed to the user for this option.- Specified by:
getItemImage
in classAbstractUISelectBoolean
-
setItemImage
-
getHelp
Text value to display as a help. -
setHelp
-
getAutoSpacing
Automatically 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
-
isReadonly
public boolean isReadonly()Flag indicating that this component will prohibit changes by the user.
Default:false
- Specified by:
isReadonly
in classAbstractUISelectBoolean
-
setReadonly
public void setReadonly(boolean readonly) -
getHelpPosition
Defines the position and the appearance of a help message on a component. The default is popoverRight. -
setHelpPosition
-
getAccessKey
The access key of this control. -
setAccessKey
-
getCustomClass
Sets 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
-
isDisabled
public boolean isDisabled()Flag indicating that this element is disabled.
Default:false
- Specified by:
isDisabled
in classAbstractUISelectBoolean
-
setDisabled
public void setDisabled(boolean disabled) -
getTip
Text value to display as tooltip. -
setTip
-
restoreState
- Specified by:
restoreState
in interfacejavax.faces.component.StateHolder
- Overrides:
restoreState
in classjavax.faces.component.UIInput
-