com.lf.commons.docking.multiview

Interface WindowView

All Known Implementing Classes:

CollapsibleOptionsView, FileSearchOptionsView, OptionsView, TableSearchOptionsView

public interface WindowView

Interface for configuring and displaying components for MultiViewWindow.

Since:

1.6

Version:

$Revision: 1.5 $, $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 multi view docking window.
StatusBarMessage	getMessage() Provides the status bar message for the view from the creator.
MultiViewWindow	getMultiViewWindow() Provides the multi view docking window specified when viewAdded() was called.
java.lang.String	getTitle() Provides the title of the view used for display.
void	refresh() Updates the contents of the view.
void	viewAdded(MultiViewWindow parent, java.lang.String id) Informs the view that it was added to the multi view window.
void	viewBecomesHidden() Informs the view that it will vanish from the screen.
void	viewBecomesShown() Informs the view that it becomes visible on the screen.
void	viewIsHiding() Informs the view that it was made invisible by the manager.
void	viewIsShowing() Informs the view that it was made visible by the manager.
void	viewRemoved(MultiViewWindow parent, java.lang.String id) Informs the view that it was removed from the multi view window.

Method Detail

getTitle

java.lang.String getTitle()

Provides the title of the view used for display.

Returns:

The view title

Since:

1.6

getComponent

java.awt.Component getComponent()

Provides the component to be displayed by the multi view docking window.

Returns:

The component

Since:

1.6

getMessage

StatusBarMessage getMessage()

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

Returns:

The status bar message

Since:

1.6

viewAdded

void viewAdded(MultiViewWindow parent,
             java.lang.String id)

Informs the view that it was added to the multi view window.

Parameters:

parent - The multi view docking window

id - The unique ID

Since:

1.6

viewRemoved

void viewRemoved(MultiViewWindow parent,
               java.lang.String id)

Informs the view that it was removed from the multi view window.

Parameters:

parent - The multi view docking window

id - The unique ID

Since:

1.6

viewBecomesShown

void viewBecomesShown()

Informs the view that it becomes visible on the screen.

Since:

1.6

viewBecomesHidden

void viewBecomesHidden()

Informs the view that it will vanish from the screen.

Since:

1.6

viewIsShowing

void viewIsShowing()

Informs the view that it was made visible by the manager.

Since:

1.6

viewIsHiding

void viewIsHiding()

Informs the view that it was made invisible by the manager.

Since:

1.6

getMultiViewWindow

MultiViewWindow getMultiViewWindow()

Provides the multi view docking window specified when viewAdded() was called.

Returns:

The multi view docking window, null if not available

Since:

1.6

refresh

void refresh()

Updates the contents of the view.

Since:

1.6

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.6