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

All Superinterfaces:

IWDUIElement, IWDViewElement

public interface IWDTabStrip

extends IWDUIElement

Web Dynpro TabStrip API. TabStrip is used to display a set of data organized in tabs. One tab at a time may be selected and its content by displayed. A tab is selected by clicking its caption.

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

See Also:

IWDTab

Field Summary

static java.lang.String	DEFAULT_ACCESSIBILITY_DESCRIPTION Default value of property accessibilityDescription.
static java.lang.String	DEFAULT_HEIGHT Default value of property height.
static java.lang.String	DEFAULT_SELECTED_TAB Default value of property selectedTab.
static WDTabAlignment	DEFAULT_TAB_ALIGNMENT Default value of property tabAlignment.
static java.lang.String	DEFAULT_WIDTH Default value of property width.

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

DEFAULT_ENABLED, DEFAULT_TOOLTIP, DEFAULT_VISIBLE

Method Summary

void	addTab(IWDTab aTab) Adds the given Tab at the end of the list of Tabs.
void	addTab(IWDTab aTab, int index) Adds the given Tab at the specified index in the list of Tabs.
void	bindAccessibilityDescription(IWDAttributeInfo attributeInfo) Binds property accessibilityDescription to the context attribute specified by the given attribute info.
void	bindAccessibilityDescription(java.lang.String path) Binds property accessibilityDescription to the context attribute specified by path.
void	bindHeight(IWDAttributeInfo attributeInfo) Binds property height to the context attribute specified by the given attribute info.
void	bindHeight(java.lang.String path) Binds property height to the context attribute specified by path.
java.lang.String	bindingOfAccessibilityDescription() Binding path of property accessibilityDescription.
java.lang.String	bindingOfHeight() Binding path of property height.
java.lang.String	bindingOfSelectedTab() Binding path of property selectedTab.
java.lang.String	bindingOfWidth() Binding path of property width.
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	bindWidth(IWDAttributeInfo attributeInfo) Binds property width to the context attribute specified by the given attribute info.
void	bindWidth(java.lang.String path) Binds property width to the context attribute specified by path.
void	destroyAllTabs() Destroys all entries in the list of Tabs.
java.lang.String	getAccessibilityDescription() Returns the value of the accessibilityDescription property.
java.lang.String	getHeight() Returns the value of the height property.
IWDAction	getOnSelect() Returns the action to which the event onSelect is mapped.
java.lang.String	getSelectedTab() Returns the value of the selectedTab property.
IWDTab	getTab(int index) Returns the Tab at the given index.
WDTabAlignment	getTabAlignment() Returns the value of the tabAlignment property.
IWDTab[]	getTabs() Returns the list of Tabs.
java.lang.String	getWidth() Returns the value of the width property.
boolean	hasTabs() Checks if there exist Tabs.
int	indexOfTab(IWDTab aTab) 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.
IWDTab	removeTab(int index) Removes the entry at the given index from the list of Tabs.
IWDTab	removeTab(java.lang.String id) Removes the entry with the given ID from the list of Tabs.
void	setAccessibilityDescription(java.lang.String value) Sets property accessibilityDescription to the new value.
void	setHeight(java.lang.String value) Sets property height 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	setTabAlignment(WDTabAlignment tabAlignment) Sets property tabAlignment to the given value.
void	setWidth(java.lang.String value) Sets property width 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.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_ACCESSIBILITY_DESCRIPTION

public static final java.lang.String DEFAULT_ACCESSIBILITY_DESCRIPTION

Default value of property accessibilityDescription.

DEFAULT_HEIGHT

public static final java.lang.String DEFAULT_HEIGHT

Default value of property height.

DEFAULT_SELECTED_TAB

public static final java.lang.String DEFAULT_SELECTED_TAB

Default value of property selectedTab.

DEFAULT_TAB_ALIGNMENT

public static final WDTabAlignment DEFAULT_TAB_ALIGNMENT

Default value of property tabAlignment.

DEFAULT_WIDTH

public static final java.lang.String DEFAULT_WIDTH

Default value of property width.

Method Detail

getOnSelect

public IWDAction getOnSelect()

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

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

Returns:

parameter mapping list.

See Also:

getOnSelect()

bindAccessibilityDescription

public void bindAccessibilityDescription(java.lang.String path)

Binds property accessibilityDescription to the context attribute specified by path.

Parameters:

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

bindAccessibilityDescription

public void bindAccessibilityDescription(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfAccessibilityDescription

public java.lang.String bindingOfAccessibilityDescription()

Binding path of property accessibilityDescription.

Returns:

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

getAccessibilityDescription

public java.lang.String getAccessibilityDescription()

Returns the value of the accessibilityDescription property. The initial value is "". Short description for the TabStrip (It's like a title) in the accessibility mode. It is only used if accessibility mode (508) is switched on and will be included into the tooltip. Its read by the screen reader when the whole UI element gets the focus.

Returns:

the current value of the accessibilityDescription property

See Also:

setAccessibilityDescription(String)

setAccessibilityDescription

public void setAccessibilityDescription(java.lang.String value)

Sets property accessibilityDescription to the new value.

Parameters:

value - the new value of the accessibilityDescription property

See Also:

getAccessibilityDescription()

bindHeight

public void bindHeight(java.lang.String path)

Binds property height to the context attribute specified by path.

Parameters:

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

bindHeight

public void bindHeight(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfHeight

public java.lang.String bindingOfHeight()

Binding path of property height.

Returns:

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

getHeight

public java.lang.String getHeight()

Returns the value of the height property. The initial value is "". Determines the height (CSS size) of the tab strip and its tabs.

Returns:

the current value of the height property

See Also:

setHeight(String)

setHeight

public void setHeight(java.lang.String value)

Sets property height to the new value.

Parameters:

value - the new value of the height property

See Also:

getHeight()

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

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

getTabAlignment

public WDTabAlignment getTabAlignment()

Returns the value of the tabAlignment property. The initial value is WDTabAlignment.FAST. Determines how each tab's width and height are aligned with the other tabs' widths and heights. BEWARE Forcing a browser based client to make all tabs equally wide and high is extremely inefficient.

Returns:

the value of the tabAlignment property

See Also:

setTabAlignment(WDTabAlignment)

setTabAlignment

public void setTabAlignment(WDTabAlignment tabAlignment)

Sets property tabAlignment to the given value.

Parameters:

tabAlignment - the new tabAlignment value

See Also:

getTabAlignment()

bindWidth

public void bindWidth(java.lang.String path)

Binds property width to the context attribute specified by path.

Parameters:

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

bindWidth

public void bindWidth(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfWidth

public java.lang.String bindingOfWidth()

Binding path of property width.

Returns:

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

getWidth

public java.lang.String getWidth()

Returns the value of the width property. The initial value is "". Determines the width (CSS size) of the tab strip and its tabs.

Returns:

the current value of the width property

See Also:

setWidth(String)

setWidth

public void setWidth(java.lang.String value)

Sets property width to the new value.

Parameters:

value - the new value of the width property

See Also:

getWidth()

addTab

public void addTab(IWDTab aTab)

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

Parameters:

aTab - the Tab to be added into the list

See Also:

getTabs()

addTab

public void addTab(IWDTab aTab,
                   int index)

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

Parameters:

aTab - 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 IWDTab[] getTabs()

Returns the list of Tabs. A tab strip consists of a number of tabs.

Returns:

an array containing references to the current Tabs

getTab

public IWDTab getTab(int index)

Returns the Tab at the given index.

Returns:

Tab at the given index

indexOfTab

public int indexOfTab(IWDTab aTab)

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 IWDTab 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(IWDTab), getTabs()

removeTab

public IWDTab 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(IWDTab), 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(IWDTab), 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.