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

All Superinterfaces:

IWDAbstractPatternContainer, IWDUIElement, IWDViewElement

public interface IWDPatternTabStrip

extends IWDAbstractPatternContainer

Web Dynpro PatternTabStrip API. PatternTabStrip is used to display a set of data organized in tabs. One tab at a time may be selected and its content be displayed. A tab is selected by clicking its title. If not all tabs can be displayed, scrolling between the tabs is possible. The PatternTabStrip combines Tray funktionality with a TabStrip. The PatternTabStrip 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:

IWDPatternExpandFunction, IWDPatternTab

Field Summary

static int	DEFAULT_MAX_VISIBLE_TABS Default value of property maxVisibleTabs.
static java.lang.String	DEFAULT_SELECTED_TAB Default value of property selectedTab.

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	addTab(IWDPatternTab aPatternTab) Adds the given Tab at the end of the list of Tabs.
void	addTab(IWDPatternTab aPatternTab, int index) Adds the given Tab at the specified index in the list of Tabs.
java.lang.String	bindingOfMaxVisibleTabs() Binding path of property maxVisibleTabs.
java.lang.String	bindingOfSelectedTab() Binding path of property selectedTab.
void	bindMaxVisibleTabs(IWDAttributeInfo attributeInfo) Binds property maxVisibleTabs to the context attribute specified by the given attribute info.
void	bindMaxVisibleTabs(java.lang.String path) Binds property maxVisibleTabs to the context attribute specified by path.
void	bindSelectedTab(IWDAttributeInfo attributeInfo) Binds property selectedTab to the context attribute specified by the given attribute info.
void	bindSelectedTab(java.lang.String path) Binds property selectedTab to the context attribute specified by path.
void	destroyAllTabs() Destroys all entries in the list of Tabs.
int	getMaxVisibleTabs() Returns the value of the maxVisibleTabs property.
IWDAction	getOnSelect() Returns the action to which the event onSelect is mapped.
java.lang.String	getSelectedTab() Returns the value of the selectedTab property.
IWDPatternTab	getTab(int index) Returns the Tab at the given index.
IWDPatternTab[]	getTabs() Returns the list of Tabs.
boolean	hasTabs() Checks if there exist Tabs.
int	indexOfTab(IWDPatternTab aPatternTab) Returns the index of the given element in the list of Tabs or -1 if it is not contained in the list.
java.util.Iterator	iterateTabs() Returns an iterator over the list of Tabs.
IWDParameterMapping	mappingOfOnSelect() Returns the parameter mapping of event onSelect.
int	numberOfTabs() Returns the number of Tabs.
void	removeAllTabs() Removes all entries from the list of Tabs.
IWDPatternTab	removeTab(int index) Removes the entry at the given index from the list of Tabs.
IWDPatternTab	removeTab(java.lang.String id) Removes the entry with the given ID from the list of Tabs.
void	setMaxVisibleTabs(int value) Sets property maxVisibleTabs to the new value.
void	setOnSelect(IWDAction action) Maps the event onSelect to the given action.
void	setSelectedTab(java.lang.String value) Sets property selectedTab to the new value.
void	swapTabs(int i, int j) Swaps the Tabs 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_MAX_VISIBLE_TABS

public static final int DEFAULT_MAX_VISIBLE_TABS

Default value of property maxVisibleTabs.

DEFAULT_SELECTED_TAB

public static final java.lang.String DEFAULT_SELECTED_TAB

Default value of property selectedTab.

Method Detail

getOnSelect

public IWDAction getOnSelect()

Returns the action to which the event onSelect is mapped. The action performed when a PatternTab is selected. Event parameter is the ID of the selected PatternTab.

Returns:

the action to which the event is mapped

See Also:

mappingOfOnSelect()

setOnSelect

public void setOnSelect(IWDAction action)

Maps the event onSelect to the given action.

Parameters:

action - the action for the event

See Also:

getOnSelect()

mappingOfOnSelect

public IWDParameterMapping mappingOfOnSelect()

Returns the parameter mapping of event onSelect.

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 tab - The ID of the selected PatternTab.

Returns:

parameter mapping list.

See Also:

getOnSelect()

bindMaxVisibleTabs

public void bindMaxVisibleTabs(java.lang.String path)

Binds property maxVisibleTabs to the context attribute specified by path.

Parameters:

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

bindMaxVisibleTabs

public void bindMaxVisibleTabs(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfMaxVisibleTabs

public java.lang.String bindingOfMaxVisibleTabs()

Binding path of property maxVisibleTabs.

Returns:

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

getMaxVisibleTabs

public int getMaxVisibleTabs()

Returns the value of the maxVisibleTabs property. The initial value is 7. Sets the maximum number of visible items for the PatternTab control. If the PatternTabStrip contains more PatternTabs scrolling between PatternTabs is enabled.

Returns:

the current value of the maxVisibleTabs property

See Also:

setMaxVisibleTabs(int)

setMaxVisibleTabs

public void setMaxVisibleTabs(int value)

Sets property maxVisibleTabs to the new value.

Parameters:

value - the new value of the maxVisibleTabs property

See Also:

getMaxVisibleTabs()

bindSelectedTab

public void bindSelectedTab(java.lang.String path)

Binds property selectedTab to the context attribute specified by path.

Parameters:

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

bindSelectedTab

public void bindSelectedTab(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfSelectedTab

public java.lang.String bindingOfSelectedTab()

Binding path of property selectedTab.

Returns:

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

getSelectedTab

public java.lang.String getSelectedTab()

Returns the value of the selectedTab property. The initial value is "". Contains the ID of the currently selected PatternTab.

Returns:

the current value of the selectedTab property

See Also:

setSelectedTab(String)

setSelectedTab

public void setSelectedTab(java.lang.String value)

Sets property selectedTab to the new value.

Parameters:

value - the new value of the selectedTab property

See Also:

getSelectedTab()

addTab

public void addTab(IWDPatternTab aPatternTab)

Adds the given Tab at the end of the list of Tabs.

Parameters:

aPatternTab - the Tab to be added into the list

See Also:

getTabs()

addTab

public void addTab(IWDPatternTab aPatternTab,
                   int index)

Adds the given Tab at the specified index in the list of Tabs.

Parameters:

aPatternTab - the Tab to be added into the list

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

See Also:

getTabs()

swapTabs

public void swapTabs(int i,
                     int j)

Swaps the Tabs at the given indices.

Parameters:

i - index of the first Tab to swap

j - index of the second Tab to swap

Throws:

IndexOutOfBoundsException - If one of the indices is out of bounds

getTabs

public IWDPatternTab[] getTabs()

Returns the list of Tabs.

Returns:

an array containing references to the current Tabs

getTab

public IWDPatternTab getTab(int index)

Returns the Tab at the given index.

Returns:

Tab at the given index

indexOfTab

public int indexOfTab(IWDPatternTab aPatternTab)

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

numberOfTabs

public int numberOfTabs()

Returns the number of Tabs.

Returns:

the current number of Tabs.

See Also:

getTabs()

hasTabs

public boolean hasTabs()

Checks if there exist Tabs.

Returns:

true if there are Tabs; false otherwise.

See Also:

getTabs()

iterateTabs

public java.util.Iterator iterateTabs()

Returns an iterator over the list of Tabs.

Returns:

an iterator over the current Tabs

See Also:

getTabs()

removeTab

public IWDPatternTab removeTab(int index)

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

addTab(IWDPatternTab), getTabs()

removeTab

public IWDPatternTab removeTab(java.lang.String id)

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

addTab(IWDPatternTab), getTabs()

removeAllTabs

public void removeAllTabs()

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

See Also:

addTab(IWDPatternTab), getTabs()

destroyAllTabs

public void destroyAllTabs()

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