com.jgraph.pad
Class JGraphpadLibrary

java.lang.Object
  javax.swing.tree.DefaultMutableTreeNode
      com.jgraph.pad.JGraphpadFile
          com.jgraph.pad.JGraphpadLibrary

All Implemented Interfaces:

Cloneable, JGraphEditorDiagram, JGraphEditorFile, MutableTreeNode, Serializable, TreeNode

public class JGraphpadLibrary

extends JGraphpadFile

implements JGraphEditorDiagram

Represents a library in the JGraphpad editor. A library is a file and at the same time a diagram which contains a set of groups to be used as template cells.

See Also:

Serialized Form

Field Summary

protected org.jgraph.graph.GraphLayoutCache	graphLayoutCache Holds the graph layout cache that contains the cells.
protected boolean	isReadOnly Specifies if the library can be changed.

Fields inherited from class com.jgraph.pad.JGraphpadFile

isNew, modified

Fields inherited from class javax.swing.tree.DefaultMutableTreeNode

allowsChildren, children, EMPTY_ENUMERATION, parent, userObject

Constructor Summary

JGraphpadLibrary()
Constructs a new library.

JGraphpadLibrary(String filename)
Constructs a new file using the filename as the user object and a JGraphpadGraphLayoutCache to hold the cells.

JGraphpadLibrary(String filename, org.jgraph.graph.GraphLayoutCache graphLayoutCache)
Constructs a new library with the specified filename as the user object and the specified graph layout cache to hold the cells.

Method Summary

org.jgraph.graph.GraphLayoutCache	getGraphLayoutCache()
org.jgraph.graph.GraphModel	getModel()
String	getName() Returns the name.
Map	getProperties() Returns the properties of the diagram.
boolean	isReadOnly()
void	setGraphLayoutCache(org.jgraph.graph.GraphLayoutCache graphLayoutCache)
void	setName(String name) Sets the name.
void	setReadOnly(boolean isReadOnly)

Methods inherited from class com.jgraph.pad.JGraphpadFile

getFilename, isModified, isNew, setFilename, setModified, setNew

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

isReadOnly

protected boolean isReadOnly

Specifies if the library can be changed. Default is false. Note: There is no way to change this setting via the UI. Please use a file edit to change the setting within the XML file that represents this library.

graphLayoutCache

protected org.jgraph.graph.GraphLayoutCache graphLayoutCache

Holds the graph layout cache that contains the cells.

Constructor Detail

JGraphpadLibrary

public JGraphpadLibrary()

Constructs a new library.

JGraphpadLibrary

public JGraphpadLibrary(String filename)

Constructs a new file using the filename as the user object and a JGraphpadGraphLayoutCache to hold the cells.

Parameters:

filename - The user object of the parent object.

JGraphpadLibrary

public JGraphpadLibrary(String filename,
                        org.jgraph.graph.GraphLayoutCache graphLayoutCache)

Constructs a new library with the specified filename as the user object and the specified graph layout cache to hold the cells.

Parameters:

filename - The user object of the parent object.

graphLayoutCache - The graph layout cache that contains the cells.

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.

getModel

public org.jgraph.graph.GraphModel getModel()

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.

isReadOnly

public boolean isReadOnly()

Returns:

Returns the isReadOnly.

setReadOnly

public void setReadOnly(boolean isReadOnly)

Parameters:

isReadOnly - The isReadOnly to set.

getProperties

public Map getProperties()

Description copied from interface: JGraphEditorDiagram

Returns the properties of the diagram.

Specified by:

getProperties in interface JGraphEditorDiagram

Returns:

Returns all properties.