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

All Superinterfaces:

IWDUIElement, IWDViewElement

public interface IWDTree

extends IWDUIElement

Web Dynpro Tree API. Tree is a UI element that displays hierarchically organized data.

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

Field Summary

static java.lang.String	DEFAULT_DEFAULT_ITEM_ICON_ALT Default value of property defaultItemIconAlt.
static java.lang.String	DEFAULT_DEFAULT_ITEM_ICON_SOURCE Default value of property defaultItemIconSource.
static java.lang.String	DEFAULT_DEFAULT_NODE_ICON_ALT Default value of property defaultNodeIconAlt.
static java.lang.String	DEFAULT_DEFAULT_NODE_ICON_SOURCE Default value of property defaultNodeIconSource.
static java.lang.String	DEFAULT_MIN_HEIGHT Default value of property minHeight.
static java.lang.String	DEFAULT_ROOT_TEXT Default value of property rootText.
static boolean	DEFAULT_ROOT_VISIBLE Default value of property rootVisible.
static java.lang.String	DEFAULT_TITLE Default value of property title.
static WDVisibility	DEFAULT_TITLE_VISIBLE Default value of property titleVisible.
static java.lang.String	DEFAULT_WIDTH Default value of property width.

Fields inherited from interface com.sap.tc.webdynpro.progmodel.api.IWDUIElement

DEFAULT_ENABLED, DEFAULT_TOOLTIP, DEFAULT_VISIBLE

Method Summary

void	addNodeType(IWDAbstractTreeNodeType aAbstractTreeNodeType) Adds the given NodeType at the end of the list of NodeTypes.
void	addNodeType(IWDAbstractTreeNodeType aAbstractTreeNodeType, int index) Adds the given NodeType at the specified index in the list of NodeTypes.
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	bindDefaultItemIconAlt(IWDAttributeInfo attributeInfo) Binds property defaultItemIconAlt to the context attribute specified by the given attribute info.
void	bindDefaultItemIconAlt(java.lang.String path) Binds property defaultItemIconAlt to the context attribute specified by path.
void	bindDefaultItemIconSource(IWDAttributeInfo attributeInfo) Binds property defaultItemIconSource to the context attribute specified by the given attribute info.
void	bindDefaultItemIconSource(java.lang.String path) Binds property defaultItemIconSource to the context attribute specified by path.
void	bindDefaultNodeIconAlt(IWDAttributeInfo attributeInfo) Binds property defaultNodeIconAlt to the context attribute specified by the given attribute info.
void	bindDefaultNodeIconAlt(java.lang.String path) Binds property defaultNodeIconAlt to the context attribute specified by path.
void	bindDefaultNodeIconSource(IWDAttributeInfo attributeInfo) Binds property defaultNodeIconSource to the context attribute specified by the given attribute info.
void	bindDefaultNodeIconSource(java.lang.String path) Binds property defaultNodeIconSource 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	bindingOfDefaultItemIconAlt() Binding path of property defaultItemIconAlt.
java.lang.String	bindingOfDefaultItemIconSource() Binding path of property defaultItemIconSource.
java.lang.String	bindingOfDefaultNodeIconAlt() Binding path of property defaultNodeIconAlt.
java.lang.String	bindingOfDefaultNodeIconSource() Binding path of property defaultNodeIconSource.
java.lang.String	bindingOfMinHeight() Binding path of property minHeight.
java.lang.String	bindingOfRootText() Binding path of property rootText.
java.lang.String	bindingOfRootVisible() Binding path of property rootVisible.
java.lang.String	bindingOfTitle() Binding path of property title.
java.lang.String	bindingOfTitleVisible() Binding path of property titleVisible.
java.lang.String	bindingOfWidth() Binding path of property width.
void	bindMinHeight(IWDAttributeInfo attributeInfo) Binds property minHeight to the context attribute specified by the given attribute info.
void	bindMinHeight(java.lang.String path) Binds property minHeight to the context attribute specified by path.
void	bindRootText(IWDAttributeInfo attributeInfo) Binds property rootText to the context attribute specified by the given attribute info.
void	bindRootText(java.lang.String path) Binds property rootText to the context attribute specified by path.
void	bindRootVisible(IWDAttributeInfo attributeInfo) Binds property rootVisible to the context attribute specified by the given attribute info.
void	bindRootVisible(java.lang.String path) Binds property rootVisible to the context attribute specified by path.
void	bindTitle(IWDAttributeInfo attributeInfo) Binds property title to the context attribute specified by the given attribute info.
void	bindTitle(java.lang.String path) Binds property title to the context attribute specified by path.
void	bindTitleVisible(IWDAttributeInfo attributeInfo) Binds property titleVisible to the context attribute specified by the given attribute info.
void	bindTitleVisible(java.lang.String path) Binds property titleVisible to the context attribute specified by path.
void	bindWidth(IWDAttributeInfo attributeInfo) Binds property width to the context attribute specified by the given attribute info.
void	bindWidth(java.lang.String path) Binds property width to the context attribute specified by path.
void	destroyAllNodeTypes() Destroys all entries in the list of NodeTypes.
java.lang.String	getDefaultItemIconAlt() Returns the value of the defaultItemIconAlt property.
java.lang.String	getDefaultItemIconSource() Returns the value of the defaultItemIconSource property.
java.lang.String	getDefaultNodeIconAlt() Returns the value of the defaultNodeIconAlt property.
java.lang.String	getDefaultNodeIconSource() Returns the value of the defaultNodeIconSource property.
java.lang.String	getMinHeight() Returns the value of the minHeight property.
IWDAbstractTreeNodeType	getNodeType(int index) Returns the NodeType at the given index.
IWDAbstractTreeNodeType[]	getNodeTypes() Returns the list of NodeTypes.
java.lang.String	getRootText() Returns the value of the rootText property.
boolean	getRootVisible() Returns the value of the rootVisible property.
java.lang.String	getTitle() Returns the value of the title property.
WDVisibility	getTitleVisible() Returns the value of the titleVisible property.
java.lang.String	getWidth() Returns the value of the width property.
boolean	hasNodeTypes() Checks if there exist NodeTypes.
int	indexOfNodeType(IWDAbstractTreeNodeType aAbstractTreeNodeType) Returns the index of the given element in the list of NodeTypes or -1 if it is not contained in the list.
java.util.Iterator	iterateNodeTypes() Returns an iterator over the list of NodeTypes.
int	numberOfNodeTypes() Returns the number of NodeTypes.
void	removeAllNodeTypes() Removes all entries from the list of NodeTypes.
IWDAbstractTreeNodeType	removeNodeType(int index) Removes the entry at the given index from the list of NodeTypes.
IWDAbstractTreeNodeType	removeNodeType(java.lang.String id) Removes the entry with the given ID from the list of NodeTypes.
void	setDefaultItemIconAlt(java.lang.String value) Sets property defaultItemIconAlt to the new value.
void	setDefaultItemIconSource(java.lang.String value) Sets property defaultItemIconSource to the new value.
void	setDefaultNodeIconAlt(java.lang.String value) Sets property defaultNodeIconAlt to the new value.
void	setDefaultNodeIconSource(java.lang.String value) Sets property defaultNodeIconSource to the new value.
void	setMinHeight(java.lang.String value) Sets property minHeight to the new value.
void	setRootText(java.lang.String value) Sets property rootText to the new value.
void	setRootVisible(boolean value) Sets property rootVisible to the new value.
void	setTitle(java.lang.String value) Sets property title to the new value.
void	setTitleVisible(WDVisibility value) Sets property titleVisible to the new value.
void	setWidth(java.lang.String value) Sets property width to the new value.
void	swapNodeTypes(int i, int j) Swaps the NodeTypes at the given indices.

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

bindEnabled, bindEnabled, bindingOfEnabled, bindingOfTooltip, bindingOfVisible, bindTooltip, bindTooltip, bindVisible, bindVisible, createLayoutData, getContainer, getEnabled, getLayoutData, getTooltip, getVisible, setEnabled, setTooltip, setVisible

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

getId, getView, requestFocus

Field Detail

DEFAULT_DEFAULT_ITEM_ICON_ALT

public static final java.lang.String DEFAULT_DEFAULT_ITEM_ICON_ALT

Default value of property defaultItemIconAlt.

DEFAULT_DEFAULT_ITEM_ICON_SOURCE

public static final java.lang.String DEFAULT_DEFAULT_ITEM_ICON_SOURCE

Default value of property defaultItemIconSource.

DEFAULT_DEFAULT_NODE_ICON_ALT

public static final java.lang.String DEFAULT_DEFAULT_NODE_ICON_ALT

Default value of property defaultNodeIconAlt.

DEFAULT_DEFAULT_NODE_ICON_SOURCE

public static final java.lang.String DEFAULT_DEFAULT_NODE_ICON_SOURCE

Default value of property defaultNodeIconSource.

DEFAULT_MIN_HEIGHT

public static final java.lang.String DEFAULT_MIN_HEIGHT

Default value of property minHeight.

DEFAULT_ROOT_TEXT

public static final java.lang.String DEFAULT_ROOT_TEXT

Default value of property rootText.

DEFAULT_ROOT_VISIBLE

public static final boolean DEFAULT_ROOT_VISIBLE

Default value of property rootVisible.

DEFAULT_TITLE

public static final java.lang.String DEFAULT_TITLE

Default value of property title.

DEFAULT_TITLE_VISIBLE

public static final WDVisibility DEFAULT_TITLE_VISIBLE

Default value of property titleVisible.

DEFAULT_WIDTH

public static final java.lang.String DEFAULT_WIDTH

Default value of property width.

Method Detail

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

bindDefaultItemIconAlt

public void bindDefaultItemIconAlt(java.lang.String path)

Binds property defaultItemIconAlt to the context attribute specified by path.

Parameters:

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

bindDefaultItemIconAlt

public void bindDefaultItemIconAlt(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfDefaultItemIconAlt

public java.lang.String bindingOfDefaultItemIconAlt()

Binding path of property defaultItemIconAlt.

Returns:

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

getDefaultItemIconAlt

public java.lang.String getDefaultItemIconAlt()

Returns the value of the defaultItemIconAlt property. The initial value is "". The alternative text displayed if the image cannot be displayed.

Returns:

the current value of the defaultItemIconAlt property

See Also:

setDefaultItemIconAlt(String)

setDefaultItemIconAlt

public void setDefaultItemIconAlt(java.lang.String value)

Sets property defaultItemIconAlt to the new value.

Parameters:

value - the new value of the defaultItemIconAlt property

See Also:

getDefaultItemIconAlt()

bindDefaultItemIconSource

public void bindDefaultItemIconSource(java.lang.String path)

Binds property defaultItemIconSource to the context attribute specified by path.

Parameters:

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

bindDefaultItemIconSource

public void bindDefaultItemIconSource(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfDefaultItemIconSource

public java.lang.String bindingOfDefaultItemIconSource()

Binding path of property defaultItemIconSource.

Returns:

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

getDefaultItemIconSource

public java.lang.String getDefaultItemIconSource()

Returns the value of the defaultItemIconSource property. The initial value is "". Determines the URL where this default icon for the Item gets its data.

Returns:

the current value of the defaultItemIconSource property

See Also:

setDefaultItemIconSource(String)

setDefaultItemIconSource

public void setDefaultItemIconSource(java.lang.String value)

Sets property defaultItemIconSource to the new value.

Parameters:

value - the new value of the defaultItemIconSource property

See Also:

getDefaultItemIconSource()

bindDefaultNodeIconAlt

public void bindDefaultNodeIconAlt(java.lang.String path)

Binds property defaultNodeIconAlt to the context attribute specified by path.

Parameters:

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

bindDefaultNodeIconAlt

public void bindDefaultNodeIconAlt(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfDefaultNodeIconAlt

public java.lang.String bindingOfDefaultNodeIconAlt()

Binding path of property defaultNodeIconAlt.

Returns:

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

getDefaultNodeIconAlt

public java.lang.String getDefaultNodeIconAlt()

Returns the value of the defaultNodeIconAlt property. The initial value is "". The alternative text displayed if the image cannot be displayed.

Returns:

the current value of the defaultNodeIconAlt property

See Also:

setDefaultNodeIconAlt(String)

setDefaultNodeIconAlt

public void setDefaultNodeIconAlt(java.lang.String value)

Sets property defaultNodeIconAlt to the new value.

Parameters:

value - the new value of the defaultNodeIconAlt property

See Also:

getDefaultNodeIconAlt()

bindDefaultNodeIconSource

public void bindDefaultNodeIconSource(java.lang.String path)

Binds property defaultNodeIconSource to the context attribute specified by path.

Parameters:

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

bindDefaultNodeIconSource

public void bindDefaultNodeIconSource(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfDefaultNodeIconSource

public java.lang.String bindingOfDefaultNodeIconSource()

Binding path of property defaultNodeIconSource.

Returns:

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

getDefaultNodeIconSource

public java.lang.String getDefaultNodeIconSource()

Returns the value of the defaultNodeIconSource property. The initial value is "". Determines the URL where this default icon for the Node gets its data.

Returns:

the current value of the defaultNodeIconSource property

See Also:

setDefaultNodeIconSource(String)

setDefaultNodeIconSource

public void setDefaultNodeIconSource(java.lang.String value)

Sets property defaultNodeIconSource to the new value.

Parameters:

value - the new value of the defaultNodeIconSource property

See Also:

getDefaultNodeIconSource()

bindMinHeight

public void bindMinHeight(java.lang.String path)

Binds property minHeight to the context attribute specified by path.

Parameters:

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

bindMinHeight

public void bindMinHeight(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfMinHeight

public java.lang.String bindingOfMinHeight()

Binding path of property minHeight.

Returns:

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

getMinHeight

public java.lang.String getMinHeight()

Returns the value of the minHeight property. The initial value is "". The minimal height of the tree given as a CSS size.

Returns:

the current value of the minHeight property

See Also:

setMinHeight(String)

setMinHeight

public void setMinHeight(java.lang.String value)

Sets property minHeight to the new value.

Parameters:

value - the new value of the minHeight property

See Also:

getMinHeight()

bindRootText

public void bindRootText(java.lang.String path)

Binds property rootText to the context attribute specified by path.

Parameters:

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

bindRootText

public void bindRootText(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfRootText

public java.lang.String bindingOfRootText()

Binding path of property rootText.

Returns:

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

getRootText

public java.lang.String getRootText()

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

Returns:

the current value of the rootText property

See Also:

setRootText(String)

setRootText

public void setRootText(java.lang.String value)

Sets property rootText to the new value.

Parameters:

value - the new value of the rootText property

See Also:

getRootText()

bindRootVisible

public void bindRootVisible(java.lang.String path)

Binds property rootVisible to the context attribute specified by path.

Parameters:

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

bindRootVisible

public void bindRootVisible(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfRootVisible

public java.lang.String bindingOfRootVisible()

Binding path of property rootVisible.

Returns:

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

getRootVisible

public boolean getRootVisible()

Returns the value of the rootVisible property. The initial value is true. Determines if the root of the tree is visible.

Returns:

the current value of the rootVisible property

See Also:

setRootVisible(boolean)

setRootVisible

public void setRootVisible(boolean value)

Sets property rootVisible to the new value.

Parameters:

value - the new value of the rootVisible property

See Also:

getRootVisible()

bindTitle

public void bindTitle(java.lang.String path)

Binds property title to the context attribute specified by path.

Parameters:

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

bindTitle

public void bindTitle(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfTitle

public java.lang.String bindingOfTitle()

Binding path of property title.

Returns:

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

getTitle

public java.lang.String getTitle()

Returns the value of the title property. The initial value is "". The title of the tree.

Returns:

the current value of the title property

See Also:

setTitle(String)

setTitle

public void setTitle(java.lang.String value)

Sets property title to the new value.

Parameters:

value - the new value of the title property

See Also:

getTitle()

bindTitleVisible

public void bindTitleVisible(java.lang.String path)

Binds property titleVisible to the context attribute specified by path.

Parameters:

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

bindTitleVisible

public void bindTitleVisible(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfTitleVisible

public java.lang.String bindingOfTitleVisible()

Binding path of property titleVisible.

Returns:

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

getTitleVisible

public WDVisibility getTitleVisible()

Returns the value of the titleVisible property. The initial value is WDVisibility.VISIBLE.

Returns:

the current value of the titleVisible property

See Also:

setTitleVisible(WDVisibility)

setTitleVisible

public void setTitleVisible(WDVisibility value)

Sets property titleVisible to the new value.

Parameters:

value - the new value of the titleVisible property

See Also:

getTitleVisible()

bindWidth

public void bindWidth(java.lang.String path)

Binds property width to the context attribute specified by path.

Parameters:

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

bindWidth

public void bindWidth(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfWidth

public java.lang.String bindingOfWidth()

Binding path of property width.

Returns:

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

getWidth

public java.lang.String getWidth()

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

Returns:

the current value of the width property

See Also:

setWidth(String)

setWidth

public void setWidth(java.lang.String value)

Sets property width to the new value.

Parameters:

value - the new value of the width property

See Also:

getWidth()

addNodeType

public void addNodeType(IWDAbstractTreeNodeType aAbstractTreeNodeType)

Adds the given NodeType at the end of the list of NodeTypes.

Parameters:

aAbstractTreeNodeType - the NodeType to be added into the list

See Also:

getNodeTypes()

addNodeType

public void addNodeType(IWDAbstractTreeNodeType aAbstractTreeNodeType,
                        int index)

Adds the given NodeType at the specified index in the list of NodeTypes.

Parameters:

aAbstractTreeNodeType - the NodeType to be added into the list

index - zero based index of the insertion position in the list

See Also:

getNodeTypes()

swapNodeTypes

public void swapNodeTypes(int i,
                          int j)

Swaps the NodeTypes at the given indices.

Parameters:

i - index of the first NodeType to swap

j - index of the second NodeType to swap

Throws:

IndexOutOfBoundsException - If one of the indices is out of bounds

getNodeTypes

public IWDAbstractTreeNodeType[] getNodeTypes()

Returns the list of NodeTypes. 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:

an array containing references to the current NodeTypes

getNodeType

public IWDAbstractTreeNodeType getNodeType(int index)

Returns the NodeType at the given index.

Returns:

NodeType at the given index

indexOfNodeType

public int indexOfNodeType(IWDAbstractTreeNodeType aAbstractTreeNodeType)

Returns the index of the given element in the list of NodeTypes or -1 if it is not contained in the list.

numberOfNodeTypes

public int numberOfNodeTypes()

Returns the number of NodeTypes.

Returns:

the current number of NodeTypes.

See Also:

getNodeTypes()

hasNodeTypes

public boolean hasNodeTypes()

Checks if there exist NodeTypes.

Returns:

true if there are NodeTypes; false otherwise.

See Also:

getNodeTypes()

iterateNodeTypes

public java.util.Iterator iterateNodeTypes()

Returns an iterator over the list of NodeTypes.

Returns:

an iterator over the current NodeTypes

See Also:

getNodeTypes()

removeNodeType

public IWDAbstractTreeNodeType removeNodeType(int index)

Removes the entry at the given index from the list of NodeTypes. This does not destroy the removed element, i.e. it may be added again!

Parameters:

index - zero based index of the deletion position in the list

Returns:

the removed element

See Also:

addNodeType(IWDAbstractTreeNodeType), getNodeTypes()

removeNodeType

public IWDAbstractTreeNodeType removeNodeType(java.lang.String id)

Removes the entry with the given ID from the list of NodeTypes. This does not destroy the removed element, i.e. it may be added again!

Parameters:

id - unique ID of the element to be deleted from the list

Returns:

the removed element

See Also:

addNodeType(IWDAbstractTreeNodeType), getNodeTypes()

removeAllNodeTypes

public void removeAllNodeTypes()

Removes all entries from the list of NodeTypes. This does not destroy the removed elements, i.e. they may be added again!

See Also:

addNodeType(IWDAbstractTreeNodeType), getNodeTypes()

destroyAllNodeTypes

public void destroyAllNodeTypes()

Destroys all entries in the list of NodeTypes. Destroyed elements do not exist any longer, i.e. new elements may be created with the same IDs.