Package de.ipk_gatersleben.ag_nw.graffiti.plugins.misc.print.printer

Class PrintAlgorithm

java.lang.Object

org.graffiti.plugin.algorithm.AbstractAlgorithm

de.ipk_gatersleben.ag_nw.graffiti.plugins.misc.print.printer.PrintAlgorithm

All Implemented Interfaces:

UndoableEdit, Algorithm

public class PrintAlgorithm
extends AbstractAlgorithm

The print algorithm.

Version:

$Revision$

Author:

Burkhard Sell

Constructor Summary

Constructors

Constructor	Description
PrintAlgorithm()

Method Summary

Modifier and Type	Method	Description
void	attach(Graph g, Selection s)	Unused for this plugin.
void	check()	Checks whether all preconditions of the current graph are satisfied.
void	execute()	This method is invoked by the plugin environment to start the action this plugin is for.
KeyStroke	getAcceleratorKeyStroke()	Default: no accelerator for the menu item, created for this algorithm.
String	getCategory()	Returns the category an algorithm should assigned to.
String	getName()	Returns the name (ID) of the algorithm.
Set<Category>	getSetCategory()	Returns a set of categories to classify this algorithm .
boolean	isLayoutAlgorithm()	A LayoutAlgorithm should return true.
void	reset()	Resets the algorithm state.
void	setActiveSession(Session session)	Sets the active session.

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

addEdit, canRedo, canUndo, die, doesUndo, getActionEvent, getDescription, getMenuCategory, getParameters, getPresentationName, getRedoPresentationName, getUndoPresentationName, isAlwaysExecutable, isSignificant, markExecutionDone, markRedoDone, markUndoDone, mayWorkOnMultipleGraphs, redo, replaceEdit, setActionEvent, setParameters, showMenuIcon, undo

Methods inherited from class java.lang.Object

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

Constructor Details

PrintAlgorithm

public PrintAlgorithm()

Method Details

getCategory

public String 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 interface Algorithm

Overrides:

getCategory in class AbstractAlgorithm

Returns:

The category an algorithm should assigned to.

getName

public String getName()

Description copied from interface: Algorithm

Returns the name (ID) of the algorithm.

Returns:

DOCUMENT ME!

getSetCategory

public Set<Category> 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 interface Algorithm

Overrides:

getSetCategory in class AbstractAlgorithm

Returns:

Set of Category Enums that classify this algorithm.

attach

public void attach(Graph g,
Selection s)

Unused for this plugin.

Specified by:

attach in interface Algorithm

Overrides:

attach in class AbstractAlgorithm

Parameters:

g - the graph to attach.

s - the selection to attach.

See Also:

org.graffiti.plugin.algorithm.Algorithm#attach(org.graffiti.graph.Graph)

check

public void check()
           throws PreconditionException

Description copied from interface: Algorithm

Checks whether all preconditions of the current graph are satisfied.

Specified by:

check in interface Algorithm

Overrides:

check in class AbstractAlgorithm

Throws:

PreconditionException - if the preconditions of the current graph are not satisfied.

getAcceleratorKeyStroke

public KeyStroke getAcceleratorKeyStroke()

Description copied from class: AbstractAlgorithm

Default: no accelerator for the menu item, created for this algorithm.

Specified by:

getAcceleratorKeyStroke in interface Algorithm

Overrides:

getAcceleratorKeyStroke in class AbstractAlgorithm

Returns:

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

execute

public void execute()

This method is invoked by the plugin environment to start the action this plugin is for.

This method starts the printprocess

*

This method needs the activeSession set by the setActiveSession(Session) Method. Make shure, that setActiveSession(Session) is called BEFORE execute() method!!!

Throws:

IllegalStateException - if activeSession is null

See Also:

Algorithm.execute(), setActiveSession(Session)

reset

public void reset()

Resets the algorithm state.

Active session will be invalidated.

ATTENTION: After calling this method setActiveSession(Session) have to be called again BEFORE calling execute()

Specified by:

reset in interface Algorithm

Overrides:

reset in class AbstractAlgorithm

See Also:

Algorithm.reset(), setActiveSession(Session)

setActiveSession

public void setActiveSession(Session session)

Sets the active session.

This session is uses by execute() Method. Make shure, that this method is called BEFORE execute()!!!

See Also:

org.graffiti.plugin.algorithm.Algorithm#setActiveSession(org.graffiti.session.Session), execute()

isLayoutAlgorithm

public boolean isLayoutAlgorithm()

Description copied from interface: Algorithm

A LayoutAlgorithm should return true. All other types of algorithms should return false.

Specified by:

isLayoutAlgorithm in interface Algorithm

Overrides:

isLayoutAlgorithm in class AbstractAlgorithm

Returns: