oracle.adf.view.faces.component.core.input
Class CoreSelectBooleanCheckbox

java.lang.Object
  javax.faces.component.UIComponent
      oracle.adf.view.faces.component.UIXComponent
          oracle.adf.view.faces.component.UIXComponentBase
              oracle.adf.view.faces.component.UIXValue
                  oracle.adf.view.faces.component.UIXEditableValue
                      oracle.adf.view.faces.component.UIXSelectBoolean
                          oracle.adf.view.faces.component.core.input.CoreSelectBooleanCheckbox

All Implemented Interfaces:

EditableValueHolder, StateHolder, ValueHolder

public class CoreSelectBooleanCheckbox

extends UIXSelectBoolean

The selectBooleanCheckbox control 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.

Example:

This example renders a checkbox with the text "checkbox2" and a label of "Label:" which can be toggled using the accessKey '2'.

    <af:selectBooleanCheckbox
              label="Label:"
              textAndAccessKey="checkbox&amp;2"
              accessKey="2"/>

Events:

Type	Phases	Description
javax.faces.event.ValueChangeEvent	Process Validations Apply Request Values	Event delivered when a new value is entered by a user.

It does not support any children.

Field Summary

static PropertyKey	ACCESS_KEY_KEY
static PropertyKey	AUTO_SUBMIT_KEY
static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static PropertyKey	DISABLED_KEY
static PropertyKey	INLINE_STYLE_KEY
static PropertyKey	LABEL_KEY
static PropertyKey	MESSAGE_DESC_URL_KEY
static PropertyKey	MESSAGE_TARGET_FRAME_KEY
static PropertyKey	ONBLUR_KEY
static PropertyKey	ONCHANGE_KEY
static PropertyKey	ONCLICK_KEY
static PropertyKey	ONDBLCLICK_KEY
static PropertyKey	ONFOCUS_KEY
static PropertyKey	ONKEYDOWN_KEY
static PropertyKey	ONKEYPRESS_KEY
static PropertyKey	ONKEYUP_KEY
static PropertyKey	ONMOUSEDOWN_KEY
static PropertyKey	ONMOUSEMOVE_KEY
static PropertyKey	ONMOUSEOUT_KEY
static PropertyKey	ONMOUSEOVER_KEY
static PropertyKey	ONMOUSEUP_KEY
static PropertyKey	PARTIAL_TRIGGERS_KEY
static PropertyKey	READ_ONLY_KEY
static PropertyKey	SHORT_DESC_KEY
static PropertyKey	SHOW_REQUIRED_KEY
static PropertyKey	SIMPLE_KEY
static PropertyKey	STYLE_CLASS_KEY
static PropertyKey	TEXT_KEY
static PropertyKey	TIP_KEY
static FacesBean.Type	TYPE
static java.lang.String	VALIGN_BOTTOM Enumerated value indicating that the valign value is bottom.
static PropertyKey	VALIGN_KEY
static java.lang.String	VALIGN_MIDDLE Enumerated value indicating that the valign value is middle.
static java.lang.String	VALIGN_TOP Enumerated value indicating that the valign value is top.

Fields inherited from class oracle.adf.view.faces.component.UIXSelectBoolean

SELECTED_KEY

Fields inherited from class oracle.adf.view.faces.component.UIXEditableValue

CONVERSION_MESSAGE_ID, IMMEDIATE_KEY, LOCAL_VALUE_SET_KEY, REQUIRED_KEY, REQUIRED_MESSAGE_DETAIL_KEY, REQUIRED_MESSAGE_ID, SUBMITTED_VALUE_KEY, VALID_KEY, VALIDATOR_KEY, VALIDATORS_KEY, VALUE_CHANGE_LISTENER_KEY

Fields inherited from class oracle.adf.view.faces.component.UIXValue

CONVERTER_KEY, VALUE_KEY

Fields inherited from class oracle.adf.view.faces.component.UIXComponentBase

BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

Constructor Summary

	CoreSelectBooleanCheckbox() Construct an instance of the CoreSelectBooleanCheckbox.
protected	CoreSelectBooleanCheckbox(java.lang.String rendererType) Construct an instance of the CoreSelectBooleanCheckbox.

Method Summary

char	getAccessKey() Gets Character used to gain quick access to this checkbox.
protected FacesBean.Type	getBeanType()
java.lang.String	getFamily()
java.lang.String	getInlineStyle() Gets the inline CSS style for this element
java.lang.String	getLabel() Gets the label of the bean.
java.lang.String	getMessageDescUrl() Gets an URL to a page with more information about the message.
java.lang.String	getMessageTargetFrame() Gets the target frame for the message description URL, if any.
java.lang.String	getOnblur() Gets the event handler for when the element loses focus.
java.lang.String	getOnchange() Gets event handler for when the value is changed.
java.lang.String	getOnclick() Gets an onclick Javascript handler.
java.lang.String	getOndblclick() Gets an ondblclick Javascript handler.
java.lang.String	getOnfocus() Gets the event handler for when the element receives focus.
java.lang.String	getOnkeydown() Gets an onkeydown Javascript handler.
java.lang.String	getOnkeypress() Gets an onkeypress Javascript handler.
java.lang.String	getOnkeyup() Gets an onkeyup Javascript handler.
java.lang.String	getOnmousedown() Gets an onmousedown Javascript handler.
java.lang.String	getOnmousemove() Gets an onmousemove Javascript handler.
java.lang.String	getOnmouseout() Gets an onmouseout Javascript handler.
java.lang.String	getOnmouseover() Gets an onmouseover Javascript handler.
java.lang.String	getOnmouseup() Gets an onmouseup Javascript handler.
java.lang.String[]	getPartialTriggers() Gets the IDs of the components that should trigger a partial update.
java.lang.String	getShortDesc() Gets the short description of the bean.
java.lang.String	getStyleClass() Gets the CSS style class of the bean.
java.lang.String	getText() Gets the text value of the checkbox.
java.lang.String	getTip() Gets the tip text associated with the control
java.lang.String	getValign() Gets the vertical alignment of the label and other contents.
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, messageDescUrl messageTargetFrame, 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	setDisabled(boolean disabled) Sets whether the element is disabled.
void	setInlineStyle(java.lang.String inlineStyle) Sets the inline CSS style for this element
void	setLabel(java.lang.String label) Sets the label of the bean.
void	setMessageDescUrl(java.lang.String messageDescUrl) Sets an URL to a page with more information about the message.
void	setMessageTargetFrame(java.lang.String messageTargetFrame) Sets the target frame for the message description URL, if any.
void	setOnblur(java.lang.String onblur) Sets the event handler for when the element loses focus.
void	setOnchange(java.lang.String onchange) Sets event handler for when the value is changed.
void	setOnclick(java.lang.String onclick) Sets an onclick Javascript handler.
void	setOndblclick(java.lang.String ondblclick) Sets an ondblclick Javascript handler.
void	setOnfocus(java.lang.String onfocus) Sets the event handler for when the element receives focus.
void	setOnkeydown(java.lang.String onkeydown) Sets an onkeydown Javascript handler.
void	setOnkeypress(java.lang.String onkeypress) Sets an onkeypress Javascript handler.
void	setOnkeyup(java.lang.String onkeyup) Sets an onkeyup Javascript handler.
void	setOnmousedown(java.lang.String onmousedown) Sets an onmousedown Javascript handler.
void	setOnmousemove(java.lang.String onmousemove) Sets an onmousemove Javascript handler.
void	setOnmouseout(java.lang.String onmouseout) Sets an onmouseout Javascript handler.
void	setOnmouseover(java.lang.String onmouseover) Sets an onmouseover Javascript handler.
void	setOnmouseup(java.lang.String onmouseup) Sets an onmouseup Javascript handler.
void	setPartialTriggers(java.lang.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(java.lang.String shortDesc) Sets the short description of the bean.
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, messageDescUrl messageTargetFrame, showRequired, tip), and may use simpler layout primitives
void	setStyleClass(java.lang.String styleClass) Sets the CSS style class of the bean.
void	setText(java.lang.String text) Sets the text value of the checkbox.
void	setTip(java.lang.String tip) Sets the tip text associated with the control
void	setValign(java.lang.String valign) Sets the vertical alignment of the label and other contents.

Methods inherited from class oracle.adf.view.faces.component.UIXSelectBoolean

isSelected, setSelected

Methods inherited from class oracle.adf.view.faces.component.UIXEditableValue

addValidator, addValueChangeListener, broadcast, compareValues, getConvertedValue, getRequiredMessageDetail, getRequiredMessageKey, getSubmittedValue, getValidator, getValidators, getValueChangeListener, getValueChangeListeners, isEmpty, isImmediate, isLocalValueSet, isRequired, isValid, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, resetValue, setImmediate, setLocalValueSet, setRequired, setRequiredMessageDetail, setSubmittedValue, setValid, setValidator, setValueChangeListener, updateModel, validate, validateValue

Methods inherited from class oracle.adf.view.faces.component.UIXValue

getConverter, getLocalValue, getValue, setConverter, setValue

Methods inherited from class oracle.adf.view.faces.component.UIXComponentBase

addAttributeChange, addAttributeChange, addAttributeChangeListener, addFacesListener, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getLocalClientId, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeAttributeChangeListener, removeFacesListener, restoreState, saveState, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, toString, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.faces.component.ValueHolder

getConverter, getLocalValue, getValue, setConverter, setValue

Field Detail

VALIGN_MIDDLE

public static final java.lang.String VALIGN_MIDDLE

Enumerated value indicating that the valign value is middle.

See Also:

Constant Field Values

VALIGN_TOP

public static final java.lang.String VALIGN_TOP

Enumerated value indicating that the valign value is top.

See Also:

Constant Field Values

VALIGN_BOTTOM

public static final java.lang.String VALIGN_BOTTOM

Enumerated value indicating that the valign value is bottom.

See Also:

Constant Field Values

TYPE

public static final FacesBean.Type TYPE

AUTO_SUBMIT_KEY

public static final PropertyKey AUTO_SUBMIT_KEY

READ_ONLY_KEY

public static final PropertyKey READ_ONLY_KEY

DISABLED_KEY

public static final PropertyKey DISABLED_KEY

SHORT_DESC_KEY

public static final PropertyKey SHORT_DESC_KEY

PARTIAL_TRIGGERS_KEY

public static final PropertyKey PARTIAL_TRIGGERS_KEY

LABEL_KEY

public static final PropertyKey LABEL_KEY

TIP_KEY

public static final PropertyKey TIP_KEY

SIMPLE_KEY

public static final PropertyKey SIMPLE_KEY

TEXT_KEY

public static final PropertyKey TEXT_KEY

ACCESS_KEY_KEY

public static final PropertyKey ACCESS_KEY_KEY

ONFOCUS_KEY

public static final PropertyKey ONFOCUS_KEY

ONBLUR_KEY

public static final PropertyKey ONBLUR_KEY

ONCHANGE_KEY

public static final PropertyKey ONCHANGE_KEY

ONCLICK_KEY

public static final PropertyKey ONCLICK_KEY

ONDBLCLICK_KEY

public static final PropertyKey ONDBLCLICK_KEY

ONMOUSEDOWN_KEY

public static final PropertyKey ONMOUSEDOWN_KEY

ONMOUSEUP_KEY

public static final PropertyKey ONMOUSEUP_KEY

ONMOUSEOVER_KEY

public static final PropertyKey ONMOUSEOVER_KEY

ONMOUSEMOVE_KEY

public static final PropertyKey ONMOUSEMOVE_KEY

ONMOUSEOUT_KEY

public static final PropertyKey ONMOUSEOUT_KEY

ONKEYPRESS_KEY

public static final PropertyKey ONKEYPRESS_KEY

ONKEYDOWN_KEY

public static final PropertyKey ONKEYDOWN_KEY

ONKEYUP_KEY

public static final PropertyKey ONKEYUP_KEY

STYLE_CLASS_KEY

public static final PropertyKey STYLE_CLASS_KEY

INLINE_STYLE_KEY

public static final PropertyKey INLINE_STYLE_KEY

SHOW_REQUIRED_KEY

public static final PropertyKey SHOW_REQUIRED_KEY

VALIGN_KEY

public static final PropertyKey VALIGN_KEY

MESSAGE_DESC_URL_KEY

public static final PropertyKey MESSAGE_DESC_URL_KEY

MESSAGE_TARGET_FRAME_KEY

public static final PropertyKey MESSAGE_TARGET_FRAME_KEY

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

CoreSelectBooleanCheckbox

public CoreSelectBooleanCheckbox()

Construct an instance of the CoreSelectBooleanCheckbox.

CoreSelectBooleanCheckbox

protected CoreSelectBooleanCheckbox(java.lang.String rendererType)

Construct an instance of the CoreSelectBooleanCheckbox.

Method Detail

isAutoSubmit

public final 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.).

setAutoSubmit

public final 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.).

isReadOnly

public final boolean isReadOnly()

Gets whether the element is read-only.

setReadOnly

public final void setReadOnly(boolean readOnly)

Sets whether the element is read-only.

isDisabled

public final boolean isDisabled()

Gets whether the element is disabled.

setDisabled

public final void setDisabled(boolean disabled)

Sets whether the element is disabled.

getShortDesc

public final java.lang.String getShortDesc()

Gets the short description of the bean. This text is commonly used by user agents to display tooltip help text.

setShortDesc

public final void setShortDesc(java.lang.String shortDesc)

Sets the short description of the bean. This text is commonly used by user agents to display tooltip help text.

getPartialTriggers

public final java.lang.String[] getPartialTriggers()

Gets the IDs of the components that should trigger a partial update. 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.

setPartialTriggers

public final void setPartialTriggers(java.lang.String[] partialTriggers)

Sets the IDs of the components that should trigger a partial update. 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.

getLabel

public final java.lang.String getLabel()

Gets the label of the bean.

setLabel

public final void setLabel(java.lang.String label)

Sets the label of the bean.

getTip

public final java.lang.String getTip()

Gets the tip text associated with the control

setTip

public final void setTip(java.lang.String tip)

Sets the tip text associated with the control

isSimple

public final 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, messageDescUrl messageTargetFrame, showRequired, tip), and may use simpler layout primitives

setSimple

public final 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, messageDescUrl messageTargetFrame, showRequired, tip), and may use simpler layout primitives

getText

public final java.lang.String getText()

Gets the text value of the checkbox.

setText

public final void setText(java.lang.String text)

Sets the text value of the checkbox.

getAccessKey

public final char getAccessKey()

Gets Character used to gain quick access to this checkbox. For accessibility reasons, this functionality is not supported in screen reader mode.

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 textattribute of this selectBooleanCheckbox instance. If it does not, the user will receive no visual indication of the existence of the accessKey.

setAccessKey

public final void setAccessKey(char accessKey)

Sets Character used to gain quick access to this checkbox. For accessibility reasons, this functionality is not supported in screen reader mode.

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 textattribute of this selectBooleanCheckbox instance. If it does not, the user will receive no visual indication of the existence of the accessKey.

getOnfocus

public final java.lang.String getOnfocus()

Gets the event handler for when the element receives focus.

setOnfocus

public final void setOnfocus(java.lang.String onfocus)

Sets the event handler for when the element receives focus.

getOnblur

public final java.lang.String getOnblur()

Gets the event handler for when the element loses focus.

setOnblur

public final void setOnblur(java.lang.String onblur)

Sets the event handler for when the element loses focus.

getOnchange

public final java.lang.String getOnchange()

Gets event handler for when the value is changed.

setOnchange

public final void setOnchange(java.lang.String onchange)

Sets event handler for when the value is changed.

getOnclick

public final java.lang.String getOnclick()

Gets an onclick Javascript handler.

setOnclick

public final void setOnclick(java.lang.String onclick)

Sets an onclick Javascript handler.

getOndblclick

public final java.lang.String getOndblclick()

Gets an ondblclick Javascript handler.

setOndblclick

public final void setOndblclick(java.lang.String ondblclick)

Sets an ondblclick Javascript handler.

getOnmousedown

public final java.lang.String getOnmousedown()

Gets an onmousedown Javascript handler.

setOnmousedown

public final void setOnmousedown(java.lang.String onmousedown)

Sets an onmousedown Javascript handler.

getOnmouseup

public final java.lang.String getOnmouseup()

Gets an onmouseup Javascript handler.

setOnmouseup

public final void setOnmouseup(java.lang.String onmouseup)

Sets an onmouseup Javascript handler.

getOnmouseover

public final java.lang.String getOnmouseover()

Gets an onmouseover Javascript handler.

setOnmouseover

public final void setOnmouseover(java.lang.String onmouseover)

Sets an onmouseover Javascript handler.

getOnmousemove

public final java.lang.String getOnmousemove()

Gets an onmousemove Javascript handler.

setOnmousemove

public final void setOnmousemove(java.lang.String onmousemove)

Sets an onmousemove Javascript handler.

getOnmouseout

public final java.lang.String getOnmouseout()

Gets an onmouseout Javascript handler.

setOnmouseout

public final void setOnmouseout(java.lang.String onmouseout)

Sets an onmouseout Javascript handler.

getOnkeypress

public final java.lang.String getOnkeypress()

Gets an onkeypress Javascript handler.

setOnkeypress

public final void setOnkeypress(java.lang.String onkeypress)

Sets an onkeypress Javascript handler.

getOnkeydown

public final java.lang.String getOnkeydown()

Gets an onkeydown Javascript handler.

setOnkeydown

public final void setOnkeydown(java.lang.String onkeydown)

Sets an onkeydown Javascript handler.

getOnkeyup

public final java.lang.String getOnkeyup()

Gets an onkeyup Javascript handler.

setOnkeyup

public final void setOnkeyup(java.lang.String onkeyup)

Sets an onkeyup Javascript handler.

getStyleClass

public final java.lang.String getStyleClass()

Gets the CSS style class of the bean.

setStyleClass

public final void setStyleClass(java.lang.String styleClass)

Sets the CSS style class of the bean.

getInlineStyle

public final java.lang.String getInlineStyle()

Gets the inline CSS style for this element

setInlineStyle

public final void setInlineStyle(java.lang.String inlineStyle)

Sets the inline CSS style for this element

isShowRequired

public final boolean isShowRequired()

Gets whether the associated control displays a visual indication of required user input. If a "required" attribute is also present, both the "required" attribute and the "showRequired" attribute must be false for the visual indication not to be displayed.

setShowRequired

public final void setShowRequired(boolean showRequired)

Sets whether the associated control displays a visual indication of required user input. If a "required" attribute is also present, both the "required" attribute and the "showRequired" attribute must be false for the visual indication not to be displayed.

getValign

public final java.lang.String getValign()

Gets the vertical alignment of the label and other contents. The acceptable values are "middle", "top", and "bottom".

setValign

public final void setValign(java.lang.String valign)

Sets the vertical alignment of the label and other contents. The acceptable values are "middle", "top", and "bottom".

getMessageDescUrl

public final java.lang.String getMessageDescUrl()

Gets an URL to a page with more information about the message.

setMessageDescUrl

public final void setMessageDescUrl(java.lang.String messageDescUrl)

Sets an URL to a page with more information about the message.

getMessageTargetFrame

public final java.lang.String getMessageTargetFrame()

Gets the target frame for the message description URL, if any.

setMessageTargetFrame

public final void setMessageTargetFrame(java.lang.String messageTargetFrame)

Sets the target frame for the message description URL, if any.

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class UIXSelectBoolean

getBeanType

protected FacesBean.Type getBeanType()

Overrides:

getBeanType in class UIXSelectBoolean