Class SetBackgroundColorAlgorithm
java.lang.Object
org.graffiti.plugin.algorithm.AbstractAlgorithm
org.graffiti.plugin.algorithm.AbstractEditorAlgorithm
de.ipk_gatersleben.ag_nw.graffiti.plugins.gui.set_background_color.SetBackgroundColorAlgorithm
- All Implemented Interfaces:
NeedsSwingThread
,ActionListener
,EventListener
,UndoableEdit
,Algorithm
,EditorAlgorithm
,ProvidesGeneralContextMenu
public class SetBackgroundColorAlgorithm extends AbstractEditorAlgorithm implements ProvidesGeneralContextMenu, ActionListener, NeedsSwingThread
DOCUMENT ME!
- Author:
- Christian Klukas To change the template for this generated type comment go to Window>Preferences>Java>Code Generation>Code and Comments
-
Constructor Summary
Constructors Constructor Description SetBackgroundColorAlgorithm()
-
Method Summary
Modifier and Type Method Description void
actionPerformed(ActionEvent e)
boolean
activeForView(View v)
void
execute()
Executes the whole algorithm.KeyStroke
getAcceleratorKeyStroke()
Default: no accelerator for the menu item, created for this algorithm.String
getCategory()
Returns the category an algorithm should assigned to.JMenuItem[]
getCurrentContextMenuItem()
This method should be implemented, as that it returns the desired Context-MenuItem for the Plugin.String
getName()
Returns the name (ID) of the algorithm.Set<Category>
getSetCategory()
Returns a set of categories to classify this algorithm .Methods inherited from class org.graffiti.plugin.algorithm.AbstractEditorAlgorithm
getIcon, getParameterDialog, getShortName
Methods inherited from class org.graffiti.plugin.algorithm.AbstractAlgorithm
addEdit, attach, canRedo, canUndo, check, die, doesUndo, getActionEvent, getDescription, getMenuCategory, getParameters, getPresentationName, getRedoPresentationName, 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, getActionEvent, getDescription, getMenuCategory, getParameters, isLayoutAlgorithm, mayWorkOnMultipleGraphs, reset, setActionEvent, setParameters, showMenuIcon
-
Constructor Details
-
SetBackgroundColorAlgorithm
public SetBackgroundColorAlgorithm()
-
-
Method Details
-
getName
Description copied from interface:Algorithm
Returns the name (ID) of the algorithm. -
getCategory
Description copied from interface:Algorithm
Returns the category an algorithm should assigned to. Return NULL if the algorithm should be sorted directly in the plugin menu.- Specified by:
getCategory
in interfaceAlgorithm
- Overrides:
getCategory
in classAbstractAlgorithm
- Returns:
- The category an algorithm should assigned to.
-
getSetCategory
Description copied from interface:Algorithm
Returns a set of categories to classify this algorithm . e.g. return new HashSet(Arrays.asList( Category.GRAPH, Category.NODE )); is an algorithm, working on graphs and more specific on nodes - Specified by:
getSetCategory
in interfaceAlgorithm
- Overrides:
getSetCategory
in classAbstractAlgorithm
- Returns:
- Set of Category Enums that classify this algorithm.
-
getAcceleratorKeyStroke
Description copied from class:AbstractAlgorithm
Default: no accelerator for the menu item, created for this algorithm.- Specified by:
getAcceleratorKeyStroke
in interfaceAlgorithm
- Overrides:
getAcceleratorKeyStroke
in classAbstractAlgorithm
- Returns:
- NULL (default) if no accelerator should be assigned for this algorithm.
-
execute
public void execute()Description copied from interface:Algorithm
Executes the whole algorithm. -
getCurrentContextMenuItem
Description copied from interface:ProvidesGeneralContextMenu
This method should be implemented, as that it returns the desired Context-MenuItem for the Plugin. It will be added on the fly to a newly created context menu, when the user right-clicks an EditorFrame. The plugin should implement the InterfaceSelectionListener
if the menu item should be variable to the current selection. You could also return a MenuItem that contains a subMenu.- Specified by:
getCurrentContextMenuItem
in interfaceProvidesGeneralContextMenu
- Returns:
MenuItem
the menu item for the context menu
-
actionPerformed
- Specified by:
actionPerformed
in interfaceActionListener
-
activeForView
- Specified by:
activeForView
in interfaceEditorAlgorithm
-