Package docking

Class AbstractDockingTool

java.lang.Object

docking.AbstractDockingTool

All Implemented Interfaces:

DockingTool

Direct Known Subclasses:

FakeDockingTool, PluginTool

public abstract class AbstractDockingTool
extends java.lang.Object
implements DockingTool

A partial implementation of DockingTool that serves as a place to share common functionality

Field Summary

Fields

Modifier and Type	Field	Description
protected DockingToolActionManager	actionMgr
protected boolean	configChangedFlag
protected java.util.Map<java.lang.String,ToolOptions>	optionsMap
protected DockingWindowManager	winMgr

Constructor Summary

Constructors

Constructor	Description
AbstractDockingTool()

Method Summary

Modifier and Type	Method	Description
void	addAction(DockingActionIf action)	Adds the action to the tool.
void	addComponentProvider(ComponentProvider provider, boolean show)	Adds the ComponentProvider to the tool, optionally making it visible.
void	addLocalAction(ComponentProvider provider, DockingActionIf action)	Adds the action to the given provider as a local action.
void	contextChanged(ComponentProvider provider)	Signals to the tool that the provider's context has changed.
java.util.List<DockingActionIf>	getAllActions()	Return a list of all actions in the tool.
ComponentProvider	getComponentProvider(java.lang.String name)	Gets the ComponentProvider with the given name.
java.util.List<DockingActionIf>	getDockingActionsByFullActionName(java.lang.String fullActionName)	Return an list of actions with the given full name
java.util.List<DockingActionIf>	getDockingActionsByOwnerName(java.lang.String owner)	Returns all actions for the given owner
java.awt.Window	getProviderWindow(ComponentProvider provider)	Returns the parent window for the given provider
javax.swing.JFrame	getToolFrame()
DockingWindowManager	getWindowManager()	Returns the DockingWindowManger for this tool.
boolean	hasConfigChanged()	Return true if the tool's configuration has changed.
boolean	isActive(ComponentProvider provider)	Returns true if the ComponentProvider is the currently active provider.
boolean	isVisible()	Returns true if tool is visible.
boolean	isVisible(ComponentProvider provider)	Returns true if the given ComponentProvider is currently visible.
void	removeAction(DockingActionIf action)	Removes the given action from the tool
void	removeComponentProvider(ComponentProvider provider)	Removes the given ComponentProvider from the tool.
void	removeLocalAction(ComponentProvider provider, DockingActionIf action)	Removes the action from the provider
void	setConfigChanged(boolean changed)	Toggles the "change" state of the tool...
void	setStatusInfo(java.lang.String text)	Set the status information
void	setVisible(boolean visibility)	Sets the tool visible or invisible.
void	showComponentProvider(ComponentProvider provider, boolean visible)	Shows or hides the component provider in the tool
void	showDialog(DialogComponentProvider dialogComponent)	Shows the dialog using the tool's root frame as a parent.
void	toFront()	Brings this tool to the front.
void	toFront(ComponentProvider provider)	Makes the given ComponentProvider move to the front if it is tabbed with other components.
void	updateTitle(ComponentProvider provider)	Indicates to the tool that the given componentProvider's title has changed.

Methods inherited from class java.lang.Object

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

Methods inherited from interface docking.DockingTool

getIcon, getName, getOptions

Field Detail

winMgr

protected DockingWindowManager winMgr

actionMgr

protected DockingToolActionManager actionMgr

optionsMap

protected java.util.Map<java.lang.String,ToolOptions> optionsMap

configChangedFlag

protected boolean configChangedFlag

Constructor Detail

AbstractDockingTool

public AbstractDockingTool()

Method Detail

isVisible

public boolean isVisible()

Description copied from interface: DockingTool

Returns true if tool is visible.

Specified by:

isVisible in interface DockingTool

setVisible

public void setVisible(boolean visibility)

Description copied from interface: DockingTool

Sets the tool visible or invisible. This method is used by the Project to make it's tools visible or invisible depending on whether this tool is in is the active workspace.

Specified by:

setVisible in interface DockingTool

Parameters:

visibility - true specifies that the tool should be visible

toFront

public void toFront()

Description copied from interface: DockingTool

Brings this tool to the front. Places this tool at the top of the stacking order and shows it in front of any other tools.

Specified by:

toFront in interface DockingTool

addComponentProvider

public void addComponentProvider(ComponentProvider provider,
                                 boolean show)

Description copied from interface: DockingTool

Adds the ComponentProvider to the tool, optionally making it visible.

Specified by:

addComponentProvider in interface DockingTool

Parameters:

provider - the provider to add to the tool

show - if true, the component is made visible.

removeComponentProvider

public void removeComponentProvider(ComponentProvider provider)

Description copied from interface: DockingTool

Removes the given ComponentProvider from the tool.

Specified by:

removeComponentProvider in interface DockingTool

getComponentProvider

public ComponentProvider getComponentProvider(java.lang.String name)

Description copied from interface: DockingTool

Gets the ComponentProvider with the given name.

Specified by:

getComponentProvider in interface DockingTool

Parameters:

name - the name of the provider to get

Returns:

the provider

setStatusInfo

public void setStatusInfo(java.lang.String text)

Description copied from interface: DockingTool

Set the status information

Specified by:

setStatusInfo in interface DockingTool

Parameters:

text - string to be displayed in the Status display area

addAction

public void addAction(DockingActionIf action)

Description copied from interface: DockingTool

Adds the action to the tool.

Specified by:

addAction in interface DockingTool

Parameters:

action - the action to be added.

removeAction

public void removeAction(DockingActionIf action)

Description copied from interface: DockingTool

Removes the given action from the tool

Specified by:

removeAction in interface DockingTool

Parameters:

action - the action to be removed.

addLocalAction

public void addLocalAction(ComponentProvider provider,
                           DockingActionIf action)

Description copied from interface: DockingTool

Adds the action to the given provider as a local action.

Specified by:

addLocalAction in interface DockingTool

Parameters:

provider - the provider to add the action to.

action - the DockingAction to add to the componentProvider.

removeLocalAction

public void removeLocalAction(ComponentProvider provider,
                              DockingActionIf action)

Description copied from interface: DockingTool

Removes the action from the provider

Specified by:

removeLocalAction in interface DockingTool

Parameters:

provider - the component provider from which to remove the action.

action - the action to remove.

getAllActions

public java.util.List<DockingActionIf> getAllActions()

Description copied from interface: DockingTool

Return a list of all actions in the tool.

Specified by:

getAllActions in interface DockingTool

Returns:

list of all actions

getDockingActionsByOwnerName

public java.util.List<DockingActionIf> getDockingActionsByOwnerName(java.lang.String owner)

Description copied from interface: DockingTool

Returns all actions for the given owner

Specified by:

getDockingActionsByOwnerName in interface DockingTool

Parameters:

owner - the action owner's name

Returns:

the actions

getDockingActionsByFullActionName

public java.util.List<DockingActionIf> getDockingActionsByFullActionName(java.lang.String fullActionName)

Description copied from interface: DockingTool

Return an list of actions with the given full name

Specified by:

getDockingActionsByFullActionName in interface DockingTool

Parameters:

fullActionName - action name that includes the owner's name in parentheses, e.g. "MyAction (MyPlugin)"

Returns:

the actions

showComponentProvider

public void showComponentProvider(ComponentProvider provider,
                                  boolean visible)

Description copied from interface: DockingTool

Shows or hides the component provider in the tool

Specified by:

showComponentProvider in interface DockingTool

Parameters:

provider - the provider to either show or hide.

visible - true to show the provider, false to hide it.

showDialog

public void showDialog(DialogComponentProvider dialogComponent)

Description copied from interface: DockingTool

Shows the dialog using the tool's root frame as a parent. Also, remembers any size and location adjustments made by the user for the next time the dialog is shown.

Specified by:

showDialog in interface DockingTool

Parameters:

dialogComponent - the DialogComponentProvider object to be shown in a dialog.

getToolFrame

public javax.swing.JFrame getToolFrame()

getProviderWindow

public java.awt.Window getProviderWindow(ComponentProvider provider)

Description copied from interface: DockingTool

Returns the parent window for the given provider

Specified by:

getProviderWindow in interface DockingTool

Parameters:

provider - the provider

Returns:

the window

toFront

public void toFront(ComponentProvider provider)

Description copied from interface: DockingTool

Makes the given ComponentProvider move to the front if it is tabbed with other components.

Specified by:

toFront in interface DockingTool

Parameters:

provider - the provider to move to the top of its stacking order.

isVisible

public boolean isVisible(ComponentProvider provider)

Description copied from interface: DockingTool

Returns true if the given ComponentProvider is currently visible.

Specified by:

isVisible in interface DockingTool

Parameters:

provider - the provider to check for visibility.

Returns:

true if the given ComponentProvider is currently visible.

isActive

public boolean isActive(ComponentProvider provider)

Description copied from interface: DockingTool

Returns true if the ComponentProvider is the currently active provider. The active provider is the provider that has keyboard focus and provides the current action context.

Specified by:

isActive in interface DockingTool

Parameters:

provider - the provider to check for active.

Returns:

true if the ComponentProvider is the currently active provider.

updateTitle

public void updateTitle(ComponentProvider provider)

Description copied from interface: DockingTool

Indicates to the tool that the given componentProvider's title has changed.

Specified by:

updateTitle in interface DockingTool

Parameters:

provider - the componentProvider whose title has changed.

contextChanged

public void contextChanged(ComponentProvider provider)

Description copied from interface: DockingTool

Signals to the tool that the provider's context has changed. This lets toolbar actions update enablement based on current context.

Specified by:

contextChanged in interface DockingTool

Parameters:

provider - the provider whose context changed.

getWindowManager

public DockingWindowManager getWindowManager()

Description copied from interface: DockingTool

Returns the DockingWindowManger for this tool.

Specified by:

getWindowManager in interface DockingTool

Returns:

the DockingWindowManger for this tool.

setConfigChanged

public void setConfigChanged(boolean changed)

Description copied from interface: DockingTool

Toggles the "change" state of the tool...

Specified by:

setConfigChanged in interface DockingTool

Parameters:

changed - true indicates that the tool config has changed.

hasConfigChanged

public boolean hasConfigChanged()

Description copied from interface: DockingTool

Return true if the tool's configuration has changed.

Specified by:

hasConfigChanged in interface DockingTool