|
Oracle UIX API Reference Release 2.1.22.0.0 B12196-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--oracle.cabo.ui.DeprecatedUINode | +--oracle.cabo.ui.BaseUINode | +--oracle.cabo.ui.BaseMutableUINode | +--oracle.cabo.ui.beans.BaseWebBean | +--oracle.cabo.ui.beans.MarlinBean | +--oracle.cabo.ui.beans.form.FormElementBean | +--oracle.cabo.ui.beans.form.CheckBoxBean
User interface radio buttons and checkboxes.
The checkbox control maps to a standard browser input checkbox, which toggles between selected and unselected states. The text contained by the checkbox control will be displayed as the checkbox label.
This basic example renders an unchecked checkbox which can be toggled with the 'C' access key.
<checkBox name="cb1" value="1" accessKey="C"/>
This example renders a checkbox with the label "checkbox2" which can be toggled using the accessKey '2'.
<checkBox name="cb2" textAndAccessKey="checkbox&2" value="1" id="check2" accessKey="2"/>
It does not support any children.
Constructor Summary | |
|
CheckBoxBean()
Construct an instance of the CheckBoxBean. |
protected |
CheckBoxBean(boolean ignored,
java.lang.String localName)
Construct an instance of the CheckBoxBean. |
|
CheckBoxBean(java.lang.String name)
Construct an instance of the CheckBoxBean. |
|
CheckBoxBean(java.lang.String name,
java.lang.String text)
Construct an instance of the CheckBoxBean. |
|
CheckBoxBean(java.lang.String name,
java.lang.String text,
boolean checked)
Construct an instance of the CheckBoxBean. |
Method Summary | |
char |
getAccessKey()
Gets Character used to gain quick access to this checkbox. |
static char |
getAccessKey(MutableUINode bean)
Gets Character used to gain quick access to this checkbox. |
java.lang.String |
getSelectedValue()
Gets the string value for this checkbox, when equal to value, the checkbox behaves as though checked is true, overriding the attribute value for checked. |
static java.lang.String |
getSelectedValue(MutableUINode bean)
Gets the string value for this checkbox, when equal to value, the checkbox behaves as though checked is true, overriding the attribute value for checked. |
java.lang.String |
getText()
Gets the text value of the checkbox. |
static java.lang.String |
getText(MutableUINode bean)
Gets the text value of the checkbox. |
java.lang.String |
getValue()
Gets the string value to be sent when this checkbox is selected. |
static java.lang.String |
getValue(MutableUINode bean)
Gets the string value to be sent when this checkbox is selected. |
boolean |
isChecked()
Gets a boolean value indicating whether or not the checkbox is currently checked. |
static boolean |
isChecked(MutableUINode bean)
Gets a boolean value indicating whether or not the checkbox is currently checked. |
void |
setAccessKey(char accessKey)
Sets Character used to gain quick access to this checkbox. |
static void |
setAccessKey(MutableUINode bean,
char accessKey)
Sets Character used to gain quick access to this checkbox. |
void |
setChecked(boolean checked)
Sets a boolean value indicating whether or not the checkbox is currently checked. |
static void |
setChecked(MutableUINode bean,
boolean checked)
Sets a boolean value indicating whether or not the checkbox is currently checked. |
void |
setCheckedBinding(BoundValue boundValue)
Binds the a boolean value indicating whether or not the checkbox is currently checked. |
static void |
setCheckedBinding(MutableUINode bean,
BoundValue boundValue)
Binds the a boolean value indicating whether or not the checkbox is currently checked. |
static void |
setCheckedBinding(MutableUINode bean,
java.lang.Object selectKey)
Binds the a boolean value indicating whether or not the checkbox is currently checked. |
static void |
setCheckedBinding(MutableUINode bean,
java.lang.String dataNamespace,
java.lang.String dataName,
java.lang.Object selectKey)
Binds the a boolean value indicating whether or not the checkbox is currently checked. |
void |
setCheckedBinding(java.lang.Object selectKey)
Binds the a boolean value indicating whether or not the checkbox is currently checked. |
void |
setCheckedBinding(java.lang.String dataNamespace,
java.lang.String dataName,
java.lang.Object selectKey)
Binds the a boolean value indicating whether or not the checkbox is currently checked. |
static void |
setSelectedValue(MutableUINode bean,
java.lang.String selectedValue)
Sets the string value for this checkbox, when equal to value, the checkbox behaves as though checked is true, overriding the attribute value for checked. |
void |
setSelectedValue(java.lang.String selectedValue)
Sets the string value for this checkbox, when equal to value, the checkbox behaves as though checked is true, overriding the attribute value for checked. |
void |
setSelectedValueBinding(BoundValue boundValue)
Binds the the string value for this checkbox, when equal to value, the checkbox behaves as though checked is true, overriding the attribute value for checked. |
static void |
setSelectedValueBinding(MutableUINode bean,
BoundValue boundValue)
Binds the the string value for this checkbox, when equal to value, the checkbox behaves as though checked is true, overriding the attribute value for checked. |
static void |
setSelectedValueBinding(MutableUINode bean,
java.lang.Object selectKey)
Binds the the string value for this checkbox, when equal to value, the checkbox behaves as though checked is true, overriding the attribute value for checked. |
static void |
setSelectedValueBinding(MutableUINode bean,
java.lang.String dataNamespace,
java.lang.String dataName,
java.lang.Object selectKey)
Binds the the string value for this checkbox, when equal to value, the checkbox behaves as though checked is true, overriding the attribute value for checked. |
void |
setSelectedValueBinding(java.lang.Object selectKey)
Binds the the string value for this checkbox, when equal to value, the checkbox behaves as though checked is true, overriding the attribute value for checked. |
void |
setSelectedValueBinding(java.lang.String dataNamespace,
java.lang.String dataName,
java.lang.Object selectKey)
Binds the the string value for this checkbox, when equal to value, the checkbox behaves as though checked is true, overriding the attribute value for checked. |
static void |
setText(MutableUINode bean,
java.lang.String text)
Sets the text value of the checkbox. |
void |
setText(java.lang.String text)
Sets the text value of the checkbox. |
void |
setTextBinding(BoundValue boundValue)
Binds the the text value of the checkbox. |
static void |
setTextBinding(MutableUINode bean,
BoundValue boundValue)
Binds the the text value of the checkbox. |
static void |
setTextBinding(MutableUINode bean,
java.lang.Object selectKey)
Binds the the text value of the checkbox. |
static void |
setTextBinding(MutableUINode bean,
java.lang.String dataNamespace,
java.lang.String dataName,
java.lang.Object selectKey)
Binds the the text value of the checkbox. |
void |
setTextBinding(java.lang.Object selectKey)
Binds the the text value of the checkbox. |
void |
setTextBinding(java.lang.String dataNamespace,
java.lang.String dataName,
java.lang.Object selectKey)
Binds the the text value of the checkbox. |
static void |
setTranslatableText(MutableUINode bean,
java.lang.String bundleName,
java.lang.String key)
Binds to a ResourceBundle the the text value of the checkbox. |
void |
setTranslatableText(java.lang.String bundleName,
java.lang.String key)
Binds to a ResourceBundle the the text value of the checkbox. |
static void |
setValue(MutableUINode bean,
java.lang.String value)
Sets the string value to be sent when this checkbox is selected. |
void |
setValue(java.lang.String value)
Sets the string value to be sent when this checkbox is selected. |
void |
setValueBinding(BoundValue boundValue)
Binds the the string value to be sent when this checkbox is selected. |
static void |
setValueBinding(MutableUINode bean,
BoundValue boundValue)
Binds the the string value to be sent when this checkbox is selected. |
static void |
setValueBinding(MutableUINode bean,
java.lang.Object selectKey)
Binds the the string value to be sent when this checkbox is selected. |
static void |
setValueBinding(MutableUINode bean,
java.lang.String dataNamespace,
java.lang.String dataName,
java.lang.Object selectKey)
Binds the the string value to be sent when this checkbox is selected. |
void |
setValueBinding(java.lang.Object selectKey)
Binds the the string value to be sent when this checkbox is selected. |
void |
setValueBinding(java.lang.String dataNamespace,
java.lang.String dataName,
java.lang.Object selectKey)
Binds the the string value to be sent when this checkbox is selected. |
Methods inherited from class oracle.cabo.ui.beans.form.FormElementBean |
getName, getName, getOnBlur, getOnBlur, getOnFocus, getOnFocus, isDisabled, isDisabled, isReadOnly, isReadOnly, setDisabled, setDisabled, setName, setName, setNameBinding, setNameBinding, setNameBinding, setNameBinding, setNameBinding, setNameBinding, setOnBlur, setOnBlur, setOnFocus, setOnFocus, setReadOnly, setReadOnly |
Methods inherited from class oracle.cabo.ui.beans.MarlinBean |
isEqualMarlinName |
Methods inherited from class oracle.cabo.ui.BaseUINode |
getAttributeNames, getAttributeValue, getAttributeValueImpl, getChildArray, getChildNames, getIndexedChild, getIndexedChild, getIndexedChildCount, getLocalName, getNamedChild, getNamespaceURI, getNodeID, getNodeRole, getPreorderDescendentAttributeValue, getRawAttributeValue, getRenderedUINode, getRenderer, getRenderer, render, render, toString |
Methods inherited from class oracle.cabo.ui.DeprecatedUINode |
getAttributeValue, getChildNames, getNamedChild |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface oracle.cabo.ui.UINode |
getAttributeNames, getAttributeValue, getAttributeValue, getChildNames, getChildNames, getIndexedChild, getIndexedChild, getIndexedChildCount, getLocalName, getNamedChild, getNamedChild, getNamespaceURI, getNodeID, getNodeRole, getRawAttributeValue, render, render |
Constructor Detail |
public CheckBoxBean()
public CheckBoxBean(java.lang.String name)
name
- the name used to identify the element in client-to-client or
client-to-server events.public CheckBoxBean(java.lang.String name, java.lang.String text)
name
- the name used to identify the element in client-to-client or
client-to-server events.text
- the text value of the checkbox.public CheckBoxBean(java.lang.String name, java.lang.String text, boolean checked)
name
- the name used to identify the element in client-to-client or
client-to-server events.text
- the text value of the checkbox.checked
- a boolean value indicating whether or not the checkbox is
currently checked.protected CheckBoxBean(boolean ignored, java.lang.String localName)
Method Detail |
public final java.lang.String getText()
public final void setText(java.lang.String text)
public final void setTranslatableText(java.lang.String bundleName, java.lang.String key)
bundleName
- the name of the ResourceBundlekey
- the key of the string to retrieve from the ResourceBundlepublic final void setTextBinding(BoundValue boundValue)
boundValue
- a BoundValue implementation to be used
to retrieve the value.public final void setTextBinding(java.lang.Object selectKey)
selectKey
- the key to be passed to selectValue()
on the
current DataObject
, e.g., the DataObject for the current
table row.public final void setTextBinding(java.lang.String dataNamespace, java.lang.String dataName, java.lang.Object selectKey)
dataNamespace
- the namespace to be passed to
RenderingContext.getDataObject()
dataName
- the name to be passed to
RenderingContext.getDataObject()
selectKey
- the key to be passed to selectValue()
on the
DataObject
.public final boolean isChecked()
public final void setChecked(boolean checked)
public final void setCheckedBinding(BoundValue boundValue)
boundValue
- a BoundValue implementation to be used
to retrieve the value.public final void setCheckedBinding(java.lang.Object selectKey)
selectKey
- the key to be passed to selectValue()
on the
current DataObject
, e.g., the DataObject for the current
table row.public final void setCheckedBinding(java.lang.String dataNamespace, java.lang.String dataName, java.lang.Object selectKey)
dataNamespace
- the namespace to be passed to
RenderingContext.getDataObject()
dataName
- the name to be passed to
RenderingContext.getDataObject()
selectKey
- the key to be passed to selectValue()
on the
DataObject
.public final java.lang.String getValue()
public final void setValue(java.lang.String value)
public final void setValueBinding(BoundValue boundValue)
boundValue
- a BoundValue implementation to be used
to retrieve the value.public final void setValueBinding(java.lang.Object selectKey)
selectKey
- the key to be passed to selectValue()
on the
current DataObject
, e.g., the DataObject for the current
table row.public final void setValueBinding(java.lang.String dataNamespace, java.lang.String dataName, java.lang.Object selectKey)
dataNamespace
- the namespace to be passed to
RenderingContext.getDataObject()
dataName
- the name to be passed to
RenderingContext.getDataObject()
selectKey
- the key to be passed to selectValue()
on the
DataObject
.public final java.lang.String getSelectedValue()
public final void setSelectedValue(java.lang.String selectedValue)
public final void setSelectedValueBinding(BoundValue boundValue)
boundValue
- a BoundValue implementation to be used
to retrieve the value.public final void setSelectedValueBinding(java.lang.Object selectKey)
selectKey
- the key to be passed to selectValue()
on the
current DataObject
, e.g., the DataObject for the current
table row.public final void setSelectedValueBinding(java.lang.String dataNamespace, java.lang.String dataName, java.lang.Object selectKey)
dataNamespace
- the namespace to be passed to
RenderingContext.getDataObject()
dataName
- the name to be passed to
RenderingContext.getDataObject()
selectKey
- the key to be passed to selectValue()
on the
DataObject
.public 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 CheckBox instance.
If it does not, the user will receive no visual indication of
the existence of the accessKey.
The easiest, and most convenient
way to specify both the text and the mnemonic together is to use
NodeUtils.setTextAndAccessKey().
getText()
,
setText(java.lang.String)
,
NodeUtils.setTextAndAccessKey(oracle.cabo.ui.MutableUINode, java.lang.String)
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 CheckBox instance.
If it does not, the user will receive no visual indication of
the existence of the accessKey.
The easiest, and most convenient
way to specify both the text and the mnemonic together is to use
NodeUtils.setTextAndAccessKey().
getText()
,
setText(java.lang.String)
,
NodeUtils.setTextAndAccessKey(oracle.cabo.ui.MutableUINode, java.lang.String)
public static java.lang.String getText(MutableUINode bean)
public static void setText(MutableUINode bean, java.lang.String text)
public static void setTranslatableText(MutableUINode bean, java.lang.String bundleName, java.lang.String key)
bundleName
- the name of the ResourceBundlekey
- the key of the string to retrieve from the ResourceBundlepublic static void setTextBinding(MutableUINode bean, BoundValue boundValue)
boundValue
- a BoundValue implementation to be used
to retrieve the value.public static void setTextBinding(MutableUINode bean, java.lang.Object selectKey)
selectKey
- the key to be passed to selectValue()
on the
current DataObject
, e.g., the DataObject for the current
table row.public static void setTextBinding(MutableUINode bean, java.lang.String dataNamespace, java.lang.String dataName, java.lang.Object selectKey)
dataNamespace
- the namespace to be passed to
RenderingContext.getDataObject()
dataName
- the name to be passed to
RenderingContext.getDataObject()
selectKey
- the key to be passed to selectValue()
on the
DataObject
.public static boolean isChecked(MutableUINode bean)
public static void setChecked(MutableUINode bean, boolean checked)
public static void setCheckedBinding(MutableUINode bean, BoundValue boundValue)
boundValue
- a BoundValue implementation to be used
to retrieve the value.public static void setCheckedBinding(MutableUINode bean, java.lang.Object selectKey)
selectKey
- the key to be passed to selectValue()
on the
current DataObject
, e.g., the DataObject for the current
table row.public static void setCheckedBinding(MutableUINode bean, java.lang.String dataNamespace, java.lang.String dataName, java.lang.Object selectKey)
dataNamespace
- the namespace to be passed to
RenderingContext.getDataObject()
dataName
- the name to be passed to
RenderingContext.getDataObject()
selectKey
- the key to be passed to selectValue()
on the
DataObject
.public static java.lang.String getValue(MutableUINode bean)
public static void setValue(MutableUINode bean, java.lang.String value)
public static void setValueBinding(MutableUINode bean, BoundValue boundValue)
boundValue
- a BoundValue implementation to be used
to retrieve the value.public static void setValueBinding(MutableUINode bean, java.lang.Object selectKey)
selectKey
- the key to be passed to selectValue()
on the
current DataObject
, e.g., the DataObject for the current
table row.public static void setValueBinding(MutableUINode bean, java.lang.String dataNamespace, java.lang.String dataName, java.lang.Object selectKey)
dataNamespace
- the namespace to be passed to
RenderingContext.getDataObject()
dataName
- the name to be passed to
RenderingContext.getDataObject()
selectKey
- the key to be passed to selectValue()
on the
DataObject
.public static java.lang.String getSelectedValue(MutableUINode bean)
public static void setSelectedValue(MutableUINode bean, java.lang.String selectedValue)
public static void setSelectedValueBinding(MutableUINode bean, BoundValue boundValue)
boundValue
- a BoundValue implementation to be used
to retrieve the value.public static void setSelectedValueBinding(MutableUINode bean, java.lang.Object selectKey)
selectKey
- the key to be passed to selectValue()
on the
current DataObject
, e.g., the DataObject for the current
table row.public static void setSelectedValueBinding(MutableUINode bean, java.lang.String dataNamespace, java.lang.String dataName, java.lang.Object selectKey)
dataNamespace
- the namespace to be passed to
RenderingContext.getDataObject()
dataName
- the name to be passed to
RenderingContext.getDataObject()
selectKey
- the key to be passed to selectValue()
on the
DataObject
.public static char getAccessKey(MutableUINode bean)
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 CheckBox instance.
If it does not, the user will receive no visual indication of
the existence of the accessKey.
The easiest, and most convenient
way to specify both the text and the mnemonic together is to use
NodeUtils.setTextAndAccessKey().
getText()
,
setText(java.lang.String)
,
NodeUtils.setTextAndAccessKey(oracle.cabo.ui.MutableUINode, java.lang.String)
public static void setAccessKey(MutableUINode bean, 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 CheckBox instance.
If it does not, the user will receive no visual indication of
the existence of the accessKey.
The easiest, and most convenient
way to specify both the text and the mnemonic together is to use
NodeUtils.setTextAndAccessKey().
getText()
,
setText(java.lang.String)
,
NodeUtils.setTextAndAccessKey(oracle.cabo.ui.MutableUINode, java.lang.String)
|
Oracle UIX API Reference Release 2.1.22.0.0 B12196-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |