edu.uci.ics.jung.algorithms.layout

Class AbstractLayout<V,E>

java.lang.Object

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

Type Parameters:

V - the vertex type

E - the edge type

All Implemented Interfaces:

com.google.common.base.Function<V,java.awt.geom.Point2D>, Layout<V,E>

Direct Known Subclasses:

CircleLayout, FRLayout, FRLayout2, ISOMLayout, KKLayout, SpringLayout, StaticLayout

public abstract class AbstractLayout<V,E>
extends java.lang.Object
implements Layout<V,E>

Abstract class for implementations of Layout. It handles some of the basic functions: storing coordinates, maintaining the dimensions, initializing the locations, maintaining locked vertices.

Method Summary

Modifier and Type	Method and Description
java.awt.geom.Point2D	apply(V v)
Graph<V,E>	getGraph()
java.awt.Dimension	getSize() Returns the current size of the visualization space, accoring to the last call to resize().
double	getX(V v) Returns the x coordinate of the vertex from the Coordinates object.
double	getY(V v) Returns the y coordinate of the vertex from the Coordinates object.
boolean	isLocked(V v)
void	lock(boolean lock)
void	lock(V v, boolean state) Locks v in place if state is true, otherwise unlocks it.
void	setGraph(Graph<V,E> graph)
void	setInitializer(com.google.common.base.Function<V,java.awt.geom.Point2D> initializer)
void	setLocation(V picked, double x, double y) Forcibly moves a vertex to the (x,y) location by setting its x and y locations to the specified location.
void	setLocation(V picked, java.awt.geom.Point2D p) Changes the layout coordinates of v to location.
void	setSize(java.awt.Dimension size) When a visualization is resized, it presumably wants to fix the locations of the vertices and possibly to reinitialize its data.

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.uci.ics.jung.algorithms.layout.Layout

initialize, reset

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

equals

Method Detail

setGraph

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

Specified by:

setGraph in interface Layout<V,E>

Parameters:

graph - the graph that this algorithm is to operate on

setSize

public void setSize(java.awt.Dimension size)

When a visualization is resized, it presumably wants to fix the locations of the vertices and possibly to reinitialize its data. The current method calls initializeLocations followed by initialize_local.

Specified by:

setSize in interface Layout<V,E>

Parameters:

size - the space to use to lay out this graph

isLocked

public boolean isLocked(V v)

Specified by:

isLocked in interface Layout<V,E>

Parameters:

v - the vertex whose locked state is being queried

Returns:

true if the position of vertex v is locked

setInitializer

public void setInitializer(com.google.common.base.Function<V,java.awt.geom.Point2D> initializer)

Specified by:

setInitializer in interface Layout<V,E>

Parameters:

initializer - a function that specifies initial locations for all vertices

getSize

public java.awt.Dimension getSize()

Returns the current size of the visualization space, accoring to the last call to resize().

Specified by:

getSize in interface Layout<V,E>

Returns:

the current size of the screen

apply

public java.awt.geom.Point2D apply(V v)

Specified by:

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

getX

public double getX(V v)

Returns the x coordinate of the vertex from the Coordinates object. in most cases you will be better off calling transform(v).

Parameters:

v - the vertex whose x coordinate is to be returned

Returns:

the x coordinate of v

getY

public double getY(V v)

Returns the y coordinate of the vertex from the Coordinates object. In most cases you will be better off calling transform(v).

Parameters:

v - the vertex whose y coordinate is to be returned

Returns:

the y coordinate of v

getGraph

public Graph<V,E> getGraph()

Specified by:

getGraph in interface Layout<V,E>

Returns:

the graph that this layout operates on

setLocation

public void setLocation(V picked,
                        double x,
                        double y)

Forcibly moves a vertex to the (x,y) location by setting its x and y locations to the specified location. Does not add the vertex to the "dontmove" list, and (in the default implementation) does not make any adjustments to the rest of the graph.

Parameters:

picked - the vertex whose location is being set

x - the x coordinate of the location to set

y - the y coordinate of the location to set

setLocation

public void setLocation(V picked,
                        java.awt.geom.Point2D p)

Description copied from interface: Layout

Changes the layout coordinates of v to location.

Specified by:

setLocation in interface Layout<V,E>

Parameters:

picked - the vertex whose location is to be specified

p - the coordinates of the specified location

lock

public void lock(V v,
                 boolean state)

Locks v in place if state is true, otherwise unlocks it.

Specified by:

lock in interface Layout<V,E>

Parameters:

v - the vertex whose position is to be (un)locked

state - true if the vertex is to be locked, false if to be unlocked

lock

public void lock(boolean lock)

Parameters:

lock - true to lock all vertices in place, false to unlock all vertices