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

All Superinterfaces:

IWDViewElement

public interface IWDPatternTab

extends IWDViewElement

Web Dynpro PatternTab API. PatternTab represents a single tab in a PatternTabStrip. A PatternTab contains a caption that may be activated to display the content of the PatternTab. Each PatternTab can contain several PatternContentAreas. Each area contains a UIElement or a ToolBar.

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

See Also:

IWDPatternContentArea, IWDPatternTabStrip

Field Summary

static boolean	DEFAULT_ENABLED Default value of property enabled.
static WDTextDirection	DEFAULT_TEXT_DIRECTION Default value of property textDirection.
static java.lang.String	DEFAULT_TITLE Default value of property title.
static java.lang.String	DEFAULT_TOOLTIP Default value of property tooltip.
static WDVisibility	DEFAULT_VISIBLE Default value of property 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.
void	bindEnabled(IWDAttributeInfo attributeInfo) Binds property enabled to the context attribute specified by the given attribute info.
void	bindEnabled(java.lang.String path) Binds property enabled to the context attribute specified by path.
java.lang.String	bindingOfEnabled() Binding path of property enabled.
java.lang.String	bindingOfTextDirection() Binding path of property textDirection.
java.lang.String	bindingOfTitle() Binding path of property title.
java.lang.String	bindingOfTooltip() Binding path of property tooltip.
java.lang.String	bindingOfVisible() Binding path of property visible.
void	bindTextDirection(IWDAttributeInfo attributeInfo) Binds property textDirection to the context attribute specified by the given attribute info.
void	bindTextDirection(java.lang.String path) Binds property textDirection to the context attribute specified by path.
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	bindTooltip(IWDAttributeInfo attributeInfo) Binds property tooltip to the context attribute specified by the given attribute info.
void	bindTooltip(java.lang.String path) Binds property tooltip to the context attribute specified by path.
void	bindVisible(IWDAttributeInfo attributeInfo) Binds property visible to the context attribute specified by the given attribute info.
void	bindVisible(java.lang.String path) Binds property visible to the context attribute specified by path.
void	destroyAllItems() Destroys all entries in the list of Items.
boolean	getEnabled() Returns the value of the enabled property.
IWDPatternContentArea	getItem(int index) Returns the Item at the given index.
IWDPatternContentArea[]	getItems() Returns the list of Items.
IWDPatternTabStrip	getPatternTabStrip() Returns the current PatternTabStrip.
WDTextDirection	getTextDirection() Returns the value of the textDirection property.
java.lang.String	getTitle() Returns the value of the title property.
java.lang.String	getTooltip() Returns the value of the tooltip property.
WDVisibility	getVisible() Returns the value of the visible 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	setEnabled(boolean value) Sets property enabled to the new value.
void	setTextDirection(WDTextDirection value) Sets property textDirection to the new value.
void	setTitle(java.lang.String value) Sets property title to the new value.
void	setTooltip(java.lang.String value) Sets property tooltip to the new value.
void	setVisible(WDVisibility value) Sets property visible 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.progmodel.api.IWDViewElement

getId, getView, requestFocus

Field Detail

DEFAULT_ENABLED

public static final boolean DEFAULT_ENABLED

Default value of property enabled.

DEFAULT_TEXT_DIRECTION

public static final WDTextDirection DEFAULT_TEXT_DIRECTION

Default value of property textDirection.

DEFAULT_TITLE

public static final java.lang.String DEFAULT_TITLE

Default value of property title.

DEFAULT_TOOLTIP

public static final java.lang.String DEFAULT_TOOLTIP

Default value of property tooltip.

DEFAULT_VISIBLE

public static final WDVisibility DEFAULT_VISIBLE

Default value of property visible.

Method Detail

bindEnabled

public void bindEnabled(java.lang.String path)

Binds property enabled to the context attribute specified by path.

Parameters:

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

bindEnabled

public void bindEnabled(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfEnabled

public java.lang.String bindingOfEnabled()

Binding path of property enabled.

Returns:

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

getEnabled

public boolean getEnabled()

Returns the value of the enabled property. The initial value is true. Determines whether the PatternTab is enabled.

Returns:

the current value of the enabled property

See Also:

setEnabled(boolean)

setEnabled

public void setEnabled(boolean value)

Sets property enabled to the new value.

Parameters:

value - the new value of the enabled property

See Also:

getEnabled()

bindTextDirection

public void bindTextDirection(java.lang.String path)

Binds property textDirection to the context attribute specified by path.

Parameters:

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

bindTextDirection

public void bindTextDirection(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfTextDirection

public java.lang.String bindingOfTextDirection()

Binding path of property textDirection.

Returns:

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

getTextDirection

public WDTextDirection getTextDirection()

Returns the value of the textDirection property. The initial value is WDTextDirection.INHERIT. The text-direction of the button text.

Returns:

the current value of the textDirection property

See Also:

setTextDirection(WDTextDirection)

setTextDirection

public void setTextDirection(WDTextDirection value)

Sets property textDirection to the new value.

Parameters:

value - the new value of the textDirection property

See Also:

getTextDirection()

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 title of the PatternTab control.

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

bindTooltip

public void bindTooltip(java.lang.String path)

Binds property tooltip to the context attribute specified by path.

Parameters:

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

bindTooltip

public void bindTooltip(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfTooltip

public java.lang.String bindingOfTooltip()

Binding path of property tooltip.

Returns:

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

getTooltip

public java.lang.String getTooltip()

Returns the value of the tooltip property. The initial value is "". The text that is displayed when the mouse cursor is moved onto the PatternTab.

Returns:

the current value of the tooltip property

See Also:

setTooltip(String)

setTooltip

public void setTooltip(java.lang.String value)

Sets property tooltip to the new value.

Parameters:

value - the new value of the tooltip property

See Also:

getTooltip()

bindVisible

public void bindVisible(java.lang.String path)

Binds property visible to the context attribute specified by path.

Parameters:

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

bindVisible

public void bindVisible(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfVisible

public java.lang.String bindingOfVisible()

Binding path of property visible.

Returns:

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

getVisible

public WDVisibility getVisible()

Returns the value of the visible property. The initial value is WDVisibility.VISIBLE. Determines whether the PatternTab is visible.

Returns:

the current value of the visible property

See Also:

setVisible(WDVisibility)

setVisible

public void setVisible(WDVisibility value)

Sets property visible to the new value.

Parameters:

value - the new value of the visible property

See Also:

getVisible()

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.

getPatternTabStrip

public IWDPatternTabStrip getPatternTabStrip()

Returns the current PatternTabStrip.

Returns:

the current PatternTabStrip