Package org.graffiti.plugin.algorithm

Class AbstractEditorAlgorithm

java.lang.Object

org.graffiti.plugin.algorithm.AbstractAlgorithm

org.graffiti.plugin.algorithm.AbstractEditorAlgorithm

All Implemented Interfaces:

UndoableEdit, Algorithm, EditorAlgorithm

Direct Known Subclasses:

AbstractExperimentDataProcessor, BackgroundAlgorithm, ChangeEdgeStyle, ChangeElementStyle, ChangeNodeStyle, CloseAllWindows, DuplicateEdge, ExportDataTableAlgorithm, LaunchGui, RecreateView, RemoveParallelEdges, ResetEdgeSourceOrTarget, SearchAndSelecAlgorithm, SelectClusterAlgorithm, SetBackgroundColorAlgorithm, ShowLayoutTab, WebsiteGeneration

public abstract class AbstractEditorAlgorithm
extends AbstractAlgorithm
implements EditorAlgorithm

Constructor Summary

Constructors

Constructor	Description
AbstractEditorAlgorithm()

Method Summary

Modifier and Type	Method	Description
ImageIcon	getIcon()	Returns the icon of the algorithm (used, e.g.
ParameterDialog	getParameterDialog(Selection s)	Returns a custom ParameterDialog if the algorithm wants to provide one.
String	getShortName()

Methods inherited from class org.graffiti.plugin.algorithm.AbstractAlgorithm

addEdit, attach, canRedo, canUndo, check, die, doesUndo, getAcceleratorKeyStroke, getActionEvent, getCategory, getDescription, getMenuCategory, getParameters, getPresentationName, getRedoPresentationName, getSetCategory, getUndoPresentationName, isAlwaysExecutable, isLayoutAlgorithm, isSignificant, markExecutionDone, markRedoDone, markUndoDone, mayWorkOnMultipleGraphs, redo, replaceEdit, reset, setActionEvent, setParameters, showMenuIcon, undo

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, getAcceleratorKeyStroke, getActionEvent, getCategory, getDescription, getMenuCategory, getName, getParameters, getSetCategory, isLayoutAlgorithm, mayWorkOnMultipleGraphs, reset, setActionEvent, setParameters, showMenuIcon

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

activeForView

Constructor Details

AbstractEditorAlgorithm

public AbstractEditorAlgorithm()

Method Details

getParameterDialog

public ParameterDialog getParameterDialog(Selection s)

Description copied from interface: EditorAlgorithm

Returns a custom ParameterDialog if the algorithm wants to provide one. If this method returns null, a generic dialog will be generated using standard EditComponents.

Specified by:

getParameterDialog in interface EditorAlgorithm

Returns:

DOCUMENT ME!

getShortName

public String getShortName()

Specified by:

getShortName in interface EditorAlgorithm

Returns:

A short name, used for the parameter dialog window.

getIcon

public ImageIcon getIcon()

Returns the icon of the algorithm (used, e.g. in the menu bar). Icon is only shown if showMenuIcon returns true.

Specified by:

getIcon in interface EditorAlgorithm

Returns:

The icon of the algorithm or null if the plugin icon should be used.