org.wandora.application.tools.docking

Class AddDockable

java.lang.Object

org.wandora.application.tools.AbstractWandoraTool

org.wandora.application.tools.docking.AbstractDockingTool

org.wandora.application.tools.docking.AddDockable

All Implemented Interfaces:

java.io.Serializable, java.lang.Runnable, WandoraTool, WandoraToolLogger, TopicMapLogger

Direct Known Subclasses:

AddGraph, AddSearch, AddSketchGrid, AddTraditional, AddTree, AddWebView

public class AddDockable
extends AbstractDockingTool

Add a topic panel into the DockingFramePanel. Added topic panel is specified with a class argument passed to the constructor. A single AddDockable object can add only one type of topic panels. Whenever a topic panel is added a context topic is passed to the topic panel as an argument.

Author:

akivela

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.Class	dockableClass
private javax.swing.Icon	dockableIcon

Fields inherited from interface org.wandora.application.WandoraToolLogger

CLOSE, EXECUTE, INVISIBLE, VISIBLE, WAIT

Constructor Summary

Constructors

Constructor and Description
AddDockable(java.lang.Class dc) Creates a new instance of AddDockable
AddDockable(java.lang.String className)

Method Summary

Modifier and Type	Method and Description
void	execute(Wandora w, Context context) Runs the tool.
javax.swing.Icon	getIcon() All tools may have identifying graphic icon used within tool GUI elements.
java.lang.String	getName() Tools name represent the tool in UI unless the tool has been given explicitly another GUI name.
boolean	requiresRefresh() If any visible topic has been changed during tool execution GUI is automatically refreshed.

Methods inherited from class org.wandora.application.tools.docking.AbstractDockingTool

solveDockingFramePanel

Methods inherited from class org.wandora.application.tools.AbstractWandoraTool

addUndoMarker, addUndoMarker, allowMultipleInvocations, clearAllThreads, clearThreads, clearThreads, clearToolLock, clearToolLock, clearToolLocks, configure, execute, execute, forceStop, forceStop, getContext, getCurrentLogger, getDefaultLogger, getDescription, getHistory, getLastLogger, getState, getThreads, getThreads, getToolMenuItem, getToolMenuItem, getTopicName, getType, hlog, initialize, interruptAllThreads, interruptThreads, interruptThreads, isConfigurable, isRunning, isRunning, lockLog, log, log, log, log, run, runInOwnThread, setContext, setDefaultLogger, setLogTitle, setProgress, setProgressMax, setState, setToolLogger, singleLog, singleLog, singleLog, solveContextTopicMap, solveNameForTopicMap, writeOptions

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.wandora.application.WandoraTool

configure, execute, execute, getContext, getDescription, getToolMenuItem, getType, hlog, initialize, isConfigurable, isRunning, log, log, log, log, setContext, setToolLogger, writeOptions

Methods inherited from interface org.wandora.application.WandoraToolLogger

forceStop, getHistory, getState, lockLog, setLogTitle, setProgress, setProgressMax, setState

Field Detail

dockableClass

private java.lang.Class dockableClass

dockableIcon

private javax.swing.Icon dockableIcon

Constructor Detail

AddDockable

public AddDockable(java.lang.Class dc)

Creates a new instance of AddDockable

AddDockable

public AddDockable(java.lang.String className)

Method Detail

getName

public java.lang.String getName()

Description copied from class: AbstractWandoraTool

Tools name represent the tool in UI unless the tool has been given explicitly another GUI name. All tools should override this method and return a valid string representing name of the tool.

Specified by:

getName in interface WandoraTool

Overrides:

getName in class AbstractWandoraTool

Returns:

String representing tool's name.

getIcon

public javax.swing.Icon getIcon()

Description copied from class: AbstractWandoraTool

All tools may have identifying graphic icon used within tool GUI elements. getIcon should return Icon object of the tool.

Specified by:

getIcon in interface WandoraTool

Overrides:

getIcon in class AbstractWandoraTool

Returns:

icon for the tool.

execute

public void execute(Wandora w,
                    Context context)

Description copied from interface: WandoraTool

Runs the tool. This is the main entry to the tool. Here the context

Specified by:

execute in interface WandoraTool

Overrides:

execute in class AbstractDockingTool

requiresRefresh

public boolean requiresRefresh()

Description copied from class: AbstractWandoraTool

If any visible topic has been changed during tool execution GUI is automatically refreshed. If tool doesn't change topics but GUI still requires refresh, tool should override this method and return true.

For example tools that alter the GUI but change no topics should return true.

Specified by:

requiresRefresh in interface WandoraTool

Overrides:

requiresRefresh in class AbstractWandoraTool

Returns:

true if Wandora application should refresh user interface.