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

All Superinterfaces:

IWDAbstractTreeNodeType, IWDViewElement

public interface IWDTreeNodeType

extends IWDAbstractTreeNodeType

Web Dynpro TreeNodeType API. TreeNodeType is the type of tree nodes that may have nested nodes.

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

Field Summary

static boolean	DEFAULT_EXPANDED Default value of property expanded.
static boolean	DEFAULT_HAS_CHILDREN Default value of property hasChildren.

Fields inherited from interface com.sap.tc.webdynpro.clientserver.uielib.standard.api.IWDAbstractTreeNodeType

DEFAULT_DESIGN, DEFAULT_ICON_ALT, DEFAULT_ICON_SOURCE, DEFAULT_IGNORE_ACTION, DEFAULT_TEXT, DEFAULT_TEXT_DIRECTION, DEFAULT_TOOLTIP

Method Summary

void	bindExpanded(IWDAttributeInfo attributeInfo) Binds property expanded to the context attribute specified by the given attribute info.
void	bindExpanded(java.lang.String path) Binds property expanded to the context attribute specified by path.
void	bindHasChildren(IWDAttributeInfo attributeInfo) Binds property hasChildren to the context attribute specified by the given attribute info.
void	bindHasChildren(java.lang.String path) Binds property hasChildren to the context attribute specified by path.
java.lang.String	bindingOfExpanded() Binding path of property expanded.
java.lang.String	bindingOfHasChildren() Binding path of property hasChildren.
boolean	getExpanded() Returns the value of the expanded property.
boolean	getHasChildren() Returns the value of the hasChildren property.
IWDAction	getOnLoadChildren() Returns the action to which the event onLoadChildren is mapped.
IWDParameterMapping	mappingOfOnLoadChildren() Returns the parameter mapping of event onLoadChildren.
void	setExpanded(boolean value) Sets property expanded to the new value.
void	setHasChildren(boolean value) Sets property hasChildren to the new value.
void	setOnLoadChildren(IWDAction action) Maps the event onLoadChildren to the given action.

Methods inherited from interface com.sap.tc.webdynpro.clientserver.uielib.standard.api.IWDAbstractTreeNodeType

bindDataSource, bindDataSource, bindDesign, bindDesign, bindIconAlt, bindIconAlt, bindIconSource, bindIconSource, bindIgnoreAction, bindIgnoreAction, bindingOfDataSource, bindingOfDesign, bindingOfIconAlt, bindingOfIconSource, bindingOfIgnoreAction, bindingOfText, bindingOfTextDirection, bindingOfTooltip, bindText, bindText, bindTextDirection, bindTextDirection, bindTooltip, bindTooltip, getDesign, getIconAlt, getIconSource, getIgnoreAction, getOnAction, getText, getTextDirection, getTooltip, getTree, mappingOfOnAction, setDesign, setIconAlt, setIconSource, setIgnoreAction, setOnAction, setText, setTextDirection, setTooltip

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

getId, getView, requestFocus

Field Detail

DEFAULT_EXPANDED

public static final boolean DEFAULT_EXPANDED

Default value of property expanded.

DEFAULT_HAS_CHILDREN

public static final boolean DEFAULT_HAS_CHILDREN

Default value of property hasChildren.

Method Detail

getOnLoadChildren

public IWDAction getOnLoadChildren()

Returns the action to which the event onLoadChildren is mapped. Event that is caused when a tree node without children is expanded for the first time.

Returns:

the action to which the event is mapped

See Also:

mappingOfOnLoadChildren()

setOnLoadChildren

public void setOnLoadChildren(IWDAction action)

Maps the event onLoadChildren to the given action.

Parameters:

action - the action for the event

See Also:

getOnLoadChildren()

mappingOfOnLoadChildren

public IWDParameterMapping mappingOfOnLoadChildren()

Returns the parameter mapping of event onLoadChildren.

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 load children event.

Returns:

parameter mapping list.

See Also:

getOnLoadChildren()

bindExpanded

public void bindExpanded(java.lang.String path)

Binds property expanded to the context attribute specified by path.

Parameters:

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

bindExpanded

public void bindExpanded(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfExpanded

public java.lang.String bindingOfExpanded()

Binding path of property expanded.

Returns:

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

getExpanded

public boolean getExpanded()

Returns the value of the expanded property. The initial value is false. Determines if this node is currently expanded (i.e. open).

Returns:

the current value of the expanded property

See Also:

setExpanded(boolean)

setExpanded

public void setExpanded(boolean value)

Sets property expanded to the new value.

Parameters:

value - the new value of the expanded property

See Also:

getExpanded()

bindHasChildren

public void bindHasChildren(java.lang.String path)

Binds property hasChildren to the context attribute specified by path.

Parameters:

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

bindHasChildren

public void bindHasChildren(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfHasChildren

public java.lang.String bindingOfHasChildren()

Binding path of property hasChildren.

Returns:

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

getHasChildren

public boolean getHasChildren()

Returns the value of the hasChildren property. The initial value is true. Determines if this node has children

Returns:

the current value of the hasChildren property

See Also:

setHasChildren(boolean)

setHasChildren

public void setHasChildren(boolean value)

Sets property hasChildren to the new value.

Parameters:

value - the new value of the hasChildren property

See Also:

getHasChildren()