Package org.graffiti.plugin.algorithm

Class ThreadSafeAlgorithm

java.lang.Object

org.graffiti.plugin.algorithm.ThreadSafeAlgorithm

All Implemented Interfaces:

Algorithm

Direct Known Subclasses:

BackgroundExecutionAlgorithm, ForceDirectedLayoutWrapper, MultilevelFrameworkLayout, PatternSpringembedder, PatternSpringembedder, PatternSpringembedder3d, RotateAlgorithm

public abstract class ThreadSafeAlgorithm
extends Object
implements Algorithm

DOCUMENT ME!

Version:

$Revision: 1.5 $

Author:

$author$

Constructor Summary

Constructors

Constructor	Description
ThreadSafeAlgorithm()

Method Summary

Modifier and Type	Method	Description
abstract void	executeThreadSafe(ThreadSafeOptions options)
KeyStroke	getAcceleratorKeyStroke()	Override this method to provide a accelerator hot key for the algorithm.
boolean	mayWorkOnMultipleGraphs()
abstract void	resetDataCache(ThreadSafeOptions options)
abstract boolean	setControlInterface(ThreadSafeOptions options, JComponent jc)	DOCUMENT ME!
boolean	showMenuIcon()	Override this method to give a different look and feel to the application, and to put the plugin icon next to the menu item in the main menu bar.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.graffiti.plugin.algorithm.Algorithm

attach, check, execute, getActionEvent, getCategory, getDescription, getMenuCategory, getName, getParameters, getSetCategory, isLayoutAlgorithm, reset, setActionEvent, setParameters

Constructor Details

ThreadSafeAlgorithm

public ThreadSafeAlgorithm()

Method Details

setControlInterface

public abstract boolean setControlInterface(ThreadSafeOptions options,
JComponent jc)

DOCUMENT ME!

Parameters:

jc -

Returns:

true, if an GUI was set, false if no interface is needed

executeThreadSafe

public abstract void executeThreadSafe(ThreadSafeOptions options)

resetDataCache

public abstract void resetDataCache(ThreadSafeOptions options)

getAcceleratorKeyStroke

public KeyStroke getAcceleratorKeyStroke()

Description copied from interface: Algorithm

Override this method to provide a accelerator hot key for the algorithm.

Specified by:

getAcceleratorKeyStroke in interface Algorithm

Returns:

NULL (default) if no accelerator should be assigned for this algorithm.

showMenuIcon

public boolean showMenuIcon()

Description copied from interface: Algorithm

Override this method to give a different look and feel to the application, and to put the plugin icon next to the menu item in the main menu bar.

Specified by:

showMenuIcon in interface Algorithm

Returns:

True, if the plugin icon should be shown next to the menu item. Return FALSE (default!), if no icon should be shown in the menu.

mayWorkOnMultipleGraphs

public boolean mayWorkOnMultipleGraphs()

Specified by:

mayWorkOnMultipleGraphs in interface Algorithm