com.lf.commons.docking.tabbed

Interface TabbedWindowTab

All Known Implementing Classes:

CryptoResultsTab, DatabaseSessionTab, DatabaseTabbedSession, DatabaseUpdateLogTab, EditorTab, FileSystemFindTab, OptionsTab, OutputLogFileTab, VFSFindTab, VFSSessionTab

public interface TabbedWindowTab

Interface for configuring and displaying tabs for TabbedWindow.

Since:

1.5

Version:

$Revision: 1.9 $, $Date: 2012/12/28 11:44:25 $

Author:

Axel Schwolow

Method Summary

Methods

Modifier and Type	Method and Description
ActionDelegate	getActionDelegate() Provides the optional action delegate responsible for shared buttons and menu items.
java.awt.Component	getComponent() Provides the component to be displayed by the tabbed docking window.
javax.swing.Icon	getIcon() Provides the graphical icon of the tab used for display.
StatusBarMessage	getMessage() Provides the status bar message for the tab from the creator.
TabbedWindow	getTabbedWindow() Provides the tabbed docking window specified when tabAdded() was called.
java.lang.String	getTitle() Provides the title of the tab used for display.
java.lang.String	getToolTip() Provides the tooltip of the tab used for display.
boolean	isCloseAllowed() Provides the info whether the tab may be closed by the user or not.
void	refresh() Updates the contents of the tab.
void	tabAdded(TabbedWindow parent, java.lang.String id) Informs the tab that it was added to the tabbed window.
void	tabBecomesHidden() Informs the tab that it will vanish from the screen (deselected).
void	tabBecomesShown() Informs the tab that it becomes visible on the screen (selected).
void	tabIsHiding() Informs the tab that it was made invisible by the manager (deselected).
void	tabIsShowing() Informs the tab that it was made visible by the manager (selected).
void	tabRemoved(TabbedWindow parent, java.lang.String id) Informs the tab that it was removed from the tabbed window.

Method Detail

getTitle

java.lang.String getTitle()

Provides the title of the tab used for display.

Returns:

The tab title

Since:

1.5

getToolTip

java.lang.String getToolTip()

Provides the tooltip of the tab used for display.

Returns:

The tab tooltip

Since:

1.5

getIcon

javax.swing.Icon getIcon()

Provides the graphical icon of the tab used for display.

Returns:

The tab icon

Since:

1.5

getComponent

java.awt.Component getComponent()

Provides the component to be displayed by the tabbed docking window.

Returns:

The component

Since:

1.5

getMessage

StatusBarMessage getMessage()

Provides the status bar message for the tab from the creator.

Returns:

The status bar message

Since:

1.5

isCloseAllowed

boolean isCloseAllowed()

Provides the info whether the tab may be closed by the user or not.

Returns:

The close allowed flag

Since:

1.5

tabAdded

void tabAdded(TabbedWindow parent,
            java.lang.String id)

Informs the tab that it was added to the tabbed window.

Parameters:

parent - The tabbed docking window

id - The unique ID

Since:

1.5

tabRemoved

void tabRemoved(TabbedWindow parent,
              java.lang.String id)

Informs the tab that it was removed from the tabbed window.

Parameters:

parent - The tabbed docking window

id - The unique ID

Since:

1.5

tabBecomesShown

void tabBecomesShown()

Informs the tab that it becomes visible on the screen (selected).

Since:

1.5

tabBecomesHidden

void tabBecomesHidden()

Informs the tab that it will vanish from the screen (deselected).

Since:

1.5

tabIsShowing

void tabIsShowing()

Informs the tab that it was made visible by the manager (selected).

Since:

1.5

tabIsHiding

void tabIsHiding()

Informs the tab that it was made invisible by the manager (deselected).

Since:

1.5

getTabbedWindow

TabbedWindow getTabbedWindow()

Provides the tabbed docking window specified when tabAdded() was called.

Returns:

The tabbed docking window, null if not available

Since:

1.5

refresh

void refresh()

Updates the contents of the tab.

Since:

1.5

getActionDelegate

ActionDelegate getActionDelegate()

Provides the optional action delegate responsible for shared buttons and menu items.

Returns:

The delegate instance, null if not available

Since:

1.5