Field Detail

• listenerList

  protected transient javax.swing.event.EventListenerList listenerList

  The list of listeners that listen to the model.

• emptyIterator

  protected transient java.util.Iterator emptyIterator

  Default instance of an empty iterator.

• roots

  protected java.util.List roots

  Set that contains all root cells of this model.

• asksAllowsChildren

  protected boolean asksAllowsChildren

  Indicates whether isLeaf is based on a node's allowsChildren value.

• removeEmptyGroups

  protected boolean removeEmptyGroups

  Whether or not to remove group cells from the model when all of their children are removed

• attributes

  protected AttributeMap attributes

  The model's own attributes as a map. Defaults to an empty Hashtable.

• updateLevel

  protected transient int updateLevel

  Counter for the depth of nested transactions. Each call to beginUpdate increments this counter and each call to endUpdate decrements it. When the counter reaches 0, the transaction is closed and applied to the model.

• transAddedCells

  protected transient java.util.Set transAddedCells

  Stores nested transaction added cells

• transRemovedCells

  protected transient java.util.Set transRemovedCells

  Stores nested transaction removed cells

• transEditAttrs

  protected transient java.util.Map transEditAttrs

  Stores nested transaction transport attribute maps

• transEditCS

  protected transient ConnectionSet transEditCS

  Stores nested transaction connection sets

• transEditPM

  protected transient ParentMap transEditPM

  Stores nested transaction parent maps

Constructor Detail

• DefaultGraphModel

  public DefaultGraphModel()

  Constructs a model that is not an attribute store.

• DefaultGraphModel

  public DefaultGraphModel​(java.util.List roots,
                           AttributeMap attributes)

  Constructs a model that is not an attribute store.

• DefaultGraphModel

  public DefaultGraphModel​(java.util.List roots,
                           AttributeMap attributes,
                           ConnectionSet cs)

  Constructs a model using the specified information to construct the cells, attributes and connection data.

Method Detail

• getRoots

  public java.util.List getRoots()

• getRootCount

  public int getRootCount()

  Returns the number of roots in the model. Returns 0 if the model is empty.

  Specified by:

  getRootCount in interface GraphModel

  Returns:

  the number of roots in the model

• getRootAt

  public java.lang.Object getRootAt​(int index)

  Returns the root at index index in the model. This should not return null if index is a valid index for the model (that is index >= 0 && index < getRootCount()).

  Specified by:

  getRootAt in interface GraphModel

  Returns:

  the root of at index index

• getIndexOfRoot

  public int getIndexOfRoot​(java.lang.Object root)

  Returns the index of root in the model. If root is null, returns -1.

  Specified by:

  getIndexOfRoot in interface GraphModel

  Parameters:

  root - a root in the model, obtained from this data source

  Returns:

  the index of the root in the model, or -1 if the parent is null

• contains

  public boolean contains​(java.lang.Object node)

  Returns true if node or one of its ancestors is in the model.

  Specified by:

  contains in interface GraphModel

  Returns:

  true if node is in the model

• getAttributes

  public AttributeMap getAttributes​(java.lang.Object node)

  Returns a Map that represents the attributes for the specified cell. This attributes have precedence over each view's attributes, regardless of isAttributeStore.

  Specified by:

  getAttributes in interface GraphModel

  Returns:

  attributes of node as a Map

• getValue

  public java.lang.Object getValue​(java.lang.Object cell)

  Description copied from interface: GraphModel
  Returns the user object for the specified cell.

  Specified by:

  getValue in interface GraphModel

  Returns:

  Returns the user object of the given cell. This implementation checks if the cell is a default mutable tree node and returns it's user object.

• getAttributes

  public java.util.Map getAttributes()

  Returns the graph model's attribute. Shortcut to getAttributes(null).

  Returns:

  attributes of node as a Map

• getSource

  public java.lang.Object getSource​(java.lang.Object edge)

  Returns the source of edge. edge must be an object previously obtained from this data source.

  Specified by:

  getSource in interface GraphModel

  Returns:

  Object that represents the source of edge

• getTarget

  public java.lang.Object getTarget​(java.lang.Object edge)

  Returns the target of edge. edge must be an object previously obtained from this data source.

  Specified by:

  getTarget in interface GraphModel

  Returns:

  Object that represents the target of edge

• acceptsSource

  public boolean acceptsSource​(java.lang.Object edge,
                               java.lang.Object port)

  Returns true if port is a valid source for edge. edge and port must be objects previously obtained from this data source.

  Specified by:

  acceptsSource in interface GraphModel

  Returns:

  true if port is a valid source for edge.

• acceptsTarget

  public boolean acceptsTarget​(java.lang.Object edge,
                               java.lang.Object port)

  Returns true if port is a valid target for edge. edge and port must be objects previously obtained from this data source.

  Specified by:

  acceptsTarget in interface GraphModel

  Returns:

  true if port is a valid target for edge.

• edges

  public java.util.Iterator edges​(java.lang.Object port)

  Returns an iterator of the edges connected to port. port must be a object previously obtained from this data source. This method never returns null.

  Specified by:

  edges in interface GraphModel

  Parameters:

  port - a port in the graph, obtained from this data source

  Returns:

  Iterator that represents the connected edges

• isEdge

  public boolean isEdge​(java.lang.Object edge)

  Returns true if edge is a valid edge.

  Specified by:

  isEdge in interface GraphModel

  Returns:

  true if edge is a valid edge.

• isPort

  public boolean isPort​(java.lang.Object port)

  Returns true if port is a valid port, possibly supporting edge connection.

  Specified by:

  isPort in interface GraphModel

  Returns:

  true if port is a valid port.

• getConnectionSet

  public ConnectionSet getConnectionSet()

  A shortcut method to create a connection set that represents the connections in this model. Useful for encoding to avoid writing redundant connection data stored in the cells.

• cloneCells

  public java.util.Map cloneCells​(java.lang.Object[] cells)

  Returns a map of (cell, clone)-pairs for all cells. In the new array, all references are replaced with references to the cloned cells (ie parent or anchor). This method does only include children which are in cells. Use JGraph.getDescendants to get a complete list of all children.

  Specified by:

  cloneCells in interface GraphModel

• setParent

  protected void setParent​(java.lang.Object child,
                           java.lang.Object parent)

  Sets the parent of the specified cell.

• cloneCell

  protected java.lang.Object cloneCell​(java.lang.Object cellObj)

  Creates a shallow copy of the cell including a copy of the user object. Subclassers can override the cloneUserObject to provide a custom user object cloning mechanism.

• cloneUserObject

  protected java.lang.Object cloneUserObject​(java.lang.Object userObject)

  Clones the user object. Helper method that is invoked from cloneCells. You must use cloneCells (or cloneCell for single cells) to get a deep copy of a clone. Subclassers must override this and valueForCellChanged to implement custom user objects. This implementation returns object.

• getParent

  public java.lang.Object getParent​(java.lang.Object child)

  Returns the parent of child in the model. child must be a node previously obtained from this data source. This returns null if child is a root in the model.

  Specified by:

  getParent in interface GraphModel

  Parameters:

  child - a node in the graph, obtained from this data source

  Returns:

  the parent of child

• getIndexOfChild

  public int getIndexOfChild​(java.lang.Object parent,
                             java.lang.Object child)

  Returns the index of child in parent. If either the parent or child is null, returns -1.

  Specified by:

  getIndexOfChild in interface GraphModel

  Parameters:

  parent - a note in the tree, obtained from this data source

  child - the node we are interested in

  Returns:

  the index of the child in the parent, or -1 if either the parent or the child is null

• getChild

  public java.lang.Object getChild​(java.lang.Object parent,
                                   int index)

  Returns the child of parent at index index in the parent's child array. parent must be a node previously obtained from this data source. This should not return null if index is a valid index for parent (that is index >= 0 && index < getChildCount( parent )).

  Specified by:

  getChild in interface GraphModel

  Parameters:

  parent - a node in the tree, obtained from this data source

  Returns:

  the child of parent at index index

• getChildCount

  public int getChildCount​(java.lang.Object parent)

  Returns the number of children of parent . Returns 0 if the node is a leaf or if it has no children. parent must be a node previously obtained from this data source.

  Specified by:

  getChildCount in interface GraphModel

  Parameters:

  parent - a node in the tree, obtained from this data source

  Returns:

  the number of children of the node parent

• isLeaf

  public boolean isLeaf​(java.lang.Object node)

  Returns whether the specified node is a leaf node. The way the test is performed depends on the.

  Specified by:

  isLeaf in interface GraphModel

  Parameters:

  node - the node to check

  Returns:

  true if the node is a leaf node

• insert

  public void insert​(java.lang.Object[] roots,
                     java.util.Map attributes,
                     ConnectionSet cs,
                     ParentMap pm,
                     javax.swing.undo.UndoableEdit[] edits)

  Inserts the roots and connections into the model. Notifies the model- and undo listeners of the change. The passed-in edits are executed if they implement the GraphModelEvent.ExecutableGraphChange interface in ascending array-order, after execution of the model change. Note: The passed-in propertyMap may contain PortView s which must be turned into Point s when stored in the model.

  Specified by:

  insert in interface GraphModel

• remove

  public void remove​(java.lang.Object[] roots)

  Removes cells from the model. Notifies the model- and undo listeners of the change.

  Specified by:

  remove in interface GraphModel

• edit

  public void edit​(java.util.Map attributes,
                   ConnectionSet cs,
                   ParentMap pm,
                   javax.swing.undo.UndoableEdit[] edits)

  Shortcut to the new edit method which allows inserts and removes to go along with an edit.

  Specified by:

  edit in interface GraphModel

• edit

  public void edit​(java.lang.Object[] inserted,
                   java.lang.Object[] removed,
                   java.util.Map attributes,
                   ConnectionSet cs,
                   ParentMap pm,
                   javax.swing.undo.UndoableEdit[] edits)

  Applies attributes and the connection changes to the model. The initial edits that triggered the call are considered to be part of this transaction. The passed-in edits are executed if they implement the GraphModelEvent.ExecutableGraphChange interface in ascending array-order, after execution of the model change. Notifies the model- and undo listeners of the change. Note: If only edits is non-null, the edits are directly passed to the UndoableEditListeners. Note: The passed-in propertyMap may contains PortViews which must be turned into Points when stored in the model.

• execute

  public void execute​(ExecutableChange change)

  Description copied from interface: GraphModel
  Executes the specified executable change on this graph model

  Specified by:

  execute in interface GraphModel

  Parameters:

  change - the change to be executed

• getUpdateLevel

  public int getUpdateLevel()

  Overrides:

  getUpdateLevel in class javax.swing.undo.UndoableEditSupport

• beginUpdate

  public void beginUpdate()

  Description copied from interface: GraphModel
  Indicates the start of one level of an executable change

  Specified by:

  beginUpdate in interface GraphModel

  Overrides:

  beginUpdate in class javax.swing.undo.UndoableEditSupport

• endUpdate

  public void endUpdate()

  Description copied from interface: GraphModel
  Indicates the end of the current level of an executable change

  Specified by:

  endUpdate in interface GraphModel

  Overrides:

  endUpdate in class javax.swing.undo.UndoableEditSupport

• updateTransaction

  protected void updateTransaction​(java.lang.Object[] inserted,
                                   java.lang.Object[] removed,
                                   java.util.Map attributes,
                                   ConnectionSet cs,
                                   ParentMap pm)

  Updates the current state of the various transaction data

  Parameters:

  inserted - inserted cell to be added to the transaction

  removed - removed cells to be removed from the transaction

  attributes - nested attribute maps to apply to the transaction

  cs - connection sets to add to the transaction

  pm - parent maps to add to the transaction

• toBack

  public void toBack​(java.lang.Object[] cells)

  Sends cells to back.

  Specified by:

  toBack in interface GraphModel

• toFront

  public void toFront​(java.lang.Object[] cells)

  Brings cells to front.

  Specified by:

  toFront in interface GraphModel

• createLayerEdit

  protected DefaultGraphModel.GraphModelLayerEdit createLayerEdit​(java.lang.Object[] cells,
                                                                  int layer)

• createRemoveEdit

  protected DefaultGraphModel.GraphModelEdit createRemoveEdit​(java.lang.Object[] cells)

  Returns an edit that represents a remove.

• createEdit

  protected DefaultGraphModel.GraphModelEdit createEdit​(java.lang.Object[] inserted,
                                                        java.lang.Object[] removed,
                                                        java.util.Map attributes,
                                                        ConnectionSet cs,
                                                        ParentMap pm,
                                                        javax.swing.undo.UndoableEdit[] edits)

• handleInsert

  protected java.lang.Object[] handleInsert​(java.lang.Object[] cells)

  Inserts cells into the model. Returns the cells that were inserted (including descendants).

• handleRemove

  protected java.lang.Object[] handleRemove​(java.lang.Object[] cells)

  Removes cells from the model. Returns the cells that were removed as roots.

• handleParentMap

  protected ParentMap handleParentMap​(ParentMap parentMap)

  Applies cells to the model. Returns a parent map that may be used to undo this change.

• handleAttributes

  protected java.util.Map handleAttributes​(java.util.Map attributes)

  Applies attributes to the cells specified as keys. Returns the attributes to undo the change.

• valueForCellChanged

  public java.lang.Object valueForCellChanged​(java.lang.Object cell,
                                              java.lang.Object newValue)

  Applies the new value to the specified cell. Unfortunately for cloning the user object you must still override the attribute map and provide a custom cloneUserObject method. This is because the cloning of a cell is local to the cell, which in turn has a reference to its attribute map.

  Specified by:

  valueForCellChanged in interface GraphModel

  Parameters:

  cell -

  newValue -

  Returns:

  the old value for the cell, if any

• handleConnectionSet

  protected ConnectionSet handleConnectionSet​(ConnectionSet cs)

  Applies connectionSet to the model. Returns a connection set that may be used to undo this change.

• handleConnection

  protected void handleConnection​(ConnectionSet.Connection c,
                                  boolean establish)

  Inserts the specified connection into the model.

• connect

  protected void connect​(java.lang.Object edge,
                         java.lang.Object port,
                         boolean isSource,
                         boolean insert)

  Connects or disconnects the edge and port in this model based on remove. Subclassers should override this to update connectivity datastructures.

• addGraphModelListener

  public void addGraphModelListener​(GraphModelListener l)

  Adds a listener for the GraphModelEvent posted after the graph changes.

  Specified by:

  addGraphModelListener in interface GraphModel

  Parameters:

  l - the listener to add

  See Also:

  removeGraphModelListener(org.jgraph.event.GraphModelListener)

• removeGraphModelListener

  public void removeGraphModelListener​(GraphModelListener l)

  Removes a listener previously added with addGraphModelListener() .

  Specified by:

  removeGraphModelListener in interface GraphModel

  Parameters:

  l - the listener to remove

  See Also:

  addGraphModelListener(org.jgraph.event.GraphModelListener)

• cellsChanged

  public void cellsChanged​(java.lang.Object[] cells)

  Invoke this method after you've changed how the cells are to be represented in the graph.

• fireGraphChanged

  protected void fireGraphChanged​(java.lang.Object source,
                                  GraphModelEvent.GraphModelChange edit)

• getGraphModelListeners

  public GraphModelListener[] getGraphModelListeners()

  Return an array of all GraphModelListeners that were added to this model.

• cloneCell

  public static java.lang.Object cloneCell​(GraphModel model,
                                           java.lang.Object cell)

  Returns a deep clone of the specified cell, including all children.

• cloneCell

  public static java.lang.Object[] cloneCell​(GraphModel model,
                                             java.lang.Object[] cells)

  Returns a deep clone of the specified cells, including all children.

• setSourcePort

  public static void setSourcePort​(GraphModel model,
                                   java.lang.Object edge,
                                   java.lang.Object port)

  Helper methods that connects the source of edge to port in model.