maxGraph/dotnet/docs/html/classcom_1_1mxgraph_1_1mxGr...

368 lines
19 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>mxGraph: com.mxgraph.mxGraphViewReader Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">mxGraph
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.6.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>com</b> </li>
<li class="navelem"><a class="el" href="namespacecom_1_1mxgraph.html">mxgraph</a> </li>
<li class="navelem"><a class="el" href="classcom_1_1mxgraph_1_1mxGraphViewReader.html">mxGraphViewReader</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="#properties">Properties</a> </div>
<div class="headertitle">
<div class="title">com.mxgraph.mxGraphViewReader Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="com::mxgraph::mxGraphViewReader" -->
<p>An abstract converter that renders display XML data onto a canvas.
<a href="classcom_1_1mxgraph_1_1mxGraphViewReader.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for com.mxgraph.mxGraphViewReader:</div>
<div class="dyncontent">
<div class="center">
<img src="classcom_1_1mxgraph_1_1mxGraphViewReader.png" usemap="#com.mxgraph.mxGraphViewReader_map" alt=""/>
<map id="com.mxgraph.mxGraphViewReader_map" name="com.mxgraph.mxGraphViewReader_map">
<area href="classcom_1_1mxgraph_1_1mxGraphViewImageReader.html" title="A converter that renders display XML data onto a GDI canvas." alt="com.mxgraph.mxGraphViewImageReader" shape="rect" coords="0,56,243,80"/>
</map>
</div></div>
<p><a href="classcom_1_1mxgraph_1_1mxGraphViewReader-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxGraphViewReader.html#a22ffb53c5451f9bb251fb5457b02ba1f">mxGraphViewReader</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a new graph view reader. <a href="#a22ffb53c5451f9bb251fb5457b02ba1f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxGraphViewReader.html#a8f6fcc12f257aa158199c9bbabef3cf5">mxGraphViewReader</a> (XmlReader reader)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a new graph view reader and reads the given display XML data. <a href="#a8f6fcc12f257aa158199c9bbabef3cf5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">abstract <a class="el" href="interfacecom_1_1mxgraph_1_1mxICanvas.html">mxICanvas</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxGraphViewReader.html#a16cbdd6012a6daa03b51fbf99e3aa8c4">CreateCanvas</a> (Dictionary&lt; string, Object &gt; attrs)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the canvas to be used for rendering. <a href="#a16cbdd6012a6daa03b51fbf99e3aa8c4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxGraphViewReader.html#afb10e352abb9b9dce621d59f26af4c5e">Read</a> (XmlReader reader)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads the given display XML data and parses all elements. <a href="#afb10e352abb9b9dce621d59f26af4c5e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxGraphViewReader.html#ab9f05c7beb8e61208b89de407a11b7c4">ParseElement</a> (string tagName, Dictionary&lt; string, Object &gt; attrs)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Parses the given element and paints it onto the canvas. <a href="#ab9f05c7beb8e61208b89de407a11b7c4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxGraphViewReader.html#a00df67012ee01cdb6e02dbcc1ef1c546">ParseState</a> (<a class="el" href="classcom_1_1mxgraph_1_1mxCellState.html">mxCellState</a> state, bool edge)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Parses the bounds, absolute points and label information from the style of the state into its respective fields and returns the label of the cell. <a href="#a00df67012ee01cdb6e02dbcc1ef1c546"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static List&lt; <a class="el" href="classcom_1_1mxgraph_1_1mxPoint.html">mxPoint</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxGraphViewReader.html#aec1ffc675bae41de08f3db21fad5a8b1">ParsePoints</a> (string pts)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Parses the list of points into an object-oriented representation. <a href="#aec1ffc675bae41de08f3db21fad5a8b1"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfacecom_1_1mxgraph_1_1mxICanvas.html">mxICanvas</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxGraphViewReader.html#acb86df46a548fe81374953640b5c85f6">canvas</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Holds the canvas to be used for rendering the graph. <a href="#acb86df46a548fe81374953640b5c85f6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxGraphViewReader.html#a90a2224de5a84ddc4e3c0012e0ae8aca">scale</a> = 1</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Holds the global scale of the graph. This is set just before createCanvas is called. <a href="#a90a2224de5a84ddc4e3c0012e0ae8aca"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="properties"></a>
Properties</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfacecom_1_1mxgraph_1_1mxICanvas.html">mxICanvas</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxGraphViewReader.html#a0000f8bde71ef72b8923c221c1ecc872">Canvas</a><code> [get]</code></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the canvas that is used for rendering the graph. <a href="#a0000f8bde71ef72b8923c221c1ecc872"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>An abstract converter that renders display XML data onto a canvas. </p>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a22ffb53c5451f9bb251fb5457b02ba1f"></a><!-- doxytag: member="com::mxgraph::mxGraphViewReader::mxGraphViewReader" ref="a22ffb53c5451f9bb251fb5457b02ba1f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classcom_1_1mxgraph_1_1mxGraphViewReader.html#a22ffb53c5451f9bb251fb5457b02ba1f">com.mxgraph.mxGraphViewReader.mxGraphViewReader</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructs a new graph view reader. </p>
</div>
</div>
<a class="anchor" id="a8f6fcc12f257aa158199c9bbabef3cf5"></a><!-- doxytag: member="com::mxgraph::mxGraphViewReader::mxGraphViewReader" ref="a8f6fcc12f257aa158199c9bbabef3cf5" args="(XmlReader reader)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classcom_1_1mxgraph_1_1mxGraphViewReader.html#a22ffb53c5451f9bb251fb5457b02ba1f">com.mxgraph.mxGraphViewReader.mxGraphViewReader</a> </td>
<td>(</td>
<td class="paramtype">XmlReader&#160;</td>
<td class="paramname"><em>reader</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructs a new graph view reader and reads the given display XML data. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">reader</td><td>Reader that represents the display XML data.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a16cbdd6012a6daa03b51fbf99e3aa8c4"></a><!-- doxytag: member="com::mxgraph::mxGraphViewReader::CreateCanvas" ref="a16cbdd6012a6daa03b51fbf99e3aa8c4" args="(Dictionary&lt; string, Object &gt; attrs)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">abstract <a class="el" href="interfacecom_1_1mxgraph_1_1mxICanvas.html">mxICanvas</a> <a class="el" href="classcom_1_1mxgraph_1_1mxGraphViewReader.html#a16cbdd6012a6daa03b51fbf99e3aa8c4">com.mxgraph.mxGraphViewReader.CreateCanvas</a> </td>
<td>(</td>
<td class="paramtype">Dictionary&lt; string, Object &gt;&#160;</td>
<td class="paramname"><em>attrs</em></td><td>)</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the canvas to be used for rendering. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">attrs</td><td>Specifies the attributes of the new canvas.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns a new canvas.</dd></dl>
<p>Implemented in <a class="el" href="classcom_1_1mxgraph_1_1mxGraphViewImageReader.html#ac751f8dd4b8f3109adecb6dfc54e653a">com.mxgraph.mxGraphViewImageReader</a>.</p>
</div>
</div>
<a class="anchor" id="ab9f05c7beb8e61208b89de407a11b7c4"></a><!-- doxytag: member="com::mxgraph::mxGraphViewReader::ParseElement" ref="ab9f05c7beb8e61208b89de407a11b7c4" args="(string tagName, Dictionary&lt; string, Object &gt; attrs)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classcom_1_1mxgraph_1_1mxGraphViewReader.html#ab9f05c7beb8e61208b89de407a11b7c4">com.mxgraph.mxGraphViewReader.ParseElement</a> </td>
<td>(</td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>tagName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Dictionary&lt; string, Object &gt;&#160;</td>
<td class="paramname"><em>attrs</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Parses the given element and paints it onto the canvas. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">tagName</td><td>Name of the node to be parsed.</td></tr>
<tr><td class="paramname">attrs</td><td>Attributes of the node to be parsed.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aec1ffc675bae41de08f3db21fad5a8b1"></a><!-- doxytag: member="com::mxgraph::mxGraphViewReader::ParsePoints" ref="aec1ffc675bae41de08f3db21fad5a8b1" args="(string pts)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static List&lt;<a class="el" href="classcom_1_1mxgraph_1_1mxPoint.html">mxPoint</a>&gt; <a class="el" href="classcom_1_1mxgraph_1_1mxGraphViewReader.html#aec1ffc675bae41de08f3db21fad5a8b1">com.mxgraph.mxGraphViewReader.ParsePoints</a> </td>
<td>(</td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>pts</em></td><td>)</td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Parses the list of points into an object-oriented representation. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">pts</td><td>String containing a list of points.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns the points as a list of mxPoints.</dd></dl>
</div>
</div>
<a class="anchor" id="a00df67012ee01cdb6e02dbcc1ef1c546"></a><!-- doxytag: member="com::mxgraph::mxGraphViewReader::ParseState" ref="a00df67012ee01cdb6e02dbcc1ef1c546" args="(mxCellState state, bool edge)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string <a class="el" href="classcom_1_1mxgraph_1_1mxGraphViewReader.html#a00df67012ee01cdb6e02dbcc1ef1c546">com.mxgraph.mxGraphViewReader.ParseState</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classcom_1_1mxgraph_1_1mxCellState.html">mxCellState</a>&#160;</td>
<td class="paramname"><em>state</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>edge</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Parses the bounds, absolute points and label information from the style of the state into its respective fields and returns the label of the cell. </p>
</div>
</div>
<a class="anchor" id="afb10e352abb9b9dce621d59f26af4c5e"></a><!-- doxytag: member="com::mxgraph::mxGraphViewReader::Read" ref="afb10e352abb9b9dce621d59f26af4c5e" args="(XmlReader reader)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classcom_1_1mxgraph_1_1mxGraphViewReader.html#afb10e352abb9b9dce621d59f26af4c5e">com.mxgraph.mxGraphViewReader.Read</a> </td>
<td>(</td>
<td class="paramtype">XmlReader&#160;</td>
<td class="paramname"><em>reader</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reads the given display XML data and parses all elements. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">reader</td><td>Reader that represents the display XML data.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="acb86df46a548fe81374953640b5c85f6"></a><!-- doxytag: member="com::mxgraph::mxGraphViewReader::canvas" ref="acb86df46a548fe81374953640b5c85f6" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="interfacecom_1_1mxgraph_1_1mxICanvas.html">mxICanvas</a> <a class="el" href="classcom_1_1mxgraph_1_1mxGraphViewReader.html#acb86df46a548fe81374953640b5c85f6">com.mxgraph.mxGraphViewReader.canvas</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Holds the canvas to be used for rendering the graph. </p>
</div>
</div>
<a class="anchor" id="a90a2224de5a84ddc4e3c0012e0ae8aca"></a><!-- doxytag: member="com::mxgraph::mxGraphViewReader::scale" ref="a90a2224de5a84ddc4e3c0012e0ae8aca" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double <a class="el" href="classcom_1_1mxgraph_1_1mxGraphViewReader.html#a90a2224de5a84ddc4e3c0012e0ae8aca">com.mxgraph.mxGraphViewReader.scale</a> = 1<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Holds the global scale of the graph. This is set just before createCanvas is called. </p>
</div>
</div>
<hr/><h2>Property Documentation</h2>
<a class="anchor" id="a0000f8bde71ef72b8923c221c1ecc872"></a><!-- doxytag: member="com::mxgraph::mxGraphViewReader::Canvas" ref="a0000f8bde71ef72b8923c221c1ecc872" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="interfacecom_1_1mxgraph_1_1mxICanvas.html">mxICanvas</a> <a class="el" href="classcom_1_1mxgraph_1_1mxGraphViewReader.html#a0000f8bde71ef72b8923c221c1ecc872">com.mxgraph.mxGraphViewReader.Canvas</a><code> [get]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the canvas that is used for rendering the graph. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/reader/mxGraphViewReader.cs</li>
</ul>
</div><!-- contents -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Aug 9 2013 10:05:12 for mxGraph by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>
</body>
</html>