nextapp.echo2.extras.app
Class TabPane

java.lang.Object
  Component
      nextapp.echo2.extras.app.TabPane

public class TabPane
extends Component

A container pane which displays child components in separate tabs.

Field Summary

static java.lang.String	ACTIVE_TAB_INDEX_CHANGED_PROPERTY
static int	BORDER_TYPE_ADJACENT_TO_TABS Constant for the borderType property indicating that a border should be drawn immediately adjacent to the tabs only.
static int	BORDER_TYPE_NONE Constant for the borderType property indicating that no border should be drawn around the content.
static int	BORDER_TYPE_PARALLEL_TO_TABS Constant for the borderType property indicating that borders should be drawn above and below the content, but not at its sides.
static int	BORDER_TYPE_SURROUND Constant for the borderType property indicating that borders should be drawn on all sides of the content.
static java.lang.String	INPUT_TAB_INDEX
static java.lang.String	PROPERTY_BORDER_TYPE
static java.lang.String	PROPERTY_DEFAULT_CONTENT_INSETS
static java.lang.String	PROPERTY_INSETS
static java.lang.String	PROPERTY_TAB_ACTIVE_BACKGROUND
static java.lang.String	PROPERTY_TAB_ACTIVE_BACKGROUND_IMAGE
static java.lang.String	PROPERTY_TAB_ACTIVE_BORDER
static java.lang.String	PROPERTY_TAB_ACTIVE_FONT
static java.lang.String	PROPERTY_TAB_ACTIVE_FOREGROUND
static java.lang.String	PROPERTY_TAB_HEIGHT
static java.lang.String	PROPERTY_TAB_INACTIVE_BACKGROUND
static java.lang.String	PROPERTY_TAB_INACTIVE_BACKGROUND_IMAGE
static java.lang.String	PROPERTY_TAB_INACTIVE_BORDER
static java.lang.String	PROPERTY_TAB_INACTIVE_FONT
static java.lang.String	PROPERTY_TAB_INACTIVE_FOREGROUND
static java.lang.String	PROPERTY_TAB_INSET
static java.lang.String	PROPERTY_TAB_POSITION
static java.lang.String	PROPERTY_TAB_SPACING
static java.lang.String	PROPERTY_TAB_WIDTH
static int	TAB_POSITION_BOTTOM Constant for the tabPosition property indicating that the tabs should be rendered beneath the content.
static int	TAB_POSITION_TOP Constant for the tabPosition property indicating that the tabs should be rendered above the content.

Constructor Summary

TabPane()

Method Summary

int	getActiveTabIndex() Returns the index of the active tab.
int	getBorderType() Returns the mode in which the border will be drawn around the TabPane.
Insets	getDefaultContentInsets() Returns the default content inset margin.
Insets	getInsets() Returns the Insets around the entire TabPane.
Color	getTabActiveBackground() Returns the background color used to render active tabs.
FillImage	getTabActiveBackgroundImage() Returns the background image used to render active tabs.
Border	getTabActiveBorder() Returns the Border used to draw the active tab and surround the content of the TabPane.
Font	getTabActiveFont() Returns the font used to render active tabs.
Color	getTabActiveForeground() Returns the foreground color used to render active tabs.
Extent	getTabHeight() Returns the height of an individual tab.
Color	getTabInactiveBackground() Returns the background color used to render inactive tabs.
FillImage	getTabInactiveBackgroundImage() Returns the background image used to render inactive tabs.
Border	getTabInactiveBorder() Returns the Border used to draw inactive tabs.
Font	getTabInactiveFont() Returns the font used to render inactive tabs.
Color	getTabInactiveForeground() Returns the foreground color used to render inactive tabs.
Extent	getTabInset() Returns the horizontal distance from which all tabs are inset from the edge of the TabPane.
int	getTabPosition() Returns the position where the tabs are located relative to the pane content.
Extent	getTabSpacing() Returns the horizontal space between individual tabs.
Extent	getTabWidth() Returns the width of an individual tab.
boolean	isValidParent(Component c)
void	processInput(java.lang.String inputName, java.lang.Object inputValue)
void	setActiveTabIndex(int newValue) Sets the active tab index.
void	setBorderType(int newValue) Sets the mode in which the border will be drawn around the TabPane.
void	setDefaultContentInsets(Insets newValue) Sets the default content inset margin.
void	setInsets(Insets newValue) Sets the Insets around the entire TabPane.
void	setTabActiveBackground(Color newValue) Sets the background color used to render active tabs.
void	setTabActiveBackgroundImage(FillImage newValue) Sets the background image used to render active tabs.
void	setTabActiveBorder(Border newValue) Sets the Border used to draw the active tab and surround the content of the TabPane.
void	setTabActiveFont(Font newValue) Sets the font used to render active tabs.
void	setTabActiveForeground(Color newValue) Sets the foreground color used to render active tabs.
void	setTabHeight(Extent newValue) Sets the height of an individual tab.
void	setTabInactiveBackground(Color newValue) Sets the background color used to render inactive tabs.
void	setTabInactiveBackgroundImage(FillImage newValue) Sets the background image used to render inactive tabs.
void	setTabInactiveBorder(Border newValue) Sets the Border used to draw inactive tabs in the TabPane.
void	setTabInactiveFont(Font newValue) Sets the font used to render inactive tabs.
void	setTabInactiveForeground(Color newValue) Sets the foreground color used to render inactive tabs.
void	setTabInset(Extent newValue) Sets the horizontal distance from which all tabs are inset from the edge of the TabPane.
void	setTabPosition(int newValue) Sets the position where the tabs are located relative to the pane content.
void	setTabSpacing(Extent newValue) Sets the horizontal space between individual tabs.
void	setTabWidth(Extent newValue) Sets the width of an individual tab.

Methods inherited from class java.lang.Object

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

Field Detail

INPUT_TAB_INDEX

public static final java.lang.String INPUT_TAB_INDEX

See Also:

Constant Field Values

ACTIVE_TAB_INDEX_CHANGED_PROPERTY

public static final java.lang.String ACTIVE_TAB_INDEX_CHANGED_PROPERTY

See Also:

Constant Field Values

PROPERTY_BORDER_TYPE

public static final java.lang.String PROPERTY_BORDER_TYPE

See Also:

Constant Field Values

PROPERTY_DEFAULT_CONTENT_INSETS

public static final java.lang.String PROPERTY_DEFAULT_CONTENT_INSETS

See Also:

Constant Field Values

PROPERTY_INSETS

public static final java.lang.String PROPERTY_INSETS

See Also:

Constant Field Values

PROPERTY_TAB_ACTIVE_BACKGROUND

public static final java.lang.String PROPERTY_TAB_ACTIVE_BACKGROUND

See Also:

Constant Field Values

PROPERTY_TAB_ACTIVE_BACKGROUND_IMAGE

public static final java.lang.String PROPERTY_TAB_ACTIVE_BACKGROUND_IMAGE

See Also:

Constant Field Values

PROPERTY_TAB_ACTIVE_BORDER

public static final java.lang.String PROPERTY_TAB_ACTIVE_BORDER

See Also:

Constant Field Values

PROPERTY_TAB_ACTIVE_FONT

public static final java.lang.String PROPERTY_TAB_ACTIVE_FONT

See Also:

Constant Field Values

PROPERTY_TAB_ACTIVE_FOREGROUND

public static final java.lang.String PROPERTY_TAB_ACTIVE_FOREGROUND

See Also:

Constant Field Values

PROPERTY_TAB_HEIGHT

public static final java.lang.String PROPERTY_TAB_HEIGHT

See Also:

Constant Field Values

PROPERTY_TAB_INACTIVE_BACKGROUND

public static final java.lang.String PROPERTY_TAB_INACTIVE_BACKGROUND

See Also:

Constant Field Values

PROPERTY_TAB_INACTIVE_BACKGROUND_IMAGE

public static final java.lang.String PROPERTY_TAB_INACTIVE_BACKGROUND_IMAGE

See Also:

Constant Field Values

PROPERTY_TAB_INACTIVE_BORDER

public static final java.lang.String PROPERTY_TAB_INACTIVE_BORDER

See Also:

Constant Field Values

PROPERTY_TAB_INACTIVE_FONT

public static final java.lang.String PROPERTY_TAB_INACTIVE_FONT

See Also:

Constant Field Values

PROPERTY_TAB_INACTIVE_FOREGROUND

public static final java.lang.String PROPERTY_TAB_INACTIVE_FOREGROUND

See Also:

Constant Field Values

PROPERTY_TAB_INSET

public static final java.lang.String PROPERTY_TAB_INSET

See Also:

Constant Field Values

PROPERTY_TAB_SPACING

public static final java.lang.String PROPERTY_TAB_SPACING

See Also:

Constant Field Values

PROPERTY_TAB_POSITION

public static final java.lang.String PROPERTY_TAB_POSITION

See Also:

Constant Field Values

PROPERTY_TAB_WIDTH

public static final java.lang.String PROPERTY_TAB_WIDTH

See Also:

Constant Field Values

BORDER_TYPE_NONE

public static final int BORDER_TYPE_NONE

Constant for the borderType property indicating that no border should be drawn around the content.

See Also:

Constant Field Values

BORDER_TYPE_ADJACENT_TO_TABS

public static final int BORDER_TYPE_ADJACENT_TO_TABS

Constant for the borderType property indicating that a border should be drawn immediately adjacent to the tabs only. If the tabs are positioned at the top of the TabPane the border will only be drawn directly beneath the tabs with this setting. If the tabs are positioned at the bottom of the TabPane the border will only be drawn directly above the tabs with this setting. This is the default rendering style.

See Also:

Constant Field Values

BORDER_TYPE_PARALLEL_TO_TABS

public static final int BORDER_TYPE_PARALLEL_TO_TABS

Constant for the borderType property indicating that borders should be drawn above and below the content, but not at its sides.

See Also:

Constant Field Values

BORDER_TYPE_SURROUND

public static final int BORDER_TYPE_SURROUND

Constant for the borderType property indicating that borders should be drawn on all sides of the content.

See Also:

Constant Field Values

TAB_POSITION_BOTTOM

public static final int TAB_POSITION_BOTTOM

Constant for the tabPosition property indicating that the tabs should be rendered beneath the content.

See Also:

Constant Field Values

TAB_POSITION_TOP

public static final int TAB_POSITION_TOP

Constant for the tabPosition property indicating that the tabs should be rendered above the content. This is the default rendering style.

See Also:

Constant Field Values

Constructor Detail

TabPane

public TabPane()

Method Detail

getActiveTabIndex

public int getActiveTabIndex()

Returns the index of the active tab.

Returns:

the active tab index

getBorderType

public int getBorderType()

Returns the mode in which the border will be drawn around the TabPane.

Returns:

the border border type, one of the following values:

• BORDER_TYPE_NONE
• BORDER_TYPE_ADJACENT_TO_TABS (the default)
• BORDER_TYPE_PARALLEL_TO_TABS
• BORDER_TYPE_SURROUND

getDefaultContentInsets

public Insets getDefaultContentInsets()

Returns the default content inset margin. This margin is applied by default to each child component.

Returns:

the default content inset margin

getInsets

public Insets getInsets()

Returns the Insets around the entire TabPane. Insets will only be drawn on sides of the TabPane which have a border (i.e., based on the value of the borderType property). Values for this property must be in pixel units.

Returns:

the insets

getTabActiveBackground

public Color getTabActiveBackground()

Returns the background color used to render active tabs.

Returns:

the active tab background

getTabActiveBackgroundImage

public FillImage getTabActiveBackgroundImage()

Returns the background image used to render active tabs.

Returns:

the active tab background image

getTabActiveBorder

public Border getTabActiveBorder()

Returns the Border used to draw the active tab and surround the content of the TabPane.

Returns:

the border

getTabActiveFont

public Font getTabActiveFont()

Returns the font used to render active tabs.

Returns:

the active tab font

getTabActiveForeground

public Color getTabActiveForeground()

Returns the foreground color used to render active tabs.

Returns:

the active tab foreground

getTabHeight

public Extent getTabHeight()

Returns the height of an individual tab. Extent values for this property must be in pixel units.

Returns:

the tab height

getTabInactiveBackground

public Color getTabInactiveBackground()

Returns the background color used to render inactive tabs.

Returns:

the inactive tab background

getTabInactiveBackgroundImage

public FillImage getTabInactiveBackgroundImage()

Returns the background image used to render inactive tabs.

Returns:

the inactive tab background image

getTabInactiveBorder

public Border getTabInactiveBorder()

Returns the Border used to draw inactive tabs.

Returns:

the border

getTabInactiveFont

public Font getTabInactiveFont()

Returns the font used to render inactive tabs.

Returns:

the inactive tab font

getTabInactiveForeground

public Color getTabInactiveForeground()

Returns the foreground color used to render inactive tabs.

Returns:

the inactive tab foreground

getTabInset

public Extent getTabInset()

Returns the horizontal distance from which all tabs are inset from the edge of the TabPane.

Returns:

the tab inset

getTabPosition

public int getTabPosition()

Returns the position where the tabs are located relative to the pane content.

Returns:

the tab position, one of the following values:

• TAB_POSITION_TOP
• TAB_POSITION_BOTTOM

getTabSpacing

public Extent getTabSpacing()

Returns the horizontal space between individual tabs.

Returns:

the tab spacing

getTabWidth

public Extent getTabWidth()

Returns the width of an individual tab.

Returns:

the tab width

isValidParent

public boolean isValidParent(Component c)

See Also:

nextapp.echo2.app.Component#isValidParent(nextapp.echo2.app.Component)

processInput

public void processInput(java.lang.String inputName,
                         java.lang.Object inputValue)

See Also:

nextapp.echo2.app.Component#processInput(java.lang.String, java.lang.Object)

setActiveTabIndex

public void setActiveTabIndex(int newValue)

Sets the active tab index.

Parameters:

newValue - the index of the child Component whose tab should be displayed

setBorderType

public void setBorderType(int newValue)

Sets the mode in which the border will be drawn around the TabPane.

Parameters:

newValue - the new border type one of the following values:

• BORDER_TYPE_NONE
• BORDER_TYPE_ADJACENT_TO_TABS (the default)
• BORDER_TYPE_PARALLEL_TO_TABS
• BORDER_TYPE_SURROUND

setDefaultContentInsets

public void setDefaultContentInsets(Insets newValue)

Sets the default content inset margin. This margin is applied by default to each child component.

Parameters:

newValue - the new default content inset margin

setInsets

public void setInsets(Insets newValue)

Sets the Insets around the entire TabPane. Insets will only be drawn on sides of the TabPane which have a border (i.e., based on the value of the borderType property). Values for this property must be in pixel units.

Parameters:

newValue - the new inset margin

setTabActiveBackground

public void setTabActiveBackground(Color newValue)

Sets the background color used to render active tabs.

Parameters:

newValue - the new active tab background

setTabActiveBackgroundImage

public void setTabActiveBackgroundImage(FillImage newValue)

Sets the background image used to render active tabs.

Parameters:

newValue - the new active tab background image

setTabActiveBorder

public void setTabActiveBorder(Border newValue)

Sets the Border used to draw the active tab and surround the content of the TabPane.

Parameters:

newValue - the new border

setTabActiveFont

public void setTabActiveFont(Font newValue)

Sets the font used to render active tabs.

Parameters:

newValue - the new active tab font

setTabActiveForeground

public void setTabActiveForeground(Color newValue)

Sets the foreground color used to render active tabs.

Parameters:

newValue - the new active tab foreground

setTabHeight

public void setTabHeight(Extent newValue)

Sets the height of an individual tab. Extent values for this property must be in pixel units.

Parameters:

newValue - the new tab height

setTabInactiveBackground

public void setTabInactiveBackground(Color newValue)

Sets the background color used to render inactive tabs.

Parameters:

newValue - the new inactive tab background

setTabInactiveBackgroundImage

public void setTabInactiveBackgroundImage(FillImage newValue)

Sets the background image used to render inactive tabs.

Parameters:

newValue - the new inactive tab background image

setTabInactiveBorder

public void setTabInactiveBorder(Border newValue)

Sets the Border used to draw inactive tabs in the TabPane.

Parameters:

newValue - the new border

setTabInactiveFont

public void setTabInactiveFont(Font newValue)

Sets the font used to render inactive tabs.

Parameters:

newValue - the new inactive tab font

setTabInactiveForeground

public void setTabInactiveForeground(Color newValue)

Sets the foreground color used to render inactive tabs.

Parameters:

newValue - the new inactive tab foreground

setTabInset

public void setTabInset(Extent newValue)

Sets the horizontal distance from which all tabs are inset from the edge of the TabPane.

Parameters:

newValue - the new tab inset

setTabPosition

public void setTabPosition(int newValue)

Sets the position where the tabs are located relative to the pane content.

Parameters:

newValue - the new tab position, one of the following values:

• TAB_POSITION_TOP
• TAB_POSITION_BOTTOM

setTabSpacing

public void setTabSpacing(Extent newValue)

Sets the horizontal space between individual tabs.

Parameters:

newValue - the new tab spacing

setTabWidth

public void setTabWidth(Extent newValue)

Sets the width of an individual tab.

Parameters:

newValue - the new tab width