com.sap.tc.webdynpro.clientserver.uielib.pattern.api

Interface IWDPatternTray

All Superinterfaces:

IWDAbstractPatternContainer, IWDUIElement, IWDViewElement

public interface IWDPatternTray

extends IWDAbstractPatternContainer

Web Dynpro PatternTray API. Use the PatternTray control to create a Tray like control. It groups a number of UI elements under a common header. The PatternTray can contain a Menu and several PatternExpandFunction elements (for open/close buttons).

Note: To be used only by the Portal Platform group. Other usages by applications and customers WILL NOT BE SUPPORTED!

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

See Also:

IWDPatternContentArea, IWDPatternExpandFunction

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_TITLE Default value of the title property is "".

Fields inherited from interface com.sap.tc.webdynpro.clientserver.uielib.pattern.api.IWDAbstractPatternContainer

DEFAULT_ACCESSIBILITY_DESCRIPTION, DEFAULT_DESIGN, DEFAULT_HAS_CONTENT_CONNECTOR

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

DEFAULT_ENABLED, DEFAULT_TOOLTIP, DEFAULT_VISIBLE

Method Summary

void	addItem(IWDPatternContentArea item) Adds the given Item at the end of the Items list.
void	addItem(IWDPatternContentArea item, int index) Inserts the given Item at the specified (zero-based) index into the Items list.
String	bindingOfTitle() Returns the binding path of the title property.
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	destroyAllItems() Destroys all elements in the Items list.
IWDPatternContentArea	getItem(int index) Returns the Item at the given index.
IWDPatternContentArea[]	getItems() Returns the Items list as an array
String	getTitle() Returns the value of the title property.
boolean	hasItems() Returns true if there exists a Item.
int	indexOfItem(IWDPatternContentArea item) Returns the index of the given element in the Items list, returns -1 if the element is not in the list.
Iterator	iterateItems() Returns an iterator over the Items list.
int	numberOfItems() Returns the number of Items.
void	removeAllItems() Removes all elements from the Items list.
IWDPatternContentArea	removeItem(int index) Removes the Item at the given index from the Items list.
IWDPatternContentArea	removeItem(String id) Removes the Item with the given ID from the Items list.
void	setTitle(String value) Sets the title property to the given value.
void	swapItems(int i, int j) Swaps the Items at the given indices.

Methods inherited from interface com.sap.tc.webdynpro.clientserver.uielib.pattern.api.IWDAbstractPatternContainer

addExpandFunction, addExpandFunction, bindAccessibilityDescription, bindAccessibilityDescription, bindDesign, bindDesign, bindHasContentConnector, bindHasContentConnector, bindingOfAccessibilityDescription, bindingOfDesign, bindingOfHasContentConnector, destroyAllExpandFunctions, destroyPopupMenu, getAccessibilityDescription, getDesign, getExpandFunction, getExpandFunctions, getHasContentConnector, getPopupMenu, hasExpandFunctions, indexOfExpandFunction, iterateExpandFunctions, numberOfExpandFunctions, removeAllExpandFunctions, removeExpandFunction, removeExpandFunction, setAccessibilityDescription, setDesign, setHasContentConnector, setPopupMenu, swapExpandFunctions

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_TITLE

public static final String DEFAULT_TITLE

Default value of the title property is "".

See Also:

Constant Field Values

Method Detail

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 "".

Determines the header text of a PatternTitle container.

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

addItem

public void addItem(IWDPatternContentArea item)

Adds the given Item at the end of the Items list.

Parameters:

item - the Item to be added to the list

See Also:

getItems()

addItem

public void addItem(IWDPatternContentArea item,
                    int index)

Inserts the given Item at the specified (zero-based) index into the Items list.

Parameters:

item - the Item to be inserted into the list

index - (zero-based) insertion position in the list

See Also:

getItems()

swapItems

public void swapItems(int i,
                      int j)

Swaps the Items at the given indices.

Parameters:

i - index of the first Item to swap

j - index of the second Item to swap

Throws:

IndexOutOfBoundsException - If one of the indices is out of bounds

getItems

public IWDPatternContentArea[] getItems()

Returns the Items list as an array.

Returns:

an array containing the current Items list

getItem

public IWDPatternContentArea getItem(int index)

Returns the Item at the given index.

Returns:

Item at the given index

indexOfItem

public int indexOfItem(IWDPatternContentArea item)

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

numberOfItems

public int numberOfItems()

Returns the number of Items.

Returns:

the number of Items

See Also:

getItems()

hasItems

public boolean hasItems()

Returns true if there exists a Item.

Returns:

true if there exists a Item, otherwise returns false

See Also:

getItems()

iterateItems

public Iterator iterateItems()

Returns an iterator over the Items list.

Returns:

an iterator over the Items list

See Also:

getItems()

removeItem

public IWDPatternContentArea removeItem(int index)

Removes the Item at the given index from the Items 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:

addItem(IWDPatternContentArea), getItems()

removeItem

public IWDPatternContentArea removeItem(String id)

Removes the Item with the given ID from the Items 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:

addItem(IWDPatternContentArea), getItems()

removeAllItems

public void removeAllItems()

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

See Also:

addItem(IWDPatternContentArea), getItems()

destroyAllItems

public void destroyAllItems()

Destroys all elements in the Items list. Destroyed view elements do not exist any longer in their view, i.e. new elements may be created with the same IDs.