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

270 lines
14 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"/>
2013-04-04 11:51:15 +00:00
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>mxGraph: com.mxgraph.mxModelCodec Class Reference</title>
2012-05-21 20:32:26 +00:00
<link href="tabs.css" rel="stylesheet" type="text/css"/>
2013-04-04 11:51:15 +00:00
<link href="doxygen.css" rel="stylesheet" type="text/css" />
2012-05-21 20:32:26 +00:00
</head>
<body>
2013-04-04 11:51:15 +00:00
<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>
2012-05-21 20:32:26 +00:00
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
2013-04-04 11:51:15 +00:00
<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>
2012-05-21 20:32:26 +00:00
</ul>
</div>
2013-04-04 11:51:15 +00:00
<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_1mxModelCodec.html">mxModelCodec</a> </li>
</ul>
2012-05-21 20:32:26 +00:00
</div>
</div>
2013-04-04 11:51:15 +00:00
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<div class="title">com.mxgraph.mxModelCodec Class Reference</div> </div>
</div><!--header-->
2012-05-21 20:32:26 +00:00
<div class="contents">
2013-04-04 11:51:15 +00:00
<!-- 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 files the XML d...">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 of using this clas...">mxCodecRegistry</a>.
<a href="classcom_1_1mxgraph_1_1mxModelCodec.html#details">More...</a></p>
2012-05-21 20:32:26 +00:00
<div class="dynheader">
2013-04-04 11:51:15 +00:00
Inheritance diagram for com.mxgraph.mxModelCodec:</div>
<div class="dyncontent">
2012-05-21 20:32:26 +00:00
<div class="center">
2013-04-04 11:51:15 +00:00
<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" title="Generic codec for C# objects. See below for a detailed description of the encoding/decoding scheme..." alt="com.mxgraph.mxObjectCodec" shape="rect" coords="0,0,180,24"/>
2012-05-21 20:32:26 +00:00
</map>
2013-04-04 11:51:15 +00:00
</div></div>
2012-05-21 20:32:26 +00:00
<p><a href="classcom_1_1mxgraph_1_1mxModelCodec-members.html">List of all members.</a></p>
2013-04-04 11:51:15 +00:00
<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_1mxModelCodec.html#a34594105ccead527e72ffb2763940d07">mxModelCodec</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a new model codec. <a href="#a34594105ccead527e72ffb2763940d07"></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_1mxModelCodec.html#aef538f1f3a9165e93f78c054ac2b374b">mxModelCodec</a> (Object <a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#ab96f31d7efa7d5d51a13062e1ba4ddae">template</a>)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a new model codec for the given template. <a href="#aef538f1f3a9165e93f78c054ac2b374b"></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_1mxModelCodec.html#a80f3c85cd4a26832277a6442477cc0e9">mxModelCodec</a> (Object <a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#ab96f31d7efa7d5d51a13062e1ba4ddae">template</a>, String[] <a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#afc2e8997b3371e5ae38ad67e9e404c58">exclude</a>, String[] <a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#a2c02744b7fd32e18ec3a54683d8ffff3">idrefs</a>, Dictionary&lt; string, string &gt; <a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#a84a82aa104ca8c7402f38f8aae0980c0">mapping</a>)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a new model codec for the given arguments. <a href="#a80f3c85cd4a26832277a6442477cc0e9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">override XmlNode&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxModelCodec.html#a87ebd28e84d602ec87f411744bbe0ef8">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">&#160;</td><td class="mdescRight">Reads the cells into the graph model. All cells are children of the root element in the node. <a href="#a87ebd28e84d602ec87f411744bbe0ef8"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">override void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxModelCodec.html#acc086a36b6e6fe3119a4db05c73b68c9">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">&#160;</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 are in charge of s...">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 and used implicitely...">mxCellCodec</a>. The sequence is wrapped-up in a node with the name root. <a href="#acc086a36b6e6fe3119a4db05c73b68c9"></a><br/></td></tr>
2012-05-21 20:32:26 +00:00
</table>
2013-04-04 11:51:15 +00:00
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><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 files the XML d...">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 of using this clas...">mxCodecRegistry</a>. </p>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a34594105ccead527e72ffb2763940d07"></a><!-- doxytag: member="com::mxgraph::mxModelCodec::mxModelCodec" ref="a34594105ccead527e72ffb2763940d07" args="()" -->
2012-05-21 20:32:26 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2013-04-04 11:51:15 +00:00
<td class="memname"><a class="el" href="classcom_1_1mxgraph_1_1mxModelCodec.html#a34594105ccead527e72ffb2763940d07">com.mxgraph.mxModelCodec.mxModelCodec</a> </td>
2012-05-21 20:32:26 +00:00
<td>(</td>
2013-04-04 11:51:15 +00:00
<td class="paramname"></td><td>)</td>
2012-05-21 20:32:26 +00:00
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructs a new model codec. </p>
</div>
</div>
2013-04-04 11:51:15 +00:00
<a class="anchor" id="aef538f1f3a9165e93f78c054ac2b374b"></a><!-- doxytag: member="com::mxgraph::mxModelCodec::mxModelCodec" ref="aef538f1f3a9165e93f78c054ac2b374b" args="(Object template)" -->
2012-05-21 20:32:26 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2013-04-04 11:51:15 +00:00
<td class="memname"><a class="el" href="classcom_1_1mxgraph_1_1mxModelCodec.html#a34594105ccead527e72ffb2763940d07">com.mxgraph.mxModelCodec.mxModelCodec</a> </td>
2012-05-21 20:32:26 +00:00
<td>(</td>
2013-04-04 11:51:15 +00:00
<td class="paramtype">Object&#160;</td>
<td class="paramname"><em>template</em></td><td>)</td>
2012-05-21 20:32:26 +00:00
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructs a new model codec for the given template. </p>
</div>
</div>
2013-04-04 11:51:15 +00:00
<a class="anchor" id="a80f3c85cd4a26832277a6442477cc0e9"></a><!-- doxytag: member="com::mxgraph::mxModelCodec::mxModelCodec" ref="a80f3c85cd4a26832277a6442477cc0e9" args="(Object template, String[] exclude, String[] idrefs, Dictionary&lt; string, string &gt; mapping)" -->
2012-05-21 20:32:26 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2013-04-04 11:51:15 +00:00
<td class="memname"><a class="el" href="classcom_1_1mxgraph_1_1mxModelCodec.html#a34594105ccead527e72ffb2763940d07">com.mxgraph.mxModelCodec.mxModelCodec</a> </td>
2012-05-21 20:32:26 +00:00
<td>(</td>
2013-04-04 11:51:15 +00:00
<td class="paramtype">Object&#160;</td>
<td class="paramname"><em>template</em>, </td>
2012-05-21 20:32:26 +00:00
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
2013-04-04 11:51:15 +00:00
<td class="paramtype">String[]&#160;</td>
<td class="paramname"><em>exclude</em>, </td>
2012-05-21 20:32:26 +00:00
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
2013-04-04 11:51:15 +00:00
<td class="paramtype">String[]&#160;</td>
<td class="paramname"><em>idrefs</em>, </td>
2012-05-21 20:32:26 +00:00
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
2013-04-04 11:51:15 +00:00
<td class="paramtype">Dictionary&lt; string, string &gt;&#160;</td>
<td class="paramname"><em>mapping</em>&#160;</td>
2012-05-21 20:32:26 +00:00
</tr>
<tr>
<td></td>
<td>)</td>
2013-04-04 11:51:15 +00:00
<td></td><td><code> [inline]</code></td>
2012-05-21 20:32:26 +00:00
</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>
2013-04-04 11:51:15 +00:00
<a class="anchor" id="a87ebd28e84d602ec87f411744bbe0ef8"></a><!-- doxytag: member="com::mxgraph::mxModelCodec::BeforeDecode" ref="a87ebd28e84d602ec87f411744bbe0ef8" args="(mxCodec dec, XmlNode node, Object into)" -->
2012-05-21 20:32:26 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2013-04-04 11:51:15 +00:00
<td class="memname">override XmlNode <a class="el" href="classcom_1_1mxgraph_1_1mxModelCodec.html#a87ebd28e84d602ec87f411744bbe0ef8">com.mxgraph.mxModelCodec.BeforeDecode</a> </td>
2012-05-21 20:32:26 +00:00
<td>(</td>
2013-04-04 11:51:15 +00:00
<td class="paramtype"><a class="el" href="classcom_1_1mxgraph_1_1mxCodec.html">mxCodec</a>&#160;</td>
<td class="paramname"><em>dec</em>, </td>
2012-05-21 20:32:26 +00:00
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
2013-04-04 11:51:15 +00:00
<td class="paramtype">XmlNode&#160;</td>
<td class="paramname"><em>node</em>, </td>
2012-05-21 20:32:26 +00:00
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
2013-04-04 11:51:15 +00:00
<td class="paramtype">Object&#160;</td>
<td class="paramname"><em>into</em>&#160;</td>
2012-05-21 20:32:26 +00:00
</tr>
<tr>
<td></td>
<td>)</td>
2013-04-04 11:51:15 +00:00
<td></td><td><code> [inline, virtual]</code></td>
2012-05-21 20:32:26 +00:00
</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>
2013-04-04 11:51:15 +00:00
<p>Reimplemented from <a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#a164fbdf1d3283051873590addbdd524a">com.mxgraph.mxObjectCodec</a>.</p>
2012-05-21 20:32:26 +00:00
</div>
</div>
2013-04-04 11:51:15 +00:00
<a class="anchor" id="acc086a36b6e6fe3119a4db05c73b68c9"></a><!-- doxytag: member="com::mxgraph::mxModelCodec::EncodeObject" ref="acc086a36b6e6fe3119a4db05c73b68c9" args="(mxCodec enc, Object obj, XmlNode node)" -->
2012-05-21 20:32:26 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2013-04-04 11:51:15 +00:00
<td class="memname">override void <a class="el" href="classcom_1_1mxgraph_1_1mxModelCodec.html#acc086a36b6e6fe3119a4db05c73b68c9">com.mxgraph.mxModelCodec.EncodeObject</a> </td>
2012-05-21 20:32:26 +00:00
<td>(</td>
2013-04-04 11:51:15 +00:00
<td class="paramtype"><a class="el" href="classcom_1_1mxgraph_1_1mxCodec.html">mxCodec</a>&#160;</td>
<td class="paramname"><em>enc</em>, </td>
2012-05-21 20:32:26 +00:00
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
2013-04-04 11:51:15 +00:00
<td class="paramtype">Object&#160;</td>
<td class="paramname"><em>obj</em>, </td>
2012-05-21 20:32:26 +00:00
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
2013-04-04 11:51:15 +00:00
<td class="paramtype">XmlNode&#160;</td>
<td class="paramname"><em>node</em>&#160;</td>
2012-05-21 20:32:26 +00:00
</tr>
<tr>
<td></td>
<td>)</td>
2013-04-04 11:51:15 +00:00
<td></td><td><code> [inline, protected, virtual]</code></td>
2012-05-21 20:32:26 +00:00
</tr>
</table>
</div>
<div class="memdoc">
2013-04-04 11:51:15 +00:00
<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 are in charge of s...">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 and used implicitely...">mxCellCodec</a>. The sequence is wrapped-up in a node with the name root. </p>
2012-05-21 20:32:26 +00:00
2013-04-04 11:51:15 +00:00
<p>Reimplemented from <a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#a9f6a46c7f5d672663352742e7379f042">com.mxgraph.mxObjectCodec</a>.</p>
2012-05-21 20:32:26 +00:00
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/io/mxModelCodec.cs</li>
</ul>
2013-04-04 11:51:15 +00:00
</div><!-- contents -->
<hr class="footer"/><address class="footer"><small>
2013-04-10 15:34:04 +00:00
Generated on Wed Apr 10 2013 16:31:03 for mxGraph by &#160;<a href="http://www.doxygen.org/index.html">
2013-04-04 11:51:15 +00:00
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>
2012-05-21 20:32:26 +00:00
</body>
</html>