public class CoreSelectBooleanCheckbox extends UIXSelectBoolean implements javax.faces.component.behavior.ClientBehaviorHolder
The selectBooleanCheckbox component maps to a standard browser input checkbox, which toggles between selected and unselected states. It supports displaying a prompt, text, and messages. The text contained by the selectBooleanCheckbox control will be displayed as the checkbox label.
Type | Phases | Description |
---|---|---|
javax.faces.event.ValueChangeEvent |
Process Validations Apply Request Values |
The valueChange event is delivered when the value attribute is changed. |
org.apache.myfaces.trinidad.event.AttributeChangeEvent |
Invoke Application Apply Request Values |
Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change event might include the width of a column that supported client-side resizing. |
UIXComponentBase.ComponentSystemEventListenerWrapper
SELECTED_KEY
CONVERSION_MESSAGE_ID, IMMEDIATE_KEY, LOCAL_VALUE_SET_KEY, REQUIRED_KEY, REQUIRED_MESSAGE_DETAIL_KEY, REQUIRED_MESSAGE_ID, SUBMITTED_VALUE_KEY, TRINIDAD_BEAN_VALIDATION_AVAILABLE, TRINIDAD_EMPTY_VALUES_AS_NULL_PARAM_NAME, VALID_KEY, VALIDATE_EMPTY_FIELDS_PARAM_NAME, VALIDATOR_KEY, VALIDATORS_KEY, VALUE_CHANGE_LISTENER_KEY
CONVERTER_KEY, VALUE_KEY
BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY
Modifier | Constructor and Description |
---|---|
|
CoreSelectBooleanCheckbox()
Construct an instance of the CoreSelectBooleanCheckbox.
|
protected |
CoreSelectBooleanCheckbox(String rendererType)
Construct an instance of the CoreSelectBooleanCheckbox.
|
Modifier and Type | Method and Description |
---|---|
void |
addClientBehavior(String eventName,
javax.faces.component.behavior.ClientBehavior behavior)
Utility method to assist sub-classes in the implementation of the
ClientBehaviorHolder interface. |
char |
getAccessKey()
Gets
Character used to gain quick access to this checkbox.
|
protected FacesBean.Type |
getBeanType() |
Map<String,List<javax.faces.component.behavior.ClientBehavior>> |
getClientBehaviors()
Utility method to assist sub-classes in the implementation of the
ClientBehaviorHolder interface. |
String |
getContentStyle()
Gets the CSS styles to attach to the content of the component.
|
String |
getDefaultEventName()
Utility method to assist sub-classes in the implementation of the
ClientBehaviorHolder interface. |
Collection<String> |
getEventNames() |
String |
getFamily() |
javax.faces.component.UIComponent |
getHelp()
This facet should contain field level help.
|
String |
getInlineStyle()
Gets the CSS styles to use for this component.
|
String |
getLabel()
Gets the label of the bean.
|
String |
getOnblur()
Gets the event handler for the component losing the focus.
|
String |
getOnchange()
Gets event handler for when the value is changed.
|
String |
getOnclick()
Gets an onclick Javascript handler.
|
String |
getOndblclick()
Gets an ondblclick Javascript handler.
|
String |
getOnfocus()
Gets the event handler for the component gaining the focus.
|
String |
getOnkeydown()
Gets an onkeydown Javascript handler.
|
String |
getOnkeypress()
Gets an onkeypress Javascript handler.
|
String |
getOnkeyup()
Gets an onkeyup Javascript handler.
|
String |
getOnmousedown()
Gets an onmousedown Javascript handler.
|
String |
getOnmousemove()
Gets an onmousemove Javascript handler.
|
String |
getOnmouseout()
Gets an onmouseout Javascript handler.
|
String |
getOnmouseover()
Gets an onmouseover Javascript handler.
|
String |
getOnmouseup()
Gets an onmouseup Javascript handler.
|
String[] |
getPartialTriggers()
Gets the IDs of the components that should trigger a partial update.
|
String |
getShortDesc()
Gets The short description of the component.
|
String |
getStyleClass()
Gets a CSS style class to use for this component.
|
String |
getText()
Gets the text value of the checkbox.
|
boolean |
isAutoSubmit()
Gets If set to TRUE on a form element, the component will automatically submit
the enclosing form when an appropriate action takes place (a click, text
change, etc.).
|
boolean |
isDisabled()
Gets whether the element is disabled.
|
boolean |
isReadOnly()
Gets whether the element is read-only.
|
boolean |
isShowRequired()
Gets whether the associated control displays a visual indication of required user input.
|
boolean |
isSimple()
Gets a boolean value that controls whether the component
provides label and message support; when set to "true", the component will
not display messaging support or the label (these attributes may be ignored: label,
labelAndAccessKey, accessKey, showRequired,
tip), and may use simpler layout primitives
|
void |
setAccessKey(char accessKey)
Sets
Character used to gain quick access to this checkbox.
|
void |
setAutoSubmit(boolean autoSubmit)
Sets If set to TRUE on a form element, the component will automatically submit
the enclosing form when an appropriate action takes place (a click, text
change, etc.).
|
void |
setContentStyle(String contentStyle)
Sets the CSS styles to attach to the content of the component.
|
void |
setDisabled(boolean disabled)
Sets whether the element is disabled.
|
void |
setHelp(javax.faces.component.UIComponent helpFacet)
This facet should contain field level help.
|
void |
setInlineStyle(String inlineStyle)
Sets the CSS styles to use for this component.
|
void |
setLabel(String label)
Sets the label of the bean.
|
void |
setOnblur(String onblur)
Sets the event handler for the component losing the focus.
|
void |
setOnchange(String onchange)
Sets event handler for when the value is changed.
|
void |
setOnclick(String onclick)
Sets an onclick Javascript handler.
|
void |
setOndblclick(String ondblclick)
Sets an ondblclick Javascript handler.
|
void |
setOnfocus(String onfocus)
Sets the event handler for the component gaining the focus.
|
void |
setOnkeydown(String onkeydown)
Sets an onkeydown Javascript handler.
|
void |
setOnkeypress(String onkeypress)
Sets an onkeypress Javascript handler.
|
void |
setOnkeyup(String onkeyup)
Sets an onkeyup Javascript handler.
|
void |
setOnmousedown(String onmousedown)
Sets an onmousedown Javascript handler.
|
void |
setOnmousemove(String onmousemove)
Sets an onmousemove Javascript handler.
|
void |
setOnmouseout(String onmouseout)
Sets an onmouseout Javascript handler.
|
void |
setOnmouseover(String onmouseover)
Sets an onmouseover Javascript handler.
|
void |
setOnmouseup(String onmouseup)
Sets an onmouseup Javascript handler.
|
void |
setPartialTriggers(String[] partialTriggers)
Sets the IDs of the components that should trigger a partial update.
|
void |
setReadOnly(boolean readOnly)
Sets whether the element is read-only.
|
void |
setShortDesc(String shortDesc)
Sets The short description of the component.
|
void |
setShowRequired(boolean showRequired)
Sets whether the associated control displays a visual indication of required user input.
|
void |
setSimple(boolean simple)
Sets a boolean value that controls whether the component
provides label and message support; when set to "true", the component will
not display messaging support or the label (these attributes may be ignored: label,
labelAndAccessKey, accessKey, showRequired,
tip), and may use simpler layout primitives
|
void |
setStyleClass(String styleClass)
Sets a CSS style class to use for this component.
|
void |
setText(String text)
Sets the text value of the checkbox.
|
isSelected, setSelected
addValidator, addValueChangeListener, addValueUpdatedListener, broadcast, compareValues, getConvertedValue, getRequiredMessageDetail, getRequiredMessageKey, getSubmittedValue, getValidator, getValidators, getValueChangeListener, getValueChangeListeners, isEmpty, isImmediate, isLocalValueSet, isRequired, isValid, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, removeValueUpdatedListener, resetValue, setImmediate, setLocalValueSet, setRequired, setRequiredMessageDetail, setSubmittedValue, setValid, setValidator, setValueChangeListener, shouldInterpretEmptyStringSubmittedValuesAsNull, shouldValidateEmptyFields, updateModel, validate, validateValue
getConverter, getLocalValue, getValue, setConverter, setValue
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, clearCachedClientIds, clearInitialState, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getComponentChangeFilters, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getListenersForEventClass, getParent, getPassThroughAttributes, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, initialStateMarked, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, queueEvent, removeAttributeChangeListener, removeComponentChangeFilter, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setupFlattenedChildrenContext, setupFlattenedContext, setValueBinding, setValueExpression, subscribeToEvent, tearDownFlattenedChildrenContext, tearDownFlattenedContext, toString, unsubscribeFromEvent, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl
addPartialTarget, broadcastInContext, clearCachedClientIds, defaultGetRenderedFacetsAndChildren, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, getStateHelper, getStateHelper, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setupChildrenEncodingContext, setupChildrenVisitingContext, setupEncodingContext, setUpEncodingContext, setupVisitingContext, tearDownChildrenEncodingContext, tearDownChildrenVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitAllChildren, visitChildren, visitChildren, visitTree, visitTree
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getTransientStateHelper, getTransientStateHelper, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView
public static final FacesBean.Type TYPE
public static final PropertyKey CONTENT_STYLE_KEY
public static final PropertyKey AUTO_SUBMIT_KEY
public static final PropertyKey READ_ONLY_KEY
public static final PropertyKey DISABLED_KEY
public static final PropertyKey LABEL_KEY
public static final PropertyKey SIMPLE_KEY
public static final PropertyKey TEXT_KEY
public static final PropertyKey ACCESS_KEY_KEY
public static final PropertyKey ONCHANGE_KEY
public static final PropertyKey INLINE_STYLE_KEY
public static final PropertyKey STYLE_CLASS_KEY
public static final PropertyKey SHORT_DESC_KEY
public static final PropertyKey PARTIAL_TRIGGERS_KEY
public static final PropertyKey ONCLICK_KEY
public static final PropertyKey ONDBLCLICK_KEY
public static final PropertyKey ONMOUSEDOWN_KEY
public static final PropertyKey ONMOUSEUP_KEY
public static final PropertyKey ONMOUSEOVER_KEY
public static final PropertyKey ONMOUSEMOVE_KEY
public static final PropertyKey ONMOUSEOUT_KEY
public static final PropertyKey ONKEYPRESS_KEY
public static final PropertyKey ONKEYDOWN_KEY
public static final PropertyKey ONKEYUP_KEY
public static final PropertyKey ONBLUR_KEY
public static final PropertyKey ONFOCUS_KEY
public static final PropertyKey SHOW_REQUIRED_KEY
public static final String HELP_FACET
public static final String COMPONENT_FAMILY
public static final String COMPONENT_TYPE
public CoreSelectBooleanCheckbox()
protected CoreSelectBooleanCheckbox(String rendererType)
public final javax.faces.component.UIComponent getHelp()
public final void setHelp(javax.faces.component.UIComponent helpFacet)
public final String getContentStyle()
public final void setContentStyle(String contentStyle)
contentStyle
- the new contentStyle valuepublic final boolean isAutoSubmit()
public final void setAutoSubmit(boolean autoSubmit)
autoSubmit
- the new autoSubmit valuepublic final boolean isReadOnly()
public final void setReadOnly(boolean readOnly)
readOnly
- the new readOnly valuepublic final boolean isDisabled()
public final void setDisabled(boolean disabled)
disabled
- the new disabled valuepublic final String getLabel()
public final void setLabel(String label)
label
- the new label valuepublic final boolean isSimple()
public final void setSimple(boolean simple)
simple
- the new simple valuepublic final String getText()
public final void setText(String text)
text
- the new text valuepublic final char getAccessKey()
If the same access key appears in multiple locations in the same page of output, the rendering user agent will cycle among the elements accessed by the similar keys.
This attribute is sometimes referred to as the "mnemonic".
The character specified by this attribute
mustexist in the
text
attribute of this selectBooleanCheckbox instance.
If it does not, the user will receive no visual indication of
the existence of the accessKey.
public final void setAccessKey(char accessKey)
If the same access key appears in multiple locations in the same page of output, the rendering user agent will cycle among the elements accessed by the similar keys.
This attribute is sometimes referred to as the "mnemonic".
The character specified by this attribute
mustexist in the
text
attribute of this selectBooleanCheckbox instance.
If it does not, the user will receive no visual indication of
the existence of the accessKey.
accessKey
- the new accessKey valuepublic final String getOnchange()
public final void setOnchange(String onchange)
onchange
- the new onchange valuepublic final String getInlineStyle()
public final void setInlineStyle(String inlineStyle)
inlineStyle
- the new inlineStyle valuepublic final String getStyleClass()
public final void setStyleClass(String styleClass)
styleClass
- the new styleClass valuepublic final String getShortDesc()
public final void setShortDesc(String shortDesc)
shortDesc
- the new shortDesc valuepublic final String[] getPartialTriggers()
This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too.
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root, or use multiple colons to move up through the NamingContainer. For example, "::" will pop out of this component's naming container (it pops out of itself if it is a naming container), ":::" will pop out of two naming containers, etc. The search for the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the component with id = commandButton1 after popping out of two naming containers relative to this component. To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".
public final void setPartialTriggers(String[] partialTriggers)
This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too.
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root, or use multiple colons to move up through the NamingContainer. For example, "::" will pop out of this component's naming container (it pops out of itself if it is a naming container), ":::" will pop out of two naming containers, etc. The search for the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the component with id = commandButton1 after popping out of two naming containers relative to this component. To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".
partialTriggers
- the new partialTriggers valuepublic final String getOnclick()
public final void setOnclick(String onclick)
onclick
- the new onclick valuepublic final String getOndblclick()
public final void setOndblclick(String ondblclick)
ondblclick
- the new ondblclick valuepublic final String getOnmousedown()
public final void setOnmousedown(String onmousedown)
onmousedown
- the new onmousedown valuepublic final String getOnmouseup()
public final void setOnmouseup(String onmouseup)
onmouseup
- the new onmouseup valuepublic final String getOnmouseover()
public final void setOnmouseover(String onmouseover)
onmouseover
- the new onmouseover valuepublic final String getOnmousemove()
public final void setOnmousemove(String onmousemove)
onmousemove
- the new onmousemove valuepublic final String getOnmouseout()
public final void setOnmouseout(String onmouseout)
onmouseout
- the new onmouseout valuepublic final String getOnkeypress()
public final void setOnkeypress(String onkeypress)
onkeypress
- the new onkeypress valuepublic final String getOnkeydown()
public final void setOnkeydown(String onkeydown)
onkeydown
- the new onkeydown valuepublic final String getOnkeyup()
public final void setOnkeyup(String onkeyup)
onkeyup
- the new onkeyup valuepublic final String getOnblur()
public final void setOnblur(String onblur)
onblur
- the new onblur valuepublic final String getOnfocus()
public final void setOnfocus(String onfocus)
onfocus
- the new onfocus valuepublic final boolean isShowRequired()
public final void setShowRequired(boolean showRequired)
showRequired
- the new showRequired valuepublic String getDefaultEventName()
UIXComponentBase
ClientBehaviorHolder
interface.
This method must only be called by classes that implement the interface, doing otherwise will result in an exception.
getDefaultEventName
in interface javax.faces.component.behavior.ClientBehaviorHolder
getDefaultEventName
in class UIXComponentBase
ClientBehaviorHolder.getDefaultEventName()
public Collection<String> getEventNames()
getEventNames
in interface javax.faces.component.behavior.ClientBehaviorHolder
public Map<String,List<javax.faces.component.behavior.ClientBehavior>> getClientBehaviors()
UIXComponentBase
ClientBehaviorHolder
interface.
This method must only be called by classes that implement the interface, doing otherwise will result in an exception.
getClientBehaviors
in interface javax.faces.component.behavior.ClientBehaviorHolder
getClientBehaviors
in class UIXComponentBase
ClientBehaviorHolder.getClientBehaviors()
public void addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior)
UIXComponentBase
ClientBehaviorHolder
interface.
This method must only be called by classes that implement the interface, doing otherwise will result in an exception.
addClientBehavior
in interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior
in class UIXComponentBase
eventName
- The event namebehavior
- The behavior to addClientBehaviorHolder.addClientBehavior(String, ClientBehavior)
public String getFamily()
getFamily
in class UIXSelectBoolean
protected FacesBean.Type getBeanType()
getBeanType
in class UIXSelectBoolean
Copyright © 2001-2017 The Apache Software Foundation. All Rights Reserved.