edu.uci.ics.jung.visualization
Interface VisualizationModel

All Superinterfaces:

ChangeEventSupport

All Known Implementing Classes:

DefaultVisualizationModel

public interface VisualizationModel
extends ChangeEventSupport

Interface for the state holding model of the VisualizationViewer. Refactored and extracted from the 1.6.0 version of VisualizationViewer

Author:

Tom Nelson - RABA Technologies

Method Summary

void	addChangeListener(ChangeListener l) Register l as a listeners to changes in the model.
ChangeListener[]	getChangeListeners() Returns an array of all the ChangeListeners added with addChangeListener().
Layout	getGraphLayout() Returns the current graph layout.
long	getRelaxerThreadSleepTime()
void	init() initialize the layout
boolean	isVisRunnerRunning() Returns a flag that says whether the visRunner thread is running.
void	prerelax() iterate over the layout algorithm prior to displaying the graph
void	removeChangeListener(ChangeListener l) Removes a ChangeListener.
void	restart() restart the layout
void	restartThreadOnly()
void	setGraphLayout(Layout layout) set the graph Layout
void	setGraphLayout(Layout layout, Dimension d) Sets the graph Layout and initialize the Layout size to the passed dimensions.
void	setRelaxerThreadSleepTime(long relaxerThreadSleepTime) Sets the relaxerThreadSleepTime.
void	setTextCallback(StatusCallback scb) set a callback to be called during the relaxer iteration
void	start() start the relaxer
void	stop() Request that the relaxer be stopped.
void	suspend() suspend the relaxer
void	unsuspend() unsuspend the relaxer

Methods inherited from interface edu.uci.ics.jung.utils.ChangeEventSupport

fireStateChanged

Method Detail

getRelaxerThreadSleepTime

long getRelaxerThreadSleepTime()

Returns:

the sleep time of the relaxer thread

setTextCallback

void setTextCallback(StatusCallback scb)

set a callback to be called during the relaxer iteration

Parameters:

scb -

restart

void restart()

restart the layout

init

void init()

initialize the layout

start

void start()

start the relaxer

suspend

void suspend()

suspend the relaxer

unsuspend

void unsuspend()

unsuspend the relaxer

prerelax

void prerelax()

iterate over the layout algorithm prior to displaying the graph

setRelaxerThreadSleepTime

void setRelaxerThreadSleepTime(long relaxerThreadSleepTime)

Sets the relaxerThreadSleepTime. @see #getRelaxerThreadSleepTime()

Parameters:

relaxerThreadSleepTime - The relaxerThreadSleepTime to set.

setGraphLayout

void setGraphLayout(Layout layout)

set the graph Layout

Parameters:

layout -

setGraphLayout

void setGraphLayout(Layout layout,
                    Dimension d)

Sets the graph Layout and initialize the Layout size to the passed dimensions. The passed Dimension will often be the size of the View that will display the graph.

Parameters:

layout -

d -

getGraphLayout

Layout getGraphLayout()

Returns the current graph layout.

restartThreadOnly

void restartThreadOnly()

isVisRunnerRunning

boolean isVisRunnerRunning()

Returns a flag that says whether the visRunner thread is running. If it is not, then you may need to restart the thread.

stop

void stop()

Request that the relaxer be stopped. The Thread will terminate.

addChangeListener

void addChangeListener(ChangeListener l)

Register l as a listeners to changes in the model. The View registers in order to repaint itself when the model changes.

Specified by:

addChangeListener in interface ChangeEventSupport

removeChangeListener

void removeChangeListener(ChangeListener l)

Removes a ChangeListener.

Specified by:

removeChangeListener in interface ChangeEventSupport

Parameters:

l - the listener to be removed

getChangeListeners

ChangeListener[] getChangeListeners()

Returns an array of all the ChangeListeners added with addChangeListener().

Specified by:

getChangeListeners in interface ChangeEventSupport

Returns:

all of the ChangeListeners added or an empty array if no listeners have been added