Web Dynpro Link API - IWDLink 
Definition
The Link UI element is the abstract base class for UI elements of a hypertext link type. The classes LinkToAction and LinkToURL inherit all the properties of this UI element. The UI element consists of a text and a graphic.
Description of the UI Element Properties
·
imageHeight
Specifies the height of the
graphic next to the link. You can specify the height in CSS units like em, ex,
pixels, or percentage.
·
imageWidth
Specifies the width of the
graphic next to the link. You can specify the width in CSS units like em, ex,
pixels, or percentage.
·
size
Specifies the size of the
Link UI element. The size property can be filled with the following values and is represented
by the enumeration type WDLinkSize.
small |
The UI element is displayed in a small font. |
standard |
A default size is displayed. |
·
text
Describes the label
text.
·
wrapping
Indicates whether or not the link text is wrapped. If the initial value is
false, the link text is not wrapped.
If the value of this property is false, the link text is not wrapped.
Overview of Inherited and Additional Properties
Name |
Interface |
Type |
Initial Value |
Bindable |
Value Required |
IWDUIElement |
boolean |
true |
bindable |
No |
|
IWDAbstractCaption |
String (TranslatableText) |
|
bindable |
No |
|
IWDAbstractCaption |
boolean |
true |
bindable |
No |
|
imageHeight |
IWDLink |
String (CSS size) |
|
bindable |
No |
IWDAbstractCaption |
String |
|
bindable |
No |
|
imageWidth |
IWDLink |
String (CSS size) |
|
bindable |
No |
size |
IWDLink |
WDLinkSize |
standard |
bindable |
No |
text |
IWDLink |
String (TranslatableText) |
|
bindable |
No |
IWDUIElement |
String (TranslatableText) |
|
bindable |
No |
|
IWDUIElement |
WDVisibility |
visible |
bindable |
No |
|
wrapping |
IWDLink |
boolean |
false |
bindable |
No |
Subclasses
IWDLinkToAction, IWDLinkToURL.
Methods in the Web Dynpro Link API
Method Name |
Parameter |
Return Value |
Short Description |
bindImageHeight |
(String path) |
|
Binds the imageHeight property to the context node specified by a path. |
bindImageWidth |
(String path) |
|
Binds the imageWidth property to the context node specified by a path. |
bindingOfImageHeight |
|
String |
Returns the path of the context element to which the imageHeight property is bound. Returns NULL if no binding exists. |
bindingOfImageWidth |
|
String |
Returns the path of the context element to which the imageWidth property is bound. Returns NULL if no binding exists. |
bindingOfSize |
|
String |
Returns the path of the context element to which the size 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. |
bindingOfWrapping |
|
String |
Returns the path of the context element to which the wrapping property is bound. Returns NULL if no binding exists. |
bindSize |
(String path) |
|
Binds the size property to the context node specified by a path. |
bindText |
(String path) |
|
Binds the text property to the context node specified by a path. |
bindWrapping |
(String path) |
|
Binds the wrapping property to the context node specified by a path. |
getImageHeight |
|
String |
Returns the value of the imageHeight property. |
getImageWidth |
|
String |
Returns the value of the imageWidth property. |
getSize |
|
WDLinkSize |
Returns the value of the size property. |
getText |
|
String |
Returns the value of the text property. |
getWrapping |
|
boolean |
Returns the value of the wrapping property. |
setImageHeight |
(String value) |
|
Sets the value of the imageHeight property. |
setImageWidth |
(String value) |
|
Sets the value of the imageWidth property. |
setSize |
(WDLinkSize value) |
|
Sets the value of the size property. |
setText |
(String value) |
|
Sets the value of the text property. |
setWrapping |
(boolean value) |
|
Sets the value of the wrapping property. |
Additional methods are available using inheritance:
IWDAbstractCaption, IWDUIElement, IWDViewElement.
For detailed documentation of all inherited methods, see the documentation for the relevant APIs.