| 
 | JGraph X 2.1.0.7 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface mxIGraphModel
Defines the requirements for a graph model to be used with mxGraph.
| Nested Class Summary | |
|---|---|
| static class | mxIGraphModel.mxAtomicGraphModelChangeDefines the interface for an atomic change of the graph model. | 
| Method Summary | |
|---|---|
|  Object | add(Object parent,
    Object child,
    int index)Adds the specified child to the parent at the given index. | 
|  void | addListener(String eventName,
            mxEventSource.mxIEventListener listener)Binds the specified function to the given event name. | 
|  void | beginUpdate()Increments the updateLevel by one. | 
|  Object[] | cloneCells(Object[] cells,
           boolean includeChildren)Returns an array of clones for the given array of cells. | 
|  boolean | contains(Object cell)Returns true if the model contains the given cell. | 
|  void | endUpdate()Decrements the updateLevel by one and fires a notification event if the updateLevel reaches 0. | 
|  Object | getChildAt(Object parent,
           int index)Returns the child of the given parent at the given index. | 
|  int | getChildCount(Object cell)Returns the number of children in the given cell. | 
|  Object | getEdgeAt(Object cell,
          int index)Returns the edge of cell at the given index. | 
|  int | getEdgeCount(Object cell)Returns the number of distinct edges connected to the given cell. | 
|  mxGeometry | getGeometry(Object cell)Returns the geometry of the given cell. | 
|  Object | getParent(Object child)Returns the parent of the given cell. | 
|  Object | getRoot()Returns the root of the model or the topmost parent of the given cell. | 
|  String | getStyle(Object cell)Returns the style of the given cell. | 
|  Object | getTerminal(Object edge,
            boolean isSource)Returns the source or target terminal of the given edge depending on the value of the boolean parameter. | 
|  Object | getValue(Object cell)Returns the user object of the given cell. | 
|  boolean | isAncestor(Object parent,
           Object child)Returns true if the given parent is an ancestor of the given child. | 
|  boolean | isCollapsed(Object cell)Returns true if the given cell is collapsed. | 
|  boolean | isConnectable(Object cell)Returns true if the given cell is connectable. | 
|  boolean | isEdge(Object cell)Returns true if the given cell is an edge. | 
|  boolean | isVertex(Object cell)Returns true if the given cell is a vertex. | 
|  boolean | isVisible(Object cell)Returns true if the given cell is visible. | 
|  Object | remove(Object cell)Removes the specified cell from the model. | 
|  void | removeListener(mxEventSource.mxIEventListener listener)Function: removeListener Removes the given listener from the list of listeners. | 
|  void | removeListener(mxEventSource.mxIEventListener listener,
               String eventName)Function: removeListener Removes the given listener from the list of listeners. | 
|  boolean | setCollapsed(Object cell,
             boolean collapsed)Sets the collapsed state of the given cell. | 
|  mxGeometry | setGeometry(Object cell,
            mxGeometry geometry)Sets the geometry of the given cell. | 
|  Object | setRoot(Object root)Sets the root of the model and resets all structures. | 
|  String | setStyle(Object cell,
         String style)Sets the style of the given cell. | 
|  Object | setTerminal(Object edge,
            Object terminal,
            boolean isSource)Sets the source or target terminal of the given edge using. | 
|  Object | setValue(Object cell,
         Object value)Sets the user object of then given cell. | 
|  boolean | setVisible(Object cell,
           boolean visible)Sets the visible state of the given cell. | 
| Method Detail | 
|---|
Object getRoot()
Object setRoot(Object root)
root - Cell that specifies the new root.
Object[] cloneCells(Object[] cells,
                    boolean includeChildren)
cells - Array of cells to be cloned.includeChildren - Boolean indicating if the cells should be cloned
 with all descendants.
boolean isAncestor(Object parent,
                   Object child)
parent - Cell that specifies the parent.child - Cell that specifies the child.
boolean contains(Object cell)
cell - Cell to be checked.
Object getParent(Object child)
child - Cell whose parent should be returned.
Object add(Object parent,
           Object child,
           int index)
parent - Cell that specifies the parent to contain the child.child - Cell that specifies the child to be inserted.index - Integer that specifies the index of the child.
Object remove(Object cell)
cell - Cell that should be removed.
int getChildCount(Object cell)
cell - Cell whose number of children should be returned.
Object getChildAt(Object parent,
                  int index)
parent - Cell that represents the parent.index - Integer that specifies the index of the child to be
 returned.
Object getTerminal(Object edge,
                   boolean isSource)
edge - Cell that specifies the edge.isSource - Boolean indicating which end of the edge should be
 returned.
Object setTerminal(Object edge,
                   Object terminal,
                   boolean isSource)
edge - Cell that specifies the edge.terminal - Cell that specifies the new terminal.isSource - Boolean indicating if the terminal is the new source or
 target terminal of the edge.
int getEdgeCount(Object cell)
cell - Cell that represents the vertex.
Object getEdgeAt(Object cell,
                 int index)
cell - Cell that specifies the vertex.index - Integer that specifies the index of the edge to return.
boolean isVertex(Object cell)
cell - Cell that represents the possible vertex.
boolean isEdge(Object cell)
cell - Cell that represents the possible edge.
boolean isConnectable(Object cell)
cell - Cell whose connectable state should be returned.
Object getValue(Object cell)
cell - Cell whose user object should be returned.
Object setValue(Object cell,
                Object value)
cell - Cell whose user object should be changed.value - Object that defines the new user object.
mxGeometry getGeometry(Object cell)
cell - Cell whose geometry should be returned.
mxGeometry setGeometry(Object cell,
                       mxGeometry geometry)
cell - Cell whose geometry should be changed.geometry - Object that defines the new geometry.
String getStyle(Object cell)
cell - Cell whose style should be returned.
String setStyle(Object cell,
                String style)
cell - Cell whose style should be changed.style - String of the form stylename[;key=value] to specify
 the new cell style.
boolean isCollapsed(Object cell)
cell - Cell whose collapsed state should be returned.
boolean setCollapsed(Object cell,
                     boolean collapsed)
cell - Cell whose collapsed state should be changed.collapsed - Boolean that specifies the new collpased state.
boolean isVisible(Object cell)
cell - Cell whose visible state should be returned.
boolean setVisible(Object cell,
                   boolean visible)
cell - Cell whose visible state should be changed.visible - Boolean that specifies the new visible state.
void beginUpdate()
void endUpdate()
void addListener(String eventName,
                 mxEventSource.mxIEventListener listener)
void removeListener(mxEventSource.mxIEventListener listener)
void removeListener(mxEventSource.mxIEventListener listener,
                    String eventName)
| 
 | JGraph X 2.1.0.7 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||