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.ValueHolder,javax.faces.event.ComponentSystemEventListener,javax.faces.event.FacesListener,javax.faces.event.SystemEventListenerHolder,SupportFieldId,SupportsAccessKey,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
CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID, VALIDATE_EMPTY_FIELDS_PARAM_NAMEFields inherited from class javax.faces.component.UIComponent
BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionThe access key of this control.Sets a CSS class in its parent, if the parent supports it.getHelp()Text value to display as a help.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.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(javax.faces.context.FacesContext context, Object state) voidsetAccessKey(Character accessKey) voidsetCustomClass(CustomClass customClass) voidsetDisabled(boolean disabled) voidsetFocus(boolean focus) voidvoidsetItemLabel(String itemLabel) voidvoidsetLabelLayout(LabelLayout labelLayout) voidvoidsetReadonly(boolean readonly) voidsetTabIndex(Integer tabIndex) voidMethods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUISelectBoolean
getFieldId, isLabelLayoutSkip, isSelected, validateValueMethods inherited from class javax.faces.component.UISelectBoolean
getValue, getValueBinding, getValueExpression, setSelected, setValueBinding, setValueExpressionMethods 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, validateMethods inherited from class javax.faces.component.UIOutput
getConverter, getLocalValue, setConverterMethods 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, getRenderer, getRendererType, getRendersChildren, initialStateMarked, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, visitTreeMethods inherited from class javax.faces.component.UIComponent
getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, subscribeToEvent, unsubscribeFromEventMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviorsMethods inherited from interface javax.faces.component.ValueHolder
getConverter, getLocalValue, setConverterMethods 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:
getEventNamesin interfacejavax.faces.component.behavior.ClientBehaviorHolder- Overrides:
getEventNamesin classjavax.faces.component.UIComponentBase
-
getDefaultEventName
- Specified by:
getDefaultEventNamein interfacejavax.faces.component.behavior.ClientBehaviorHolder- Overrides:
getDefaultEventNamein classjavax.faces.component.UIComponentBase
-
getFamily
- Overrides:
getFamilyin 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
-
isFocus
public boolean isFocus()Flag indicating this component should receive the focus.
Default:false- Specified by:
isFocusin 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:
getTabIndexin classAbstractUISelectBoolean
-
setTabIndex
-
getLabel
A localized user presentable label for this component.- Specified by:
getLabelin interfaceSupportsAccessKey- Specified by:
getLabelin classAbstractUISelectBoolean
-
setLabel
-
getItemLabel
Label to be displayed to the user for this option.- Specified by:
getItemLabelin classAbstractUISelectBoolean
-
setItemLabel
- Specified by:
setItemLabelin classAbstractUISelectBoolean
-
getHelp
Text value to display as a help. -
setHelp
-
isReadonly
public boolean isReadonly()Flag indicating that this component will prohibit changes by the user.
Default:false- Specified by:
isReadonlyin classAbstractUISelectBoolean
-
setReadonly
public void setReadonly(boolean readonly) -
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:
isDisabledin classAbstractUISelectBoolean
-
setDisabled
public void setDisabled(boolean disabled) -
getTip
Text value to display as tooltip. -
setTip
-
restoreState
- Specified by:
restoreStatein interfacejavax.faces.component.StateHolder- Overrides:
restoreStatein classjavax.faces.component.UIInput
-