com.lf.commons.docking

Interface DockingWindow

All Known Implementing Classes:

CollapsibeOptionsWindow, DatabaseSessionWindow, DatabaseUpdateLogWindow, EditorWindow, FileSystemWindow, FindWindow, MultiViewOptionsWindow, MultiViewSearchOptionsWindow, MultiViewWindow, OutputWindow, ResultsWindow, TabbedOptionsWindow, TabbedWindow, TaskWindow, VFSSessionWindow

public interface DockingWindow

Interface for configuring and displaying specialized windows shown by the docking manager.

The most well-known windows are the file system and network docking windows.

Since:

1.5

Version:

$Revision: 1.18 $, $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 docking manager.
DockingManager	getDockingManager() Provides the docking manager specified when windowAdded() was called.
javax.swing.ImageIcon	getIcon() Provides the graphical icon of the window used for display.
java.lang.String	getID() Provides the identifier for the window.
int	getMode() Provides the mode the window is presented.
int	getPreferredHeight() Provides the preferred height of the component for TOP and BOTTOM locations.
int	getPreferredWidth() Provides the preferred width of the component for LEFT and RIGHT locations.
java.lang.String	getTitle() Provides the title of the window used for display.
java.lang.String	getToolTip() Provides the tooltip of the window used for display.
int	getWindowHeight() Provides the height when in window mode.
int	getWindowLocation() Provides the last location of the window passed to the windowxxx() methods.
int	getWindowLocationX() Provides the location on the x-axis when in window mode.
int	getWindowLocationY() Provides the location on the y-axis when in window mode.
int	getWindowState() Provides the state (iconified etc.) when in window mode.
int	getWindowWidth() Provides the width when in window mode.
boolean	isAutomatic() Provides if the window may be controlled externally.
boolean	isButtonPressed() Provides the info whether the window is showing or not (hidden).
boolean	isButtonVisible() Provides the info whether the control button is visible or not.
boolean	isGrowing() Provides if the window fills the location completely.
boolean	isWindowMode() Provides the info whether the window is being displayed as separate window.
boolean	isWindowVisible() Provides if the window is currently being shown.
void	refresh() Updates the contents of the docking window.
void	setAutomatic(boolean enable) Sets if the window may be controlled externally.
void	setButtonPressed(boolean pressed) Sets the info whether the window is showing or not (hidden).
void	setButtonVisible(boolean visible) Sets the info whether the control button is visible or not.
void	setGrowing(boolean enable) Sets if the window fills the location completely.
void	setMode(int mode) Sets the mode the the window is presented.
void	setPreferredHeight(int height) Sets the preferred height of the component for TOP and BOTTOM locations.
void	setPreferredWidth(int width) Sets the preferred width of the component for LEFT and RIGHT locations.
void	setWindowHeight(int height) Sets the height when in window mode.
void	setWindowLocationX(int locx) Sets the location on the x-axis when in window mode.
void	setWindowLocationY(int locy) Sets the location on the y-axis when in window mode.
void	setWindowMode(boolean enable) Sets the info whether the window is being displayed as separate window.
void	setWindowState(int state) Sets the state (iconified etc.) when in window mode.
void	setWindowVisible(boolean visible) Sets the state if the window is currently being shown.
void	setWindowWidth(int width) Sets the width when in window mode.
void	windowAdded(DockingManager manager, int location) Informs the docking window that it was added by the manager.
void	windowBecomesHidden(int location) Informs the docking window that it will be made invisible by the manager.
void	windowBecomesShown(int location) Informs the docking window that it will be made visible by the manager.
void	windowIsActive(int location) Informs the docking window that it is now the active window.
void	windowIsHiding(int location) Informs the docking window that it was made invisible by the manager.
void	windowIsInactive(int location) Informs the docking window that it is not the active window any longer.
void	windowIsShowing(int location) Informs the docking window that it was made visible by the manager.
void	windowRemoved(DockingManager manager, int location) Informs the docking window that it was removed by the manager.

Method Detail

getID

java.lang.String getID()

Provides the identifier for the window.

Returns:

The window identifier

Since:

1.6

getTitle

java.lang.String getTitle()

Provides the title of the window used for display.

Returns:

The window title

Since:

1.5

getToolTip

java.lang.String getToolTip()

Provides the tooltip of the window used for display.

Returns:

The window tooltip

Since:

1.5

getIcon

javax.swing.ImageIcon getIcon()

Provides the graphical icon of the window used for display.

Returns:

The window icon

Since:

1.5

getComponent

java.awt.Component getComponent()

Provides the component to be displayed by the docking manager.

Returns:

The component

Since:

1.5

getPreferredWidth

int getPreferredWidth()

Provides the preferred width of the component for LEFT and RIGHT locations.

Returns:

The preferred width

Since:

1.5

setPreferredWidth

void setPreferredWidth(int width)

Sets the preferred width of the component for LEFT and RIGHT locations.

Parameters:

width - The preferred width

Since:

1.5

getPreferredHeight

int getPreferredHeight()

Provides the preferred height of the component for TOP and BOTTOM locations.

Returns:

The preferred height

Since:

1.5

setPreferredHeight

void setPreferredHeight(int height)

Sets the preferred height of the component for TOP and BOTTOM locations.

Parameters:

height - The preferred height

Since:

1.5

getMode

int getMode()

Provides the mode the window is presented.

Returns:

The mode (MODE_DOCKING_PINNED, MODE_DOCKING_UNPINNED, ...)

Since:

1.5

setMode

void setMode(int mode)

Sets the mode the the window is presented.

Parameters:

mode - The mode (MODE_DOCKING_PINNED, MODE_DOCKING_UNPINNED, ...)

Since:

1.5

isAutomatic

boolean isAutomatic()

Provides if the window may be controlled externally.

Returns:

The automatic mode

Since:

1.6

setAutomatic

void setAutomatic(boolean enable)

Sets if the window may be controlled externally.

Parameters:

enable - The automatic mode

Since:

1.6

isGrowing

boolean isGrowing()

Provides if the window fills the location completely.

Returns:

The growing mode

Since:

1.6

setGrowing

void setGrowing(boolean enable)

Sets if the window fills the location completely.

Parameters:

enable - The growing mode

Since:

1.6

isButtonVisible

boolean isButtonVisible()

Provides the info whether the control button is visible or not.

Returns:

The visibility flag

Since:

1.5

setButtonVisible

void setButtonVisible(boolean visible)

Sets the info whether the control button is visible or not.

Parameters:

visible - The visibility flag

Since:

1.5

isButtonPressed

boolean isButtonPressed()

Provides the info whether the window is showing or not (hidden).

Returns:

The pressed flag

Since:

1.6

setButtonPressed

void setButtonPressed(boolean pressed)

Sets the info whether the window is showing or not (hidden).

Parameters:

pressed - The pressed flag

Since:

1.6

isWindowMode

boolean isWindowMode()

Provides the info whether the window is being displayed as separate window.

Returns:

The flag

Since:

1.6

setWindowMode

void setWindowMode(boolean enable)

Sets the info whether the window is being displayed as separate window.

Parameters:

enable - The flag

Since:

1.6

getWindowLocationX

int getWindowLocationX()

Provides the location on the x-axis when in window mode.

Returns:

The x-axis location

Since:

1.6

setWindowLocationX

void setWindowLocationX(int locx)

Sets the location on the x-axis when in window mode.

Parameters:

locx - The x-axis location

Since:

1.6

getWindowLocationY

int getWindowLocationY()

Provides the location on the y-axis when in window mode.

Returns:

The The y-axis location

Since:

1.6

setWindowLocationY

void setWindowLocationY(int locy)

Sets the location on the y-axis when in window mode.

Parameters:

locy - The y-axis location

Since:

1.6

getWindowWidth

int getWindowWidth()

Provides the width when in window mode.

Returns:

The width

Since:

1.6

setWindowWidth

void setWindowWidth(int width)

Sets the width when in window mode.

Parameters:

width - The width

Since:

1.6

getWindowHeight

int getWindowHeight()

Provides the height when in window mode.

Returns:

The height

Since:

1.6

setWindowHeight

void setWindowHeight(int height)

Sets the height when in window mode.

Parameters:

height - The height

Since:

1.6

getWindowState

int getWindowState()

Provides the state (iconified etc.) when in window mode.

Returns:

The state

Since:

1.6

setWindowState

void setWindowState(int state)

Sets the state (iconified etc.) when in window mode.

Parameters:

state - The state

Since:

1.6

isWindowVisible

boolean isWindowVisible()

Provides if the window is currently being shown.

Returns:

Visible?

Since:

1.6

setWindowVisible

void setWindowVisible(boolean visible)

Sets the state if the window is currently being shown.

Parameters:

visible - The state

Since:

1.6

windowAdded

void windowAdded(DockingManager manager,
               int location)

Informs the docking window that it was added by the manager.

Remember that if the window is moved from one docking bar to another it is removed and added again so that this method and windowRemoved() are called.

Parameters:

manager - The docking manager

location - The location (TOP, BOTTOM, LEFT, RIGHT)

Since:

1.5

windowRemoved

void windowRemoved(DockingManager manager,
                 int location)

Informs the docking window that it was removed by the manager.

Remember that if the window is moved from one docking bar to another it is removed and added again so that this method and windowAdded() are called.

Parameters:

manager - The docking manager

location - The location (TOP, BOTTOM, LEFT, RIGHT)

Since:

1.5

windowBecomesShown

void windowBecomesShown(int location)

Informs the docking window that it will be made visible by the manager.

Parameters:

location - The location (TOP, BOTTOM, LEFT, RIGHT)

Since:

1.5

windowBecomesHidden

void windowBecomesHidden(int location)

Informs the docking window that it will be made invisible by the manager.

Parameters:

location - The location (TOP, BOTTOM, LEFT, RIGHT)

Since:

1.5

windowIsShowing

void windowIsShowing(int location)

Informs the docking window that it was made visible by the manager.

Parameters:

location - The location (TOP, BOTTOM, LEFT, RIGHT)

Since:

1.5

windowIsHiding

void windowIsHiding(int location)

Informs the docking window that it was made invisible by the manager.

Parameters:

location - The location (TOP, BOTTOM, LEFT, RIGHT)

Since:

1.5

windowIsActive

void windowIsActive(int location)

Informs the docking window that it is now the active window.

Parameters:

location - The location (TOP, BOTTOM, LEFT, RIGHT)

Since:

1.6

windowIsInactive

void windowIsInactive(int location)

Informs the docking window that it is not the active window any longer.

Parameters:

location - The location (TOP, BOTTOM, LEFT, RIGHT)

Since:

1.6

getDockingManager

DockingManager getDockingManager()

Provides the docking manager specified when windowAdded() was called.

Returns:

The docking manager, null if not available

Since:

1.5

refresh

void refresh()

Updates the contents of the docking window.

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

getWindowLocation

int getWindowLocation()

Provides the last location of the window passed to the windowxxx() methods.

Returns:

The location (TOP, BOTTOM, LEFT, RIGHT) or -1

Since:

1.6