com.sapportals.htmlb

Class TabStripItem

java.lang.Object
  com.sapportals.htmlb.Component
      com.sapportals.htmlb.Container
          com.sapportals.htmlb.TabStripItem

public class TabStripItem

extends Container

Field Summary

static String

UI_ID

Fields inherited from class com.sapportals.htmlb.Container

elements

Method Summary

Component	getBody() gets the body component of the TabStripItem.
Component	getHeader() gets the header of the TabStripItem.
String	getHeight() gets the height of this item.
int	getIndex() gets the index of this item.
String	getOnSelect() gets the event action for this item.
ForcedTextDirection	getTextDirection() Gets the text direction for the component
String	getTitle() gets the title of the TabStripItem
String	getTooltip() get the tooltip for the tab item
String	getUI() get a identification String for the renderer that is unique across all supported components.
String	getWidth() gets the width of this item
void	setBody(Component body) sets the body component of the TabStripItem.
void	setHeader(Component header) sets the header of the TabStripItem.
void	setHeight(String height) sets the height of this item.
void	setOnSelect(String onSelect) set an event action for the selection of this item.
void	setTextDirection(ForcedTextDirection textDirection) Sets the text direction for the component
void	setTitle(String title) sets the title of the TabStripItem.
void	setTooltip(String tooltip) sets the tooltip for the tab item.
void	setWidth(String width) sets the width of this item.

Methods inherited from class com.sapportals.htmlb.Container

addComponent, addRawText, addText, getChildCount, iterator, preRender, removeComponent, render

Methods inherited from class com.sapportals.htmlb.Component

getEncodedIdForForm, getId, getParent, initFromPageContext, initFromShortId, initializeFromId, isJsObjectNeeded, render, renderAsString, requiresForm, setId, setJsObjectNeeded, setParent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

UI_ID

public static final String UI_ID

See Also:

Constant Field Values

Method Detail

getUI

public String getUI()

Description copied from class: Component

get a identification String for the renderer that is unique across all supported components. E.g. you could simply return the class name of the component class. The reason for using a separate method and not some internal reflection method is that you can more easily extend the functionality or your Component class without having to rewrite the view class.

Specified by:

getUI in class Component

Returns:

a unique identification string for this Component

getTitle

public String getTitle()

gets the title of the TabStripItem

Returns:

the title

setTitle

public void setTitle(String title)

sets the title of the TabStripItem. Note that title and header are exclusive. Title is offered as a convenience so that you can easily set a simple text for the header.

Parameters:

title - the title

getHeader

public Component getHeader()

gets the header of the TabStripItem. Note that header and title are exclusive. If you use special components as header you might have to use the setTooltip method of that component to get a visible tooltip.

Returns:

the header component for this item

setHeader

public void setHeader(Component header)

sets the header of the TabStripItem. Note that header and title are exclusive. If you use special components as header you might have to use the setTooltip method of that component to get a visible tooltip.

Parameters:

header - the header component for this item

getBody

public Component getBody()

gets the body component of the TabStripItem.

Returns:

the body component for this item

setBody

public void setBody(Component body)

sets the body component of the TabStripItem. You can set an arbitrary component to be displayed within the TabStrip.

Parameters:

body - the body component for this item

getIndex

public int getIndex()

gets the index of this item. Indices need not be consecutive.

Returns:

the index if this item

getWidth

public String getWidth()

gets the width of this item

Returns:

the width of this item

setWidth

public void setWidth(String width)

sets the width of this item. You shouldn't actually set pixel widths using this method.

Parameters:

width - the width of this item

getHeight

public String getHeight()

gets the height of this item.

Returns:

the height of this item

setHeight

public void setHeight(String height)

sets the height of this item. You shouldn't actually set pixel heights using this method.

Parameters:

height - the height of this item

getTooltip

public String getTooltip()

get the tooltip for the tab item

Returns:

the string to be displayed as tooltip

setTooltip

public void setTooltip(String tooltip)

sets the tooltip for the tab item. Note that this tooltip might not be displayed correctly if you use complex components for the header of this item.

Parameters:

tooltip - the string to be displayed as tooltip

getOnSelect

public String getOnSelect()

gets the event action for this item.

Returns:

the event action associated with selecting this item.

setOnSelect

public void setOnSelect(String onSelect)

set an event action for the selection of this item.

Parameters:

onSelect - a string identifying the event

getTextDirection

public ForcedTextDirection getTextDirection()

Gets the text direction for the component

Returns:

com.sapportals.htmlb.enum.ForcedTextDirection

setTextDirection

public void setTextDirection(ForcedTextDirection textDirection)

Sets the text direction for the component

Parameters:

textDirection - com.sapportals.htmlb.enum.ForcedTextDirection