mxGraph
Public Member Functions | Properties | List of all members
com.mxgraph.mxICell Interface Reference

Defines the requirements for a cell that can be used in an mxGraphModel. More...

Inheritance diagram for com.mxgraph.mxICell:
com.mxgraph.mxCell

Public Member Functions

mxICell GetTerminal (bool source)
 Returns the source or target terminal of the cell. More...
 
mxICell SetTerminal (mxICell terminal, bool source)
 Sets the source or target terminal. More...
 
int ChildCount ()
 Returns the number of child cells. More...
 
int GetIndex (mxICell child)
 Returns the index of the specified child in the child array. More...
 
mxICell GetChildAt (int index)
 Returns the child at the specified index. More...
 
mxICell Insert (mxICell child)
 Appends the specified child into the child array and updates the parent reference of the child. More...
 
mxICell Insert (mxICell child, int index)
 Inserts the specified child into the child array at the specified index and updates the parent reference of the child. More...
 
mxICell Remove (int index)
 Removes the child at the specified index from the child array and returns the child that was removed. Will remove the parent reference of the child. More...
 
mxICell Remove (mxICell child)
 Removes the given child from the child array. Will remove the parent reference of the child. More...
 
void RemoveFromParent ()
 Removes the cell from its parent. More...
 
int EdgeCount ()
 Returns the number of edges in the edge array. More...
 
int GetEdgeIndex (mxICell edge)
 Returns the index of the specified edge in the edge array. More...
 
mxICell GetEdgeAt (int index)
 Returns the edge at the specified index in the edge array. More...
 
mxICell InsertEdge (mxICell edge, bool isOutgoing)
 Inserts the specified edge into the edge array and returns the edge. Will update the respective terminal reference of the edge. More...
 
mxICell RemoveEdge (mxICell edge, bool isOutgoing)
 Removes the specified edge from the edge array and returns the edge. Will remove the respective terminal reference from the edge. More...
 
void RemoveFromTerminal (bool isSource)
 Removes the edge from its source or target terminal. More...
 
Object Clone ()
 Returns a clone of this cell. More...
 

Properties

string Id [get, set]
 Sets or returns the Id of the cell. More...
 
Object Value [get, set]
 Sets or returns the user object of the cell. More...
 
mxGeometry Geometry [get, set]
 Sets or returns the geometry of the cell. More...
 
string Style [get, set]
 Sets or returns the string that describes the style. More...
 
bool Vertex [get]
 Returns true if the cell is a vertex. More...
 
bool Edge [get]
 Returns true if the cell is an edge. More...
 
bool Connectable [get]
 Returns true if the cell is connectable. More...
 
bool Visible [get, set]
 Sets or returns the visible state of the cell. More...
 
bool Collapsed [get, set]
 Sets or returns the collapsed state of the cell. More...
 
mxICell Parent [get, set]
 Sets or returns the parent of the cell. More...
 

Detailed Description

Defines the requirements for a cell that can be used in an mxGraphModel.

Member Function Documentation

int com.mxgraph.mxICell.ChildCount ( )

Returns the number of child cells.

Returns
Returns the number of child cells.

Implemented in com.mxgraph.mxCell.

Object com.mxgraph.mxICell.Clone ( )

Returns a clone of this cell.

Returns
Returns a clone of this cell.

Implemented in com.mxgraph.mxCell.

Referenced by com.mxgraph.mxGraphModel.MergeChildrenImpl().

int com.mxgraph.mxICell.EdgeCount ( )

Returns the number of edges in the edge array.

Returns
Returns the number of edges.

Implemented in com.mxgraph.mxCell.

mxICell com.mxgraph.mxICell.GetChildAt ( int  index)

Returns the child at the specified index.

Parameters
indexInteger that specifies the child to be returned.
Returns
Returns the child at the specified index.

Implemented in com.mxgraph.mxCell.

Referenced by com.mxgraph.mxGraphModel.CellAdded(), com.mxgraph.mxGraphModel.CellRemoved(), and com.mxgraph.mxCodec.EncodeCell().

mxICell com.mxgraph.mxICell.GetEdgeAt ( int  index)

Returns the edge at the specified index in the edge array.

Parameters
indexInteger that specifies the index of the edge to be returned.
Returns
Returns the edge at the specified index.

Implemented in com.mxgraph.mxCell.

int com.mxgraph.mxICell.GetEdgeIndex ( mxICell  edge)

Returns the index of the specified edge in the edge array.

Parameters
edgeCell whose index should be returned.
Returns
Returns the index of the given edge.

Implemented in com.mxgraph.mxCell.

int com.mxgraph.mxICell.GetIndex ( mxICell  child)

Returns the index of the specified child in the child array.

Parameters
childChild whose index should be returned.
Returns
Returns the index of the specified child.

Implemented in com.mxgraph.mxCell.

mxICell com.mxgraph.mxICell.GetTerminal ( bool  source)

Returns the source or target terminal of the cell.

Parameters
sourceBoolean that specifies if the source terminal should be returned.
Returns
Returns the source or target terminal.

Implemented in com.mxgraph.mxCell.

Referenced by com.mxgraph.mxCell.InsertEdge(), and com.mxgraph.mxCell.RemoveEdge().

mxICell com.mxgraph.mxICell.Insert ( mxICell  child)

Appends the specified child into the child array and updates the parent reference of the child.

Parameters
childCell to be appended to the child array.
Returns
Returns the appended child.

Implemented in com.mxgraph.mxCell.

mxICell com.mxgraph.mxICell.Insert ( mxICell  child,
int  index 
)

Inserts the specified child into the child array at the specified index and updates the parent reference of the child.

Parameters
childCell to be inserted into the child array.
indexInteger that specifies the index at which the child should be inserted into the child array.
Returns
Returns the inserted child.

Implemented in com.mxgraph.mxCell.

mxICell com.mxgraph.mxICell.InsertEdge ( mxICell  edge,
bool  isOutgoing 
)

Inserts the specified edge into the edge array and returns the edge. Will update the respective terminal reference of the edge.

Parameters
edgeCell to be inserted into the edge array.
isOutgoingBoolean that specifies if the edge is outgoing.
Returns
Returns the inserted edge.

Implemented in com.mxgraph.mxCell.

mxICell com.mxgraph.mxICell.Remove ( int  index)

Removes the child at the specified index from the child array and returns the child that was removed. Will remove the parent reference of the child.

Parameters
indexInteger that specifies the index of the child to be removed.
Returns
Returns the child that was removed.

Implemented in com.mxgraph.mxCell.

mxICell com.mxgraph.mxICell.Remove ( mxICell  child)

Removes the given child from the child array. Will remove the parent reference of the child.

Parameters
child
Returns
Returns the child that was removed.

Implemented in com.mxgraph.mxCell.

mxICell com.mxgraph.mxICell.RemoveEdge ( mxICell  edge,
bool  isOutgoing 
)

Removes the specified edge from the edge array and returns the edge. Will remove the respective terminal reference from the edge.

Parameters
edgeCell to be removed from the edge array.
isOutgoingBoolean that specifies if the edge is outgoing.
Returns
Returns the edge that was removed.

Implemented in com.mxgraph.mxCell.

void com.mxgraph.mxICell.RemoveFromParent ( )

Removes the cell from its parent.

Implemented in com.mxgraph.mxCell.

void com.mxgraph.mxICell.RemoveFromTerminal ( bool  isSource)

Removes the edge from its source or target terminal.

Parameters
isSourceBoolean that specifies if the edge should be removed from its source or target terminal.

Implemented in com.mxgraph.mxCell.

mxICell com.mxgraph.mxICell.SetTerminal ( mxICell  terminal,
bool  source 
)

Sets the source or target terminal.

Parameters
terminalCell that represents the new source or target terminal.
sourceBoolean that specifies if the source or target terminal should be set.
Returns
Returns the new terminal.

Implemented in com.mxgraph.mxCell.

Property Documentation

bool com.mxgraph.mxICell.Collapsed
getset

Sets or returns the collapsed state of the cell.

bool com.mxgraph.mxICell.Connectable
get

Returns true if the cell is connectable.

bool com.mxgraph.mxICell.Edge
get

Returns true if the cell is an edge.

mxGeometry com.mxgraph.mxICell.Geometry
getset

Sets or returns the geometry of the cell.

string com.mxgraph.mxICell.Id
getset

Sets or returns the Id of the cell.

Referenced by com.mxgraph.mxGraphModel.CellAdded(), and com.mxgraph.mxGraphModel.CellRemoved().

mxICell com.mxgraph.mxICell.Parent
getset

Sets or returns the parent of the cell.

Referenced by com.mxgraph.mxModelCodec.BeforeDecode(), com.mxgraph.mxCellPath.Create(), and com.mxgraph.mxCell.Insert().

string com.mxgraph.mxICell.Style
getset

Sets or returns the string that describes the style.

Object com.mxgraph.mxICell.Value
getset

Sets or returns the user object of the cell.

bool com.mxgraph.mxICell.Vertex
get

Returns true if the cell is a vertex.

bool com.mxgraph.mxICell.Visible
getset

Sets or returns the visible state of the cell.


The documentation for this interface was generated from the following file: