view.userinterfaces

Class GUIUserInterface

java.lang.Object

graphana.UserInterface

view.VisualizingUserInterface

view.userinterfaces.GUIUserInterface

All Implemented Interfaces:

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

public class GUIUserInterface
extends VisualizingUserInterface

A Graphana GUI user interface. Creates GUI components to give the user access to the Graphana functionalities.

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
GUIUserInterface()

Method Summary

Modifier and Type	Method and Description
void	close()
void	derivedUserOutput(java.lang.String message)
OperationThread	getOperationThread()
boolean	hasScriptThread()
void	hideProgressOutput(java.lang.Object sender) Hides the progress output.
void	init(MainControl mainControl) Initializes this instance.
void	initializeMessage() Informs the user, that the program is beeing initialized.
void	insertInput(java.lang.String input)
void	mainLoop() Starts the user interaction.
void	removeOperationThread()
void	removeScriptThread()
void	setOperationThread(OperationThread operationThread)
void	setProgress(java.lang.Object sender, double progress) Sets the progress output to the given value.
void	setProgressMessage(java.lang.Object sender, java.lang.String message) Sets the progress label.
void	setScriptThread(ExecuterThread thread)
boolean	showGraphFilesFrame() Presents the graph files frame to the user.
void	signalUserInput(java.lang.String prefix) Informs the user, that input can be done.
void	simulateUserInput(java.lang.String input, boolean print, boolean execute) Simulates a user input.
void	startInitialization() Invokes the initialization of the user interface.
void	startMessage() Informs the user, that the user interface is beeing started.
java.lang.String	userInput() Awaits a user input and returns it as a string.

Methods inherited from class view.VisualizingUserInterface

algorithmOutputStep, algorithmStartMessage, closeGraphFilesFrame, closeGraphView, derivAlgorithmMessage, derivShowGraph, getArgumentComponentManager, getGraphFileSet, refreshGraphOutput, showGraphFilesFrame, windowActivated, windowClosed, windowClosing, windowDeactivated, windowDeiconified, windowIconified, windowOpened

Methods inherited from class graphana.UserInterface

algorithmMessage, algorithmOutputStep, algorithmOutputStep, clearProgressMessage, clearProgressMessage, derivedPrintWarning, derivedResultOutput, errorOutput, errorOutput, finishAlgorithmOutput, finishAlgorithmOutput, getAlgoVisualizationHeight, getAlgoVisualizationLayout, getAlgoVisualizationWidth, getInputHistory, getMainControl, getOutputStreamFile, getProgressSender, hideProgressOutput, isAlgorithmVisualizationActive, pause, resultOutput, setAlgorithmOutputActive, setAlgorithmVisualizationParameters, setOutputStreamFile, setPrintResults, setPrintWarnings, setProgress, setProgressMessage, setProgressSender, showGraph, showGraph, showGraph, showGraph, showGraph, startAlgorithmOutput, startProgressOutput, startProgressOutput, userOutput, userOutput, warningOutput, warningOutputFac

Methods inherited from class java.lang.Object

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

Constructor Detail

GUIUserInterface

public GUIUserInterface()

Method Detail

init

public void init(MainControl mainControl)

Description copied from class: UserInterface

Initializes this instance.

Overrides:

init in class VisualizingUserInterface

Parameters:

mainControl - the main control of the program.

startInitialization

public void startInitialization()

Description copied from class: UserInterface

Invokes the initialization of the user interface.

Specified by:

startInitialization in class UserInterface

showGraphFilesFrame

public boolean showGraphFilesFrame()

Presents the graph files frame to the user. The frame will appear left besides the main frame.

Overrides:

showGraphFilesFrame in class VisualizingUserInterface

Returns:

true, if and only if, initialization was successful

mainLoop

public void mainLoop()

Description copied from class: UserInterface

Starts the user interaction. The method is blocking, until the program is quit.

Specified by:

mainLoop in class UserInterface

derivedUserOutput

public void derivedUserOutput(java.lang.String message)

Specified by:

derivedUserOutput in class UserInterface

userInput

public java.lang.String userInput()

Description copied from class: UserInterface

Awaits a user input and returns it as a string.

Specified by:

userInput in class UserInterface

Returns:

the string typed by the user.

initializeMessage

public void initializeMessage()

Description copied from class: UserInterface

Informs the user, that the program is beeing initialized.

Specified by:

initializeMessage in class UserInterface

startMessage

public void startMessage()

Description copied from class: UserInterface

Informs the user, that the user interface is beeing started.

Overrides:

startMessage in class UserInterface

signalUserInput

public void signalUserInput(java.lang.String prefix)

Description copied from class: UserInterface

Informs the user, that input can be done.

Specified by:

signalUserInput in class UserInterface

Parameters:

prefix - an additional string for the signal.

simulateUserInput

public void simulateUserInput(java.lang.String input,
                              boolean print,
                              boolean execute)

Description copied from class: UserInterface

Simulates a user input. That is, the given string will be handled as if the user would have typed it in.

Overrides:

simulateUserInput in class UserInterface

Parameters:

input - the input.

print - if true, then the input will be printed before it will be executed.

execute - if true, then the input will be executed.

setProgress

public void setProgress(java.lang.Object sender,
                        double progress)

Description copied from class: UserInterface

Sets the progress output to the given value.

Overrides:

setProgress in class UserInterface

progress - the progress. Must be between 0 (started) and 1 (finished).

hideProgressOutput

public void hideProgressOutput(java.lang.Object sender)

Description copied from class: UserInterface

Hides the progress output.

Overrides:

hideProgressOutput in class UserInterface

setProgressMessage

public void setProgressMessage(java.lang.Object sender,
                               java.lang.String message)

Description copied from class: UserInterface

Sets the progress label.

Overrides:

setProgressMessage in class UserInterface

Parameters:

sender - the sender of the message

getOperationThread

public OperationThread getOperationThread()

Overrides:

getOperationThread in class UserInterface

setOperationThread

public void setOperationThread(OperationThread operationThread)

Overrides:

setOperationThread in class UserInterface

removeOperationThread

public void removeOperationThread()

Overrides:

removeOperationThread in class UserInterface

setScriptThread

public void setScriptThread(ExecuterThread thread)

Overrides:

setScriptThread in class UserInterface

removeScriptThread

public void removeScriptThread()

Overrides:

removeScriptThread in class UserInterface

hasScriptThread

public boolean hasScriptThread()

Overrides:

hasScriptThread in class UserInterface

insertInput

public void insertInput(java.lang.String input)

Overrides:

insertInput in class UserInterface

close

public void close()

Overrides:

close in class VisualizingUserInterface