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!

Type Classification:

This interface is part of the Web Dynpro API, so applications may reference it or call any method of it, but they must not implement or extend it.

For a detailed explanation of API classification see the Web Dynpro Compatibility Guide

Field Summary

static String	DEFAULT_DEFAULT_ITEM_ICON_ALT Default value of the defaultItemIconAlt property is "".
static String	DEFAULT_DEFAULT_ITEM_ICON_SOURCE Default value of the defaultItemIconSource property is "".
static String	DEFAULT_DEFAULT_NODE_ICON_ALT Default value of the defaultNodeIconAlt property is "".
static String	DEFAULT_DEFAULT_NODE_ICON_SOURCE Default value of the defaultNodeIconSource property is "".
static String	DEFAULT_MIN_HEIGHT Default value of the minHeight property is "".
static String	DEFAULT_ROOT_TEXT Default value of the rootText property is "".
static boolean	DEFAULT_ROOT_VISIBLE Default value of the rootVisible property is true.
static WDLeadSelectionChangeBehaviour	DEFAULT_SELECTION_CHANGE_BEHAVIOUR Default value of the selectionChangeBehaviour property is WDLeadSelectionChangeBehaviour.AUTO.
static String	DEFAULT_TITLE Default value of the title property is "".
static WDVisibility	DEFAULT_TITLE_VISIBLE Default value of the titleVisible property is WDVisibility.VISIBLE.
static String	DEFAULT_WIDTH Default value of the width property is "".

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

DEFAULT_ENABLED, DEFAULT_TOOLTIP, DEFAULT_VISIBLE

Method Summary

void	addNodeType(IWDAbstractTreeNodeType nodeType) Adds the given NodeType at the end of the NodeTypes list.
void	addNodeType(IWDAbstractTreeNodeType nodeType, int index) Inserts the given NodeType at the specified (zero-based) index into the NodeTypes list.
void	bindDataSource(IWDNodeInfo nodeInfo) Binds the dataSource property to the context node specified by the given node info.
void	bindDataSource(String path) Binds the dataSource property to the context attribute specified by the given path.
void	bindDefaultItemIconAlt(IWDAttributeInfo attributeInfo) Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Unnecessary attribute if the tooltip contains semantic information about the image.
void	bindDefaultItemIconAlt(String path) Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Unnecessary attribute if the tooltip contains semantic information about the image.
void	bindDefaultItemIconSource(IWDAttributeInfo attributeInfo) Binds the defaultItemIconSource property to the context attribute specified by the given attribute info.
void	bindDefaultItemIconSource(String path) Binds the defaultItemIconSource property to the context attribute specified by the given path.
void	bindDefaultNodeIconAlt(IWDAttributeInfo attributeInfo) Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Unnecessary attribute if the tooltip contains semantic information about the image.
void	bindDefaultNodeIconAlt(String path) Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Unnecessary attribute if the tooltip contains semantic information about the image.
void	bindDefaultNodeIconSource(IWDAttributeInfo attributeInfo) Binds the defaultNodeIconSource property to the context attribute specified by the given attribute info.
void	bindDefaultNodeIconSource(String path) Binds the defaultNodeIconSource property to the context attribute specified by the given path.
String	bindingOfDataSource() Returns the binding path of the dataSource property.
String	bindingOfDefaultItemIconAlt() Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Unnecessary attribute if the tooltip contains semantic information about the image.
String	bindingOfDefaultItemIconSource() Returns the binding path of the defaultItemIconSource property.
String	bindingOfDefaultNodeIconAlt() Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Unnecessary attribute if the tooltip contains semantic information about the image.
String	bindingOfDefaultNodeIconSource() Returns the binding path of the defaultNodeIconSource property.
String	bindingOfMinHeight() Returns the binding path of the minHeight property.
String	bindingOfRootText() Returns the binding path of the rootText property.
String	bindingOfRootVisible() Returns the binding path of the rootVisible property.
String	bindingOfTitle() Returns the binding path of the title property.
String	bindingOfTitleVisible() Returns the binding path of the titleVisible property.
String	bindingOfWidth() Returns the binding path of the width property.
void	bindMinHeight(IWDAttributeInfo attributeInfo) Binds the minHeight property to the context attribute specified by the given attribute info.
void	bindMinHeight(String path) Binds the minHeight property to the context attribute specified by the given path.
void	bindRootText(IWDAttributeInfo attributeInfo) Binds the rootText property to the context attribute specified by the given attribute info.
void	bindRootText(String path) Binds the rootText property to the context attribute specified by the given path.
void	bindRootVisible(IWDAttributeInfo attributeInfo) Binds the rootVisible property to the context attribute specified by the given attribute info.
void	bindRootVisible(String path) Binds the rootVisible property to the context attribute specified by the given path.
void	bindTitle(IWDAttributeInfo attributeInfo) Binds the title property to the context attribute specified by the given attribute info.
void	bindTitle(String path) Binds the title property to the context attribute specified by the given path.
void	bindTitleVisible(IWDAttributeInfo attributeInfo) Binds the titleVisible property to the context attribute specified by the given attribute info.
void	bindTitleVisible(String path) Binds the titleVisible property to the context attribute specified by the given path.
void	bindWidth(IWDAttributeInfo attributeInfo) Binds the width property to the context attribute specified by the given attribute info.
void	bindWidth(String path) Binds the width property to the context attribute specified by the given path.
void	destroyAllNodeTypes() Destroys all elements in the NodeTypes list.
String	getDefaultItemIconAlt() Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Unnecessary attribute if the tooltip contains semantic information about the image.
String	getDefaultItemIconSource() Returns the value of the defaultItemIconSource property.
String	getDefaultNodeIconAlt() Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Unnecessary attribute if the tooltip contains semantic information about the image.
String	getDefaultNodeIconSource() Returns the value of the defaultNodeIconSource property.
String	getMinHeight() Returns the value of the minHeight property.
IWDAbstractTreeNodeType	getNodeType(int index) Returns the NodeType at the given index.
IWDAbstractTreeNodeType[]	getNodeTypes() Returns the NodeTypes list as an array.
String	getRootText() Returns the value of the rootText property.
boolean	getRootVisible() Returns the value of the rootVisible property.
WDLeadSelectionChangeBehaviour	getSelectionChangeBehaviour() Returns the value of the selectionChangeBehaviour property.
String	getTitle() Returns the value of the title property.
WDVisibility	getTitleVisible() Returns the value of the titleVisible property.
String	getWidth() Returns the value of the width property.
boolean	hasNodeTypes() Returns true if there exists a NodeType.
int	indexOfNodeType(IWDAbstractTreeNodeType nodeType) Returns the index of the given element in the NodeTypes list, returns -1 if the element is not in the list.
Iterator	iterateNodeTypes() Returns an iterator over the NodeTypes list.
int	numberOfNodeTypes() Returns the number of NodeTypes.
void	removeAllNodeTypes() Removes all elements from the NodeTypes list.
IWDAbstractTreeNodeType	removeNodeType(int index) Removes the NodeType at the given index from the NodeTypes list.
IWDAbstractTreeNodeType	removeNodeType(String id) Removes the NodeType with the given ID from the NodeTypes list.
void	setDefaultItemIconAlt(String value) Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Unnecessary attribute if the tooltip contains semantic information about the image.
void	setDefaultItemIconSource(String value) Sets the defaultItemIconSource property to the given value.
void	setDefaultNodeIconAlt(String value) Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Unnecessary attribute if the tooltip contains semantic information about the image.
void	setDefaultNodeIconSource(String value) Sets the defaultNodeIconSource property to the given value.
void	setMinHeight(String value) Sets the minHeight property to the given value.
void	setRootText(String value) Sets the rootText property to the given value.
void	setRootVisible(boolean value) Sets the rootVisible property to the given value.
void	setSelectionChangeBehaviour(WDLeadSelectionChangeBehaviour selectionChangeBehaviour) Sets the selectionChangeBehaviour property to the given value.
void	setTitle(String value) Sets the title property to the given value.
void	setTitleVisible(WDVisibility value) Sets the titleVisible property to the given value.
void	setWidth(String value) Sets the width property to the given 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

destroy, getId, getView, requestFocus

Field Detail

DEFAULT_DEFAULT_ITEM_ICON_ALT

public static final String DEFAULT_DEFAULT_ITEM_ICON_ALT

Default value of the defaultItemIconAlt property is "".

See Also:

Constant Field Values

DEFAULT_DEFAULT_ITEM_ICON_SOURCE

public static final String DEFAULT_DEFAULT_ITEM_ICON_SOURCE

Default value of the defaultItemIconSource property is "".

See Also:

Constant Field Values

DEFAULT_DEFAULT_NODE_ICON_ALT

public static final String DEFAULT_DEFAULT_NODE_ICON_ALT

Default value of the defaultNodeIconAlt property is "".

See Also:

Constant Field Values

DEFAULT_DEFAULT_NODE_ICON_SOURCE

public static final String DEFAULT_DEFAULT_NODE_ICON_SOURCE

Default value of the defaultNodeIconSource property is "".

See Also:

Constant Field Values

DEFAULT_MIN_HEIGHT

public static final String DEFAULT_MIN_HEIGHT

Default value of the minHeight property is "".

See Also:

Constant Field Values

DEFAULT_ROOT_TEXT

public static final String DEFAULT_ROOT_TEXT

Default value of the rootText property is "".

See Also:

Constant Field Values

DEFAULT_ROOT_VISIBLE

public static final boolean DEFAULT_ROOT_VISIBLE

Default value of the rootVisible property is true.

See Also:

Constant Field Values

DEFAULT_SELECTION_CHANGE_BEHAVIOUR

public static final WDLeadSelectionChangeBehaviour DEFAULT_SELECTION_CHANGE_BEHAVIOUR

Default value of the selectionChangeBehaviour property is WDLeadSelectionChangeBehaviour.AUTO.

DEFAULT_TITLE

public static final String DEFAULT_TITLE

Default value of the title property is "".

See Also:

Constant Field Values

DEFAULT_TITLE_VISIBLE

public static final WDVisibility DEFAULT_TITLE_VISIBLE

Default value of the titleVisible property is WDVisibility.VISIBLE.

DEFAULT_WIDTH

public static final String DEFAULT_WIDTH

Default value of the width property is "".

See Also:

Constant Field Values

Method Detail

bindDataSource

public void bindDataSource(String path)

Binds the dataSource property to the context attribute specified by the given path.

Note: This property must be bound to the context!

Parameters:

path - the context path of the attribute to which the dataSource property will be bound

bindDataSource

public void bindDataSource(IWDNodeInfo nodeInfo)

Binds the dataSource property to the context node specified by the given node info.

Note: This property must be bound to the context!

Parameters:

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

bindingOfDataSource

public String bindingOfDataSource()

Returns the binding path of the dataSource property.

Note: This property must be bound to the context!

Returns:

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

bindDefaultItemIconAlt

public void bindDefaultItemIconAlt(String path)

Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Unnecessary attribute if the tooltip contains semantic information about the image.

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

Parameters:

path - the context path of the attribute to which the defaultItemIconAlt property will be bound

bindDefaultItemIconAlt

public void bindDefaultItemIconAlt(IWDAttributeInfo attributeInfo)

Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Unnecessary attribute if the tooltip contains semantic information about the image.

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

Parameters:

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

bindingOfDefaultItemIconAlt

public String bindingOfDefaultItemIconAlt()

Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Unnecessary attribute if the tooltip contains semantic information about the image.

Returns the binding path of the defaultItemIconAlt property.

Returns:

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

getDefaultItemIconAlt

public String getDefaultItemIconAlt()

Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Unnecessary attribute if the tooltip contains semantic information about the image.

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(String value)

Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Unnecessary attribute if the tooltip contains semantic information about the image.

Sets the defaultItemIconAlt property to the given value.

Parameters:

value - the new value of the defaultItemIconAlt property

See Also:

getDefaultItemIconAlt()

bindDefaultItemIconSource

public void bindDefaultItemIconSource(String path)

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

Parameters:

path - the context path of the attribute to which the defaultItemIconSource property will be bound

bindDefaultItemIconSource

public void bindDefaultItemIconSource(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfDefaultItemIconSource

public String bindingOfDefaultItemIconSource()

Returns the binding path of the defaultItemIconSource property.

Returns:

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

getDefaultItemIconSource

public 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(String value)

Sets the defaultItemIconSource property to the given value.

Parameters:

value - the new value of the defaultItemIconSource property

See Also:

getDefaultItemIconSource()

bindDefaultNodeIconAlt

public void bindDefaultNodeIconAlt(String path)

Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Unnecessary attribute if the tooltip contains semantic information about the image.

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

Parameters:

path - the context path of the attribute to which the defaultNodeIconAlt property will be bound

bindDefaultNodeIconAlt

public void bindDefaultNodeIconAlt(IWDAttributeInfo attributeInfo)

Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Unnecessary attribute if the tooltip contains semantic information about the image.

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

Parameters:

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

bindingOfDefaultNodeIconAlt

public String bindingOfDefaultNodeIconAlt()

Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Unnecessary attribute if the tooltip contains semantic information about the image.

Returns the binding path of the defaultNodeIconAlt property.

Returns:

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

getDefaultNodeIconAlt

public String getDefaultNodeIconAlt()

Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Unnecessary attribute if the tooltip contains semantic information about the image.

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(String value)

Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Unnecessary attribute if the tooltip contains semantic information about the image.

Sets the defaultNodeIconAlt property to the given value.

Parameters:

value - the new value of the defaultNodeIconAlt property

See Also:

getDefaultNodeIconAlt()

bindDefaultNodeIconSource

public void bindDefaultNodeIconSource(String path)

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

Parameters:

path - the context path of the attribute to which the defaultNodeIconSource property will be bound

bindDefaultNodeIconSource

public void bindDefaultNodeIconSource(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfDefaultNodeIconSource

public String bindingOfDefaultNodeIconSource()

Returns the binding path of the defaultNodeIconSource property.

Returns:

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

getDefaultNodeIconSource

public 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(String value)

Sets the defaultNodeIconSource property to the given value.

Parameters:

value - the new value of the defaultNodeIconSource property

See Also:

getDefaultNodeIconSource()

bindMinHeight

public void bindMinHeight(String path)

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

Parameters:

path - the context path of the attribute to which the minHeight property will be bound

bindMinHeight

public void bindMinHeight(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfMinHeight

public String bindingOfMinHeight()

Returns the binding path of the minHeight property.

Returns:

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

getMinHeight

public 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(String value)

Sets the minHeight property to the given value.

Parameters:

value - the new value of the minHeight property

See Also:

getMinHeight()

bindRootText

public void bindRootText(String path)

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

Parameters:

path - the context path of the attribute to which the rootText property will be bound

bindRootText

public void bindRootText(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfRootText

public String bindingOfRootText()

Returns the binding path of the rootText property.

Returns:

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

getRootText

public 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(String value)

Sets the rootText property to the given value.

Parameters:

value - the new value of the rootText property

See Also:

getRootText()

bindRootVisible

public void bindRootVisible(String path)

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

Parameters:

path - the context path of the attribute to which the rootVisible property will be bound

bindRootVisible

public void bindRootVisible(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfRootVisible

public String bindingOfRootVisible()

Returns the binding path of the rootVisible property.

Returns:

the path of the context attribute to which the rootVisible property 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 the rootVisible property to the given value.

Parameters:

value - the new value of the rootVisible property

See Also:

getRootVisible()

getSelectionChangeBehaviour

public WDLeadSelectionChangeBehaviour getSelectionChangeBehaviour()

Returns the value of the selectionChangeBehaviour property. The initial value is WDLeadSelectionChangeBehaviour.AUTO. Determines how this UI element reacts to user interactions with respect to (automatically) changing the data source's lead selection.

Returns:

the value of the selectionChangeBehaviour property

See Also:

setSelectionChangeBehaviour(WDLeadSelectionChangeBehaviour)

setSelectionChangeBehaviour

public void setSelectionChangeBehaviour(WDLeadSelectionChangeBehaviour selectionChangeBehaviour)

Sets the selectionChangeBehaviour property to the given value.

Parameters:

selectionChangeBehaviour - the new value of the selectionChangeBehaviour property

See Also:

getSelectionChangeBehaviour()

bindTitle

public void bindTitle(String path)

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

Parameters:

path - the context path of the attribute to which the title property will be bound

bindTitle

public void bindTitle(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfTitle

public String bindingOfTitle()

Returns the binding path of the title property.

Returns:

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

getTitle

public 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(String value)

Sets the title property to the given value.

Parameters:

value - the new value of the title property

See Also:

getTitle()

bindTitleVisible

public void bindTitleVisible(String path)

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

Parameters:

path - the context path of the attribute to which the titleVisible property will be bound

bindTitleVisible

public void bindTitleVisible(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfTitleVisible

public String bindingOfTitleVisible()

Returns the binding path of the titleVisible property.

Returns:

the path of the context attribute to which the titleVisible property 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 the titleVisible property to the given value.

Parameters:

value - the new value of the titleVisible property

See Also:

getTitleVisible()

bindWidth

public void bindWidth(String path)

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

Parameters:

path - the context path of the attribute to which the width property will be bound

bindWidth

public void bindWidth(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfWidth

public String bindingOfWidth()

Returns the binding path of the width property.

Returns:

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

getWidth

public 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(String value)

Sets the width property to the given value.

Parameters:

value - the new value of the width property

See Also:

getWidth()

addNodeType

public void addNodeType(IWDAbstractTreeNodeType nodeType)

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

Parameters:

nodeType - the NodeType to be added to the list

See Also:

getNodeTypes()

addNodeType

public void addNodeType(IWDAbstractTreeNodeType nodeType,
                        int index)

Inserts the given NodeType at the specified (zero-based) index into the NodeTypes list.

Parameters:

nodeType - the NodeType to be inserted into the list

index - (zero-based) 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 NodeTypes list as an array. 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 the current NodeTypes list

getNodeType

public IWDAbstractTreeNodeType getNodeType(int index)

Returns the NodeType at the given index.

Returns:

NodeType at the given index

indexOfNodeType

public int indexOfNodeType(IWDAbstractTreeNodeType nodeType)

Returns the index of the given element in the NodeTypes list, returns -1 if the element is not in the list.

numberOfNodeTypes

public int numberOfNodeTypes()

Returns the number of NodeTypes.

Returns:

the number of NodeTypes

See Also:

getNodeTypes()

hasNodeTypes

public boolean hasNodeTypes()

Returns true if there exists a NodeType.

Returns:

true if there exists a NodeType, otherwise returns false

See Also:

getNodeTypes()

iterateNodeTypes

public Iterator iterateNodeTypes()

Returns an iterator over the NodeTypes list.

Returns:

an iterator over the NodeTypes list

See Also:

getNodeTypes()

removeNodeType

public IWDAbstractTreeNodeType removeNodeType(int index)

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

Parameters:

index - (zero-based) index of the removal position in the list

Returns:

the removed element

See Also:

addNodeType(IWDAbstractTreeNodeType), getNodeTypes()

removeNodeType

public IWDAbstractTreeNodeType removeNodeType(String id)

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

Parameters:

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

Returns:

the removed element

See Also:

addNodeType(IWDAbstractTreeNodeType), getNodeTypes()

removeAllNodeTypes

public void removeAllNodeTypes()

Removes all elements from the NodeTypes list. 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 elements in the NodeTypes list. Destroyed view elements do not exist any longer in their view, i.e. new elements may be created with the same IDs.