prajna.viz.display

Class SvgRenderer<N,E>

java.lang.Object

prajna.viz.display.SvgRenderer<N,E>

Type Parameters:

N - The node class for graphs and trees

E - The edge class for graphs

public class SvgRenderer<N,E>
extends java.lang.Object

This class provides the ability to render graph and tree displays into an SVG representation. A SvgGraphics object is used to generate the SVG content, while the actual arranging and drawing are handled by the Arrangements and Renderers respectively.

Author:

Edward Swing

Constructor Summary

Constructors

Constructor and Description
SvgRenderer()

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Clear the current SVG graphics object and document
EdgeRenderer	getEdgeRenderer() Get the Edge Renderer
GraphArrangement<N,E>	getGraphArrangement() Get the current graph arrangement
int	getHeight() Get the height used for arranging and defining the SVG canvas
NodeRenderer	getNodeRenderer() Get the current node renderer
java.lang.String	getSvg() Get the SVG content of this Renderer
TreeArrangement<N>	getTreeArrangement() Get the current tree arrangement
int	getWidth() Get the width used for arranging and defining the SVG canvas
void	renderSvgGraph(Graph<N,E> graph) Render the specified graph into SVG.
void	renderSvgTree(Tree<N> tree) Render the specified tree into SVG.
void	setEdgeRenderer(EdgeRenderer edgeRenderer) Set the Edge Renderer
void	setGraphArrangement(GraphArrangement<N,E> graphArrangement) Set the Graph Arrangement
void	setHeight(int hgt) Set the working height
void	setNodeRenderer(NodeRenderer nodeRenderer) Set the Node Renderer
void	setTreeArrangement(TreeArrangement<N> treeArrangement) Set the Tree Arrangement
void	setWidth(int wid) Set the width
void	writeSvg(java.io.Writer writer) Write SVG to the provided Writer.

Methods inherited from class java.lang.Object

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

Constructor Detail

SvgRenderer

public SvgRenderer()

Method Detail

clear

public void clear()

Clear the current SVG graphics object and document

getEdgeRenderer

public EdgeRenderer getEdgeRenderer()

Get the Edge Renderer

Returns:

the edgeRenderer

getGraphArrangement

public GraphArrangement<N,E> getGraphArrangement()

Get the current graph arrangement

Returns:

the graphArrangement

getHeight

public int getHeight()

Get the height used for arranging and defining the SVG canvas

Returns:

the height

getNodeRenderer

public NodeRenderer getNodeRenderer()

Get the current node renderer

Returns:

the nodeRenderer

getSvg

public java.lang.String getSvg()

Get the SVG content of this Renderer

Returns:

The SVG content as a String

getTreeArrangement

public TreeArrangement<N> getTreeArrangement()

Get the current tree arrangement

Returns:

the treeArrangement

getWidth

public int getWidth()

Get the width used for arranging and defining the SVG canvas

Returns:

the width

renderSvgGraph

public void renderSvgGraph(Graph<N,E> graph)

Render the specified graph into SVG. This uses the GraphArrangement and the Node and Edge renderers to create the representation of the graph

Parameters:

graph - the graph to render

renderSvgTree

public void renderSvgTree(Tree<N> tree)

Render the specified tree into SVG. This uses the TreeArrangement and the Node renderer to create the representation of the tree

Parameters:

tree - the tree to render

setEdgeRenderer

public void setEdgeRenderer(EdgeRenderer edgeRenderer)

Set the Edge Renderer

Parameters:

edgeRenderer - the edgeRenderer

setGraphArrangement

public void setGraphArrangement(GraphArrangement<N,E> graphArrangement)

Set the Graph Arrangement

Parameters:

graphArrangement - the graphArrangement

setHeight

public void setHeight(int hgt)

Set the working height

Parameters:

hgt - the height

setNodeRenderer

public void setNodeRenderer(NodeRenderer nodeRenderer)

Set the Node Renderer

Parameters:

nodeRenderer - the nodeRenderer

setTreeArrangement

public void setTreeArrangement(TreeArrangement<N> treeArrangement)

Set the Tree Arrangement

Parameters:

treeArrangement - the treeArrangement

setWidth

public void setWidth(int wid)

Set the width

Parameters:

wid - the width

writeSvg

public void writeSvg(java.io.Writer writer)

Write SVG to the provided Writer. This outputs the current SVG document onto the specified stream

Parameters:

writer - the writer

See Also:

SvgGraphics.writeSvg(java.io.Writer)