TabPane (NextApp . Echo3 Extras . API Specification)

Overview

Package

Class

Tree

Deprecated

Index

Help

NextApp Echo3 Extras
v3.0.b8

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

nextapp.echo.extras.app
Class TabPane

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

All Implemented Interfaces:: Serializable, Pane, PaneContainer, RenderIdSupport

public class TabPane
extends Component
implements Pane, PaneContainer
extends Component
implements Pane, PaneContainer

TabPane component: a container which displays children as an array of tabs, displaying only the component whose tab is selected at a specific time. May contain zero or more child components. May contain Pane components as children.

See Also:: Serialized Form

Field Summary
`static 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 String`	`INPUT_TAB_CLOSE`
`static String`	`INPUT_TAB_SELECT`
`static String`	`PROPERTY_BORDER`
`static String`	`PROPERTY_BORDER_TYPE`
`static String`	`PROPERTY_DEFAULT_CONTENT_INSETS`
`static String`	`PROPERTY_IMAGE_BORDER`
`static String`	`PROPERTY_INSETS`
`static String`	`PROPERTY_ROLLOVER_SCROLL_LEFT_ICON`
`static String`	`PROPERTY_ROLLOVER_SCROLL_RIGHT_ICON`
`static String`	`PROPERTY_SCROLL_LEFT_ICON`
`static String`	`PROPERTY_SCROLL_RIGHT_ICON`
`static String`	`PROPERTY_TAB_ACTIVE_BACKGROUND`
`static String`	`PROPERTY_TAB_ACTIVE_BACKGROUND_IMAGE`
`static String`	`PROPERTY_TAB_ACTIVE_BACKGROUND_INSETS`
`static String`	`PROPERTY_TAB_ACTIVE_BORDER`
`static String`	`PROPERTY_TAB_ACTIVE_FONT`
`static String`	`PROPERTY_TAB_ACTIVE_FOREGROUND`
`static String`	`PROPERTY_TAB_ACTIVE_HEIGHT_INCREASE`
`static String`	`PROPERTY_TAB_ACTIVE_IMAGE_BORDER`
`static String`	`PROPERTY_TAB_ACTIVE_INSETS`
`static String`	`PROPERTY_TAB_ACTIVE_LEFT_IMAGE`
`static String`	`PROPERTY_TAB_ACTIVE_RIGHT_IMAGE`
`static String`	`PROPERTY_TAB_ALIGNMENT`
`static String`	`PROPERTY_TAB_BACKGROUND_IMAGE`
`static String`	`PROPERTY_TAB_CLOSE_ENABLED`
`static String`	`PROPERTY_TAB_CLOSE_ICON`
`static String`	`PROPERTY_TAB_CLOSE_ICON_ROLLOVER_ENABLED`
`static String`	`PROPERTY_TAB_DEFAULT_CLOSE_OPERATION`
`static String`	`PROPERTY_TAB_DISABLED_CLOSE_ICON`
`static String`	`PROPERTY_TAB_HEIGHT`
`static String`	`PROPERTY_TAB_ICON_TEXT_MARGIN`
`static String`	`PROPERTY_TAB_INACTIVE_BACKGROUND`
`static String`	`PROPERTY_TAB_INACTIVE_BACKGROUND_IMAGE`
`static String`	`PROPERTY_TAB_INACTIVE_BACKGROUND_INSETS`
`static String`	`PROPERTY_TAB_INACTIVE_BORDER`
`static String`	`PROPERTY_TAB_INACTIVE_FONT`
`static String`	`PROPERTY_TAB_INACTIVE_FOREGROUND`
`static String`	`PROPERTY_TAB_INACTIVE_IMAGE_BORDER`
`static String`	`PROPERTY_TAB_INACTIVE_INSETS`
`static String`	`PROPERTY_TAB_INACTIVE_LEFT_IMAGE`
`static String`	`PROPERTY_TAB_INACTIVE_RIGHT_IMAGE`
`static String`	`PROPERTY_TAB_INSET`
`static String`	`PROPERTY_TAB_MAXIMUM_WIDTH`
`static String`	`PROPERTY_TAB_POSITION`
`static String`	`PROPERTY_TAB_ROLLOVER_BACKGROUND`
`static String`	`PROPERTY_TAB_ROLLOVER_BACKGROUND_IMAGE`
`static String`	`PROPERTY_TAB_ROLLOVER_BACKGROUND_INSETS`
`static String`	`PROPERTY_TAB_ROLLOVER_BORDER`
`static String`	`PROPERTY_TAB_ROLLOVER_CLOSE_ICON`
`static String`	`PROPERTY_TAB_ROLLOVER_ENABLED`
`static String`	`PROPERTY_TAB_ROLLOVER_FONT`
`static String`	`PROPERTY_TAB_ROLLOVER_FOREGROUND`
`static String`	`PROPERTY_TAB_ROLLOVER_IMAGE_BORDER`
`static String`	`PROPERTY_TAB_SPACING`
`static String`	`PROPERTY_TAB_WIDTH`
`static String`	`TAB_CLOSING_LISTENERS_CHANGED_PROPERTY`
`static int`	`TAB_DISPOSE_ON_CLOSE` A constant for the `tabDefaultCloseOperation` property indicating that a tab should be removed from the component hierarchy when a user attempts to close it.
`static int`	`TAB_DO_NOTHING_ON_CLOSE` A constant for the `tabDefaultCloseOperation` property indicating that nothing should be done when the user attempts to close a tab.
`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.
`static String`	`TAB_SELECTION_LISTENERS_CHANGED_PROPERTY`

Fields inherited from class nextapp.echo.app.Component
`CHILD_VISIBLE_CHANGED_PROPERTY, CHILDREN_CHANGED_PROPERTY, ENABLED_CHANGED_PROPERTY, FOCUS_NEXT_ID_CHANGED_PROPERTY, FOCUS_PREVIOUS_ID_CHANGED_PROPERTY, LAYOUT_DIRECTION_CHANGED_PROPERTY, LOCALE_CHANGED_PROPERTY, PROPERTY_BACKGROUND, PROPERTY_FONT, PROPERTY_FOREGROUND, PROPERTY_LAYOUT_DATA, STYLE_CHANGED_PROPERTY, STYLE_NAME_CHANGED_PROPERTY, VISIBLE_CHANGED_PROPERTY`

Constructor Summary
`TabPane()`

Method Summary
`void`	`addTabClosingListener(TabClosingListener l)` Adds a `TabPaneListener` to receive event notifications.
`void`	`addTabSelectionListener(TabSelectionListener l)` Adds a `TabSelectionListener` to receive event notifications.
`protected void`	`fireTabClosing(int tabIndex)` Notifies `TabClosingListener`s that the user has requested to close a tab.
`protected void`	`fireTabSelected(int tabIndex)` Notifies `TabSelectionListener`s that the user has selected a tab.
`int`	`getActiveTabIndex()` Returns the index of the active tab.
`Border`	`getBorder()` Returns the border surrounding the entire `TabPane`.
`int`	`getBorderType()` Returns the mode in which the border will be drawn around the `TabPane`.
`Insets`	`getDefaultContentInsets()` Returns the default content inset margin.
`FillImageBorder`	`getImageBorder()` Returns the `FillImageBorder` surrounding the entire TabPane.
`Insets`	`getInsets()` Returns the `Insets` around the entire `TabPane`.
`ImageReference`	`getRolloverScrollLeftIcon()` Returns the left-hand rollover icon displayed when too many tabs are present to fit on-screen.
`ImageReference`	`getRolloverScrollRightIcon()` Returns the right-hand rollover icon displayed when too many tabs are present to fit on-screen.
`ImageReference`	`getScrollLeftIcon()` Returns the left-hand icon displayed when too many tabs are present to fit on-screen.
`ImageReference`	`getScrollRightIcon()` Returns the right-hand icon displayed when too many tabs are present to fit on-screen.
`Color`	`getTabActiveBackground()` Returns the background color used to render active tabs.
`FillImage`	`getTabActiveBackgroundImage()` Returns the background image used to render active tabs.
`Insets`	`getTabActiveBackgroundInsets()` Returns the inset margin displayed around the background color/image used to render active tabs.
`Border`	`getTabActiveBorder()` Returns the `Border` used to draw the active tab.
`Font`	`getTabActiveFont()` Returns the font used to render active tabs.
`Color`	`getTabActiveForeground()` Returns the foreground color used to render active tabs.
`Extent`	`getTabActiveHeightIncrease()` Returns the height increase of active tabs.
`FillImageBorder`	`getTabActiveImageBorder()` Returns the `FillImageBorder` used to draw the active tab.
`Insets`	`getTabActiveInsets()` Returns the insets of active tabs.
`ImageReference`	`getTabActiveLeftImage()` Deprecated. `FillImageBorder`s should be used to render complex tabs
`ImageReference`	`getTabActiveRightImage()` Deprecated. `FillImageBorder`s should be used to render complex tabs
`Alignment`	`getTabAlignment()` Returns the alignment within an individual tab.
`FillImage`	`getTabBackgroundImage()` Returns the background image used to render behind tabs.
`ImageReference`	`getTabCloseIcon()` Returns the close icon displayed in the tabs.
`int`	`getTabDefaultCloseOperation()` Returns the default tab close operation.
`ImageReference`	`getTabDisabledCloseIcon()` Returns the close icon that is displayed when tab close is disabled.
`Extent`	`getTabHeight()` Returns the height of an individual tab.
`Extent`	`getTabIconTextMargin()` Returns the margin size between the icon and the text.
`Color`	`getTabInactiveBackground()` Returns the background color used to render inactive tabs.
`FillImage`	`getTabInactiveBackgroundImage()` Returns the background image used to render inactive tabs.
`Insets`	`getTabInactiveBackgroundInsets()` Returns the inset margin displayed around the background color/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.
`FillImageBorder`	`getTabInactiveImageBorder()` Returns the `FillImageBorder` used to draw inactive tabs.
`Insets`	`getTabInactiveInsets()` Returns the insets of inactive tabs.
`ImageReference`	`getTabInactiveLeftImage()` Deprecated. `FillImageBorder`s should be used to render complex tabs
`ImageReference`	`getTabInactiveRightImage()` Deprecated. `FillImageBorder`s should be used to render complex tabs
`Extent`	`getTabInset()` Returns the horizontal distance from which all tabs are inset from the edge of the `TabPane`.
`Extent`	`getTabMaximumWidth()` Returns the maximum allowed width of a tab.
`int`	`getTabPosition()` Returns the position where the tabs are located relative to the pane content.
`Color`	`getTabRolloverBackground()` Returns the background color used to render rolled over tabs.
`FillImage`	`getTabRolloverBackgroundImage()` Returns the background image used to render rolled over tabs.
`Insets`	`getTabRolloverBackgroundInsets()` Returns the inset margin displayed around the background color/image used to render rolled over tabs.
`Border`	`getTabRolloverBorder()` Returns the `Border` used to draw rolled over tabs.
`ImageReference`	`getTabRolloverCloseIcon()` Returns the close icon that is displayed when the mouse cursor is inside its bounds.
`Font`	`getTabRolloverFont()` Returns the font used to render rolled over tabs.
`Color`	`getTabRolloverForeground()` Returns the foreground color used to render rolled over tabs.
`FillImageBorder`	`getTabRolloverImageBorder()` Returns the `FillImageBorder` used to draw rolled over tabs.
`Extent`	`getTabSpacing()` Returns the horizontal space between individual tabs.
`Extent`	`getTabWidth()` Returns the width of an individual tab.
`boolean`	`hasTabClosingListeners()` Determines if any `TabClosingListener`s are registered.
`boolean`	`hasTabSelectionListeners()` Determines the any `TabSelectionListener`s are registered.
`boolean`	`isTabCloseEnabled()` Determines if tab close is enabled in general.
`boolean`	`isTabCloseIconRolloverEnabled()` Determines if close icon rollover effects are enabled.
`boolean`	`isTabRolloverEnabled()` Determines if tab rollover effects are enabled.
`boolean`	`isValidParent(Component c)`
`void`	`processInput(String inputName, Object inputValue)`
`void`	`removeTabClosingListener(TabClosingListener l)` Removes a `TabPaneListener` from receiving event notifications.
`void`	`removeTabSelectionListener(TabSelectionListener l)` Removes a `TabSelectionListener` from receiving event notifications.
`void`	`setActiveTabIndex(int newValue)` Sets the active tab index.
`void`	`setBorder(Border newValue)` Sets the border surrounding the entire `TabPane`.
`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`	`setImageBorder(FillImageBorder newValue)` Sets the `FillImageBorder` surrounding the entire TabPane.
`void`	`setInsets(Insets newValue)` Sets the `Insets` around the entire `TabPane`.
`void`	`setRolloverScrollLeftIcon(ImageReference newValue)` Sets the left-hand rollover icon displayed when too many tabs are present to fit on-screen.
`void`	`setRolloverScrollRightIcon(ImageReference newValue)` Sets the right-hand rollover icon displayed when too many tabs are present to fit on-screen.
`void`	`setScrollLeftIcon(ImageReference newValue)` Sets the left-hand icon displayed when too many tabs are present to fit on-screen.
`void`	`setScrollRightIcon(ImageReference newValue)` Sets the right-hand icon displayed when too many tabs are present to fit on-screen.
`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`	`setTabActiveBackgroundInsets(Insets newValue)` Sets the inset margin displayed around the background color/image used to render active tabs.
`void`	`setTabActiveBorder(Border newValue)` Sets the `Border` used to draw the active tab.
`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`	`setTabActiveHeightIncrease(Extent newValue)` Sets the height increase of active tabs.
`void`	`setTabActiveImageBorder(FillImageBorder newValue)` Sets the `FiillImageBorder` used to draw the active tab.
`void`	`setTabActiveInsets(Insets newValue)` Sets the insets of active tabs.
`void`	`setTabActiveLeftImage(ImageReference newValue)` Deprecated. `FillImageBorder`s should be used to render complex tabs
`void`	`setTabActiveRightImage(ImageReference newValue)` Deprecated. `FillImageBorder`s should be used to render complex tabs
`void`	`setTabAlignment(Alignment newValue)` Sets the alignment within an individual tab.
`void`	`setTabBackgroundImage(FillImage newValue)` Sets the background image used to render behind tabs.
`void`	`setTabCloseEnabled(boolean newValue)` Sets the enabled state of tab close buttons.
`void`	`setTabCloseIcon(ImageReference newValue)` Sets the close icon displayed in the tabs.
`void`	`setTabCloseIconRolloverEnabled(boolean newValue)` Sets the enabled state of tab close icon rollover effects.
`void`	`setTabDefaultCloseOperation(int newValue)` Sets the default tab close operation.
`void`	`setTabDisabledCloseIcon(ImageReference newValue)` Sets the close icon that is displayed when tab close is disabled.
`void`	`setTabHeight(Extent newValue)` Sets the height of an individual tab.
`void`	`setTabIconTextMargin(Extent newValue)` Sets the margin size between the icon and the text.
`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`	`setTabInactiveBackgroundInsets(Insets newValue)` Sets the inset margin displayed around the background color/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`	`setTabInactiveImageBorder(FillImageBorder newValue)` Sets the `FillImageBorder` used to draw inactive tabs.
`void`	`setTabInactiveInsets(Insets newValue)` Sets the insets of inactive tabs.
`void`	`setTabInactiveLeftImage(ImageReference newValue)` Deprecated. `FillImageBorder`s should be used to render complex tabs
`void`	`setTabInactiveRightImage(ImageReference newValue)` Deprecated. `FillImageBorder`s should be used to render complex tabs
`void`	`setTabInset(Extent newValue)` Sets the horizontal distance from which all tabs are inset from the edge of the `TabPane`.
`void`	`setTabMaximumWidth(Extent newValue)` Sets the maximum allowed width of a tab.
`void`	`setTabPosition(int newValue)` Sets the position where the tabs are located relative to the pane content.
`void`	`setTabRolloverBackground(Color newValue)` Sets the background color used to render rolled over tabs.
`void`	`setTabRolloverBackgroundImage(FillImage newValue)` Sets the background image used to render rolled over tabs.
`void`	`setTabRolloverBackgroundInsets(Insets newValue)` Sets the inset margin displayed around the background color/image used to render rolled over tabs.
`void`	`setTabRolloverBorder(Border newValue)` Sets the `Border` used to draw rolled over tabs in the `TabPane`.
`void`	`setTabRolloverCloseIcon(ImageReference newValue)` Sets the close icon that is displayed when the mouse cursor is inside its bounds.
`void`	`setTabRolloverEnabled(boolean newValue)` Sets the enabled state of tab rollover effects.
`void`	`setTabRolloverFont(Font newValue)` Sets the font used to render rolled over tabs.
`void`	`setTabRolloverForeground(Color newValue)` Sets the foreground color used to render rolled over tabs.
`void`	`setTabRolloverImageBorder(FillImageBorder newValue)` Sets the `FillImageBorder` used to draw rolled over tabs.
`void`	`setTabSpacing(Extent newValue)` Sets the horizontal space between individual tabs.
`void`	`setTabWidth(Extent newValue)` Sets the width of an individual tab.
`void`	`userTabClose(int tabIndex)` Processes a user request to close the tab with the given index (via the close button).
`void`	`userTabSelect(int tabIndex)` Processes a user request to select the tab with the given index.

Methods inherited from class nextapp.echo.app.Component
add, add, addPropertyChangeListener, addPropertyChangeListener, dispose, firePropertyChange, get, getApplicationInstance, getBackground, getComponent, getComponent, getComponentCount, getComponents, getEventListenerList, getFocusNextId, getFocusPreviousId, getFont, getForeground, getId, getIndex, getLayoutData, getLayoutDirection, getLocale, getLocalStyle, getParent, getRenderId, getRenderIndexedProperty, getRenderIndexedProperty, getRenderLocale, getRenderProperty, getRenderProperty, getStyle, getStyleName, getVisibleComponent, getVisibleComponentCount, getVisibleComponents, hasEventListenerList, indexOf, init, isAncestorOf, isEnabled, isFocusTraversalParticipant, isRegistered, isRenderEnabled, isRenderVisible, isValidChild, isVisible, remove, remove, removeAll, removePropertyChangeListener, removePropertyChangeListener, set, setBackground, setComponents, setEnabled, setFocusNextId, setFocusPreviousId, setFocusTraversalParticipant, setFont, setForeground, setId, setIndex, setLayoutData, setLayoutDirection, setLocale, setRenderId, setStyle, setStyleName, setVisible, validate, verifyInput, visibleIndexOf

Methods inherited from class nextapp.echo.app.Component

add, add, addPropertyChangeListener, addPropertyChangeListener, dispose, firePropertyChange, get, getApplicationInstance, getBackground, getComponent, getComponent, getComponentCount, getComponents, getEventListenerList, getFocusNextId, getFocusPreviousId, getFont, getForeground, getId, getIndex, getLayoutData, getLayoutDirection, getLocale, getLocalStyle, getParent, getRenderId, getRenderIndexedProperty, getRenderIndexedProperty, getRenderLocale, getRenderProperty, getRenderProperty, getStyle, getStyleName, getVisibleComponent, getVisibleComponentCount, getVisibleComponents, hasEventListenerList, indexOf, init, isAncestorOf, isEnabled, isFocusTraversalParticipant, isRegistered, isRenderEnabled, isRenderVisible, isValidChild, isVisible, remove, remove, removeAll, removePropertyChangeListener, removePropertyChangeListener, set, setBackground, setComponents, setEnabled, setFocusNextId, setFocusPreviousId, setFocusTraversalParticipant, setFont, setForeground, setId, setIndex, setLayoutData, setLayoutDirection, setLocale, setRenderId, setStyle, setStyleName, setVisible, validate, verifyInput, visibleIndexOf

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

INPUT_TAB_CLOSE

public static final String INPUT_TAB_CLOSE

See Also:: Constant Field Values

INPUT_TAB_SELECT

public static final String INPUT_TAB_SELECT

See Also:: Constant Field Values

ACTIVE_TAB_INDEX_CHANGED_PROPERTY

public static final String ACTIVE_TAB_INDEX_CHANGED_PROPERTY

See Also:: Constant Field Values

TAB_CLOSING_LISTENERS_CHANGED_PROPERTY

public static final String TAB_CLOSING_LISTENERS_CHANGED_PROPERTY

See Also:: Constant Field Values

TAB_SELECTION_LISTENERS_CHANGED_PROPERTY

public static final String TAB_SELECTION_LISTENERS_CHANGED_PROPERTY

See Also:: Constant Field Values

PROPERTY_BORDER

public static final String PROPERTY_BORDER

See Also:: Constant Field Values

PROPERTY_BORDER_TYPE

public static final String PROPERTY_BORDER_TYPE

See Also:: Constant Field Values

PROPERTY_DEFAULT_CONTENT_INSETS

public static final String PROPERTY_DEFAULT_CONTENT_INSETS

See Also:: Constant Field Values

PROPERTY_IMAGE_BORDER

public static final String PROPERTY_IMAGE_BORDER

See Also:: Constant Field Values

PROPERTY_INSETS

public static final String PROPERTY_INSETS

See Also:: Constant Field Values

PROPERTY_ROLLOVER_SCROLL_LEFT_ICON

public static final String PROPERTY_ROLLOVER_SCROLL_LEFT_ICON

See Also:: Constant Field Values

PROPERTY_ROLLOVER_SCROLL_RIGHT_ICON

public static final String PROPERTY_ROLLOVER_SCROLL_RIGHT_ICON

See Also:: Constant Field Values

PROPERTY_SCROLL_LEFT_ICON

public static final String PROPERTY_SCROLL_LEFT_ICON

See Also:: Constant Field Values

PROPERTY_SCROLL_RIGHT_ICON

public static final String PROPERTY_SCROLL_RIGHT_ICON

See Also:: Constant Field Values

PROPERTY_TAB_ACTIVE_BACKGROUND

public static final String PROPERTY_TAB_ACTIVE_BACKGROUND

See Also:: Constant Field Values

PROPERTY_TAB_ACTIVE_BACKGROUND_IMAGE

public static final String PROPERTY_TAB_ACTIVE_BACKGROUND_IMAGE

See Also:: Constant Field Values

PROPERTY_TAB_ACTIVE_BACKGROUND_INSETS

public static final String PROPERTY_TAB_ACTIVE_BACKGROUND_INSETS

See Also:: Constant Field Values

PROPERTY_TAB_ACTIVE_BORDER

public static final String PROPERTY_TAB_ACTIVE_BORDER

See Also:: Constant Field Values

PROPERTY_TAB_ACTIVE_FONT

public static final String PROPERTY_TAB_ACTIVE_FONT

See Also:: Constant Field Values

PROPERTY_TAB_ACTIVE_FOREGROUND

public static final String PROPERTY_TAB_ACTIVE_FOREGROUND

See Also:: Constant Field Values

PROPERTY_TAB_ACTIVE_HEIGHT_INCREASE

public static final String PROPERTY_TAB_ACTIVE_HEIGHT_INCREASE

See Also:: Constant Field Values

PROPERTY_TAB_ACTIVE_IMAGE_BORDER

public static final String PROPERTY_TAB_ACTIVE_IMAGE_BORDER

See Also:: Constant Field Values

PROPERTY_TAB_ACTIVE_INSETS

public static final String PROPERTY_TAB_ACTIVE_INSETS

See Also:: Constant Field Values

PROPERTY_TAB_ACTIVE_LEFT_IMAGE

public static final String PROPERTY_TAB_ACTIVE_LEFT_IMAGE

See Also:: Constant Field Values

PROPERTY_TAB_ACTIVE_RIGHT_IMAGE

public static final String PROPERTY_TAB_ACTIVE_RIGHT_IMAGE

See Also:: Constant Field Values

PROPERTY_TAB_ALIGNMENT

public static final String PROPERTY_TAB_ALIGNMENT

See Also:: Constant Field Values

PROPERTY_TAB_BACKGROUND_IMAGE

public static final String PROPERTY_TAB_BACKGROUND_IMAGE

See Also:: Constant Field Values

PROPERTY_TAB_CLOSE_ENABLED

public static final String PROPERTY_TAB_CLOSE_ENABLED

See Also:: Constant Field Values

PROPERTY_TAB_CLOSE_ICON

public static final String PROPERTY_TAB_CLOSE_ICON

See Also:: Constant Field Values

PROPERTY_TAB_CLOSE_ICON_ROLLOVER_ENABLED

public static final String PROPERTY_TAB_CLOSE_ICON_ROLLOVER_ENABLED

See Also:: Constant Field Values

PROPERTY_TAB_DEFAULT_CLOSE_OPERATION

public static final String PROPERTY_TAB_DEFAULT_CLOSE_OPERATION

See Also:: Constant Field Values

PROPERTY_TAB_DISABLED_CLOSE_ICON

public static final String PROPERTY_TAB_DISABLED_CLOSE_ICON

See Also:: Constant Field Values

PROPERTY_TAB_HEIGHT

public static final String PROPERTY_TAB_HEIGHT

See Also:: Constant Field Values

PROPERTY_TAB_ICON_TEXT_MARGIN

public static final String PROPERTY_TAB_ICON_TEXT_MARGIN

See Also:: Constant Field Values

PROPERTY_TAB_INACTIVE_BACKGROUND

public static final String PROPERTY_TAB_INACTIVE_BACKGROUND

See Also:: Constant Field Values

PROPERTY_TAB_INACTIVE_BACKGROUND_IMAGE

public static final String PROPERTY_TAB_INACTIVE_BACKGROUND_IMAGE

See Also:: Constant Field Values

PROPERTY_TAB_INACTIVE_BACKGROUND_INSETS

public static final String PROPERTY_TAB_INACTIVE_BACKGROUND_INSETS

See Also:: Constant Field Values

PROPERTY_TAB_INACTIVE_BORDER

public static final String PROPERTY_TAB_INACTIVE_BORDER

See Also:: Constant Field Values

PROPERTY_TAB_INACTIVE_FONT

public static final String PROPERTY_TAB_INACTIVE_FONT

See Also:: Constant Field Values

PROPERTY_TAB_INACTIVE_FOREGROUND

public static final String PROPERTY_TAB_INACTIVE_FOREGROUND

See Also:: Constant Field Values

PROPERTY_TAB_INACTIVE_IMAGE_BORDER

public static final String PROPERTY_TAB_INACTIVE_IMAGE_BORDER

See Also:: Constant Field Values

PROPERTY_TAB_INACTIVE_INSETS

public static final String PROPERTY_TAB_INACTIVE_INSETS

See Also:: Constant Field Values

PROPERTY_TAB_INACTIVE_LEFT_IMAGE

public static final String PROPERTY_TAB_INACTIVE_LEFT_IMAGE

See Also:: Constant Field Values

PROPERTY_TAB_INACTIVE_RIGHT_IMAGE

public static final String PROPERTY_TAB_INACTIVE_RIGHT_IMAGE

See Also:: Constant Field Values

PROPERTY_TAB_INSET

public static final String PROPERTY_TAB_INSET

See Also:: Constant Field Values

PROPERTY_TAB_MAXIMUM_WIDTH

public static final String PROPERTY_TAB_MAXIMUM_WIDTH

See Also:: Constant Field Values

PROPERTY_TAB_POSITION

public static final String PROPERTY_TAB_POSITION

See Also:: Constant Field Values

PROPERTY_TAB_ROLLOVER_CLOSE_ICON

public static final String PROPERTY_TAB_ROLLOVER_CLOSE_ICON

See Also:: Constant Field Values

PROPERTY_TAB_ROLLOVER_BACKGROUND

public static final String PROPERTY_TAB_ROLLOVER_BACKGROUND

See Also:: Constant Field Values

PROPERTY_TAB_ROLLOVER_BACKGROUND_IMAGE

public static final String PROPERTY_TAB_ROLLOVER_BACKGROUND_IMAGE

See Also:: Constant Field Values

PROPERTY_TAB_ROLLOVER_BACKGROUND_INSETS

public static final String PROPERTY_TAB_ROLLOVER_BACKGROUND_INSETS

See Also:: Constant Field Values

PROPERTY_TAB_ROLLOVER_BORDER

public static final String PROPERTY_TAB_ROLLOVER_BORDER

See Also:: Constant Field Values

PROPERTY_TAB_ROLLOVER_ENABLED

public static final String PROPERTY_TAB_ROLLOVER_ENABLED

See Also:: Constant Field Values

PROPERTY_TAB_ROLLOVER_FONT

public static final String PROPERTY_TAB_ROLLOVER_FONT

See Also:: Constant Field Values

PROPERTY_TAB_ROLLOVER_FOREGROUND

public static final String PROPERTY_TAB_ROLLOVER_FOREGROUND

See Also:: Constant Field Values

PROPERTY_TAB_ROLLOVER_IMAGE_BORDER

public static final String PROPERTY_TAB_ROLLOVER_IMAGE_BORDER

See Also:: Constant Field Values

PROPERTY_TAB_SPACING

public static final String PROPERTY_TAB_SPACING

See Also:: Constant Field Values

PROPERTY_TAB_WIDTH

public static final String PROPERTY_TAB_WIDTH

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_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_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_DO_NOTHING_ON_CLOSE

public static final int TAB_DO_NOTHING_ON_CLOSE

A constant for the tabDefaultCloseOperation property indicating that nothing should be done when the user attempts to close a tab.

See Also:: Constant Field Values

TAB_DISPOSE_ON_CLOSE

public static final int TAB_DISPOSE_ON_CLOSE

A constant for the tabDefaultCloseOperation property indicating that a tab should be removed from the component hierarchy when a user attempts to close it.

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

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

Constructor Detail

TabPane

public TabPane()

Method Detail

addTabClosingListener

public void addTabClosingListener(TabClosingListener l)

Adds a TabPaneListener to receive event notifications.

Parameters:: l - the TabPaneListener to add

addTabSelectionListener

public void addTabSelectionListener(TabSelectionListener l)

Adds a TabSelectionListener to receive event notifications.

Parameters:: l - the TabSelectionListener to add

fireTabClosing

protected void fireTabClosing(int tabIndex)

Notifies TabClosingListeners that the user has requested to close a tab.

fireTabSelected

protected void fireTabSelected(int tabIndex)

Notifies TabSelectionListeners that the user has selected a tab.

getActiveTabIndex

public int getActiveTabIndex()

Returns the index of the active tab.

Returns:: the active tab index

getBorder

public Border getBorder()

Returns the border surrounding the entire TabPane. This property will have no effect if an imageBorder has been configured.

Returns:: the border

getBorderType

public int getBorderType()

Returns the mode in which the border will be drawn around the TabPane. This property will affect the rendering of both border and imageBorder properties.

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

getImageBorder

public FillImageBorder getImageBorder()

Returns the FillImageBorder surrounding the entire TabPane. If this property is set, it will override the value of the border property.

Returns:: the image border

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

getRolloverScrollLeftIcon

public ImageReference getRolloverScrollLeftIcon()

Returns the left-hand rollover icon displayed when too many tabs are present to fit on-screen.

Returns:: the left rollover scroll icon

getRolloverScrollRightIcon

public ImageReference getRolloverScrollRightIcon()

Returns the right-hand rollover icon displayed when too many tabs are present to fit on-screen.

Returns:: the right rollover scroll icon

getScrollLeftIcon

public ImageReference getScrollLeftIcon()

Returns the left-hand icon displayed when too many tabs are present to fit on-screen.

Returns:: the left scroll icon

getScrollRightIcon

public ImageReference getScrollRightIcon()

Returns the right-hand icon displayed when too many tabs are present to fit on-screen.

Returns:: the right scroll icon

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

getTabActiveBackgroundInsets

public Insets getTabActiveBackgroundInsets()

Returns the inset margin displayed around the background color/image used to render active tabs. Rendered only when image borders are used.

Returns:: the inset margin

getTabActiveBorder

public Border getTabActiveBorder()

Returns the Border used to draw the active tab. If the border property is not set as well, this border will surround the entire 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

getTabActiveHeightIncrease

public Extent getTabActiveHeightIncrease()

Returns the height increase of active tabs. Extent values for this property must be in pixel units.

Returns:: the active tab height increase

getTabActiveInsets

public Insets getTabActiveInsets()

Returns the insets of active tabs.

Returns:: the active tab insets

getTabActiveImageBorder

public FillImageBorder getTabActiveImageBorder()

Returns the FillImageBorder used to draw the active tab.

Returns:: the border

getTabActiveLeftImage

public ImageReference getTabActiveLeftImage()

Deprecated. FillImageBorders should be used to render complex tabs

Returns the left image used to render active tabs.

Returns:: the active tab left image
See Also:: getTabActiveImageBorder()

getTabActiveRightImage

public ImageReference getTabActiveRightImage()

Deprecated. FillImageBorders should be used to render complex tabs

Returns the right image used to render active tabs.

Returns:: the active tab right image
See Also:: getTabActiveImageBorder()

getTabAlignment

public Alignment getTabAlignment()

Returns the alignment within an individual tab.

Returns:: the tab alignment.

getTabBackgroundImage

public FillImage getTabBackgroundImage()

Returns the background image used to render behind tabs.

Returns:: the background image

getTabCloseIcon

public ImageReference getTabCloseIcon()

Returns the close icon displayed in the tabs.

Returns:: the icon

getTabDefaultCloseOperation

public int getTabDefaultCloseOperation()

Returns the default tab close operation.

Returns:

the default tab close operation, one of the following values:

TAB_DO_NOTHING_ON_CLOSE
TAB_DISPOSE_ON_CLOSE

getTabDisabledCloseIcon

public ImageReference getTabDisabledCloseIcon()

Returns the close icon that is displayed when tab close is disabled.

Returns:: the icon

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

getTabIconTextMargin

public Extent getTabIconTextMargin()

Returns the margin size between the icon and the text. The margin will only be displayed if a tab has both icon and text set. This property only supports Extents with fixed (i.e., not percent) units.

Returns:: the margin size

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

getTabInactiveBackgroundInsets

public Insets getTabInactiveBackgroundInsets()

Returns the inset margin displayed around the background color/image used to render inactive tabs. Rendered only when image borders are used.

Returns:: the inset margin

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

getTabInactiveImageBorder

public FillImageBorder getTabInactiveImageBorder()

Returns the FillImageBorder used to draw inactive tabs.

Returns:: the border

getTabInactiveInsets

public Insets getTabInactiveInsets()

Returns the insets of inactive tabs.

Returns:: the inactive tab insets

getTabInactiveLeftImage

public ImageReference getTabInactiveLeftImage()

Deprecated. FillImageBorders should be used to render complex tabs

Returns the left image used to render inactive tabs.

Returns:: the inactive tab left image
See Also:: getTabInactiveImageBorder()

getTabInactiveRightImage

public ImageReference getTabInactiveRightImage()

Deprecated. FillImageBorders should be used to render complex tabs

Returns the right image used to render inactive tabs.

Returns:: the inactive tab right image
See Also:: getTabInactiveImageBorder()

getTabInset

public Extent getTabInset()

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

Returns:: the tab inset

getTabMaximumWidth

public Extent getTabMaximumWidth()

Returns the maximum allowed width of a tab.

Returns:: the maximum tab width

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

getTabRolloverBackground

public Color getTabRolloverBackground()

Returns the background color used to render rolled over tabs.

Returns:: the rollover tab background

getTabRolloverBackgroundImage

public FillImage getTabRolloverBackgroundImage()

Returns the background image used to render rolled over tabs.

Returns:: the rollover tab background image

getTabRolloverBackgroundInsets

public Insets getTabRolloverBackgroundInsets()

Returns the inset margin displayed around the background color/image used to render rolled over tabs. Rendered only when image borders are used.

Returns:: the inset margin

getTabRolloverBorder

public Border getTabRolloverBorder()

Returns the Border used to draw rolled over tabs.

Returns:: the rollover border

getTabRolloverCloseIcon

public ImageReference getTabRolloverCloseIcon()

Returns the close icon that is displayed when the mouse cursor is inside its bounds.

Returns:: the icon

getTabRolloverFont

public Font getTabRolloverFont()

Returns the font used to render rolled over tabs.

Returns:: the rollover tab font

getTabRolloverForeground

public Color getTabRolloverForeground()

Returns the foreground color used to render rolled over tabs.

Returns:: the rollover tab foreground

getTabRolloverImageBorder

public FillImageBorder getTabRolloverImageBorder()

Returns the FillImageBorder used to draw rolled over tabs.

Returns:: the rollover image border

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

hasTabClosingListeners

public boolean hasTabClosingListeners()

Determines if any TabClosingListeners are registered.

Returns:: true if any TabClosingListeners are registered

hasTabSelectionListeners

public boolean hasTabSelectionListeners()

Determines the any TabSelectionListeners are registered.

Returns:: true if any TabSelectionListeners are registered

isTabCloseEnabled

public boolean isTabCloseEnabled()

Determines if tab close is enabled in general. Individual tabs can explicitly disable close support using TabPaneLayoutData.setCloseEnabled(boolean).

Returns:: true if tab close is enabled

isTabCloseIconRolloverEnabled

public boolean isTabCloseIconRolloverEnabled()

Determines if close icon rollover effects are enabled.

Returns:: true if close icon rollover effects are enabled

isTabRolloverEnabled

public boolean isTabRolloverEnabled()

Determines if tab rollover effects are enabled.

Returns:: true if tab rollover effects are enabled

isValidParent

public boolean isValidParent(Component c)

Overrides:: isValidParent in class Component

See Also:: Component.isValidParent(nextapp.echo.app.Component)

processInput

public void processInput(String inputName,
                         Object inputValue)

Overrides:: processInput in class Component

See Also:: Component.processInput(java.lang.String, java.lang.Object)

removeTabClosingListener

public void removeTabClosingListener(TabClosingListener l)

Removes a TabPaneListener from receiving event notifications.

Parameters:: l - the TabPaneListener to remove

removeTabSelectionListener

public void removeTabSelectionListener(TabSelectionListener l)

Removes a TabSelectionListener from receiving event notifications.

Parameters:: l - the TabSelectionListener to remove

setActiveTabIndex

public void setActiveTabIndex(int newValue)

Sets the active tab index.

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

setBorder

public void setBorder(Border newValue)

Sets the border surrounding the entire TabPane. This property will have no effect if an imageBorder has been configured.

Parameters:: newValue - the new border

setBorderType

public void setBorderType(int newValue)

Sets the mode in which the border will be drawn around the TabPane. This property will affect the rendering of both border and imageBorder properties.

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

setImageBorder

public void setImageBorder(FillImageBorder newValue)

Sets the FillImageBorder surrounding the entire TabPane. If this property is set, it will override the value of the border property.

Parameters:: newValue - the new image border

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

setRolloverScrollLeftIcon

public void setRolloverScrollLeftIcon(ImageReference newValue)

Sets the left-hand rollover icon displayed when too many tabs are present to fit on-screen.

Parameters:: newValue - the new left rollover scroll icon

setRolloverScrollRightIcon

public void setRolloverScrollRightIcon(ImageReference newValue)

Sets the right-hand rollover icon displayed when too many tabs are present to fit on-screen.

Parameters:: newValue - the new right rollover scroll icon

setScrollLeftIcon

public void setScrollLeftIcon(ImageReference newValue)

Sets the left-hand icon displayed when too many tabs are present to fit on-screen.

Parameters:: newValue - the new left scroll icon

setScrollRightIcon

public void setScrollRightIcon(ImageReference newValue)

Sets the right-hand icon displayed when too many tabs are present to fit on-screen.

Parameters:: newValue - the new right scroll icon

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

setTabActiveBackgroundInsets

public void setTabActiveBackgroundInsets(Insets newValue)

Sets the inset margin displayed around the background color/image used to render active tabs. Rendered only when image borders are used.

Parameters:: newValue - the new inset margin

setTabActiveBorder

public void setTabActiveBorder(Border newValue)

Sets the Border used to draw the active tab. If the border property is not set as well, this border will surround the entire 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

setTabActiveHeightIncrease

public void setTabActiveHeightIncrease(Extent newValue)

Sets the height increase of active tabs. Extent values for this property must be in pixel units.

Parameters:: newValue - the new active tab height increase

setTabActiveImageBorder

public void setTabActiveImageBorder(FillImageBorder newValue)

Sets the FiillImageBorder used to draw the active tab.

Parameters:: newValue - the new border

setTabActiveInsets

public void setTabActiveInsets(Insets newValue)

Sets the insets of active tabs.

Parameters:: newValue - the new active tab insets

setTabActiveLeftImage

public void setTabActiveLeftImage(ImageReference newValue)

Deprecated. FillImageBorders should be used to render complex tabs

Sets the left image used to render active tabs. The width of the image must be set, and has to be a pixel value.

Parameters:: newValue - the active tab left image
See Also:: setTabActiveImageBorder(nextapp.echo.app.FillImageBorder)

setTabActiveRightImage

public void setTabActiveRightImage(ImageReference newValue)

Deprecated. FillImageBorders should be used to render complex tabs

Sets the right image used to render active tabs. The width of the image must be set, and has to be a pixel value.

Parameters:: newValue - the active tab right image
See Also:: setTabActiveImageBorder(nextapp.echo.app.FillImageBorder)

setTabAlignment

public void setTabAlignment(Alignment newValue)

Sets the alignment within an individual tab.

Parameters:: newValue - the new tab alignment

setTabBackgroundImage

public void setTabBackgroundImage(FillImage newValue)

Sets the background image used to render behind tabs.

Parameters:: newValue - the background image

setTabCloseEnabled

public void setTabCloseEnabled(boolean newValue)

Sets the enabled state of tab close buttons. Individual tabs can explicitly disable close support using TabPaneLayoutData.setCloseEnabled(boolean).

Parameters:: newValue - true if tabs should be closable

setTabCloseIcon

public void setTabCloseIcon(ImageReference newValue)

Sets the close icon displayed in the tabs.

Parameters:: newValue - the new icon

setTabCloseIconRolloverEnabled

public void setTabCloseIconRolloverEnabled(boolean newValue)

Sets the enabled state of tab close icon rollover effects.

Parameters:: newValue - true if close icon rollover effects should be enabled

setTabDefaultCloseOperation

public void setTabDefaultCloseOperation(int newValue)

Sets the default tab close operation.

Parameters:

newValue - the new default tab close operation, one of the following values:

TAB_DO_NOTHING_ON_CLOSE
TAB_DISPOSE_ON_CLOSE

setTabDisabledCloseIcon

public void setTabDisabledCloseIcon(ImageReference newValue)

Sets the close icon that is displayed when tab close is disabled.

Parameters:: newValue - the new icon

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

setTabIconTextMargin

public void setTabIconTextMargin(Extent newValue)

Sets the margin size between the icon and the text. The margin will only be displayed if a tab has both icon and text set. This property only supports Extents with fixed (i.e., not percent) units.

Parameters:: newValue - the margin size

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

setTabInactiveBackgroundInsets

public void setTabInactiveBackgroundInsets(Insets newValue)

Sets the inset margin displayed around the background color/image used to render inactive tabs. Rendered only when image borders are used.

Parameters:: newValue - the new inset margin

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

setTabInactiveImageBorder

public void setTabInactiveImageBorder(FillImageBorder newValue)

Sets the FillImageBorder used to draw inactive tabs.

Parameters:: newValue - the new border

setTabInactiveInsets

public void setTabInactiveInsets(Insets newValue)

Sets the insets of inactive tabs.

Parameters:: newValue - the new inactive tab insets

setTabInactiveLeftImage

public void setTabInactiveLeftImage(ImageReference newValue)

Deprecated. FillImageBorders should be used to render complex tabs

Sets the left image used to render inactive tabs. The width of the image must be set, and has to be a pixel value.

Parameters:: newValue - the inactive tab left image
See Also:: setTabInactiveImageBorder(nextapp.echo.app.FillImageBorder)

setTabInactiveRightImage

public void setTabInactiveRightImage(ImageReference newValue)

Deprecated. FillImageBorders should be used to render complex tabs

Sets the right image used to render inactive tabs. The width of the image must be set, and has to be a pixel value.

Parameters:: newValue - the inactive tab right image
See Also:: setTabInactiveImageBorder(nextapp.echo.app.FillImageBorder)

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

setTabMaximumWidth

public void setTabMaximumWidth(Extent newValue)

Sets the maximum allowed width of a tab.

Parameters:: newValue - the new maximum width

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

setTabRolloverBackground

public void setTabRolloverBackground(Color newValue)

Sets the background color used to render rolled over tabs.

Parameters:: newValue - the new rollover tab background

setTabRolloverBackgroundImage

public void setTabRolloverBackgroundImage(FillImage newValue)

Sets the background image used to render rolled over tabs.

Parameters:: newValue - the new rollover tab background image

setTabRolloverBackgroundInsets

public void setTabRolloverBackgroundInsets(Insets newValue)

Sets the inset margin displayed around the background color/image used to render rolled over tabs. Rendered only when image borders are used.

Parameters:: newValue - the new inset margin

setTabRolloverBorder

public void setTabRolloverBorder(Border newValue)

Sets the Border used to draw rolled over tabs in the TabPane.

Parameters:: newValue - the new rollover border

setTabRolloverCloseIcon

public void setTabRolloverCloseIcon(ImageReference newValue)

Sets the close icon that is displayed when the mouse cursor is inside its bounds.

Parameters:: newValue - the new icon

setTabRolloverEnabled

public void setTabRolloverEnabled(boolean newValue)

Sets the enabled state of tab rollover effects.

Parameters:: newValue - true if tab rollover effects should be enabled

setTabRolloverFont

public void setTabRolloverFont(Font newValue)

Sets the font used to render rolled over tabs.

Parameters:: newValue - the new rollover tab font

setTabRolloverForeground

public void setTabRolloverForeground(Color newValue)

Sets the foreground color used to render rolled over tabs.

Parameters:: newValue - the new rollover tab foreground

setTabRolloverImageBorder

public void setTabRolloverImageBorder(FillImageBorder newValue)

Sets the FillImageBorder used to draw rolled over tabs.

Parameters:: newValue - the new rollover image border

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

userTabClose

public void userTabClose(int tabIndex)

Processes a user request to close the tab with the given index (via the close button).

userTabSelect

public void userTabSelect(int tabIndex)

Processes a user request to select the tab with the given index.

Overview

Package

Class

Tree

Deprecated

Index

Help

NextApp Echo3 Extras
v3.0.b8

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

nextapp.echo.extras.app Class TabPane

INPUT_TAB_CLOSE

INPUT_TAB_SELECT

ACTIVE_TAB_INDEX_CHANGED_PROPERTY

TAB_CLOSING_LISTENERS_CHANGED_PROPERTY

TAB_SELECTION_LISTENERS_CHANGED_PROPERTY

PROPERTY_BORDER

PROPERTY_BORDER_TYPE

PROPERTY_DEFAULT_CONTENT_INSETS

PROPERTY_IMAGE_BORDER

PROPERTY_INSETS

PROPERTY_ROLLOVER_SCROLL_LEFT_ICON

PROPERTY_ROLLOVER_SCROLL_RIGHT_ICON

PROPERTY_SCROLL_LEFT_ICON

PROPERTY_SCROLL_RIGHT_ICON

PROPERTY_TAB_ACTIVE_BACKGROUND

PROPERTY_TAB_ACTIVE_BACKGROUND_IMAGE

PROPERTY_TAB_ACTIVE_BACKGROUND_INSETS

PROPERTY_TAB_ACTIVE_BORDER

PROPERTY_TAB_ACTIVE_FONT

PROPERTY_TAB_ACTIVE_FOREGROUND

PROPERTY_TAB_ACTIVE_HEIGHT_INCREASE

PROPERTY_TAB_ACTIVE_IMAGE_BORDER

PROPERTY_TAB_ACTIVE_INSETS

PROPERTY_TAB_ACTIVE_LEFT_IMAGE

PROPERTY_TAB_ACTIVE_RIGHT_IMAGE

PROPERTY_TAB_ALIGNMENT

PROPERTY_TAB_BACKGROUND_IMAGE

PROPERTY_TAB_CLOSE_ENABLED

PROPERTY_TAB_CLOSE_ICON

PROPERTY_TAB_CLOSE_ICON_ROLLOVER_ENABLED

PROPERTY_TAB_DEFAULT_CLOSE_OPERATION

PROPERTY_TAB_DISABLED_CLOSE_ICON

PROPERTY_TAB_HEIGHT

PROPERTY_TAB_ICON_TEXT_MARGIN

PROPERTY_TAB_INACTIVE_BACKGROUND

PROPERTY_TAB_INACTIVE_BACKGROUND_IMAGE

PROPERTY_TAB_INACTIVE_BACKGROUND_INSETS

PROPERTY_TAB_INACTIVE_BORDER

PROPERTY_TAB_INACTIVE_FONT

PROPERTY_TAB_INACTIVE_FOREGROUND

PROPERTY_TAB_INACTIVE_IMAGE_BORDER

PROPERTY_TAB_INACTIVE_INSETS

PROPERTY_TAB_INACTIVE_LEFT_IMAGE

PROPERTY_TAB_INACTIVE_RIGHT_IMAGE

PROPERTY_TAB_INSET

PROPERTY_TAB_MAXIMUM_WIDTH

PROPERTY_TAB_POSITION

PROPERTY_TAB_ROLLOVER_CLOSE_ICON

PROPERTY_TAB_ROLLOVER_BACKGROUND

PROPERTY_TAB_ROLLOVER_BACKGROUND_IMAGE

PROPERTY_TAB_ROLLOVER_BACKGROUND_INSETS

PROPERTY_TAB_ROLLOVER_BORDER

PROPERTY_TAB_ROLLOVER_ENABLED

PROPERTY_TAB_ROLLOVER_FONT

PROPERTY_TAB_ROLLOVER_FOREGROUND

PROPERTY_TAB_ROLLOVER_IMAGE_BORDER

PROPERTY_TAB_SPACING

PROPERTY_TAB_WIDTH

BORDER_TYPE_ADJACENT_TO_TABS

BORDER_TYPE_NONE

BORDER_TYPE_PARALLEL_TO_TABS

BORDER_TYPE_SURROUND

TAB_DO_NOTHING_ON_CLOSE

TAB_DISPOSE_ON_CLOSE

TAB_POSITION_TOP

TAB_POSITION_BOTTOM

TabPane

addTabClosingListener

addTabSelectionListener

fireTabClosing

fireTabSelected

getActiveTabIndex

getBorder

getBorderType

getDefaultContentInsets

getImageBorder

getInsets

getRolloverScrollLeftIcon

getRolloverScrollRightIcon

nextapp.echo.extras.app
Class TabPane