com.jgraph.pad
Class JGraphpadDiagram

java.lang.Object
  javax.swing.tree.DefaultMutableTreeNode
      com.jgraph.pad.JGraphpadDiagram

All Implemented Interfaces:

Cloneable, JGraphEditorDiagram, MutableTreeNode, Serializable, TreeNode

public class JGraphpadDiagram

extends DefaultMutableTreeNode

implements JGraphEditorDiagram

Represents a diagram to be contained in a JGraphpadFile. The diagram has a name, default settings for the graph that displays the diagram and a graph layout cache that contains the actual graph data.

See Also:

Serialized Form

Field Summary

protected org.jgraph.graph.GraphLayoutCache	graphLayoutCache Holds the graph layout cache that defines the diagram.
protected Map	properties Holds the diagram properties.

Fields inherited from class javax.swing.tree.DefaultMutableTreeNode

allowsChildren, children, EMPTY_ENUMERATION, parent, userObject

Constructor Summary

JGraphpadDiagram(String name)
Constructs a new diagram with the specified name and a JGraphpadGraphLayoutCache to hold the diagram.

JGraphpadDiagram(String name, org.jgraph.graph.GraphLayoutCache graphLayoutCache)
Constructs a new diagram with the specified name using graphLayoutCache to hold the diagram.

JGraphpadDiagram(String name, org.jgraph.graph.GraphLayoutCache graphLayoutCache, Map properties)
Constructs a new diagram with the specified name using graphLayoutCache to hold the diagram.

Method Summary

org.jgraph.graph.GraphLayoutCache	getGraphLayoutCache()
String	getName() Returns the name.
Map	getProperties() Returns the diagram properties.
void	setGraphLayoutCache(org.jgraph.graph.GraphLayoutCache graphLayoutCache)
void	setName(String name) Sets the name.
void	setProperties(Map properties) Sets the diagram properties.

Methods inherited from class javax.swing.tree.DefaultMutableTreeNode

add, breadthFirstEnumeration, children, clone, depthFirstEnumeration, getAllowsChildren, getChildAfter, getChildAt, getChildBefore, getChildCount, getDepth, getFirstChild, getFirstLeaf, getIndex, getLastChild, getLastLeaf, getLeafCount, getLevel, getNextLeaf, getNextNode, getNextSibling, getParent, getPath, getPathToRoot, getPreviousLeaf, getPreviousNode, getPreviousSibling, getRoot, getSharedAncestor, getSiblingCount, getUserObject, getUserObjectPath, insert, isLeaf, isNodeAncestor, isNodeChild, isNodeDescendant, isNodeRelated, isNodeSibling, isRoot, pathFromAncestorEnumeration, postorderEnumeration, preorderEnumeration, remove, remove, removeAllChildren, removeFromParent, setAllowsChildren, setParent, setUserObject, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.swing.tree.MutableTreeNode

insert, remove, remove, removeFromParent, setParent, setUserObject

Methods inherited from interface javax.swing.tree.TreeNode

children, getAllowsChildren, getChildAt, getChildCount, getIndex, getParent, isLeaf

Field Detail

graphLayoutCache

protected org.jgraph.graph.GraphLayoutCache graphLayoutCache

Holds the graph layout cache that defines the diagram.

properties

protected Map properties

Holds the diagram properties.

Constructor Detail

JGraphpadDiagram

public JGraphpadDiagram(String name)

Constructs a new diagram with the specified name and a JGraphpadGraphLayoutCache to hold the diagram.

Parameters:

name - The name of the new diagram.

JGraphpadDiagram

public JGraphpadDiagram(String name,
                        org.jgraph.graph.GraphLayoutCache graphLayoutCache)

Constructs a new diagram with the specified name using graphLayoutCache to hold the diagram.

Parameters:

name - The name of the diagram.

graphLayoutCache - The graph layout cache that makes up the diagram.

JGraphpadDiagram

public JGraphpadDiagram(String name,
                        org.jgraph.graph.GraphLayoutCache graphLayoutCache,
                        Map properties)

Constructs a new diagram with the specified name using graphLayoutCache to hold the diagram.

Parameters:

name - The name of the diagram.

graphLayoutCache - The graph layout cache that makes up the diagram.

properties - The properties to use for the diagram.

Method Detail

setGraphLayoutCache

public void setGraphLayoutCache(org.jgraph.graph.GraphLayoutCache graphLayoutCache)

Specified by:

setGraphLayoutCache in interface JGraphEditorDiagram

Parameters:

graphLayoutCache - The cache to set.

getGraphLayoutCache

public org.jgraph.graph.GraphLayoutCache getGraphLayoutCache()

Specified by:

getGraphLayoutCache in interface JGraphEditorDiagram

Returns:

Returns the cache.

setName

public void setName(String name)

Description copied from interface: JGraphEditorDiagram

Sets the name.

Specified by:

setName in interface JGraphEditorDiagram

Parameters:

name - The name to set.

getName

public String getName()

Description copied from interface: JGraphEditorDiagram

Returns the name.

Specified by:

getName in interface JGraphEditorDiagram

Returns:

Returns the name.

getProperties

public Map getProperties()

Returns the diagram properties.

Specified by:

getProperties in interface JGraphEditorDiagram

Returns:

Returns the properties.

setProperties

public void setProperties(Map properties)

Sets the diagram properties.

Parameters:

properties - The properties to set.