org.wandora.application.tools

Class SetOptions

java.lang.Object

org.wandora.application.tools.AbstractWandoraTool

org.wandora.application.tools.SetOptions

All Implemented Interfaces:

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

public class SetOptions
extends AbstractWandoraTool
implements WandoraTool

Author:

akivela

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.HashMap	options
private boolean	requiresRefresh

Fields inherited from interface org.wandora.application.WandoraToolLogger

CLOSE, EXECUTE, INVISIBLE, VISIBLE, WAIT

Constructor Summary

Constructors

Constructor and Description
SetOptions()
SetOptions(java.lang.String key, int value, boolean rf)
SetOptions(java.lang.String key, java.lang.String value, boolean rf)

Method Summary

Modifier and Type	Method and Description
void	execute(Wandora wandora, Context context) Runs the tool.
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.
void	setOption(java.lang.String key, java.lang.String value)
void	setOptions(java.util.HashMap subOptions)

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, getIcon, 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, getIcon, 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

options

private java.util.HashMap options

requiresRefresh

private boolean requiresRefresh

Constructor Detail

SetOptions

public SetOptions()

SetOptions

public SetOptions(java.lang.String key,
                  int value,
                  boolean rf)

SetOptions

public SetOptions(java.lang.String key,
                  java.lang.String value,
                  boolean rf)

Method Detail

setOption

public void setOption(java.lang.String key,
                      java.lang.String value)

setOptions

public void setOptions(java.util.HashMap subOptions)

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.

execute

public void execute(Wandora wandora,
                    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

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.