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

323 lines
17 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"/>
<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>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</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 class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
<div class="navpath"><b>com</b>::<b>mxgraph</b>::<a class="el" href="classcom_1_1mxgraph_1_1mxGraphViewReader.html">mxGraphViewReader</a>
</div>
</div>
<div class="contents">
<h1>com::mxgraph::mxGraphViewReader Class Reference</h1><!-- doxytag: class="com::mxgraph::mxGraphViewReader" -->
<p>An abstract converter that renders display XML data onto a canvas.
<a href="#_details">More...</a></p>
<div class="dynheader">
Inheritance diagram for com::mxgraph::mxGraphViewReader:</div>
<div class="dynsection">
<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" alt="com::mxgraph::mxGraphViewImageReader" shape="rect" coords="0,56,247,80"/>
</map>
</div>
</div>
<p><a href="classcom_1_1mxgraph_1_1mxGraphViewReader-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxGraphViewReader.html#a5e70037f507dd7a5b0c7ca075b58a494">mxGraphViewReader</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructs a new graph view reader. <a href="#a5e70037f507dd7a5b0c7ca075b58a494"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxGraphViewReader.html#a67e55eda51751f24e7006792976abbdf">mxGraphViewReader</a> (XmlReader reader)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructs a new graph view reader and reads the given display XML data. <a href="#a67e55eda51751f24e7006792976abbdf"></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>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxGraphViewReader.html#ae5c444871b99317d1d27268430a9016f">CreateCanvas</a> (Dictionary&lt; string, Object &gt; attrs)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the canvas to be used for rendering. <a href="#ae5c444871b99317d1d27268430a9016f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxGraphViewReader.html#a27c8f5379f6aaa9e751eef7f716d9cc7">Read</a> (XmlReader reader)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reads the given display XML data and parses all elements. <a href="#a27c8f5379f6aaa9e751eef7f716d9cc7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxGraphViewReader.html#a78ed8a118dbce9e2638954de73a9304d">ParseElement</a> (string tagName, Dictionary&lt; string, Object &gt; attrs)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Parses the given element and paints it onto the canvas. <a href="#a78ed8a118dbce9e2638954de73a9304d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxGraphViewReader.html#ac83438fd2f9c2a4f13498192aa068140">ParseState</a> (<a class="el" href="classcom_1_1mxgraph_1_1mxCellState.html">mxCellState</a> state, bool edge)</td></tr>
<tr><td class="mdescLeft">&nbsp;</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="#ac83438fd2f9c2a4f13498192aa068140"></a><br/></td></tr>
<tr><td colspan="2"><h2>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;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxGraphViewReader.html#a9e04e66ca4cdf297abee69ef68baaa04">ParsePoints</a> (string pts)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Parses the list of points into an object-oriented representation. <a href="#a9e04e66ca4cdf297abee69ef68baaa04"></a><br/></td></tr>
<tr><td colspan="2"><h2>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>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxGraphViewReader.html#a4ead1c024b80b0157e323050b273e402">canvas</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Holds the canvas to be used for rendering the graph. <a href="#a4ead1c024b80b0157e323050b273e402"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxGraphViewReader.html#a667a53ffe35f9601f814c2708d87de5e">scale</a> = 1</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Holds the global scale of the graph. This is set just before createCanvas is called. <a href="#a667a53ffe35f9601f814c2708d87de5e"></a><br/></td></tr>
<tr><td colspan="2"><h2>Properties</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfacecom_1_1mxgraph_1_1mxICanvas.html">mxICanvas</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxGraphViewReader.html#af130379cf2af3dd403a3c32d88101ecc">Canvas</a><code> [get]</code></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the canvas that is used for rendering the graph. <a href="#af130379cf2af3dd403a3c32d88101ecc"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>An abstract converter that renders display XML data onto a canvas. </p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a5e70037f507dd7a5b0c7ca075b58a494"></a><!-- doxytag: member="com::mxgraph::mxGraphViewReader::mxGraphViewReader" ref="a5e70037f507dd7a5b0c7ca075b58a494" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">com::mxgraph::mxGraphViewReader::mxGraphViewReader </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</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="a67e55eda51751f24e7006792976abbdf"></a><!-- doxytag: member="com::mxgraph::mxGraphViewReader::mxGraphViewReader" ref="a67e55eda51751f24e7006792976abbdf" args="(XmlReader reader)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">com::mxgraph::mxGraphViewReader::mxGraphViewReader </td>
<td>(</td>
<td class="paramtype">XmlReader&nbsp;</td>
<td class="paramname"> <em>reader</em></td>
<td>&nbsp;)&nbsp;</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><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>reader</em>&nbsp;</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="ae5c444871b99317d1d27268430a9016f"></a><!-- doxytag: member="com::mxgraph::mxGraphViewReader::CreateCanvas" ref="ae5c444871b99317d1d27268430a9016f" 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> com::mxgraph::mxGraphViewReader::CreateCanvas </td>
<td>(</td>
<td class="paramtype">Dictionary&lt; string, Object &gt;&nbsp;</td>
<td class="paramname"> <em>attrs</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the canvas to be used for rendering. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>attrs</em>&nbsp;</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#ac8356063dfd38867d0a9941c4211d57d">com::mxgraph::mxGraphViewImageReader</a>.</p>
</div>
</div>
<a class="anchor" id="a78ed8a118dbce9e2638954de73a9304d"></a><!-- doxytag: member="com::mxgraph::mxGraphViewReader::ParseElement" ref="a78ed8a118dbce9e2638954de73a9304d" args="(string tagName, Dictionary&lt; string, Object &gt; attrs)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void com::mxgraph::mxGraphViewReader::ParseElement </td>
<td>(</td>
<td class="paramtype">string&nbsp;</td>
<td class="paramname"> <em>tagName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Dictionary&lt; string, Object &gt;&nbsp;</td>
<td class="paramname"> <em>attrs</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<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><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>tagName</em>&nbsp;</td><td>Name of the node to be parsed.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>attrs</em>&nbsp;</td><td>Attributes of the node to be parsed.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a9e04e66ca4cdf297abee69ef68baaa04"></a><!-- doxytag: member="com::mxgraph::mxGraphViewReader::ParsePoints" ref="a9e04e66ca4cdf297abee69ef68baaa04" 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; com::mxgraph::mxGraphViewReader::ParsePoints </td>
<td>(</td>
<td class="paramtype">string&nbsp;</td>
<td class="paramname"> <em>pts</em></td>
<td>&nbsp;)&nbsp;</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><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pts</em>&nbsp;</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="ac83438fd2f9c2a4f13498192aa068140"></a><!-- doxytag: member="com::mxgraph::mxGraphViewReader::ParseState" ref="ac83438fd2f9c2a4f13498192aa068140" args="(mxCellState state, bool edge)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string com::mxgraph::mxGraphViewReader::ParseState </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classcom_1_1mxgraph_1_1mxCellState.html">mxCellState</a>&nbsp;</td>
<td class="paramname"> <em>state</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&nbsp;</td>
<td class="paramname"> <em>edge</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<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="a27c8f5379f6aaa9e751eef7f716d9cc7"></a><!-- doxytag: member="com::mxgraph::mxGraphViewReader::Read" ref="a27c8f5379f6aaa9e751eef7f716d9cc7" args="(XmlReader reader)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void com::mxgraph::mxGraphViewReader::Read </td>
<td>(</td>
<td class="paramtype">XmlReader&nbsp;</td>
<td class="paramname"> <em>reader</em></td>
<td>&nbsp;)&nbsp;</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><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>reader</em>&nbsp;</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="a4ead1c024b80b0157e323050b273e402"></a><!-- doxytag: member="com::mxgraph::mxGraphViewReader::canvas" ref="a4ead1c024b80b0157e323050b273e402" 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#a4ead1c024b80b0157e323050b273e402">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="a667a53ffe35f9601f814c2708d87de5e"></a><!-- doxytag: member="com::mxgraph::mxGraphViewReader::scale" ref="a667a53ffe35f9601f814c2708d87de5e" 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#a667a53ffe35f9601f814c2708d87de5e">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="af130379cf2af3dd403a3c32d88101ecc"></a><!-- doxytag: member="com::mxgraph::mxGraphViewReader::Canvas" ref="af130379cf2af3dd403a3c32d88101ecc" 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> com::mxgraph::mxGraphViewReader::Canvas<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>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Tue Dec 18 13:18:35 2012 for mxGraph by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>