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

All Superinterfaces:

IWDViewElement

public interface IWDTab

extends IWDViewElement

Web Dynpro Tab API. The Tab element is an individual tab page within a tab strip. The tab consists of a header area, a content area, and an optional toolbar.

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

See Also:

IWDTabStrip

Field Summary

static boolean	DEFAULT_ENABLED Default value of property enabled.
static boolean	DEFAULT_HAS_CONTENT_PADDING Default value of property hasContentPadding.
static boolean	DEFAULT_VISIBLE Default value of property visible.

Method Summary

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.
void	bindHasContentPadding(IWDAttributeInfo attributeInfo) Binds property hasContentPadding to the context attribute specified by the given attribute info.
void	bindHasContentPadding(java.lang.String path) Binds property hasContentPadding to the context attribute specified by path.
java.lang.String	bindingOfEnabled() Binding path of property enabled.
java.lang.String	bindingOfHasContentPadding() Binding path of property hasContentPadding.
java.lang.String	bindingOfVisible() Binding path of property visible.
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	destroyContent() Destroys the Content instance.
void	destroyHeader() Destroys the Header instance.
void	destroyToolBar() Destroys the ToolBar instance.
IWDUIElement	getContent() Gets the Content instance.
boolean	getEnabled() Returns the value of the enabled property.
boolean	getHasContentPadding() Returns the value of the hasContentPadding property.
IWDCaption	getHeader() Gets the Header instance.
IWDTabStrip	getTabStrip() Returns the current TabStrip.
IWDToolBar	getToolBar() Gets the ToolBar instance.
boolean	getVisible() Returns the value of the visible property.
void	setContent(IWDUIElement content) Sets the Content instance.
void	setEnabled(boolean value) Sets property enabled to the new value.
void	setHasContentPadding(boolean value) Sets property hasContentPadding to the new value.
void	setHeader(IWDCaption header) Sets the Header instance.
void	setToolBar(IWDToolBar toolBar) Sets the ToolBar instance.
void	setVisible(boolean value) Sets property visible to the new value.

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_HAS_CONTENT_PADDING

public static final boolean DEFAULT_HAS_CONTENT_PADDING

Default value of property hasContentPadding.

DEFAULT_VISIBLE

public static final boolean 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. Specifies whether the tab can be activated to display its content

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

bindHasContentPadding

public void bindHasContentPadding(java.lang.String path)

Binds property hasContentPadding to the context attribute specified by path.

Parameters:

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

bindHasContentPadding

public void bindHasContentPadding(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfHasContentPadding

public java.lang.String bindingOfHasContentPadding()

Binding path of property hasContentPadding.

Returns:

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

getHasContentPadding

public boolean getHasContentPadding()

Returns the value of the hasContentPadding property. The initial value is true. Specifies if there is a padding around the content of the tab page.

Returns:

the current value of the hasContentPadding property

See Also:

setHasContentPadding(boolean)

setHasContentPadding

public void setHasContentPadding(boolean value)

Sets property hasContentPadding to the new value.

Parameters:

value - the new value of the hasContentPadding property

See Also:

getHasContentPadding()

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

Returns the value of the visible property. The initial value is true. Specifies whether the tab is displayed.

Returns:

the current value of the visible property

See Also:

setVisible(boolean)

setVisible

public void setVisible(boolean value)

Sets property visible to the new value.

Parameters:

value - the new value of the visible property

See Also:

getVisible()

getContent

public IWDUIElement getContent()

Gets the Content instance. A tab contains a UI element as its content.

Returns:

the current Content

See Also:

setContent(IWDUIElement)

setContent

public void setContent(IWDUIElement content)

Sets the Content instance.

Parameters:

content - the new content

See Also:

getContent()

destroyContent

public void destroyContent()

Destroys the Content instance. Destroyed elements do not exist any longer, i.e. a new element may be created with the same ID.

getHeader

public IWDCaption getHeader()

Gets the Header instance. The header of a tab contains a caption.

Returns:

the current Header

See Also:

setHeader(IWDCaption)

setHeader

public void setHeader(IWDCaption header)

Sets the Header instance.

Parameters:

header - the new header

See Also:

getHeader()

destroyHeader

public void destroyHeader()

Destroys the Header instance. Destroyed elements do not exist any longer, i.e. a new element may be created with the same ID.

getToolBar

public IWDToolBar getToolBar()

Gets the ToolBar instance. A tab may contain a toolbar.

Returns:

the current ToolBar

See Also:

setToolBar(IWDToolBar)

setToolBar

public void setToolBar(IWDToolBar toolBar)

Sets the ToolBar instance.

Parameters:

toolBar - the new toolBar

See Also:

getToolBar()

destroyToolBar

public void destroyToolBar()

Destroys the ToolBar instance. Destroyed elements do not exist any longer, i.e. a new element may be created with the same ID.

getTabStrip

public IWDTabStrip getTabStrip()

Returns the current TabStrip. A tab strip consists of a number of tabs.

Returns:

the current TabStrip