com::mxgraph::mxCellState Class Reference

Represents the current state of a cell in a given graph view. More...

Inheritance diagram for com::mxgraph::mxCellState:
com::mxgraph::mxRectangle com::mxgraph::mxPoint

List of all members.

Public Member Functions

 mxCellState ()
 Constructs an empty cell state.
 mxCellState (mxGraphView view, Object cell, Dictionary< string, Object > style)
 Constructs a new object that represents the current state of the given cell in the specified view.
int AbsolutePointCount ()
 Returns the number of absolute points.
mxRectangle GetPerimeterBounds ()
 Returns the rectangle that should be used as the perimeter of the cell. This implementation adds the perimeter spacing to the rectangle defined by this cell state.
mxRectangle GetPerimeterBounds (double border)
 Returns the rectangle that should be used as the perimeter of the cell.
void SetAbsoluteTerminalPoint (mxPoint point, bool source)
 Sets the first or last point in the list of points depending on source.
new mxCellState Clone ()
 Returns a clone of this state where all members are deeply cloned except the view and cell references, which are copied with no cloning to the new instance.

Protected Attributes

mxGraphView view
 Reference to the enclosing graph view.
Object cell
 Reference to the cell that is represented by this state.
Dictionary< string, Object > style
 Contains an array of key, value pairs that represent the style of the cell.
mxPoint origin = new mxPoint()
 Holds the origin for all child cells.
List< mxPointabsolutePoints
 List of mxPoints that represent the absolute points of an edge.
mxPoint absoluteOffset = new mxPoint()
 Holds the absolute offset. For edges, this is the absolute coordinates of the label position. For vertices, this is the offset of the label relative to the top, left corner of the vertex.
double terminalDistance
 Caches the distance between the end points of an edge.
double length
 Caches the length of an edge.
double[] segments
 Array of numbers that represent the cached length of each segment of the edge.
mxRectangle labelBounds
 Holds the rectangle which contains the label.
mxRectangle boundingBox
 Holds the largest rectangle which contains all rendering for this cell.

Properties

mxGraphView View [get, set]
 Sets or returns the enclosing graph view.
Object Cell [get, set]
 Sets or returns the cell that is represented by this state.
Dictionary< string, Object > Style [get, set]
 Sets or returns the cell style as a map of key, value pairs.
mxPoint Origin [get, set]
 Sets or returns the origin for the children.
List< mxPointAbsolutePoints [get, set]
 Sets or returns the absolute points.
mxPoint AbsoluteOffset [get, set]
 Sets or returns the absolute offset.
double TerminalDistance [get, set]
 Sets or returns the terminal distance.
double Length [get, set]
 Sets or returns the length.
double[] Segments [get, set]
 Sets or returns the length of the segments.
mxRectangle LabelBounds [get, set]
 Sets or returns the label bounds.
mxRectangle BoundingBox [get, set]
 Sets or returns the bounding box.

Detailed Description

Represents the current state of a cell in a given graph view.


Constructor & Destructor Documentation

com::mxgraph::mxCellState::mxCellState (  )  [inline]

Constructs an empty cell state.

com::mxgraph::mxCellState::mxCellState ( mxGraphView  view,
Object  cell,
Dictionary< string, Object >  style 
) [inline]

Constructs a new object that represents the current state of the given cell in the specified view.

Parameters:
view Graph view that contains the state.
cell Cell that this state represents.
style Array of key, value pairs that constitute the style.

Member Function Documentation

int com::mxgraph::mxCellState::AbsolutePointCount (  )  [inline]

Returns the number of absolute points.

Returns:
new mxCellState com::mxgraph::mxCellState::Clone (  )  [inline]

Returns a clone of this state where all members are deeply cloned except the view and cell references, which are copied with no cloning to the new instance.

Returns:

Reimplemented from com::mxgraph::mxRectangle.

mxRectangle com::mxgraph::mxCellState::GetPerimeterBounds ( double  border  )  [inline]

Returns the rectangle that should be used as the perimeter of the cell.

Parameters:
border 
Returns:
Returns the rectangle that defines the perimeter.
mxRectangle com::mxgraph::mxCellState::GetPerimeterBounds (  )  [inline]

Returns the rectangle that should be used as the perimeter of the cell. This implementation adds the perimeter spacing to the rectangle defined by this cell state.

Returns:
Returns the rectangle that defines the perimeter.
void com::mxgraph::mxCellState::SetAbsoluteTerminalPoint ( mxPoint  point,
bool  source 
) [inline]

Sets the first or last point in the list of points depending on source.

Parameters:
point Point that represents the terminal point.
source Boolean that specifies if the first or last point should be assigned.

Member Data Documentation

Holds the absolute offset. For edges, this is the absolute coordinates of the label position. For vertices, this is the offset of the label relative to the top, left corner of the vertex.

List of mxPoints that represent the absolute points of an edge.

Holds the largest rectangle which contains all rendering for this cell.

Object com::mxgraph::mxCellState::cell [protected]

Reference to the cell that is represented by this state.

Holds the rectangle which contains the label.

Caches the length of an edge.

Holds the origin for all child cells.

double [] com::mxgraph::mxCellState::segments [protected]

Array of numbers that represent the cached length of each segment of the edge.

Dictionary<string, Object> com::mxgraph::mxCellState::style [protected]

Contains an array of key, value pairs that represent the style of the cell.

Caches the distance between the end points of an edge.

Reference to the enclosing graph view.


Property Documentation

mxPoint com::mxgraph::mxCellState::AbsoluteOffset [get, set]

Sets or returns the absolute offset.

List<mxPoint> com::mxgraph::mxCellState::AbsolutePoints [get, set]

Sets or returns the absolute points.

mxRectangle com::mxgraph::mxCellState::BoundingBox [get, set]

Sets or returns the bounding box.

Object com::mxgraph::mxCellState::Cell [get, set]

Sets or returns the cell that is represented by this state.

mxRectangle com::mxgraph::mxCellState::LabelBounds [get, set]

Sets or returns the label bounds.

double com::mxgraph::mxCellState::Length [get, set]

Sets or returns the length.

mxPoint com::mxgraph::mxCellState::Origin [get, set]

Sets or returns the origin for the children.

double [] com::mxgraph::mxCellState::Segments [get, set]

Sets or returns the length of the segments.

Dictionary<string, Object> com::mxgraph::mxCellState::Style [get, set]

Sets or returns the cell style as a map of key, value pairs.

double com::mxgraph::mxCellState::TerminalDistance [get, set]

Sets or returns the terminal distance.

mxGraphView com::mxgraph::mxCellState::View [get, set]

Sets or returns the enclosing graph view.


The documentation for this class was generated from the following file:
Generated on Sat Sep 22 15:55:32 2012 for mxGraph by  doxygen 1.6.3