Web Dynpro Label API -
IWDLabel 
Definition
The Label UI element is used for labeling other UI elements. Therefore, it is always associated with another UI elements.
This UI element ensures accessibility of the Web Dynpro application.
The appearance is defined by the design property. The following table shows how a label UI element for labeling an input field is displayed.
Description of the UI Element Properties
·
design
Specifies the design of the
UI element. The design property can be filled with the following values
and is represented by the enumeration type WDLabelDesign.
light |
|
The UI element is displayed without the left design bar. |
standard |
|
A default design of the UI element. |
·
labelFor
Specifies the ID of the UI element to be labeled.
·
text
Label text.
·
width
Specifies the width of the
Label UI element and can be specified in CSS units like em, ex, pixels, or
percentage.
·
wrapping
Indicates whether or not the text is wrapped. If the value is false, the text is not wrapped.
Data Binding
Since the relationship between Label UI element and associated UI element is specified by the static layout of a view, the labelFor property is not defined as bindable.
Overview of Inherited and Additional Properties
Name |
Interface |
Type |
Initial Value |
Bindable |
Value Required |
IWDUIElement |
boolean |
true |
bindable |
No |
|
design |
IWDLabel |
WDLabelDesign |
standard |
bindable |
No |
labelFor |
IWDLabel |
String |
|
not_bindable |
Yes |
text |
IWDLabel |
String (TranslatableText) |
|
bindable |
No |
IWDUIElement |
String (TranslatableText) |
|
bindable |
No |
|
IWDUIElement |
WDVisibility |
visible |
bindable |
No |
|
width |
IWDLabel |
String |
|
bindable |
No |
wrapping |
IWDLabel |
boolean |
false |
bindable |
No |
Mobile Characteristics
The UI element Label supports the development of mobile applications for pocket PCs and BlackBerry wireless handhelds (see Mobile Web Dynpro).
However, several properties supported in the desktop browser cannot be used. These include:
Variances of the properties
Properties |
Pocket PC |
BlackBerry wireless handheld |
enabled |
ignored |
ignored |
tooltip |
ignored |
ignored |
wrapping |
ignored |
ignored |
Methods in the Web Dynpro Label API
Method Name |
Parameter |
Return Value |
Short Description |
bindDesign |
(String path) |
|
Binds the value of the design property to the context element specified by the path. |
bindingOfDesign |
|
String |
Returns the path of the context element to which the design 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. |
bindingOfWidth |
|
String |
Returns the path of the context element to which the width property is bound. Returns NULL if no binding exists. |
bindingOfWrapping |
|
String |
Returns the path of the context element to which the wrapping property is bound. Returns NULL if no binding exists. |
bindText |
(String path) |
|
Binds the text property to the context node specified by a path. |
bindWidth |
(String path) |
|
Binds the value of the width property to the context element specified by the path. |
bindWrapping |
(String path) |
|
Binds the wrapping property to the context node specified by a path. |
getDesign |
|
WDLabelDesign |
Returns the value of the design property. |
getLabelFor |
|
String |
Returns the value of the labelFor property. |
getText |
|
String |
Returns the value of the text property. |
getWidth |
|
String |
Returns the value of the width property. |
getWrapping |
|
boolean |
Returns the value of the wrapping property. |
setDesign |
(WDLabelDesign value) |
|
Sets the value of the design property. |
setLabelFor |
(String labelFor) |
|
Sets the value of the labelFor property. |
setText |
(String value) |
|
Sets the value of the text property. |
setWidth |
(String width) |
|
Sets the value of the width property. |
setWrapping |
(boolean value) |
|
Sets the value of the wrapping property. |
Additional methods described in the following APIs are available using inheritance: IWDUIElement, IWDViewElement.
For detailed documentation of all inherited methods, see the documentation for the relevant APIs.