com.lf.commons.docking.options

Class OptionsView

java.lang.Object

com.lf.commons.docking.options.OptionsView

All Implemented Interfaces:

WindowView, ActionDelegate

Direct Known Subclasses:

CollapsibleOptionsView, FileSearchOptionsView, TableSearchOptionsView

public abstract class OptionsView
extends java.lang.Object
implements WindowView, ActionDelegate

The base class for components handled by the MultiViewWindow.

Since:

1.6

Version:

$Revision: 1.7 $, $Date: 2012/12/28 11:44:24 $

Author:

Axel Schwolow

Field Summary

Fields

Modifier and Type	Field and Description
protected SharedAction[]	actions Remembers the shared action components (optional).
protected java.awt.Component	comp The component that paints this view.
protected java.lang.String	helpID Help system ID from the application (must be delegated).
protected MultiViewWindow	multiViewWindow The parental multi view window for this window.
protected java.lang.String[]	supportedActions Array with supported shared actions.
protected java.lang.String	viewTitle The title of the view.

Constructor Summary

Constructors

Constructor and Description
OptionsView() Constructor method for i18n purposes only.
OptionsView(java.lang.String title) Constructor for the GUI component.

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.
abstract Configuration	getConfiguration() Provides the options as a whole.
MultiViewWindow	getMultiViewWindow() Provides the multi view docking window specified when viewAdded() was called.
java.lang.String[]	getSupportedActions() Provides the supported shared actions for this delegate.
java.lang.String	getTitle() Provides the title of the view used for display.
void	setHelpID(java.lang.String helpid) Sets the identifier for the context sensitive help (must be delegated).
void	stopControl() Provides the info that the control of the given shared actions must be stopped.
void	viewAdded(MultiViewWindow parent, java.lang.String id) Informs the view that it was added to the multi view window.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.lf.commons.docking.multiview.WindowView

getMessage, refresh, viewBecomesHidden, viewBecomesShown, viewIsHiding, viewIsShowing, viewRemoved

Methods inherited from interface com.lf.commons.gui.ActionDelegate

processAction, startControl

Field Detail

multiViewWindow

protected MultiViewWindow multiViewWindow

The parental multi view window for this window.

viewTitle

protected java.lang.String viewTitle

The title of the view.

comp

protected java.awt.Component comp

The component that paints this view.

supportedActions

protected java.lang.String[] supportedActions

Array with supported shared actions.

actions

protected SharedAction[] actions

Remembers the shared action components (optional).

helpID

protected java.lang.String helpID

Help system ID from the application (must be delegated).

Constructor Detail

OptionsView

public OptionsView()
            throws java.lang.InstantiationException

Constructor method for i18n purposes only.

Can only be used if beans design time is set (e.g. by external tools like the I18NExtractor).

Throws:

java.lang.InstantiationException - Error indication

Since:

1.6

OptionsView

public OptionsView(java.lang.String title)

Constructor for the GUI component.

The component needs to be set by the subclass.

Parameters:

title - The title of the view

Since:

1.6

Method Detail

getTitle

public java.lang.String getTitle()

Provides the title of the view used for display.

Specified by:

getTitle in interface WindowView

Returns:

The view title

Since:

1.6

getComponent

public java.awt.Component getComponent()

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

Specified by:

getComponent in interface WindowView

Returns:

The component

Since:

1.6

viewAdded

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

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

Specified by:

viewAdded in interface WindowView

Parameters:

parent - The multi view docking window

id - The unique ID

Since:

1.6

getMultiViewWindow

public MultiViewWindow getMultiViewWindow()

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

Specified by:

getMultiViewWindow in interface WindowView

Returns:

The multi view docking window, null if not available

Since:

1.6

getActionDelegate

public ActionDelegate getActionDelegate()

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

Specified by:

getActionDelegate in interface WindowView

Returns:

The delegate instance, null if not available

Since:

1.6

getSupportedActions

public java.lang.String[] getSupportedActions()

Provides the supported shared actions for this delegate.

Specified by:

getSupportedActions in interface ActionDelegate

Returns:

The names of actions supported by this delegate

Since:

1.6

stopControl

public void stopControl()

Provides the info that the control of the given shared actions must be stopped.

Specified by:

stopControl in interface ActionDelegate

Since:

1.6

setHelpID

public void setHelpID(java.lang.String helpid)

Sets the identifier for the context sensitive help (must be delegated).

Parameters:

helpid - The help system link

Since:

1.6

getConfiguration

public abstract Configuration getConfiguration()

Provides the options as a whole.

This can be used to get all current settings with one method call. The variable names are the names of the components (e.g. "radioButtonSimple"). The values are the selected states of the boxes and radio buttons.

Returns:

The configuration

Since:

1.6