342 lines
19 KiB
HTML
342 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.mxCodecRegistry 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 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 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 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_1mxCodecRegistry.html">mxCodecRegistry</a> </li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-static-methods">Static Public Member Functions</a> |
|
|
<a href="#pro-static-attribs">Static Protected Attributes</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">com.mxgraph.mxCodecRegistry Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<!-- 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 files the XML d...">mxCodec</a> for an example of using this class.
|
|
<a href="classcom_1_1mxgraph_1_1mxCodecRegistry.html#details">More...</a></p>
|
|
|
|
<p><a href="classcom_1_1mxgraph_1_1mxCodecRegistry-members.html">List of all members.</a></p>
|
|
<table class="memberdecls">
|
|
<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 <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#a9d516650c7a2051664e84d4bf14bfbd6">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="#a9d516650c7a2051664e84d4bf14bfbd6"></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#afd970db748b0cd853cc0eb2049cd7824">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="#afd970db748b0cd853cc0eb2049cd7824"></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#a26a31214cadf077d0acb37f3f0295c6c">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="#a26a31214cadf077d0acb37f3f0295c6c"></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#a1961b193103166d15bbfd6c107c1a2ed">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="#a1961b193103166d15bbfd6c107c1a2ed"></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#a637e9ce110219850251c576524b88831">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="#a637e9ce110219850251c576524b88831"></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#a702f375499d93ae78d590b19a38ee3ea">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="#a702f375499d93ae78d590b19a38ee3ea"></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#a26bc2c27208d17e5419e1964c73f1e92">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, vertices and edges in a graph.">mxCell</a>. <a href="#a26bc2c27208d17e5419e1964c73f1e92"></a><br/></td></tr>
|
|
<tr><td colspan="2"><h2><a name="pro-static-attribs"></a>
|
|
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#aa9380d57601567bcf19923a7b0efc987">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="#aa9380d57601567bcf19923a7b0efc987"></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#a819a76478c91d2ff0e97c121eebb36d8">aliases</a> = new Dictionary<string, string>()</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Maps from classnames to codecnames. <a href="#a819a76478c91d2ff0e97c121eebb36d8"></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#a7491a4a68281ea8667b2efe61d18781a">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, vertices and edges in a graph.">mxCell</a>) in XML markup. <a href="#a7491a4a68281ea8667b2efe61d18781a"></a><br/></td></tr>
|
|
</table>
|
|
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
|
|
<div class="textblock"><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 files the XML d...">mxCodec</a> for an example of using this class. </p>
|
|
</div><hr/><h2>Member Function Documentation</h2>
|
|
<a class="anchor" id="afd970db748b0cd853cc0eb2049cd7824"></a><!-- doxytag: member="com::mxgraph::mxCodecRegistry::AddAlias" ref="afd970db748b0cd853cc0eb2049cd7824" args="(string classname, string codecname)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void <a class="el" href="classcom_1_1mxgraph_1_1mxCodecRegistry.html#afd970db748b0cd853cc0eb2049cd7824">com.mxgraph.mxCodecRegistry.AddAlias</a> </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>
|
|
</tr>
|
|
<tr>
|
|
<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="a1961b193103166d15bbfd6c107c1a2ed"></a><!-- doxytag: member="com::mxgraph::mxCodecRegistry::AddNamespace" ref="a1961b193103166d15bbfd6c107c1a2ed" args="(String ns)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void <a class="el" href="classcom_1_1mxgraph_1_1mxCodecRegistry.html#a1961b193103166d15bbfd6c107c1a2ed">com.mxgraph.mxCodecRegistry.AddNamespace</a> </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 class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ns</td><td>Name of the namespace to be added.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a26a31214cadf077d0acb37f3f0295c6c"></a><!-- doxytag: member="com::mxgraph::mxCodecRegistry::GetCodec" ref="a26a31214cadf077d0acb37f3f0295c6c" 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> <a class="el" href="classcom_1_1mxgraph_1_1mxCodecRegistry.html#a26a31214cadf077d0acb37f3f0295c6c">com.mxgraph.mxCodecRegistry.GetCodec</a> </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 class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">name</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="a637e9ce110219850251c576524b88831"></a><!-- doxytag: member="com::mxgraph::mxCodecRegistry::GetInstanceForName" ref="a637e9ce110219850251c576524b88831" args="(String name)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static Object <a class="el" href="classcom_1_1mxgraph_1_1mxCodecRegistry.html#a637e9ce110219850251c576524b88831">com.mxgraph.mxCodecRegistry.GetInstanceForName</a> </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 class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">name</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="a26bc2c27208d17e5419e1964c73f1e92"></a><!-- doxytag: member="com::mxgraph::mxCodecRegistry::GetName" ref="a26bc2c27208d17e5419e1964c73f1e92" args="(Object instance)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static String <a class="el" href="classcom_1_1mxgraph_1_1mxCodecRegistry.html#a26bc2c27208d17e5419e1964c73f1e92">com.mxgraph.mxCodecRegistry.GetName</a> </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, vertices and edges in a graph.">mxCell</a>. </p>
|
|
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">instance</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="a702f375499d93ae78d590b19a38ee3ea"></a><!-- doxytag: member="com::mxgraph::mxCodecRegistry::GetTypeForName" ref="a702f375499d93ae78d590b19a38ee3ea" args="(String name)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static Type <a class="el" href="classcom_1_1mxgraph_1_1mxCodecRegistry.html#a702f375499d93ae78d590b19a38ee3ea">com.mxgraph.mxCodecRegistry.GetTypeForName</a> </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 class="params"><dt><b>Parameters:</b></dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">name</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd></dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a9d516650c7a2051664e84d4bf14bfbd6"></a><!-- doxytag: member="com::mxgraph::mxCodecRegistry::Register" ref="a9d516650c7a2051664e84d4bf14bfbd6" 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> <a class="el" href="classcom_1_1mxgraph_1_1mxCodecRegistry.html#a9d516650c7a2051664e84d4bf14bfbd6">com.mxgraph.mxCodecRegistry.Register</a> </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="a819a76478c91d2ff0e97c121eebb36d8"></a><!-- doxytag: member="com::mxgraph::mxCodecRegistry::aliases" ref="a819a76478c91d2ff0e97c121eebb36d8" 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#a819a76478c91d2ff0e97c121eebb36d8">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="aa9380d57601567bcf19923a7b0efc987"></a><!-- doxytag: member="com::mxgraph::mxCodecRegistry::codecs" ref="aa9380d57601567bcf19923a7b0efc987" 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#aa9380d57601567bcf19923a7b0efc987">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="a7491a4a68281ea8667b2efe61d18781a"></a><!-- doxytag: member="com::mxgraph::mxCodecRegistry::namespaces" ref="a7491a4a68281ea8667b2efe61d18781a" 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#a7491a4a68281ea8667b2efe61d18781a">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, vertices and edges in a graph.">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><!-- contents -->
|
|
|
|
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Fri Aug 9 2013 10:05:12 for mxGraph by  <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>
|