org.wandora.application.tools.navigate

Class OpenTopic

java.lang.Object

org.wandora.application.tools.AbstractWandoraTool

org.wandora.application.tools.navigate.OpenTopic

All Implemented Interfaces:

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

public class OpenTopic
extends AbstractWandoraTool
implements WandoraTool

Author:

akivela

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	ASK_USER
int	options
static int	SOLVE_USING_CONTEXT

Fields inherited from interface org.wandora.application.WandoraToolLogger

CLOSE, EXECUTE, INVISIBLE, VISIBLE, WAIT

Constructor Summary

Constructors

Constructor and Description
OpenTopic() Creates a new instance of OpenTopic
OpenTopic(Context preferredContext)
OpenTopic(int preferredOptions)

Method Summary

Modifier and Type	Method and Description
void	execute(Wandora wandora, Context context) Runs the tool.
java.lang.String	getDescription() AdminToolManager views tool descriptions while user browses available tools and build user customizable GUI elements such as Tools menu.
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.
boolean	runInOwnThread() Whether or not this tool should fork own thread.

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, getHistory, getLastLogger, getState, getThreads, getThreads, getToolMenuItem, getToolMenuItem, getTopicName, getType, hlog, initialize, interruptAllThreads, interruptThreads, interruptThreads, isConfigurable, isRunning, isRunning, lockLog, log, log, log, log, run, 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, 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

ASK_USER

public static final int ASK_USER

See Also:

Constant Field Values

SOLVE_USING_CONTEXT

public static final int SOLVE_USING_CONTEXT

See Also:

Constant Field Values

options

public int options

Constructor Detail

OpenTopic

public OpenTopic()

Creates a new instance of OpenTopic

OpenTopic

public OpenTopic(Context preferredContext)

OpenTopic

public OpenTopic(int preferredOptions)

Method Detail

execute

public void execute(Wandora wandora,
                    Context context)
             throws TopicMapException

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

Throws:

TopicMapException

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.

getDescription

public java.lang.String getDescription()

Description copied from class: AbstractWandoraTool

AdminToolManager views tool descriptions while user browses available tools and build user customizable GUI elements such as Tools menu. By default description equals the tool name. All tools should override this method.

Specified by:

getDescription in interface WandoraTool

Overrides:

getDescription in class AbstractWandoraTool

Returns:

String representing tool's description.

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.

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.

runInOwnThread

public boolean runInOwnThread()

Description copied from class: AbstractWandoraTool

Whether or not this tool should fork own thread. If own thread is allowed, the execution of the tool return immediately. If own thread is not allowed the thread entering initial execute method is used. Extending classes should override this method.

Overrides:

runInOwnThread in class AbstractWandoraTool

Returns:

true if the tool should should be ran in separate thread.