|
JGraph |
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
The interface that defines a suitable data model for a JGraph.
| 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. |
| Method Detail |
public int getRootCount()
public Object getRootAt(int index)
public int getIndexOfRoot(Object root)
root in the model. If root is
null, returns -1.
root - a root in the model, obtained from this data source
nullpublic boolean contains(Object node)
true if node or one of its
ancestors is in the model.
true if node is in the modelpublic AttributeMap getAttributes(Object node)
AttributeMap that represents the properties for
the specified cell.
node as a Mappublic Object getValue(Object node)
nodepublic Object getSource(Object edge)
edge. edge must be an
object previously obtained from this data source.
Object that represents the source of edge public Object getTarget(Object edge)
edge. edge must be an
object previously obtained from this data source.
Object that represents the target of edge
public boolean acceptsSource(Object edge,
Object port)
true if port is a valid source for
edge. edge and port must be objects
previously obtained from this data source.
true if port is a valid source for
edge.
public boolean acceptsTarget(Object edge,
Object port)
true if port is a valid target for
edge. edge and port must be objects
previously obtained from this data source.
true if port is a valid target for
edge.public Iterator edges(Object port)
port.
port must be a object previously obtained from this data source.
This method never returns null.
port - a port in the graph, obtained from this data source
Iterator that represents the connected edgespublic boolean isEdge(Object edge)
true if edge is a valid edge.
true if edge is a valid edge.public boolean isPort(Object port)
true if port is a valid port,
possibly supporting edge connection.
true if port is a valid port.public Object getParent(Object child)
child - a node in the graph, obtained from this data source
public int getIndexOfChild(Object parent,
Object child)
null, returns -1.
parent - a note in the tree, obtained from this data sourcechild - the node we are interested in
null
public Object getChild(Object parent,
int index)
parent - a node in the tree, obtained from this data source
public int getChildCount(Object parent)
parent - a node in the tree, obtained from this data source
public boolean isLeaf(Object node)
askAllowsChildren setting.
node - the node to check
public void insert(Object[] roots,
Map attributes,
ConnectionSet cs,
ParentMap pm,
UndoableEdit[] e)
cells and connections into the model, and
passes attributes to the views. Notifies the model- and
undo listeners of the change.
public void remove(Object[] roots)
cells from the model. If
removeChildren is true, the children are
also removed. Notifies the model- and undo listeners of the change.
public void edit(Map attributes,
ConnectionSet cs,
ParentMap pm,
UndoableEdit[] e)
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.
public void beginUpdate()
public void endUpdate()
public void execute(ExecutableChange change)
change - the change to be executedpublic Map cloneCells(Object[] cells)
cells and
their children. Special care should be taken to replace references
between cells.
public Object valueForCellChanged(Object cell,
Object newValue)
public void toBack(Object[] cells)
cells to back.
public void toFront(Object[] cells)
cells to front.
public void addGraphModelListener(GraphModelListener l)
public void removeGraphModelListener(GraphModelListener l)
public void addUndoableEditListener(UndoableEditListener listener)
UndoableEdit will cause the
appropriate ModelEvent to be fired to keep the view(s) in sync with the
model.
public void removeUndoableEditListener(UndoableEditListener listener)
|
JGraph |
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||