Web Dynpro AbstractTreeNodeType API -
IWDAbstractTreeNodeType 
Definition
The AbstractTreeNodeType class which implements the IWDAbstractTreeNodeType interface, is the abstract base class of input fields. An AbstractTreeNodeType UI element is assigned to exactly one Tree UI Element.
Description of the View Element Properties
·
dataSource
This property is used to
specify the data source. You can use it to specify the path to the context
node providing the data.
·
design
Specifies the text display of
the tree node type.
The design property can be filled with the following values
and is represented by the enumeration type WDTreeNodeDesign.
emphasized |
The text is highlighted. |
standard |
The text is displayed in default font and default color. |
·
iconAlt
Describes an alternative text
that is displayed when the corresponding graphic is not available or cannot be
loaded.
·
iconSource
Describes the Web address (URL) of the graphic to be displayed. Do not assign
a value to this property, so the graphic is displayed that is defined by the
properties defaultNodeIconSourceand defaultItemIconSource of the Tree UI element.
·
ignoreAction
Specifies whether or not a
defined action can be executed.
·
text
Specifies the text to be displayed for this tree node type. You can statically
specify this property value at design time or bind it to a context attribute
so that the value is provided automatically by the context at runtime.
·
tooltip
Describes a note for the view
element, which is displayed when the user places the cursor on the view
element.
Overview of Inherited and Additional Properties
Name |
Interface |
Type |
Initial Value |
Bindable |
Value Required |
dataSource |
IWDAbstractTreeNodeType |
Object |
|
bindable_mandatory |
No |
design |
IWDAbstractTreeNodeType |
WDTreeNodeDesign |
standard |
bindable |
No |
iconAlt |
IWDAbstractTreeNodeType |
String (TranslatableText) |
|
bindable |
No |
iconSource |
IWDAbstractTreeNodeType |
String |
|
bindable |
No |
ignoreAction |
IWDAbstractTreeNodeType |
boolean |
false |
bindable |
No |
text |
IWDAbstractTreeNodeType |
String (TranslatableText) |
|
bindable |
No |
Tooltip |
IWDAbstractTreeNodeType |
String (TranslatableText) |
|
bindable |
No |
Events
·
onAction
Describes the action to be
executed when a tree node of this type is selected. The Web Dynpro framework
can convert the parameter path into a data type that implements or extends the
interface IWDNodeElement. The parameter path points to the tree node where the action was
triggered. In the context, a node element corresponds, at runtime, to the tree
node – for example, ITreeLevel1Elementwhich has been defined as context node TreeLevel1 at design time. It is an interface that extends
IWDNodeElement.
This conversion occurs when you declare a Java class that implements
IWDNodeElement as a type of the parameter of an event handler or
when an interface extends IWDNodeElement - like the example above ITreeLevel1Element. This requires, however, that the parameter mapping
is defined using the doModifyView method, for example
· nodeType.mappingOfOnAction().addSourceMapping("path" , "selectedElement"); |
For information on parameter mapping, refer to Event Parameter and Parameter Mapping and Web Dynpro ParameterMapping API - IWDParameterMapping.
Event Parameter |
Type |
path |
String |
Subordinate Interfaces
Methods in the Web Dynpro IWDAbstractTreeNodeType API
Method Name |
Parameter |
Return Value |
Short Description |
bindDataSource |
(String path) |
|
Binds the dataSource property to the context node specified by a path. |
bindDesign |
(String path) |
|
Binds the design property to the context node specified by a path. |
bindIconAlt |
(String path) |
|
Binds the iconAlt property to the context node specified by a path. |
bindIconSource |
(String path) |
|
Binds the iconSource property to the context node specified by a path. |
bindIgnoreAction |
(String path) |
|
Binds the ignoreAction property to the context node specified by a path. |
bindingOfDataSource |
|
String |
Returns the path of the context element to which the dataSource property is bound. Returns NULL if no binding exists. |
bindingOfDesign |
|
String |
Returns the path of the context element to which the design property is bound. Returns NULL if no binding exists. |
bindingOfIconAlt |
|
String |
Returns the path of the context element to which the iconAlt property is bound. Returns NULL if no binding exists. |
bindingOfIconSource |
|
String |
Returns the path of the context element to which the iconSource property is bound. Returns NULL if no binding exists. |
bindingOfIgnoreAction |
|
String |
Returns the path of the context element to which the ignoreAction 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. |
bindingOfTooltip |
|
String |
Returns the path of the context element to which the tooltip property is bound. Returns NULL if no binding exists. |
bindText |
(String path) |
|
Binds the text property to the context node specified by a path. |
bindTooltip |
(String path) |
|
Binds the value of the tooltip property to the context element specified by the path. |
getIconAlt |
|
String |
Returns the value of the iconAlt property. |
getDesign |
|
WDTreeNodeDesign |
Returns the value of the design property. |
getIconSource |
|
String |
Returns the value of the iconSource property. |
getIgnoreAction |
|
boolean |
Returns the value of the ignoreAction property. |
getOnAction |
|
IWDAction |
Returns the action that is executed when the onAction event is triggered. |
getText |
|
String |
Returns the value of the text property. |
getTooltip |
|
String |
Returns the value of the tooltip property. |
getTree |
|
IWDTree |
Returns the Tree element in which this AbstractTreeNodeType element is contained. |
mappingOfOnAction |
|
IWDParameterMapping |
Returns the parameter mapping for the onAction action. |
setDesign |
(WDTreeNodeDesign design) |
|
Sets the value of the design property. |
setIconAlt |
(String value) |
|
Sets the value of the iconAlt property. |
setIconSource |
(String value) |
|
Sets the value of the iconSource property. |
setIgnoreAction |
(boolean value) |
|
Sets the value of the ignoreAction property. |
setOnAction |
(IWDAction action) |
|
Sets the action that is executed when the onAction event is triggered. |
setText |
(String value) |
|
Sets the value of the text property. |
setTooltip |
(String value) |
|
Sets the value of the tooltip property. |
Additional methods are available using inheritance: IWDViewElement.