view

Class VisualizingUserInterface

java.lang.Object

graphana.UserInterface

view.VisualizingUserInterface

All Implemented Interfaces:

Progress, java.awt.event.WindowListener, java.util.EventListener

Direct Known Subclasses:

ConsoleInteraction, GUIUserInterface

public abstract class VisualizingUserInterface
extends UserInterface
implements java.awt.event.WindowListener

Abstract user interface that extends the basic user interface by graph visualization frames and a graph files selection frame

Nested Class Summary

Nested classes/interfaces inherited from class graphana.UserInterface

UserInterface.NullUserInterface

Field Summary

Fields inherited from class graphana.UserInterface

inputHistory, NONE, printResults, printWarnings, progressSender

Constructor Summary

Constructors

Constructor and Description
VisualizingUserInterface()

Method Summary

Modifier and Type	Method and Description
protected boolean	algorithmOutputStep(java.lang.String titleKey, java.lang.String outputComment, boolean lastStep) Refreshes the output of an algorithm visualization.
protected void	algorithmStartMessage(java.lang.String titleKey) Called whenever an algorithm visualization starts.
void	close()
void	closeGraphFilesFrame() Closes the graph files frame
boolean	closeGraphView(java.lang.String titleKey) Closes the frame of the visualization with the given key and removes the visualization from the hash table
void	derivAlgorithmMessage(java.lang.String titleKey, java.lang.String message) Associates the given message with the given title key of an algorithm visualization and prints the message if the visualization is active.
protected <VertexType,EdgeType> boolean	derivShowGraph(GraphLibrary<VertexType,EdgeType> graph, java.lang.String titleKey, java.lang.String layout, int width, int height, boolean manualUpdate, boolean enableModification) Creates a new graph visualization with the given title key containing the given graph or replaces the visualization with the given title with the given graph, if such a visualization exists.
ArgumentComponentManager	getArgumentComponentManager() Returns the argument components manager instance
GraphFilesTable	getGraphFileSet() Initializes the graph files list (if not already initialized) and returns the list
void	init(MainControl mainControl) Initializes this instance.
boolean	refreshGraphOutput(java.lang.String titleKey) Repaints the frame of the visualization with the given key.
boolean	showGraphFilesFrame() Initializes the graph files list (if not already initialized) and displays the graph file selection window at the screen center with a width and height of 400 and 600 pixels
boolean	showGraphFilesFrame(int left, int top, int right, int bottom) Initializes the graph files list (if not already initialized) and displays the graph file selection window at the specified rectangle in screen coordinates
void	windowActivated(java.awt.event.WindowEvent arg0)
void	windowClosed(java.awt.event.WindowEvent ev)
void	windowClosing(java.awt.event.WindowEvent ev)
void	windowDeactivated(java.awt.event.WindowEvent arg0)
void	windowDeiconified(java.awt.event.WindowEvent arg0)
void	windowIconified(java.awt.event.WindowEvent arg0)
void	windowOpened(java.awt.event.WindowEvent arg0)

Methods inherited from class graphana.UserInterface

algorithmMessage, algorithmOutputStep, algorithmOutputStep, clearProgressMessage, clearProgressMessage, derivedPrintWarning, derivedResultOutput, derivedUserOutput, errorOutput, errorOutput, finishAlgorithmOutput, finishAlgorithmOutput, getAlgoVisualizationHeight, getAlgoVisualizationLayout, getAlgoVisualizationWidth, getInputHistory, getMainControl, getOperationThread, getOutputStreamFile, getProgressSender, hasScriptThread, hideProgressOutput, hideProgressOutput, initializeMessage, insertInput, isAlgorithmVisualizationActive, mainLoop, pause, removeOperationThread, removeScriptThread, resultOutput, setAlgorithmOutputActive, setAlgorithmVisualizationParameters, setOperationThread, setOutputStreamFile, setPrintResults, setPrintWarnings, setProgress, setProgress, setProgressMessage, setProgressMessage, setProgressSender, setScriptThread, showGraph, showGraph, showGraph, showGraph, showGraph, signalUserInput, simulateUserInput, startAlgorithmOutput, startInitialization, startMessage, startProgressOutput, startProgressOutput, userInput, userOutput, userOutput, warningOutput, warningOutputFac

Methods inherited from class java.lang.Object

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

Constructor Detail

VisualizingUserInterface

public VisualizingUserInterface()

Method Detail

init

public void init(MainControl mainControl)

Description copied from class: UserInterface

Initializes this instance.

Overrides:

init in class UserInterface

Parameters:

mainControl - the main control of the program.

showGraphFilesFrame

public boolean showGraphFilesFrame(int left,
                                   int top,
                                   int right,
                                   int bottom)

Initializes the graph files list (if not already initialized) and displays the graph file selection window at the specified rectangle in screen coordinates

Returns:

true, if and only if, initialization was successful

showGraphFilesFrame

public boolean showGraphFilesFrame()

Initializes the graph files list (if not already initialized) and displays the graph file selection window at the screen center with a width and height of 400 and 600 pixels

Returns:

true, if and only if, initialization was successful

closeGraphFilesFrame

public void closeGraphFilesFrame()

Closes the graph files frame

getArgumentComponentManager

public ArgumentComponentManager getArgumentComponentManager()

Returns the argument components manager instance

derivShowGraph

protected <VertexType,EdgeType> boolean derivShowGraph(GraphLibrary<VertexType,EdgeType> graph,
                                                       java.lang.String titleKey,
                                                       java.lang.String layout,
                                                       int width,
                                                       int height,
                                                       boolean manualUpdate,
                                                       boolean enableModification)
                                                throws ArrangeException

Creates a new graph visualization with the given title key containing the given graph or replaces the visualization with the given title with the given graph, if such a visualization exists.

Specified by:

derivShowGraph in class UserInterface

Returns:

True iff there was no error, like an invalid layout

Throws:

ArrangeException

refreshGraphOutput

public boolean refreshGraphOutput(java.lang.String titleKey)

Repaints the frame of the visualization with the given key. Does nothing if no such visualization exists.

Specified by:

refreshGraphOutput in class UserInterface

Parameters:

titleKey - the key of the visualization to refresh.

Returns:

true if and only if a visualization with the given key exists.

algorithmStartMessage

protected void algorithmStartMessage(java.lang.String titleKey)

Called whenever an algorithm visualization starts.

Specified by:

algorithmStartMessage in class UserInterface

Parameters:

titleKey - the key of the visualization.

algorithmOutputStep

protected boolean algorithmOutputStep(java.lang.String titleKey,
                                      java.lang.String outputComment,
                                      boolean lastStep)

Refreshes the output of an algorithm visualization.

Specified by:

algorithmOutputStep in class UserInterface

Parameters:

titleKey - the key of the algorithm visualization to refresh.

outputComment - an optional comment of the step.

lastStep - if true, then the current step is assumed to be the last step of the algorithm visualization.

Returns:

true if and only if a visualization with the given key exists.

closeGraphView

public boolean closeGraphView(java.lang.String titleKey)

Closes the frame of the visualization with the given key and removes the visualization from the hash table

Specified by:

closeGraphView in class UserInterface

Parameters:

titleKey - the key of the visualization to close.

Returns:

true if and only if a visualization with the given key exists.

windowActivated

public void windowActivated(java.awt.event.WindowEvent arg0)

Specified by:

windowActivated in interface java.awt.event.WindowListener

windowClosed

public void windowClosed(java.awt.event.WindowEvent ev)

Specified by:

windowClosed in interface java.awt.event.WindowListener

windowClosing

public void windowClosing(java.awt.event.WindowEvent ev)

Specified by:

windowClosing in interface java.awt.event.WindowListener

windowDeactivated

public void windowDeactivated(java.awt.event.WindowEvent arg0)

Specified by:

windowDeactivated in interface java.awt.event.WindowListener

windowDeiconified

public void windowDeiconified(java.awt.event.WindowEvent arg0)

Specified by:

windowDeiconified in interface java.awt.event.WindowListener

windowIconified

public void windowIconified(java.awt.event.WindowEvent arg0)

Specified by:

windowIconified in interface java.awt.event.WindowListener

windowOpened

public void windowOpened(java.awt.event.WindowEvent arg0)

Specified by:

windowOpened in interface java.awt.event.WindowListener

derivAlgorithmMessage

public void derivAlgorithmMessage(java.lang.String titleKey,
                                  java.lang.String message)

Associates the given message with the given title key of an algorithm visualization and prints the message if the visualization is active.

Specified by:

derivAlgorithmMessage in class UserInterface

close

public void close()

Overrides:

close in class UserInterface

getGraphFileSet

public GraphFilesTable getGraphFileSet()

Initializes the graph files list (if not already initialized) and returns the list

Returns:

true, if and only if, initialization was successful