Web
Dynpro CheckBox API - IWDCheckBox 
Definition
The checkbox enables the user to select a Boolean value (true/false). The UI element consists of a graphic with text. The checkmark in the box indicates that the option is selected and the value is set to true.
Description of the UI Element Properties
·
checked
Specifies whether or not a
checkbox is selected. The Boolean value true indicates that the option is selected. A
checkmark appears in the graphic that is displayed on the screen.
Short Description |
Display |
|
|
|
·
readOnly
Specifies whether or not the
user can check the checkbox.
·
state
Describes the error status of
the UI element. The data type of this property corresponds to the enumeration
type WDState. You can use the following values in the
application:
normal |
Describes the default state of the UI element. |
required |
Specifies whether the entered value is required. |
·
text
Specifies the text that is
associated with the checkbox graphic and displayed to the right of the box.
Overview of Inherited and Additional Properties
Name |
Interface |
Type |
Initial Value |
Bindable |
Value Required |
checked |
IWDCheckBox |
boolean |
false |
bindable_mandatory |
No |
IWDUIElement |
boolean |
true |
bindable |
No |
|
readOnly |
IWDCheckBox |
boolean |
false |
bindable |
No |
state |
IWDCheckBox |
WDState |
normal |
bindable |
No |
text |
IWDCheckBox |
String (TranslatableText) |
|
bindable |
No |
IWDUIElement |
String (TranslatableText) |
|
bindable |
No |
|
IWDUIElement |
WDVisibility |
visible |
bindable |
No |
Events
·
onToggle
Describes the action that is
executed when the user checks the checkbox.
Event Parameter |
Type |
Description |
checked |
boolean |
The new value of the checkbox. |
See Event Parameter and Parameter Mapping.
Mobile Characteristics
The UI element CheckBox supports the development of mobile applications for pocket PCs and BlackBerry wireless handhelds (see Mobile Web Dynpro). For BlackBerry wireless handhelds, the checkbox is displayed as a WML tag <select>.
However, several properties supported in the desktop browser cannot be used. These include:
Variances of the properties
Properties |
Pocket PC |
BlackBerry wireless handheld |
readOnly |
ignored |
ignored |
state |
ignored |
ignored |
tooltip |
ignored |
ignored |
Methods in the Web Dynpro IWDCheckBox API
Method Name |
Parameter |
Return Value |
Short Description |
bindChecked |
(String path) |
|
Binds the checked property to the context node specified by a path. |
bindingOfChecked |
|
String |
Returns the path of the context element to which the checked property is bound. Returns NULL if no binding exists. |
bindingOfReadOnly |
|
String |
Returns the path of the context element to which the readOnly property is bound. Returns NULL if no binding exists. |
bindingOfState |
|
String |
Returns the path of the context element to which the state property is bound. Returns NULL if no binding exists. |
bindingOfText |
|
String |
Returns the path of the context element to which the text property is bound. Returns NULL if no binding exists. |
bindReadOnly |
(String path) |
|
Binds the readOnly property to the context node specified by a path. |
bindState |
(String path) |
|
Binds the state property to the context node specified by a path. |
bindText |
(String path) |
|
Binds the text property to the context node specified by a path. |
getChecked |
|
boolean |
Returns the value of the checked property. |
getOnToggle |
|
IWDAction |
Returns the action that is executed when the onToggle event is triggered. |
getReadOnly |
|
boolean |
Returns the value of the readOnly property. |
getState |
|
WDState |
Returns the value of the state property. |
getText |
|
String |
Returns the value of the text property. |
mappingOfOnToggle |
|
IWDParameterMapping |
Returns the parameter mapping for the onToggle action. |
setChecked |
(boolean value) |
|
Sets the value of the checked property. |
setOnToggle |
(IWDAction action) |
|
Sets the action that is executed when the onToggle event is triggered. |
setReadOnly |
(boolean value) |
|
Sets the value of the readOnly property. |
setState |
(WDState value) |
|
Sets the value of the state property. |
setText |
(String value) |
|
Sets the value of the text property. |
Additional methods are available using inheritance: IWDUIElement, IWDViewElement.
For detailed documentation of all inherited methods, see the documentation for the relevant APIs.