301 lines
18 KiB
HTML
301 lines
18 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::mxCodecRegistry 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 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 List</span></a></li>
|
|
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="navpath"><b>com</b>::<b>mxgraph</b>::<a class="el" href="classcom_1_1mxgraph_1_1mxCodecRegistry.html">mxCodecRegistry</a>
|
|
</div>
|
|
</div>
|
|
<div class="contents">
|
|
<h1>com::mxgraph::mxCodecRegistry Class Reference</h1><!-- doxytag: class="com::mxgraph::mxCodecRegistry" -->
|
|
<p>Static class that acts as a global registry for codecs. See <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> for an example of using this class.
|
|
<a href="#_details">More...</a></p>
|
|
|
|
<p><a href="classcom_1_1mxgraph_1_1mxCodecRegistry-members.html">List of all members.</a></p>
|
|
<table border="0" cellpadding="0" cellspacing="0">
|
|
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html">mxObjectCodec</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxCodecRegistry.html#acb79fb9e18c8c61e45eb1c698252a3e3">Register</a> (<a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html">mxObjectCodec</a> codec)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Registers a new codec and associates the name of the template constructor in the codec with the codec object. Automatically creates an alias if the codename and the classname are not equal. <a href="#acb79fb9e18c8c61e45eb1c698252a3e3"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxCodecRegistry.html#a2f52b12270d43eff03f58a059dbd9c67">AddAlias</a> (string classname, string codecname)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds an alias for mapping a classname to a codecname. <a href="#a2f52b12270d43eff03f58a059dbd9c67"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html">mxObjectCodec</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxCodecRegistry.html#a520ada8bb24cd8265fe269c0c9b57a5b">GetCodec</a> (String name)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a codec that handles the given object, which can be an object instance or an XML node. <a href="#a520ada8bb24cd8265fe269c0c9b57a5b"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxCodecRegistry.html#ae9e172ad864056f7d8a6d3a3dee9a536">AddNamespace</a> (String ns)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds the given namespace to the list of known namespaces. <a href="#ae9e172ad864056f7d8a6d3a3dee9a536"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">static Object </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxCodecRegistry.html#a6f360b981789d155fdc8e6cefd895bca">GetInstanceForName</a> (String name)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates and returns a new instance for the given class name. <a href="#a6f360b981789d155fdc8e6cefd895bca"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">static Type </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxCodecRegistry.html#aa06091c0531ebe18f2c69225f0f419ae">GetTypeForName</a> (String name)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a class that corresponds to the given name. <a href="#aa06091c0531ebe18f2c69225f0f419ae"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">static String </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxCodecRegistry.html#a4398e1da710fb68c428ad5314c02f560">GetName</a> (Object instance)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the name that identifies the codec associated with the given instance. The I/O system uses unqualified classnames, eg. for a com.mxgraph.model.mxCell this returns <a class="el" href="classcom_1_1mxgraph_1_1mxCell.html" title="Cells are the elements of the graph model. They represent the state of the groups...">mxCell</a>. <a href="#a4398e1da710fb68c428ad5314c02f560"></a><br/></td></tr>
|
|
<tr><td colspan="2"><h2>Static Protected Attributes</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">static Dictionary< string, <br class="typebreak"/>
|
|
<a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html">mxObjectCodec</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxCodecRegistry.html#a86f950b4c672dfaff0656c22bf4a64e6">codecs</a> = new Dictionary<string, <a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html">mxObjectCodec</a>>()</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Maps from constructor names to codecs. <a href="#a86f950b4c672dfaff0656c22bf4a64e6"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">static Dictionary< string, string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxCodecRegistry.html#a052379e3e095439ba6dcc63e0c1df0ea">aliases</a> = new Dictionary<string, string>()</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Maps from classnames to codecnames. <a href="#a052379e3e095439ba6dcc63e0c1df0ea"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">static List< string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxCodecRegistry.html#a705daf930467bc4a397c31a97f735449">namespaces</a> = new List<string>()</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Holds the list of known namespaces. Packages are used to prefix short class names (eg. <a class="el" href="classcom_1_1mxgraph_1_1mxCell.html" title="Cells are the elements of the graph model. They represent the state of the groups...">mxCell</a>) in XML markup. <a href="#a705daf930467bc4a397c31a97f735449"></a><br/></td></tr>
|
|
</table>
|
|
<hr/><a name="_details"></a><h2>Detailed Description</h2>
|
|
<p>Static class that acts as a global registry for codecs. See <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> for an example of using this class. </p>
|
|
<hr/><h2>Member Function Documentation</h2>
|
|
<a class="anchor" id="a2f52b12270d43eff03f58a059dbd9c67"></a><!-- doxytag: member="com::mxgraph::mxCodecRegistry::AddAlias" ref="a2f52b12270d43eff03f58a059dbd9c67" args="(string classname, string codecname)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void com::mxgraph::mxCodecRegistry::AddAlias </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"> <em>classname</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"> <em>codecname</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td><code> [inline, static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Adds an alias for mapping a classname to a codecname. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ae9e172ad864056f7d8a6d3a3dee9a536"></a><!-- doxytag: member="com::mxgraph::mxCodecRegistry::AddNamespace" ref="ae9e172ad864056f7d8a6d3a3dee9a536" args="(String ns)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void com::mxgraph::mxCodecRegistry::AddNamespace </td>
|
|
<td>(</td>
|
|
<td class="paramtype">String </td>
|
|
<td class="paramname"> <em>ns</em></td>
|
|
<td> ) </td>
|
|
<td><code> [inline, static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Adds the given namespace to the list of known namespaces. </p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>ns</em> </td><td>Name of the namespace to be added.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a520ada8bb24cd8265fe269c0c9b57a5b"></a><!-- doxytag: member="com::mxgraph::mxCodecRegistry::GetCodec" ref="a520ada8bb24cd8265fe269c0c9b57a5b" args="(String name)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html">mxObjectCodec</a> com::mxgraph::mxCodecRegistry::GetCodec </td>
|
|
<td>(</td>
|
|
<td class="paramtype">String </td>
|
|
<td class="paramname"> <em>name</em></td>
|
|
<td> ) </td>
|
|
<td><code> [inline, static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Returns a codec that handles the given object, which can be an object instance or an XML node. </p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>C# type name.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd></dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a6f360b981789d155fdc8e6cefd895bca"></a><!-- doxytag: member="com::mxgraph::mxCodecRegistry::GetInstanceForName" ref="a6f360b981789d155fdc8e6cefd895bca" args="(String name)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static Object com::mxgraph::mxCodecRegistry::GetInstanceForName </td>
|
|
<td>(</td>
|
|
<td class="paramtype">String </td>
|
|
<td class="paramname"> <em>name</em></td>
|
|
<td> ) </td>
|
|
<td><code> [inline, static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Creates and returns a new instance for the given class name. </p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Name of the class to be instantiated.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns a new instance of the given class.</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a4398e1da710fb68c428ad5314c02f560"></a><!-- doxytag: member="com::mxgraph::mxCodecRegistry::GetName" ref="a4398e1da710fb68c428ad5314c02f560" args="(Object instance)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static String com::mxgraph::mxCodecRegistry::GetName </td>
|
|
<td>(</td>
|
|
<td class="paramtype">Object </td>
|
|
<td class="paramname"> <em>instance</em></td>
|
|
<td> ) </td>
|
|
<td><code> [inline, static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Returns the name that identifies the codec associated with the given instance. The I/O system uses unqualified classnames, eg. for a com.mxgraph.model.mxCell this returns <a class="el" href="classcom_1_1mxgraph_1_1mxCell.html" title="Cells are the elements of the graph model. They represent the state of the groups...">mxCell</a>. </p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>instance</em> </td><td>Instance whose node name should be returned.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns a string that identifies the codec.</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aa06091c0531ebe18f2c69225f0f419ae"></a><!-- doxytag: member="com::mxgraph::mxCodecRegistry::GetTypeForName" ref="aa06091c0531ebe18f2c69225f0f419ae" args="(String name)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static Type com::mxgraph::mxCodecRegistry::GetTypeForName </td>
|
|
<td>(</td>
|
|
<td class="paramtype">String </td>
|
|
<td class="paramname"> <em>name</em></td>
|
|
<td> ) </td>
|
|
<td><code> [inline, static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Returns a class that corresponds to the given name. </p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd></dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="acb79fb9e18c8c61e45eb1c698252a3e3"></a><!-- doxytag: member="com::mxgraph::mxCodecRegistry::Register" ref="acb79fb9e18c8c61e45eb1c698252a3e3" args="(mxObjectCodec codec)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html">mxObjectCodec</a> com::mxgraph::mxCodecRegistry::Register </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html">mxObjectCodec</a> </td>
|
|
<td class="paramname"> <em>codec</em></td>
|
|
<td> ) </td>
|
|
<td><code> [inline, static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Registers a new codec and associates the name of the template constructor in the codec with the codec object. Automatically creates an alias if the codename and the classname are not equal. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/><h2>Member Data Documentation</h2>
|
|
<a class="anchor" id="a052379e3e095439ba6dcc63e0c1df0ea"></a><!-- doxytag: member="com::mxgraph::mxCodecRegistry::aliases" ref="a052379e3e095439ba6dcc63e0c1df0ea" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Dictionary<string, string> <a class="el" href="classcom_1_1mxgraph_1_1mxCodecRegistry.html#a052379e3e095439ba6dcc63e0c1df0ea">com::mxgraph::mxCodecRegistry::aliases</a> = new Dictionary<string, string>()<code> [static, protected]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Maps from classnames to codecnames. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a86f950b4c672dfaff0656c22bf4a64e6"></a><!-- doxytag: member="com::mxgraph::mxCodecRegistry::codecs" ref="a86f950b4c672dfaff0656c22bf4a64e6" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Dictionary<string, <a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html">mxObjectCodec</a>> <a class="el" href="classcom_1_1mxgraph_1_1mxCodecRegistry.html#a86f950b4c672dfaff0656c22bf4a64e6">com::mxgraph::mxCodecRegistry::codecs</a> = new Dictionary<string, <a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html">mxObjectCodec</a>>()<code> [static, protected]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Maps from constructor names to codecs. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a705daf930467bc4a397c31a97f735449"></a><!-- doxytag: member="com::mxgraph::mxCodecRegistry::namespaces" ref="a705daf930467bc4a397c31a97f735449" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">List<string> <a class="el" href="classcom_1_1mxgraph_1_1mxCodecRegistry.html#a705daf930467bc4a397c31a97f735449">com::mxgraph::mxCodecRegistry::namespaces</a> = new List<string>()<code> [static, protected]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Holds the list of known namespaces. Packages are used to prefix short class names (eg. <a class="el" href="classcom_1_1mxgraph_1_1mxCell.html" title="Cells are the elements of the graph model. They represent the state of the groups...">mxCell</a>) in XML markup. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>src/io/mxCodecRegistry.cs</li>
|
|
</ul>
|
|
</div>
|
|
<hr class="footer"/><address style="text-align: right;"><small>Generated on Mon Oct 29 20:11:49 2012 for mxGraph by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
|
|
</body>
|
|
</html>
|