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

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

See Also:

IWDPatternContentArea, IWDPatternExpandFunction

Field Summary

static java.lang.String

DEFAULT_TITLE Default value of property title.

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 aPatternContentArea) Adds the given Item at the end of the list of Items.
void	addItem(IWDPatternContentArea aPatternContentArea, int index) Adds the given Item at the specified index in the list of Items.
java.lang.String	bindingOfTitle() Binding path of property title.
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	destroyAllItems() Destroys all entries in the list of Items.
IWDPatternContentArea	getItem(int index) Returns the Item at the given index.
IWDPatternContentArea[]	getItems() Returns the list of Items.
java.lang.String	getTitle() Returns the value of the title property.
boolean	hasItems() Checks if there exist Items.
int	indexOfItem(IWDPatternContentArea aPatternContentArea) Returns the index of the given element in the list of Items or -1 if it is not contained in the list.
java.util.Iterator	iterateItems() Returns an iterator over the list of Items.
int	numberOfItems() Returns the number of Items.
void	removeAllItems() Removes all entries from the list of Items.
IWDPatternContentArea	removeItem(int index) Removes the entry at the given index from the list of Items.
IWDPatternContentArea	removeItem(java.lang.String id) Removes the entry with the given ID from the list of Items.
void	setTitle(java.lang.String value) Sets property title to the new 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

getId, getView, requestFocus

Field Detail

DEFAULT_TITLE

public static final java.lang.String DEFAULT_TITLE

Default value of property title.

Method Detail

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 "". Determines the header text of a PatternTitle container.

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

addItem

public void addItem(IWDPatternContentArea aPatternContentArea)

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

Parameters:

aPatternContentArea - the Item to be added into the list

See Also:

getItems()

addItem

public void addItem(IWDPatternContentArea aPatternContentArea,
                    int index)

Adds the given Item at the specified index in the list of Items.

Parameters:

aPatternContentArea - the Item to be added into the list

index - zero based index of the 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 list of Items.

Returns:

an array containing references to the current Items

getItem

public IWDPatternContentArea getItem(int index)

Returns the Item at the given index.

Returns:

Item at the given index

indexOfItem

public int indexOfItem(IWDPatternContentArea aPatternContentArea)

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

numberOfItems

public int numberOfItems()

Returns the number of Items.

Returns:

the current number of Items.

See Also:

getItems()

hasItems

public boolean hasItems()

Checks if there exist Items.

Returns:

true if there are Items; false otherwise.

See Also:

getItems()

iterateItems

public java.util.Iterator iterateItems()

Returns an iterator over the list of Items.

Returns:

an iterator over the current Items

See Also:

getItems()

removeItem

public IWDPatternContentArea removeItem(int index)

Removes the entry at the given index from the list of Items. 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:

addItem(IWDPatternContentArea), getItems()

removeItem

public IWDPatternContentArea removeItem(java.lang.String id)

Removes the entry with the given ID from the list of Items. 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:

addItem(IWDPatternContentArea), getItems()

removeAllItems

public void removeAllItems()

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