org.jgraph.graph
public interface GraphModel
Method Summary | |
---|---|
boolean | acceptsSource(Object edge, Object port)
Returns true if port is a valid source for
edge . |
boolean | acceptsTarget(Object edge, Object port)
Returns true if port is a valid target for
edge . |
void | addGraphModelListener(GraphModelListener l)
Adds a listener for the GraphModelEvent posted after the model changes. |
void | addUndoableEditListener(UndoableEditListener listener)
Adds an undo listener for notification of any changes. |
void | beginUpdate()
Indicates the start of one level of an executable change |
Map | cloneCells(Object[] cells)
Returns a map of (cell, clone)-pairs for all cells and
their children. |
boolean | contains(Object node)
Returns true if node or one of its
ancestors is in the model.
|
Iterator | edges(Object port)
Returns an iterator of the edges connected to port .
|
void | edit(Map attributes, ConnectionSet cs, ParentMap pm, UndoableEdit[] e)
Applies the propertyMap and the connection changes to the
model. |
void | endUpdate()
Indicates the end of the current level of an executable change |
void | execute(ExecutableChange change)
Executes the specified executable change on this graph model |
AttributeMap | getAttributes(Object node)
Returns a AttributeMap that represents the properties for
the specified cell.
|
Object | getChild(Object parent, int index)
Returns the child of parent at index index in the
parent's child array. |
int | getChildCount(Object parent)
Returns the number of children of parent . |
int | getIndexOfChild(Object parent, Object child)
Returns the index of child in parent. |
int | getIndexOfRoot(Object root)
Returns the index of root in the model. |
Object | getParent(Object child)
Returns the parent of child in the model. |
Object | getRootAt(int index)
Returns the root at index index in the model. |
int | getRootCount()
Returns the number of roots in the model. |
Object | getSource(Object edge)
Returns the source of edge . |
Object | getTarget(Object edge)
Returns the target of edge . |
Object | getValue(Object node)
Returns the user object for the specified cell.
|
void | insert(Object[] roots, Map attributes, ConnectionSet cs, ParentMap pm, UndoableEdit[] e)
Inserts the cells and connections into the model, and
passes attributes to the views. |
boolean | isEdge(Object edge)
Returns true if edge is a valid edge.
|
boolean | isLeaf(Object node)
Returns whether the specified node is a leaf node. |
boolean | isPort(Object port)
Returns true if port is a valid port,
possibly supporting edge connection.
|
void | remove(Object[] roots)
Removes cells from the model. |
void | removeGraphModelListener(GraphModelListener l)
Removes a listener previously added with addGraphModelListener() . |
void | removeUndoableEditListener(UndoableEditListener listener)
Removes an undo listener. |
void | toBack(Object[] cells)
Sends cells to back. |
void | toFront(Object[] cells)
Brings cells to front. |
Object | valueForCellChanged(Object cell, Object newValue)
Messaged when the value of the cell has changed, eg from within the edit
method. |
true
if port
is a valid source for
edge
. edge and port must be objects
previously obtained from this data source.
Returns: true
if port
is a valid source for
edge
.
true
if port
is a valid target for
edge
. edge and port must be objects
previously obtained from this data source.
Returns: true
if port
is a valid target for
edge
.
UndoableEdit
will cause the
appropriate ModelEvent to be fired to keep the view(s) in sync with the
model.cells
and
their children. Special care should be taken to replace references
between cells.true
if node
or one of its
ancestors is in the model.
Returns: true
if node
is in the model
port
.
port must be a object previously obtained from this data source.
This method never returns null.
Parameters: port a port in the graph, obtained from this data source
Returns: Iterator
that represents the connected edges
propertyMap
and the connection changes to the
model. The initial edits
that triggered the call are
considered to be part of this transaction. Notifies the model- and undo
listeners of the change. Note: If only
edits
is non-null, the edits are directly passed to the
UndoableEditListeners.Parameters: change the change to be executed
AttributeMap
that represents the properties for
the specified cell.
Returns: properties of node
as a Map
Parameters: parent a node in the tree, obtained from this data source
Returns: the child of parent at index index
Parameters: parent a node in the tree, obtained from this data source
Returns: the number of children of the node parent
null
, returns -1.
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
root
in the model. If root is
null
, returns -1.
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
Parameters: child a node in the graph, obtained from this data source
Returns: the parent of child
Returns: the root of at index index
Returns: the number of roots in the model
edge
. edge must be an
object previously obtained from this data source.
Returns: Object
that represents the source of edge
edge
. edge must be an
object previously obtained from this data source.
Returns: Object
that represents the target of edge
Returns: userobject of node
cells
and connections into the model, and
passes attributes
to the views. Notifies the model- and
undo listeners of the change.true
if edge
is a valid edge.
Returns: true
if edge
is a valid edge.
askAllowsChildren
setting.
Parameters: node the node to check
Returns: true if the node is a leaf node
true
if port
is a valid port,
possibly supporting edge connection.
Returns: true
if port
is a valid port.
cells
from the model. Notifies the model- and undo
listeners of the change.cells
to back.cells
to front.