com.sap.tc.webdynpro.clientserver.uielib.standard.api
Interface IWDAbstractTreeNodeType

All Superinterfaces:

IWDViewElement

All Known Subinterfaces:

IWDTreeItemType, IWDTreeNodeType

public interface IWDAbstractTreeNodeType

extends IWDViewElement

Web Dynpro AbstractTreeNodeType API. AbstractTreeNodeType is the base class of a trees node types.

This type can be called by applications using Web Dynpro, but DO NOT EXTEND OR IMPLEMENT IT!

Field Summary

static WDTreeNodeDesign	DEFAULT_DESIGN Default value of property design.
static java.lang.String	DEFAULT_ICON_ALT Default value of property iconAlt.
static java.lang.String	DEFAULT_ICON_SOURCE Default value of property iconSource.
static boolean	DEFAULT_IGNORE_ACTION Default value of property ignoreAction.
static java.lang.String	DEFAULT_TEXT Default value of property text.
static WDTextDirection	DEFAULT_TEXT_DIRECTION Default value of property textDirection.
static java.lang.String	DEFAULT_TOOLTIP Default value of property tooltip.

Method Summary

void	bindDataSource(IWDNodeInfo nodeInfo) Note: This property must be bound to the context! Binds property dataSource to the context node specified by the given node info.
void	bindDataSource(java.lang.String path) Note: This property must be bound to the context! Binds property dataSource to the context attribute specified by path.
void	bindDesign(IWDAttributeInfo attributeInfo) Binds property design to the context attribute specified by the given attribute info.
void	bindDesign(java.lang.String path) Binds property design to the context attribute specified by path.
void	bindIconAlt(IWDAttributeInfo attributeInfo) Binds property iconAlt to the context attribute specified by the given attribute info.
void	bindIconAlt(java.lang.String path) Binds property iconAlt to the context attribute specified by path.
void	bindIconSource(IWDAttributeInfo attributeInfo) Binds property iconSource to the context attribute specified by the given attribute info.
void	bindIconSource(java.lang.String path) Binds property iconSource to the context attribute specified by path.
void	bindIgnoreAction(IWDAttributeInfo attributeInfo) Binds property ignoreAction to the context attribute specified by the given attribute info.
void	bindIgnoreAction(java.lang.String path) Binds property ignoreAction to the context attribute specified by path.
java.lang.String	bindingOfDataSource() Note: This property must be bound to the context! Binding path of property dataSource.
java.lang.String	bindingOfDesign() Binding path of property design.
java.lang.String	bindingOfIconAlt() Binding path of property iconAlt.
java.lang.String	bindingOfIconSource() Binding path of property iconSource.
java.lang.String	bindingOfIgnoreAction() Binding path of property ignoreAction.
java.lang.String	bindingOfText() Binding path of property text.
java.lang.String	bindingOfTextDirection() Binding path of property textDirection.
java.lang.String	bindingOfTooltip() Binding path of property tooltip.
void	bindText(IWDAttributeInfo attributeInfo) Binds property text to the context attribute specified by the given attribute info.
void	bindText(java.lang.String path) Binds property text to the context attribute specified by path.
void	bindTextDirection(IWDAttributeInfo attributeInfo) Binds property textDirection to the context attribute specified by the given attribute info.
void	bindTextDirection(java.lang.String path) Binds property textDirection to the context attribute specified by path.
void	bindTooltip(IWDAttributeInfo attributeInfo) Binds property tooltip to the context attribute specified by the given attribute info.
void	bindTooltip(java.lang.String path) Binds property tooltip to the context attribute specified by path.
WDTreeNodeDesign	getDesign() Returns the value of the design property.
java.lang.String	getIconAlt() Returns the value of the iconAlt property.
java.lang.String	getIconSource() Returns the value of the iconSource property.
boolean	getIgnoreAction() Returns the value of the ignoreAction property.
IWDAction	getOnAction() Returns the action to which the event onAction is mapped.
java.lang.String	getText() Returns the value of the text property.
WDTextDirection	getTextDirection() Returns the value of the textDirection property.
java.lang.String	getTooltip() Returns the value of the tooltip property.
IWDTree	getTree() Returns the current Tree.
IWDParameterMapping	mappingOfOnAction() Returns the parameter mapping of event onAction.
void	setDesign(WDTreeNodeDesign value) Sets property design to the new value.
void	setIconAlt(java.lang.String value) Sets property iconAlt to the new value.
void	setIconSource(java.lang.String value) Sets property iconSource to the new value.
void	setIgnoreAction(boolean value) Sets property ignoreAction to the new value.
void	setOnAction(IWDAction action) Maps the event onAction to the given action.
void	setText(java.lang.String value) Sets property text to the new value.
void	setTextDirection(WDTextDirection value) Sets property textDirection to the new value.
void	setTooltip(java.lang.String value) Sets property tooltip to the new value.

Methods inherited from interface com.sap.tc.webdynpro.progmodel.api.IWDViewElement

getId, getView, requestFocus

Field Detail

DEFAULT_DESIGN

public static final WDTreeNodeDesign DEFAULT_DESIGN

Default value of property design.

DEFAULT_ICON_ALT

public static final java.lang.String DEFAULT_ICON_ALT

Default value of property iconAlt.

DEFAULT_ICON_SOURCE

public static final java.lang.String DEFAULT_ICON_SOURCE

Default value of property iconSource.

DEFAULT_IGNORE_ACTION

public static final boolean DEFAULT_IGNORE_ACTION

Default value of property ignoreAction.

DEFAULT_TEXT

public static final java.lang.String DEFAULT_TEXT

Default value of property text.

DEFAULT_TEXT_DIRECTION

public static final WDTextDirection DEFAULT_TEXT_DIRECTION

Default value of property textDirection.

DEFAULT_TOOLTIP

public static final java.lang.String DEFAULT_TOOLTIP

Default value of property tooltip.

Method Detail

getOnAction

public IWDAction getOnAction()

Returns the action to which the event onAction is mapped. The name of the action performed when a node of this type is activated.

Returns:

the action to which the event is mapped

See Also:

mappingOfOnAction()

setOnAction

public void setOnAction(IWDAction action)

Maps the event onAction to the given action.

Parameters:

action - the action for the event

See Also:

getOnAction()

mappingOfOnAction

public IWDParameterMapping mappingOfOnAction()

Returns the parameter mapping of event onAction.

To be accessible in a view controller, a UI element event parameter has to be mapped to a controller event handler parameter. This is done by defining a parameter mapping.

Event parameters:

• String path - Path to the context element corresponding to the tree node that caused this action event.

Returns:

parameter mapping list.

See Also:

getOnAction()

bindDataSource

public void bindDataSource(java.lang.String path)

Note: This property must be bound to the context! Binds property dataSource to the context attribute specified by path.

Parameters:

path - the path of the context attribute to which the dataSource property is bound

bindDataSource

public void bindDataSource(IWDNodeInfo nodeInfo)

Note: This property must be bound to the context! Binds property dataSource to the context node specified by the given node info.

Parameters:

nodeInfo - the info of the context node to which the dataSource property is bound

bindingOfDataSource

public java.lang.String bindingOfDataSource()

Note: This property must be bound to the context! Binding path of property dataSource.

Returns:

the path of the context attribute to which the dataSource is currently bound

bindDesign

public void bindDesign(java.lang.String path)

Binds property design to the context attribute specified by path.

Parameters:

path - the path of the context attribute to which the design property is bound

bindDesign

public void bindDesign(IWDAttributeInfo attributeInfo)

Binds property design to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the design property is bound

bindingOfDesign

public java.lang.String bindingOfDesign()

Binding path of property design.

Returns:

the path of the context attribute to which the design is currently bound

getDesign

public WDTreeNodeDesign getDesign()

Returns the value of the design property. The initial value is WDTreeNodeDesign.STANDARD. Defines the appearance of the text of a TreeNode.

Returns:

the current value of the design property

See Also:

setDesign(WDTreeNodeDesign)

setDesign

public void setDesign(WDTreeNodeDesign value)

Sets property design to the new value.

Parameters:

value - the new value of the design property

See Also:

getDesign()

bindIconAlt

public void bindIconAlt(java.lang.String path)

Binds property iconAlt to the context attribute specified by path.

Parameters:

path - the path of the context attribute to which the iconAlt property is bound

bindIconAlt

public void bindIconAlt(IWDAttributeInfo attributeInfo)

Binds property iconAlt to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the iconAlt property is bound

bindingOfIconAlt

public java.lang.String bindingOfIconAlt()

Binding path of property iconAlt.

Returns:

the path of the context attribute to which the iconAlt is currently bound

getIconAlt

public java.lang.String getIconAlt()

Returns the value of the iconAlt property. The initial value is "".

Returns:

the current value of the iconAlt property

See Also:

setIconAlt(String)

setIconAlt

public void setIconAlt(java.lang.String value)

Sets property iconAlt to the new value.

Parameters:

value - the new value of the iconAlt property

See Also:

getIconAlt()

bindIconSource

public void bindIconSource(java.lang.String path)

Binds property iconSource to the context attribute specified by path.

Parameters:

path - the path of the context attribute to which the iconSource property is bound

bindIconSource

public void bindIconSource(IWDAttributeInfo attributeInfo)

Binds property iconSource to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the iconSource property is bound

bindingOfIconSource

public java.lang.String bindingOfIconSource()

Binding path of property iconSource.

Returns:

the path of the context attribute to which the iconSource is currently bound

getIconSource

public java.lang.String getIconSource()

Returns the value of the iconSource property. The initial value is "". Determines the URL where this icon gets its data.

Returns:

the current value of the iconSource property

See Also:

setIconSource(String)

setIconSource

public void setIconSource(java.lang.String value)

Sets property iconSource to the new value.

Parameters:

value - the new value of the iconSource property

See Also:

getIconSource()

bindIgnoreAction

public void bindIgnoreAction(java.lang.String path)

Binds property ignoreAction to the context attribute specified by path.

Parameters:

path - the path of the context attribute to which the ignoreAction property is bound

bindIgnoreAction

public void bindIgnoreAction(IWDAttributeInfo attributeInfo)

Binds property ignoreAction to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the ignoreAction property is bound

bindingOfIgnoreAction

public java.lang.String bindingOfIgnoreAction()

Binding path of property ignoreAction.

Returns:

the path of the context attribute to which the ignoreAction is currently bound

getIgnoreAction

public boolean getIgnoreAction()

Returns the value of the ignoreAction property. The initial value is false. Specifies wether the TreeNode should be displayed as link or not. By default every node that has an action attached to it is displayed as link. With this property this default behaviour is overwritten.

Returns:

the current value of the ignoreAction property

See Also:

setIgnoreAction(boolean)

setIgnoreAction

public void setIgnoreAction(boolean value)

Sets property ignoreAction to the new value.

Parameters:

value - the new value of the ignoreAction property

See Also:

getIgnoreAction()

bindText

public void bindText(java.lang.String path)

Binds property text to the context attribute specified by path.

Parameters:

path - the path of the context attribute to which the text property is bound

bindText

public void bindText(IWDAttributeInfo attributeInfo)

Binds property text to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the text property is bound

bindingOfText

public java.lang.String bindingOfText()

Binding path of property text.

Returns:

the path of the context attribute to which the text is currently bound

getText

public java.lang.String getText()

Returns the value of the text property. The initial value is "". The text used for nodes of this type.

Returns:

the current value of the text property

See Also:

setText(String)

setText

public void setText(java.lang.String value)

Sets property text to the new value.

Parameters:

value - the new value of the text property

See Also:

getText()

bindTextDirection

public void bindTextDirection(java.lang.String path)

Binds property textDirection to the context attribute specified by path.

Parameters:

path - the path of the context attribute to which the textDirection property is bound

bindTextDirection

public void bindTextDirection(IWDAttributeInfo attributeInfo)

Binds property textDirection to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the textDirection property is bound

bindingOfTextDirection

public java.lang.String bindingOfTextDirection()

Binding path of property textDirection.

Returns:

the path of the context attribute to which the textDirection is currently bound

getTextDirection

public WDTextDirection getTextDirection()

Returns the value of the textDirection property. The initial value is WDTextDirection.INHERIT. Determines the direction of displayed text.

Returns:

the current value of the textDirection property

See Also:

setTextDirection(WDTextDirection)

setTextDirection

public void setTextDirection(WDTextDirection value)

Sets property textDirection to the new value.

Parameters:

value - the new value of the textDirection property

See Also:

getTextDirection()

bindTooltip

public void bindTooltip(java.lang.String path)

Binds property tooltip to the context attribute specified by path.

Parameters:

path - the path of the context attribute to which the tooltip property is bound

bindTooltip

public void bindTooltip(IWDAttributeInfo attributeInfo)

Binds property tooltip to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the tooltip property is bound

bindingOfTooltip

public java.lang.String bindingOfTooltip()

Binding path of property tooltip.

Returns:

the path of the context attribute to which the tooltip is currently bound

getTooltip

public java.lang.String getTooltip()

Returns the value of the tooltip property. The initial value is "". The tooltip used for nodes of this type.

Returns:

the current value of the tooltip property

See Also:

setTooltip(String)

setTooltip

public void setTooltip(java.lang.String value)

Sets property tooltip to the new value.

Parameters:

value - the new value of the tooltip property

See Also:

getTooltip()

getTree

public IWDTree getTree()

Returns the current Tree. The nodes of a tree may be categorized into types, node types and item types. Node types may have nested nodes, item types can only be leafs.

Returns:

the current Tree