maxGraph/dotnet/docs/html/classcom_1_1mxgraph_1_1mxMo...

226 lines
13 KiB
HTML
Raw Normal View History

2012-05-21 20:32:26 +00:00
<!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::mxModelCodec 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_1mxModelCodec.html">mxModelCodec</a>
</div>
</div>
<div class="contents">
<h1>com::mxgraph::mxModelCodec Class Reference</h1><!-- doxytag: class="com::mxgraph::mxModelCodec" --><!-- doxytag: inherits="com::mxgraph::mxObjectCodec" -->
<p>Codec for mxGraphModels. This class is created and registered dynamically at load time and used implicitely via <a class="el" href="classcom_1_1mxgraph_1_1mxCodec.html" title="XML codec for .NET object graphs. In order to resolve forward references when reading...">mxCodec</a> and the <a class="el" href="classcom_1_1mxgraph_1_1mxCodecRegistry.html" title="Static class that acts as a global registry for codecs. See mxCodec for an example...">mxCodecRegistry</a>.
<a href="#_details">More...</a></p>
<div class="dynheader">
Inheritance diagram for com::mxgraph::mxModelCodec:</div>
<div class="dynsection">
<div class="center">
<img src="classcom_1_1mxgraph_1_1mxModelCodec.png" usemap="#com::mxgraph::mxModelCodec_map" alt=""/>
<map id="com::mxgraph::mxModelCodec_map" name="com::mxgraph::mxModelCodec_map">
<area href="classcom_1_1mxgraph_1_1mxObjectCodec.html" alt="com::mxgraph::mxObjectCodec" shape="rect" coords="0,0,184,24"/>
</map>
</div>
</div>
<p><a href="classcom_1_1mxgraph_1_1mxModelCodec-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_1mxModelCodec.html#a0f08ae910decb08326e279aa15253329">mxModelCodec</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructs a new model codec. <a href="#a0f08ae910decb08326e279aa15253329"></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_1mxModelCodec.html#a127ded19ebb7d5efeacfce244f0f751a">mxModelCodec</a> (Object <a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#a24bdd53b1c6af9edab63a37cbd52533e">template</a>)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructs a new model codec for the given template. <a href="#a127ded19ebb7d5efeacfce244f0f751a"></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_1mxModelCodec.html#a3954e4835954a01b46671fd802a13d42">mxModelCodec</a> (Object <a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#a24bdd53b1c6af9edab63a37cbd52533e">template</a>, String[] <a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#ae4e8b08be01d379f6a84cfe28235b94e">exclude</a>, String[] <a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#abef71a12c34e290072c9a9daeea34429">idrefs</a>, Dictionary&lt; string, string &gt; <a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#a8cf9b1b0429e7340911953750d361cf1">mapping</a>)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructs a new model codec for the given arguments. <a href="#a3954e4835954a01b46671fd802a13d42"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">override XmlNode&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxModelCodec.html#a64513ab4228e528bfd216c08def3ec6c">BeforeDecode</a> (<a class="el" href="classcom_1_1mxgraph_1_1mxCodec.html">mxCodec</a> dec, XmlNode node, Object into)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reads the cells into the graph model. All cells are children of the root element in the node. <a href="#a64513ab4228e528bfd216c08def3ec6c"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">override void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxModelCodec.html#abe01c87a42e5568047c44c78ba0b2a2d">EncodeObject</a> (<a class="el" href="classcom_1_1mxgraph_1_1mxCodec.html">mxCodec</a> enc, Object obj, XmlNode node)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Encodes the given <a class="el" href="classcom_1_1mxgraph_1_1mxGraphModel.html" title="Implements a graph model. The graph model acts as a wrapper around the cells which...">mxGraphModel</a> by writing a (flat) XML sequence of cell nodes as produced by the <a class="el" href="classcom_1_1mxgraph_1_1mxCellCodec.html" title="Codec for mxCells. This class is created and registered dynamically at load time...">mxCellCodec</a>. The sequence is wrapped-up in a node with the name root. <a href="#abe01c87a42e5568047c44c78ba0b2a2d"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Codec for mxGraphModels. This class is created and registered dynamically at load time and used implicitely via <a class="el" href="classcom_1_1mxgraph_1_1mxCodec.html" title="XML codec for .NET object graphs. In order to resolve forward references when reading...">mxCodec</a> and the <a class="el" href="classcom_1_1mxgraph_1_1mxCodecRegistry.html" title="Static class that acts as a global registry for codecs. See mxCodec for an example...">mxCodecRegistry</a>. </p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a0f08ae910decb08326e279aa15253329"></a><!-- doxytag: member="com::mxgraph::mxModelCodec::mxModelCodec" ref="a0f08ae910decb08326e279aa15253329" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">com::mxgraph::mxModelCodec::mxModelCodec </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 model codec. </p>
</div>
</div>
<a class="anchor" id="a127ded19ebb7d5efeacfce244f0f751a"></a><!-- doxytag: member="com::mxgraph::mxModelCodec::mxModelCodec" ref="a127ded19ebb7d5efeacfce244f0f751a" args="(Object template)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">com::mxgraph::mxModelCodec::mxModelCodec </td>
<td>(</td>
<td class="paramtype">Object&nbsp;</td>
<td class="paramname"> <em>template</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructs a new model codec for the given template. </p>
</div>
</div>
<a class="anchor" id="a3954e4835954a01b46671fd802a13d42"></a><!-- doxytag: member="com::mxgraph::mxModelCodec::mxModelCodec" ref="a3954e4835954a01b46671fd802a13d42" args="(Object template, String[] exclude, String[] idrefs, Dictionary&lt; string, string &gt; mapping)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">com::mxgraph::mxModelCodec::mxModelCodec </td>
<td>(</td>
<td class="paramtype">Object&nbsp;</td>
<td class="paramname"> <em>template</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">String[]&nbsp;</td>
<td class="paramname"> <em>exclude</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">String[]&nbsp;</td>
<td class="paramname"> <em>idrefs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Dictionary&lt; string, string &gt;&nbsp;</td>
<td class="paramname"> <em>mapping</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>Constructs a new model codec for the given arguments. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a64513ab4228e528bfd216c08def3ec6c"></a><!-- doxytag: member="com::mxgraph::mxModelCodec::BeforeDecode" ref="a64513ab4228e528bfd216c08def3ec6c" args="(mxCodec dec, XmlNode node, Object into)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override XmlNode com::mxgraph::mxModelCodec::BeforeDecode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classcom_1_1mxgraph_1_1mxCodec.html">mxCodec</a>&nbsp;</td>
<td class="paramname"> <em>dec</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">XmlNode&nbsp;</td>
<td class="paramname"> <em>node</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Object&nbsp;</td>
<td class="paramname"> <em>into</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reads the cells into the graph model. All cells are children of the root element in the node. </p>
<p>Reimplemented from <a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#aef2e78e13b8dd5895ac272a0542ce4f2">com::mxgraph::mxObjectCodec</a>.</p>
</div>
</div>
<a class="anchor" id="abe01c87a42e5568047c44c78ba0b2a2d"></a><!-- doxytag: member="com::mxgraph::mxModelCodec::EncodeObject" ref="abe01c87a42e5568047c44c78ba0b2a2d" args="(mxCodec enc, Object obj, XmlNode node)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override void com::mxgraph::mxModelCodec::EncodeObject </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classcom_1_1mxgraph_1_1mxCodec.html">mxCodec</a>&nbsp;</td>
<td class="paramname"> <em>enc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Object&nbsp;</td>
<td class="paramname"> <em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">XmlNode&nbsp;</td>
<td class="paramname"> <em>node</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Encodes the given <a class="el" href="classcom_1_1mxgraph_1_1mxGraphModel.html" title="Implements a graph model. The graph model acts as a wrapper around the cells which...">mxGraphModel</a> by writing a (flat) XML sequence of cell nodes as produced by the <a class="el" href="classcom_1_1mxgraph_1_1mxCellCodec.html" title="Codec for mxCells. This class is created and registered dynamically at load time...">mxCellCodec</a>. The sequence is wrapped-up in a node with the name root. </p>
<p>Reimplemented from <a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#ade4c4a85d7ed2162f9566c8df931d250">com::mxgraph::mxObjectCodec</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/io/mxModelCodec.cs</li>
</ul>
</div>
2012-06-06 12:52:32 +00:00
<hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Jun 6 13:45:13 2012 for mxGraph by&nbsp;
2012-05-21 20:32:26 +00:00
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>