edu.uci.ics.jung.visualization.layout

Class ObservableCachingLayout<V,E>

java.lang.Object

edu.uci.ics.jung.algorithms.layout.LayoutDecorator<V,E>

edu.uci.ics.jung.visualization.layout.ObservableCachingLayout<V,E>

All Implemented Interfaces:

com.google.common.base.Function<V,Point2D>, Layout<V,E>, IterativeContext, LayoutEventSupport<V,E>, Caching, ChangeEventSupport

Direct Known Subclasses:

PersistentLayoutImpl

public class ObservableCachingLayout<V,E>
extends LayoutDecorator<V,E>
implements ChangeEventSupport, Caching, LayoutEventSupport<V,E>

A LayoutDecorator that fires ChangeEvents when certain methods are called. Used to wrap a Layout so that the visualization components can be notified of changes.

Author:

Tom Nelson

See Also:

LayoutDecorator

Field Summary

Fields

Modifier and Type	Field and Description
protected ChangeEventSupport	changeSupport
protected com.google.common.cache.LoadingCache<V,Point2D>	locations

Fields inherited from class edu.uci.ics.jung.algorithms.layout.LayoutDecorator

delegate

Constructor Summary

Constructors

Constructor and Description
ObservableCachingLayout(Layout<V,E> delegate)

Method Summary

Modifier and Type	Method and Description
void	addChangeListener(ChangeListener l)
void	addLayoutChangeListener(LayoutChangeListener<V,E> listener)
Point2D	apply(V v)
void	clear() clear cache
boolean	done()
void	fireStateChanged()
ChangeListener[]	getChangeListeners() Returns an array of all the ChangeListeners added with addChangeListener().
void	init() ititialize resources for a cache
void	initialize() Initializes fields in the node that may not have been set during the constructor.
void	removeChangeListener(ChangeListener l) Removes a ChangeListener.
void	removeLayoutChangeListener(LayoutChangeListener<V,E> listener)
void	setGraph(Graph<V,E> graph)
void	setLocation(V v, Point2D location) Changes the layout coordinates of v to location.
void	step() Advances one step.

Methods inherited from class edu.uci.ics.jung.algorithms.layout.LayoutDecorator

getDelegate, getGraph, getSize, isLocked, lock, reset, setDelegate, setInitializer, setSize, transform

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.common.base.Function

equals

Field Detail

changeSupport

protected ChangeEventSupport changeSupport

locations

protected com.google.common.cache.LoadingCache<V,Point2D> locations

Constructor Detail

ObservableCachingLayout

public ObservableCachingLayout(Layout<V,E> delegate)

Method Detail

step

public void step()

Description copied from interface: IterativeContext

Advances one step.

Specified by:

step in interface IterativeContext

Overrides:

step in class LayoutDecorator<V,E>

initialize

public void initialize()

Description copied from interface: Layout

Initializes fields in the node that may not have been set during the constructor. Must be called before the iterations begin.

Specified by:

initialize in interface Layout<V,E>

Overrides:

initialize in class LayoutDecorator<V,E>

done

public boolean done()

Specified by:

done in interface IterativeContext

Overrides:

done in class LayoutDecorator<V,E>

Returns:

true if this iterative process is finished, and false otherwise.

setLocation

public void setLocation(V v,
                        Point2D location)

Description copied from interface: Layout

Changes the layout coordinates of v to location.

Specified by:

setLocation in interface Layout<V,E>

Overrides:

setLocation in class LayoutDecorator<V,E>

Parameters:

v - the vertex whose location is to be specified

location - the coordinates of the specified location

addChangeListener

public void addChangeListener(ChangeListener l)

Specified by:

addChangeListener in interface ChangeEventSupport

removeChangeListener

public void removeChangeListener(ChangeListener l)

Description copied from interface: ChangeEventSupport

Removes a ChangeListener.

Specified by:

removeChangeListener in interface ChangeEventSupport

Parameters:

l - the listener to be removed

getChangeListeners

public ChangeListener[] getChangeListeners()

Description copied from interface: ChangeEventSupport

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

fireStateChanged

public void fireStateChanged()

Specified by:

fireStateChanged in interface ChangeEventSupport

setGraph

public void setGraph(Graph<V,E> graph)

Specified by:

setGraph in interface Layout<V,E>

Overrides:

setGraph in class LayoutDecorator<V,E>

Parameters:

graph - the graph that this algorithm is to operate on

clear

public void clear()

Description copied from interface: Caching

clear cache

Specified by:

clear in interface Caching

init

public void init()

Description copied from interface: Caching

ititialize resources for a cache

Specified by:

init in interface Caching

apply

public Point2D apply(V v)

Specified by:

apply in interface com.google.common.base.Function<V,Point2D>

addLayoutChangeListener

public void addLayoutChangeListener(LayoutChangeListener<V,E> listener)

Specified by:

addLayoutChangeListener in interface LayoutEventSupport<V,E>

removeLayoutChangeListener

public void removeLayoutChangeListener(LayoutChangeListener<V,E> listener)

Specified by:

removeLayoutChangeListener in interface LayoutEventSupport<V,E>