1893 lines
92 KiB
HTML
1893 lines
92 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"/>
|
|
<meta name="generator" content="Doxygen 1.8.6"/>
|
|
<title>mxGraph: com.mxgraph.mxObjectCodec Class Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<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>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.6 -->
|
|
<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>
|
|
</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"><a class="el" href="namespacecom.html">com</a></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_1mxObjectCodec.html">mxObjectCodec</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pro-methods">Protected Member Functions</a> |
|
|
<a href="#pro-attribs">Protected Attributes</a> |
|
|
<a href="#properties">Properties</a> |
|
|
<a href="classcom_1_1mxgraph_1_1mxObjectCodec-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">com.mxgraph.mxObjectCodec Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Generic codec for C# objects. See below for a detailed description of the encoding/decoding scheme. Note: Since booleans are numbers in JavaScript, all boolean values are encoded into 1 for true and 0 for false.
|
|
<a href="classcom_1_1mxgraph_1_1mxObjectCodec.html#details">More...</a></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for com.mxgraph.mxObjectCodec:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="classcom_1_1mxgraph_1_1mxObjectCodec.png" usemap="#com.mxgraph.mxObjectCodec_map" alt=""/>
|
|
<map id="com.mxgraph.mxObjectCodec_map" name="com.mxgraph.mxObjectCodec_map">
|
|
<area href="classcom_1_1mxgraph_1_1mxCellCodec.html" title="Codec for mxCells. This class is created and registered dynamically at load time and used implicitely..." alt="com.mxgraph.mxCellCodec" shape="rect" coords="0,56,201,80"/>
|
|
<area href="classcom_1_1mxgraph_1_1mxModelCodec.html" title="Codec for mxGraphModels. This class is created and registered dynamically at load time and used impli..." alt="com.mxgraph.mxModelCodec" shape="rect" coords="211,56,412,80"/>
|
|
<area href="classcom_1_1mxgraph_1_1mxStylesheetCodec.html" title="Codec for mxStylesheets. This class is created and registered dynamically at load time and used impli..." alt="com.mxgraph.mxStylesheetCodec" shape="rect" coords="422,56,623,80"/>
|
|
</map>
|
|
</div></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a6bd06a133a05a66263c1106f3dd1a666"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#a6bd06a133a05a66263c1106f3dd1a666">mxObjectCodec</a> (Object <a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#ab96f31d7efa7d5d51a13062e1ba4ddae">template</a>)</td></tr>
|
|
<tr class="memdesc:a6bd06a133a05a66263c1106f3dd1a666"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new codec for the specified template object. <a href="#a6bd06a133a05a66263c1106f3dd1a666">More...</a><br/></td></tr>
|
|
<tr class="separator:a6bd06a133a05a66263c1106f3dd1a666"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a52e93d79c9543f837cec9f8ab316e549"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#a52e93d79c9543f837cec9f8ab316e549">mxObjectCodec</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< string, string > <a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#a84a82aa104ca8c7402f38f8aae0980c0">mapping</a>)</td></tr>
|
|
<tr class="memdesc:a52e93d79c9543f837cec9f8ab316e549"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new codec for the specified template object. The variables in the optional exclude array are ignored by the codec. Variables in the optional idrefs array are turned into references in the XML. The optional mapping may be used to map from variable names to XML attributes. <a href="#a52e93d79c9543f837cec9f8ab316e549">More...</a><br/></td></tr>
|
|
<tr class="separator:a52e93d79c9543f837cec9f8ab316e549"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:add9b5e9f0c81ddf6a0afaded9709ea61"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#add9b5e9f0c81ddf6a0afaded9709ea61">GetName</a> ()</td></tr>
|
|
<tr class="memdesc:add9b5e9f0c81ddf6a0afaded9709ea61"><td class="mdescLeft"> </td><td class="mdescRight">Returns the name used for the nodenames and lookup of the codec when classes are encoded and nodes are decoded. For classes to work with this the codec registry automatically adds an alias for the classname if that is different than what this returns. The default implementation returns the classname of the template class. <a href="#add9b5e9f0c81ddf6a0afaded9709ea61">More...</a><br/></td></tr>
|
|
<tr class="separator:add9b5e9f0c81ddf6a0afaded9709ea61"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4fecc4526bae174c5d8f26b55514d328"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#a4fecc4526bae174c5d8f26b55514d328">IsExcluded</a> (Object obj, string attr, Object value, bool write)</td></tr>
|
|
<tr class="memdesc:a4fecc4526bae174c5d8f26b55514d328"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the given attribute is to be ignored by the codec. This implementation returns true if the given fieldname is in exclude. <a href="#a4fecc4526bae174c5d8f26b55514d328">More...</a><br/></td></tr>
|
|
<tr class="separator:a4fecc4526bae174c5d8f26b55514d328"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2d45a1f0b46ae0541b5e39c946902d45"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#a2d45a1f0b46ae0541b5e39c946902d45">IsReference</a> (Object obj, string attr, Object value, bool write)</td></tr>
|
|
<tr class="memdesc:a2d45a1f0b46ae0541b5e39c946902d45"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the given fieldname is to be treated as a textual reference (ID). This implementation returns true if the given fieldname is in idrefs. <a href="#a2d45a1f0b46ae0541b5e39c946902d45">More...</a><br/></td></tr>
|
|
<tr class="separator:a2d45a1f0b46ae0541b5e39c946902d45"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af54fb528308bc68c772398c0f42862ff"><td class="memItemLeft" align="right" valign="top">virtual XmlNode </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#af54fb528308bc68c772398c0f42862ff">Encode</a> (<a class="el" href="classcom_1_1mxgraph_1_1mxCodec.html">mxCodec</a> enc, Object obj)</td></tr>
|
|
<tr class="memdesc:af54fb528308bc68c772398c0f42862ff"><td class="mdescLeft"> </td><td class="mdescRight">Encodes the specified object and returns a node representing then given object. Calls beforeEncode after creating the node and afterEncode with the resulting node after processing. Enc is a reference to the calling encoder. It is used to encode complex objects and create references. <a href="#af54fb528308bc68c772398c0f42862ff">More...</a><br/></td></tr>
|
|
<tr class="separator:af54fb528308bc68c772398c0f42862ff"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a94291cac63586be6e1a7f740ec145729"><td class="memItemLeft" align="right" valign="top">virtual Object </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#a94291cac63586be6e1a7f740ec145729">BeforeEncode</a> (<a class="el" href="classcom_1_1mxgraph_1_1mxCodec.html">mxCodec</a> enc, Object obj, XmlNode node)</td></tr>
|
|
<tr class="memdesc:a94291cac63586be6e1a7f740ec145729"><td class="mdescLeft"> </td><td class="mdescRight">Hook for subclassers to pre-process the object before encoding. This returns the input object. The return value of this function is used in encode to perform the default encoding into the given node. <a href="#a94291cac63586be6e1a7f740ec145729">More...</a><br/></td></tr>
|
|
<tr class="separator:a94291cac63586be6e1a7f740ec145729"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a02a1b8988cd5b2617ad63ecd63db3db6"><td class="memItemLeft" align="right" valign="top">virtual XmlNode </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#a02a1b8988cd5b2617ad63ecd63db3db6">AfterEncode</a> (<a class="el" href="classcom_1_1mxgraph_1_1mxCodec.html">mxCodec</a> enc, Object obj, XmlNode node)</td></tr>
|
|
<tr class="memdesc:a02a1b8988cd5b2617ad63ecd63db3db6"><td class="mdescLeft"> </td><td class="mdescRight">Hook for subclassers to Receive-process the node for the given object after encoding and return the Receive-processed node. This implementation returns the input node. The return value of this method is returned to the encoder from encode. <a href="#a02a1b8988cd5b2617ad63ecd63db3db6">More...</a><br/></td></tr>
|
|
<tr class="separator:a02a1b8988cd5b2617ad63ecd63db3db6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1ecf4a9e08d688c9041d97b6af1c2df0"><td class="memItemLeft" align="right" valign="top">virtual Object </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#a1ecf4a9e08d688c9041d97b6af1c2df0">Decode</a> (<a class="el" href="classcom_1_1mxgraph_1_1mxCodec.html">mxCodec</a> dec, XmlNode node)</td></tr>
|
|
<tr class="memdesc:a1ecf4a9e08d688c9041d97b6af1c2df0"><td class="mdescLeft"> </td><td class="mdescRight">Parses the given node into the object or returns a new object representing the given node. <a href="#a1ecf4a9e08d688c9041d97b6af1c2df0">More...</a><br/></td></tr>
|
|
<tr class="separator:a1ecf4a9e08d688c9041d97b6af1c2df0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a27db4f4c90305c7707198e7e29ba1d09"><td class="memItemLeft" align="right" valign="top">virtual Object </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#a27db4f4c90305c7707198e7e29ba1d09">Decode</a> (<a class="el" href="classcom_1_1mxgraph_1_1mxCodec.html">mxCodec</a> dec, XmlNode node, Object into)</td></tr>
|
|
<tr class="memdesc:a27db4f4c90305c7707198e7e29ba1d09"><td class="mdescLeft"> </td><td class="mdescRight">Parses the given node into the object or returns a new object representing the given node. Dec is a reference to the calling decoder. It is used to decode complex objects and resolve references. If a node has an id attribute then the object cache is checked for the object. If the object is not yet in the cache then it is constructed using the constructor of template and cached in <a class="el" href="classcom_1_1mxgraph_1_1mxCodec.html#a04522d7a38095efb6263bd10518fc6cc" title="Maps from IDs to objects. ">mxCodec.objects</a>. This implementation decodes all attributes and childs of a node according to the following rules: <a href="#a27db4f4c90305c7707198e7e29ba1d09">More...</a><br/></td></tr>
|
|
<tr class="separator:a27db4f4c90305c7707198e7e29ba1d09"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac5c143df7b7b7c9d8b7a77681b2b9815"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#ac5c143df7b7b7c9d8b7a77681b2b9815">ProcessInclude</a> (<a class="el" href="classcom_1_1mxgraph_1_1mxCodec.html">mxCodec</a> dec, XmlNode node, Object into)</td></tr>
|
|
<tr class="separator:ac5c143df7b7b7c9d8b7a77681b2b9815"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a164fbdf1d3283051873590addbdd524a"><td class="memItemLeft" align="right" valign="top">virtual XmlNode </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#a164fbdf1d3283051873590addbdd524a">BeforeDecode</a> (<a class="el" href="classcom_1_1mxgraph_1_1mxCodec.html">mxCodec</a> dec, XmlNode node, Object obj)</td></tr>
|
|
<tr class="memdesc:a164fbdf1d3283051873590addbdd524a"><td class="mdescLeft"> </td><td class="mdescRight">Hook for subclassers to pre-process the node for the specified object and return the node to be used for further processing by decode. The object is created based on the template in the calling method and is never null. This implementation returns the input node. The return value of this function is used in decode to perform the default decoding into the given object. <a href="#a164fbdf1d3283051873590addbdd524a">More...</a><br/></td></tr>
|
|
<tr class="separator:a164fbdf1d3283051873590addbdd524a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9670ef9eb8653e95387bc4e93ccb6db0"><td class="memItemLeft" align="right" valign="top">virtual Object </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#a9670ef9eb8653e95387bc4e93ccb6db0">AfterDecode</a> (<a class="el" href="classcom_1_1mxgraph_1_1mxCodec.html">mxCodec</a> dec, XmlNode node, Object obj)</td></tr>
|
|
<tr class="memdesc:a9670ef9eb8653e95387bc4e93ccb6db0"><td class="mdescLeft"> </td><td class="mdescRight">Hook for subclassers to Receive-process the object after decoding. This implementation returns the given object without any changes. The return value of this method is returned to the decoder from decode. <a href="#a9670ef9eb8653e95387bc4e93ccb6db0">More...</a><br/></td></tr>
|
|
<tr class="separator:a9670ef9eb8653e95387bc4e93ccb6db0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
|
|
Protected Member Functions</h2></td></tr>
|
|
<tr class="memitem:a428da11a0f67b9b35d6ba6a350972151"><td class="memItemLeft" align="right" valign="top">virtual Object </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#a428da11a0f67b9b35d6ba6a350972151">CloneTemplate</a> (XmlNode node)</td></tr>
|
|
<tr class="memdesc:a428da11a0f67b9b35d6ba6a350972151"><td class="mdescLeft"> </td><td class="mdescRight">Returns a new instance of the template object for representing the given node. <a href="#a428da11a0f67b9b35d6ba6a350972151">More...</a><br/></td></tr>
|
|
<tr class="separator:a428da11a0f67b9b35d6ba6a350972151"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9f6a46c7f5d672663352742e7379f042"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#a9f6a46c7f5d672663352742e7379f042">EncodeObject</a> (<a class="el" href="classcom_1_1mxgraph_1_1mxCodec.html">mxCodec</a> enc, Object obj, XmlNode node)</td></tr>
|
|
<tr class="memdesc:a9f6a46c7f5d672663352742e7379f042"><td class="mdescLeft"> </td><td class="mdescRight">Encodes the value of each member in then given obj into the given node using encodeFields and encodeElements. <a href="#a9f6a46c7f5d672663352742e7379f042">More...</a><br/></td></tr>
|
|
<tr class="separator:a9f6a46c7f5d672663352742e7379f042"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6050c05b6f5f64479777aad6edd0fecd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#a6050c05b6f5f64479777aad6edd0fecd">EncodeFields</a> (<a class="el" href="classcom_1_1mxgraph_1_1mxCodec.html">mxCodec</a> enc, Object obj, XmlNode node)</td></tr>
|
|
<tr class="memdesc:a6050c05b6f5f64479777aad6edd0fecd"><td class="mdescLeft"> </td><td class="mdescRight">Encodes the members of the given object into the given node. <a href="#a6050c05b6f5f64479777aad6edd0fecd">More...</a><br/></td></tr>
|
|
<tr class="separator:a6050c05b6f5f64479777aad6edd0fecd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adbd8cdb1423064796dc9efda5aac359f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#adbd8cdb1423064796dc9efda5aac359f">EncodeElements</a> (<a class="el" href="classcom_1_1mxgraph_1_1mxCodec.html">mxCodec</a> enc, Object obj, XmlNode node)</td></tr>
|
|
<tr class="memdesc:adbd8cdb1423064796dc9efda5aac359f"><td class="mdescLeft"> </td><td class="mdescRight">Encodes the child objects of arrays, dictionaries and enumerables. <a href="#adbd8cdb1423064796dc9efda5aac359f">More...</a><br/></td></tr>
|
|
<tr class="separator:adbd8cdb1423064796dc9efda5aac359f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a126ab2aba3fd6743cc55474b8044296e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#a126ab2aba3fd6743cc55474b8044296e">EncodeValue</a> (<a class="el" href="classcom_1_1mxgraph_1_1mxCodec.html">mxCodec</a> enc, Object obj, string fieldname, Object value, XmlNode node)</td></tr>
|
|
<tr class="memdesc:a126ab2aba3fd6743cc55474b8044296e"><td class="mdescLeft"> </td><td class="mdescRight">Converts the given value according to the mappings and id-refs in this codec and uses writeAttribute to write the attribute into the given node. <a href="#a126ab2aba3fd6743cc55474b8044296e">More...</a><br/></td></tr>
|
|
<tr class="separator:a126ab2aba3fd6743cc55474b8044296e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8644dd4b6c21d680314409628e0eeebc"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#a8644dd4b6c21d680314409628e0eeebc">IsPrimitiveValue</a> (Object value)</td></tr>
|
|
<tr class="memdesc:a8644dd4b6c21d680314409628e0eeebc"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the given object is a primitive value. <a href="#a8644dd4b6c21d680314409628e0eeebc">More...</a><br/></td></tr>
|
|
<tr class="separator:a8644dd4b6c21d680314409628e0eeebc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7364522cd513fd242b56783a92cbffeb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7364522cd513fd242b56783a92cbffeb"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#a7364522cd513fd242b56783a92cbffeb">WriteAttribute</a> (<a class="el" href="classcom_1_1mxgraph_1_1mxCodec.html">mxCodec</a> enc, Object obj, string attr, Object value, XmlNode node)</td></tr>
|
|
<tr class="memdesc:a7364522cd513fd242b56783a92cbffeb"><td class="mdescLeft"> </td><td class="mdescRight">Writes the given value into node using writePrimitiveAttribute or writeComplexAttribute depending on the type of the value. <br/></td></tr>
|
|
<tr class="separator:a7364522cd513fd242b56783a92cbffeb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad6b38c3626995256419d0d7f9d537b28"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#ad6b38c3626995256419d0d7f9d537b28">WritePrimitiveAttribute</a> (<a class="el" href="classcom_1_1mxgraph_1_1mxCodec.html">mxCodec</a> enc, Object obj, string attr, Object value, XmlNode node)</td></tr>
|
|
<tr class="memdesc:ad6b38c3626995256419d0d7f9d537b28"><td class="mdescLeft"> </td><td class="mdescRight">Writes the given value as an attribute of the given node. <a href="#ad6b38c3626995256419d0d7f9d537b28">More...</a><br/></td></tr>
|
|
<tr class="separator:ad6b38c3626995256419d0d7f9d537b28"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af82997a9553b5ef4c4c72e22ce89aab2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#af82997a9553b5ef4c4c72e22ce89aab2">WriteComplexAttribute</a> (<a class="el" href="classcom_1_1mxgraph_1_1mxCodec.html">mxCodec</a> enc, Object obj, string attr, Object value, XmlNode node)</td></tr>
|
|
<tr class="memdesc:af82997a9553b5ef4c4c72e22ce89aab2"><td class="mdescLeft"> </td><td class="mdescRight">Writes the given value as a child node of the given node. <a href="#af82997a9553b5ef4c4c72e22ce89aab2">More...</a><br/></td></tr>
|
|
<tr class="separator:af82997a9553b5ef4c4c72e22ce89aab2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9b19cfed5f9e6d2411cbc9e4834ef3d4"><td class="memItemLeft" align="right" valign="top">virtual Object </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#a9b19cfed5f9e6d2411cbc9e4834ef3d4">ConvertValueToXml</a> (Object value)</td></tr>
|
|
<tr class="memdesc:a9b19cfed5f9e6d2411cbc9e4834ef3d4"><td class="mdescLeft"> </td><td class="mdescRight">Converts true to "1" and false to "0". All other values are ignored. <a href="#a9b19cfed5f9e6d2411cbc9e4834ef3d4">More...</a><br/></td></tr>
|
|
<tr class="separator:a9b19cfed5f9e6d2411cbc9e4834ef3d4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9ee20d6a987f32bbe6be8e3bdc9427ab"><td class="memItemLeft" align="right" valign="top">virtual Object </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#a9ee20d6a987f32bbe6be8e3bdc9427ab">ConvertValueFromXml</a> (Type type, Object value)</td></tr>
|
|
<tr class="memdesc:a9ee20d6a987f32bbe6be8e3bdc9427ab"><td class="mdescLeft"> </td><td class="mdescRight">Converts XML attribute values to object of the given type. <a href="#a9ee20d6a987f32bbe6be8e3bdc9427ab">More...</a><br/></td></tr>
|
|
<tr class="separator:a9ee20d6a987f32bbe6be8e3bdc9427ab"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aba5c9df342fa7a30ec6ff66daeca37a2"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#aba5c9df342fa7a30ec6ff66daeca37a2">GetAttributeName</a> (string fieldname)</td></tr>
|
|
<tr class="memdesc:aba5c9df342fa7a30ec6ff66daeca37a2"><td class="mdescLeft"> </td><td class="mdescRight">Returns the XML node attribute name for the given C# field name. That is, it returns the mapping of the field name. <a href="#aba5c9df342fa7a30ec6ff66daeca37a2">More...</a><br/></td></tr>
|
|
<tr class="separator:aba5c9df342fa7a30ec6ff66daeca37a2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad0a8e0ce71eca6b42aa1bfcddb1a5b7a"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#ad0a8e0ce71eca6b42aa1bfcddb1a5b7a">GetFieldName</a> (string attributename)</td></tr>
|
|
<tr class="memdesc:ad0a8e0ce71eca6b42aa1bfcddb1a5b7a"><td class="mdescLeft"> </td><td class="mdescRight">Returns the C# field name for the given XML attribute name. That is, it returns the reverse mapping of the attribute name. <a href="#ad0a8e0ce71eca6b42aa1bfcddb1a5b7a">More...</a><br/></td></tr>
|
|
<tr class="separator:ad0a8e0ce71eca6b42aa1bfcddb1a5b7a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:add2bd8c96029c73a09282da4b23cbd56"><td class="memItemLeft" align="right" valign="top">Object </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#add2bd8c96029c73a09282da4b23cbd56">GetFieldValue</a> (Object obj, string name)</td></tr>
|
|
<tr class="memdesc:add2bd8c96029c73a09282da4b23cbd56"><td class="mdescLeft"> </td><td class="mdescRight">Returns the value of the field with the specified name in the specified object instance. <a href="#add2bd8c96029c73a09282da4b23cbd56">More...</a><br/></td></tr>
|
|
<tr class="separator:add2bd8c96029c73a09282da4b23cbd56"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5af0d1c3adaa61ff229a2aac70be10f2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#a5af0d1c3adaa61ff229a2aac70be10f2">SetFieldValue</a> (Object obj, string name, Object value)</td></tr>
|
|
<tr class="memdesc:a5af0d1c3adaa61ff229a2aac70be10f2"><td class="mdescLeft"> </td><td class="mdescRight">Sets the value of the field with the specified name in the specified object instance. <a href="#a5af0d1c3adaa61ff229a2aac70be10f2">More...</a><br/></td></tr>
|
|
<tr class="separator:a5af0d1c3adaa61ff229a2aac70be10f2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a89d21dbe19f669563fdb219eed890b78"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#a89d21dbe19f669563fdb219eed890b78">DecodeNode</a> (<a class="el" href="classcom_1_1mxgraph_1_1mxCodec.html">mxCodec</a> dec, XmlNode node, Object obj)</td></tr>
|
|
<tr class="memdesc:a89d21dbe19f669563fdb219eed890b78"><td class="mdescLeft"> </td><td class="mdescRight">Calls decodeAttributes and decodeChildren for the given node. <a href="#a89d21dbe19f669563fdb219eed890b78">More...</a><br/></td></tr>
|
|
<tr class="separator:a89d21dbe19f669563fdb219eed890b78"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad97f11e9b24539d8dab390ab8b80e43d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#ad97f11e9b24539d8dab390ab8b80e43d">DecodeAttributes</a> (<a class="el" href="classcom_1_1mxgraph_1_1mxCodec.html">mxCodec</a> dec, XmlNode node, Object obj)</td></tr>
|
|
<tr class="memdesc:ad97f11e9b24539d8dab390ab8b80e43d"><td class="mdescLeft"> </td><td class="mdescRight">Decodes all attributes of the given node using decodeAttribute. <a href="#ad97f11e9b24539d8dab390ab8b80e43d">More...</a><br/></td></tr>
|
|
<tr class="separator:ad97f11e9b24539d8dab390ab8b80e43d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a438a81b33fc988dc9e43e76cf2f1a248"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#a438a81b33fc988dc9e43e76cf2f1a248">DecodeAttribute</a> (<a class="el" href="classcom_1_1mxgraph_1_1mxCodec.html">mxCodec</a> dec, XmlNode attr, Object obj)</td></tr>
|
|
<tr class="memdesc:a438a81b33fc988dc9e43e76cf2f1a248"><td class="mdescLeft"> </td><td class="mdescRight">Reads the given attribute into the specified object. <a href="#a438a81b33fc988dc9e43e76cf2f1a248">More...</a><br/></td></tr>
|
|
<tr class="separator:a438a81b33fc988dc9e43e76cf2f1a248"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab89216e04b622642e41426b93202baac"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#ab89216e04b622642e41426b93202baac">DecodeChildren</a> (<a class="el" href="classcom_1_1mxgraph_1_1mxCodec.html">mxCodec</a> dec, XmlNode node, Object obj)</td></tr>
|
|
<tr class="memdesc:ab89216e04b622642e41426b93202baac"><td class="mdescLeft"> </td><td class="mdescRight">Reads the given attribute into the specified object. <a href="#ab89216e04b622642e41426b93202baac">More...</a><br/></td></tr>
|
|
<tr class="separator:ab89216e04b622642e41426b93202baac"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7690c0e1b9d4e2e3a84d5811dca5ed10"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#a7690c0e1b9d4e2e3a84d5811dca5ed10">DecodeChild</a> (<a class="el" href="classcom_1_1mxgraph_1_1mxCodec.html">mxCodec</a> dec, XmlNode child, Object obj)</td></tr>
|
|
<tr class="memdesc:a7690c0e1b9d4e2e3a84d5811dca5ed10"><td class="mdescLeft"> </td><td class="mdescRight">Reads the specified child into the given object. <a href="#a7690c0e1b9d4e2e3a84d5811dca5ed10">More...</a><br/></td></tr>
|
|
<tr class="separator:a7690c0e1b9d4e2e3a84d5811dca5ed10"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afb4f9492d816ae229dec762154cc9cb3"><td class="memItemLeft" align="right" valign="top">Object </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#afb4f9492d816ae229dec762154cc9cb3">GetFieldTemplate</a> (Object obj, String fieldname, XmlNode child)</td></tr>
|
|
<tr class="memdesc:afb4f9492d816ae229dec762154cc9cb3"><td class="mdescLeft"> </td><td class="mdescRight">Returns the template instance for the given field. This returns the value of the field, null if the value is an array or an empty collection if the value is a collection. The value is then used to populate the field for a new instance. For strongly typed languages it may be required to override this to return the correct collection instance based on the encoded child. <a href="#afb4f9492d816ae229dec762154cc9cb3">More...</a><br/></td></tr>
|
|
<tr class="separator:afb4f9492d816ae229dec762154cc9cb3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad972bc0c7e66dc3cf752ed93a0166a42"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#ad972bc0c7e66dc3cf752ed93a0166a42">AddObjectValue</a> (Object obj, String fieldname, Object value, Object <a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#ab96f31d7efa7d5d51a13062e1ba4ddae">template</a>)</td></tr>
|
|
<tr class="memdesc:ad972bc0c7e66dc3cf752ed93a0166a42"><td class="mdescLeft"> </td><td class="mdescRight">Sets the decoded child node as a value of the given object. If the object is a map, then the value is added with the given fieldname as a key. If the fieldname is not empty, then setFieldValue is called or else, if the object is a collection, the value is added to the collection. For strongly typed languages it may be required to override this with the correct code to add an entry to an object. <a href="#ad972bc0c7e66dc3cf752ed93a0166a42">More...</a><br/></td></tr>
|
|
<tr class="separator:ad972bc0c7e66dc3cf752ed93a0166a42"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
|
|
Protected Attributes</h2></td></tr>
|
|
<tr class="memitem:ab96f31d7efa7d5d51a13062e1ba4ddae"><td class="memItemLeft" align="right" valign="top">Object </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#ab96f31d7efa7d5d51a13062e1ba4ddae">template</a></td></tr>
|
|
<tr class="memdesc:ab96f31d7efa7d5d51a13062e1ba4ddae"><td class="mdescLeft"> </td><td class="mdescRight">Holds the template object associated with this codec. <a href="#ab96f31d7efa7d5d51a13062e1ba4ddae">More...</a><br/></td></tr>
|
|
<tr class="separator:ab96f31d7efa7d5d51a13062e1ba4ddae"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afc2e8997b3371e5ae38ad67e9e404c58"><td class="memItemLeft" align="right" valign="top">List< string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#afc2e8997b3371e5ae38ad67e9e404c58">exclude</a></td></tr>
|
|
<tr class="memdesc:afc2e8997b3371e5ae38ad67e9e404c58"><td class="mdescLeft"> </td><td class="mdescRight">Array containing the variable names that should be ignored by the codec. <a href="#afc2e8997b3371e5ae38ad67e9e404c58">More...</a><br/></td></tr>
|
|
<tr class="separator:afc2e8997b3371e5ae38ad67e9e404c58"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2c02744b7fd32e18ec3a54683d8ffff3"><td class="memItemLeft" align="right" valign="top">List< string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#a2c02744b7fd32e18ec3a54683d8ffff3">idrefs</a></td></tr>
|
|
<tr class="memdesc:a2c02744b7fd32e18ec3a54683d8ffff3"><td class="mdescLeft"> </td><td class="mdescRight">Array containing the variable names that should be turned into or converted from references. See mxCodec.getId and mxCodec.getObject. <a href="#a2c02744b7fd32e18ec3a54683d8ffff3">More...</a><br/></td></tr>
|
|
<tr class="separator:a2c02744b7fd32e18ec3a54683d8ffff3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a84a82aa104ca8c7402f38f8aae0980c0"><td class="memItemLeft" align="right" valign="top">Dictionary< string, string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#a84a82aa104ca8c7402f38f8aae0980c0">mapping</a></td></tr>
|
|
<tr class="memdesc:a84a82aa104ca8c7402f38f8aae0980c0"><td class="mdescLeft"> </td><td class="mdescRight">Maps from from fieldnames to XML attribute names. <a href="#a84a82aa104ca8c7402f38f8aae0980c0">More...</a><br/></td></tr>
|
|
<tr class="separator:a84a82aa104ca8c7402f38f8aae0980c0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aed0785d4118b05b9b482dbe7f8b7e83c"><td class="memItemLeft" align="right" valign="top">Dictionary< string, string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#aed0785d4118b05b9b482dbe7f8b7e83c">reverse</a></td></tr>
|
|
<tr class="memdesc:aed0785d4118b05b9b482dbe7f8b7e83c"><td class="mdescLeft"> </td><td class="mdescRight">Maps from from XML attribute names to fieldnames. <a href="#aed0785d4118b05b9b482dbe7f8b7e83c">More...</a><br/></td></tr>
|
|
<tr class="separator:aed0785d4118b05b9b482dbe7f8b7e83c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
|
|
Properties</h2></td></tr>
|
|
<tr class="memitem:a52203bf1f50b6384908669ff234edb4b"><td class="memItemLeft" align="right" valign="top">Object </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxObjectCodec.html#a52203bf1f50b6384908669ff234edb4b">Template</a><code> [get]</code></td></tr>
|
|
<tr class="memdesc:a52203bf1f50b6384908669ff234edb4b"><td class="mdescLeft"> </td><td class="mdescRight">Returns the template object associated with this codec. <a href="#a52203bf1f50b6384908669ff234edb4b">More...</a><br/></td></tr>
|
|
<tr class="separator:a52203bf1f50b6384908669ff234edb4b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Generic codec for C# objects. See below for a detailed description of the encoding/decoding scheme. Note: Since booleans are numbers in JavaScript, all boolean values are encoded into 1 for true and 0 for false. </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="a6bd06a133a05a66263c1106f3dd1a666"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">com.mxgraph.mxObjectCodec.mxObjectCodec </td>
|
|
<td>(</td>
|
|
<td class="paramtype">Object </td>
|
|
<td class="paramname"><em>template</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Constructs a new codec for the specified template object. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">template</td><td>Prototypical instance of the object to be encoded/decoded.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a52e93d79c9543f837cec9f8ab316e549"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">com.mxgraph.mxObjectCodec.mxObjectCodec </td>
|
|
<td>(</td>
|
|
<td class="paramtype">Object </td>
|
|
<td class="paramname"><em>template</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string[] </td>
|
|
<td class="paramname"><em>exclude</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string[] </td>
|
|
<td class="paramname"><em>idrefs</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Dictionary< string, string > </td>
|
|
<td class="paramname"><em>mapping</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Constructs a new codec for the specified template object. The variables in the optional exclude array are ignored by the codec. Variables in the optional idrefs array are turned into references in the XML. The optional mapping may be used to map from variable names to XML attributes. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">template</td><td>Prototypical instance of the object to be encoded/decoded.</td></tr>
|
|
<tr><td class="paramname">exclude</td><td>Optional array of fieldnames to be ignored.</td></tr>
|
|
<tr><td class="paramname">idrefs</td><td>Optional array of fieldnames to be converted to/from references.</td></tr>
|
|
<tr><td class="paramname">mapping</td><td>Optional mapping from field- to attributenames.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="ad972bc0c7e66dc3cf752ed93a0166a42"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void com.mxgraph.mxObjectCodec.AddObjectValue </td>
|
|
<td>(</td>
|
|
<td class="paramtype">Object </td>
|
|
<td class="paramname"><em>obj</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">String </td>
|
|
<td class="paramname"><em>fieldname</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Object </td>
|
|
<td class="paramname"><em>value</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Object </td>
|
|
<td class="paramname"><em>template</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the decoded child node as a value of the given object. If the object is a map, then the value is added with the given fieldname as a key. If the fieldname is not empty, then setFieldValue is called or else, if the object is a collection, the value is added to the collection. For strongly typed languages it may be required to override this with the correct code to add an entry to an object. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a9670ef9eb8653e95387bc4e93ccb6db0"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual Object com.mxgraph.mxObjectCodec.AfterDecode </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classcom_1_1mxgraph_1_1mxCodec.html">mxCodec</a> </td>
|
|
<td class="paramname"><em>dec</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">XmlNode </td>
|
|
<td class="paramname"><em>node</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Object </td>
|
|
<td class="paramname"><em>obj</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Hook for subclassers to Receive-process the object after decoding. This implementation returns the given object without any changes. The return value of this method is returned to the decoder from decode. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">dec</td><td>Codec that controls the decoding process.</td></tr>
|
|
<tr><td class="paramname">node</td><td>XML node to be decoded.</td></tr>
|
|
<tr><td class="paramname">obj</td><td>Object that represents the default decoding.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns the result of the decoding process.</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a02a1b8988cd5b2617ad63ecd63db3db6"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual XmlNode com.mxgraph.mxObjectCodec.AfterEncode </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classcom_1_1mxgraph_1_1mxCodec.html">mxCodec</a> </td>
|
|
<td class="paramname"><em>enc</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Object </td>
|
|
<td class="paramname"><em>obj</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">XmlNode </td>
|
|
<td class="paramname"><em>node</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Hook for subclassers to Receive-process the node for the given object after encoding and return the Receive-processed node. This implementation returns the input node. The return value of this method is returned to the encoder from encode. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">enc</td><td>Codec that controls the encoding process.</td></tr>
|
|
<tr><td class="paramname">obj</td><td>Object to be encoded.</td></tr>
|
|
<tr><td class="paramname">node</td><td>XML node that represents the default encoding.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns the resulting node of the encoding.</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a164fbdf1d3283051873590addbdd524a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual XmlNode com.mxgraph.mxObjectCodec.BeforeDecode </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classcom_1_1mxgraph_1_1mxCodec.html">mxCodec</a> </td>
|
|
<td class="paramname"><em>dec</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">XmlNode </td>
|
|
<td class="paramname"><em>node</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Object </td>
|
|
<td class="paramname"><em>obj</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Hook for subclassers to pre-process the node for the specified object and return the node to be used for further processing by decode. The object is created based on the template in the calling method and is never null. This implementation returns the input node. The return value of this function is used in decode to perform the default decoding into the given object. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">dec</td><td>Codec that controls the decoding process.</td></tr>
|
|
<tr><td class="paramname">node</td><td>XML node to be decoded.</td></tr>
|
|
<tr><td class="paramname">obj</td><td>Object to encode the node into.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns the node used for the default decoding.</dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="classcom_1_1mxgraph_1_1mxModelCodec.html#a87ebd28e84d602ec87f411744bbe0ef8">com.mxgraph.mxModelCodec</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a94291cac63586be6e1a7f740ec145729"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual Object com.mxgraph.mxObjectCodec.BeforeEncode </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classcom_1_1mxgraph_1_1mxCodec.html">mxCodec</a> </td>
|
|
<td class="paramname"><em>enc</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Object </td>
|
|
<td class="paramname"><em>obj</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">XmlNode </td>
|
|
<td class="paramname"><em>node</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Hook for subclassers to pre-process the object before encoding. This returns the input object. The return value of this function is used in encode to perform the default encoding into the given node. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">enc</td><td>Codec that controls the encoding process.</td></tr>
|
|
<tr><td class="paramname">obj</td><td>Object to be encoded.</td></tr>
|
|
<tr><td class="paramname">node</td><td>XML node to encode the object into.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns the object to be encoded by the default encoding.</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a428da11a0f67b9b35d6ba6a350972151"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual Object com.mxgraph.mxObjectCodec.CloneTemplate </td>
|
|
<td>(</td>
|
|
<td class="paramtype">XmlNode </td>
|
|
<td class="paramname"><em>node</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns a new instance of the template object for representing the given node. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">node</td><td>XML node that the object is going to represent.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns a new template instance.</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a9ee20d6a987f32bbe6be8e3bdc9427ab"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual Object com.mxgraph.mxObjectCodec.ConvertValueFromXml </td>
|
|
<td>(</td>
|
|
<td class="paramtype">Type </td>
|
|
<td class="paramname"><em>type</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Object </td>
|
|
<td class="paramname"><em>value</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Converts XML attribute values to object of the given type. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a9b19cfed5f9e6d2411cbc9e4834ef3d4"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual Object com.mxgraph.mxObjectCodec.ConvertValueToXml </td>
|
|
<td>(</td>
|
|
<td class="paramtype">Object </td>
|
|
<td class="paramname"><em>value</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Converts true to "1" and false to "0". All other values are ignored. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a1ecf4a9e08d688c9041d97b6af1c2df0"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual Object com.mxgraph.mxObjectCodec.Decode </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classcom_1_1mxgraph_1_1mxCodec.html">mxCodec</a> </td>
|
|
<td class="paramname"><em>dec</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">XmlNode </td>
|
|
<td class="paramname"><em>node</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Parses the given node into the object or returns a new object representing the given node. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">dec</td><td>Codec that controls the encoding process.</td></tr>
|
|
<tr><td class="paramname">node</td><td>XML node to be decoded.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns the resulting object that represents the given XML node.</dd></dl>
|
|
|
|
<p>Referenced by <a class="el" href="classcom_1_1mxgraph_1_1mxCodec.html#a824d4ca6eaa4cf228e055c4485b7ea52">com.mxgraph.mxCodec.DecodeCell()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a27db4f4c90305c7707198e7e29ba1d09"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual Object com.mxgraph.mxObjectCodec.Decode </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classcom_1_1mxgraph_1_1mxCodec.html">mxCodec</a> </td>
|
|
<td class="paramname"><em>dec</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">XmlNode </td>
|
|
<td class="paramname"><em>node</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Object </td>
|
|
<td class="paramname"><em>into</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Parses the given node into the object or returns a new object representing the given node. Dec is a reference to the calling decoder. It is used to decode complex objects and resolve references. If a node has an id attribute then the object cache is checked for the object. If the object is not yet in the cache then it is constructed using the constructor of template and cached in <a class="el" href="classcom_1_1mxgraph_1_1mxCodec.html#a04522d7a38095efb6263bd10518fc6cc" title="Maps from IDs to objects. ">mxCodec.objects</a>. This implementation decodes all attributes and childs of a node according to the following rules: </p>
|
|
<ul>
|
|
<li>If the variable name is in exclude or if the attribute name is "id" or "as" then it is ignored.</li>
|
|
<li>If the variable name is in idrefs then mxCodec.getObject is used to replace the reference with an object.</li>
|
|
<li>The variable name is mapped using a reverse mapping.</li>
|
|
<li>If the value has a child node, then the codec is used to create a child object with the variable name taken from the "as" attribute.</li>
|
|
<li>If the object is an array and the variable name is empty then the value or child object is appended to the array.</li>
|
|
<li>If an add child has no value or the object is not an array then the child text content is evaluated using mxUtils.eval. If no object exists for an ID in idrefs a warning is issued using mxLog.warn. Returns the resulting object that represents the given XML node or the configured given object. </li>
|
|
</ul>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">dec</td><td>Codec that controls the encoding process.</td></tr>
|
|
<tr><td class="paramname">node</td><td>XML node to be decoded.</td></tr>
|
|
<tr><td class="paramname">into</td><td>Optional objec to encode the node into.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns the resulting object that represents the given XML node or the object given to the method as the into parameter.</dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="classcom_1_1mxgraph_1_1mxStylesheetCodec.html#a0b91a548bbfba3a0c29b929ca223f7a4">com.mxgraph.mxStylesheetCodec</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a438a81b33fc988dc9e43e76cf2f1a248"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void com.mxgraph.mxObjectCodec.DecodeAttribute </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classcom_1_1mxgraph_1_1mxCodec.html">mxCodec</a> </td>
|
|
<td class="paramname"><em>dec</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">XmlNode </td>
|
|
<td class="paramname"><em>attr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Object </td>
|
|
<td class="paramname"><em>obj</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reads the given attribute into the specified object. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad97f11e9b24539d8dab390ab8b80e43d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void com.mxgraph.mxObjectCodec.DecodeAttributes </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classcom_1_1mxgraph_1_1mxCodec.html">mxCodec</a> </td>
|
|
<td class="paramname"><em>dec</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">XmlNode </td>
|
|
<td class="paramname"><em>node</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Object </td>
|
|
<td class="paramname"><em>obj</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Decodes all attributes of the given node using decodeAttribute. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a7690c0e1b9d4e2e3a84d5811dca5ed10"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void com.mxgraph.mxObjectCodec.DecodeChild </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classcom_1_1mxgraph_1_1mxCodec.html">mxCodec</a> </td>
|
|
<td class="paramname"><em>dec</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">XmlNode </td>
|
|
<td class="paramname"><em>child</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Object </td>
|
|
<td class="paramname"><em>obj</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reads the specified child into the given object. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab89216e04b622642e41426b93202baac"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void com.mxgraph.mxObjectCodec.DecodeChildren </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classcom_1_1mxgraph_1_1mxCodec.html">mxCodec</a> </td>
|
|
<td class="paramname"><em>dec</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">XmlNode </td>
|
|
<td class="paramname"><em>node</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Object </td>
|
|
<td class="paramname"><em>obj</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reads the given attribute into the specified object. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a89d21dbe19f669563fdb219eed890b78"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void com.mxgraph.mxObjectCodec.DecodeNode </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classcom_1_1mxgraph_1_1mxCodec.html">mxCodec</a> </td>
|
|
<td class="paramname"><em>dec</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">XmlNode </td>
|
|
<td class="paramname"><em>node</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Object </td>
|
|
<td class="paramname"><em>obj</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Calls decodeAttributes and decodeChildren for the given node. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="af54fb528308bc68c772398c0f42862ff"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual XmlNode com.mxgraph.mxObjectCodec.Encode </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classcom_1_1mxgraph_1_1mxCodec.html">mxCodec</a> </td>
|
|
<td class="paramname"><em>enc</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Object </td>
|
|
<td class="paramname"><em>obj</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Encodes the specified object and returns a node representing then given object. Calls beforeEncode after creating the node and afterEncode with the resulting node after processing. Enc is a reference to the calling encoder. It is used to encode complex objects and create references. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">enc</td><td>Codec that controls the encoding process.</td></tr>
|
|
<tr><td class="paramname">obj</td><td>Object to be encoded.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns the resulting XML node that represents the given object.</dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="classcom_1_1mxgraph_1_1mxStylesheetCodec.html#a0d1d57effb1d0827d40ef39af0f4a5aa">com.mxgraph.mxStylesheetCodec</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="adbd8cdb1423064796dc9efda5aac359f"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void com.mxgraph.mxObjectCodec.EncodeElements </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classcom_1_1mxgraph_1_1mxCodec.html">mxCodec</a> </td>
|
|
<td class="paramname"><em>enc</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Object </td>
|
|
<td class="paramname"><em>obj</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">XmlNode </td>
|
|
<td class="paramname"><em>node</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Encodes the child objects of arrays, dictionaries and enumerables. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">enc</td><td>Codec that controls the encoding process.</td></tr>
|
|
<tr><td class="paramname">obj</td><td>Object whose child objects should be encoded.</td></tr>
|
|
<tr><td class="paramname">node</td><td>XML node that contains the encoded object.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a6050c05b6f5f64479777aad6edd0fecd"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void com.mxgraph.mxObjectCodec.EncodeFields </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classcom_1_1mxgraph_1_1mxCodec.html">mxCodec</a> </td>
|
|
<td class="paramname"><em>enc</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Object </td>
|
|
<td class="paramname"><em>obj</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">XmlNode </td>
|
|
<td class="paramname"><em>node</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Encodes the members of the given object into the given node. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">enc</td><td>Codec that controls the encoding process.</td></tr>
|
|
<tr><td class="paramname">obj</td><td>Object whose fields should be encoded.</td></tr>
|
|
<tr><td class="paramname">node</td><td>XML node that contains the encoded object.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a9f6a46c7f5d672663352742e7379f042"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void com.mxgraph.mxObjectCodec.EncodeObject </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classcom_1_1mxgraph_1_1mxCodec.html">mxCodec</a> </td>
|
|
<td class="paramname"><em>enc</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Object </td>
|
|
<td class="paramname"><em>obj</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">XmlNode </td>
|
|
<td class="paramname"><em>node</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Encodes the value of each member in then given obj into the given node using encodeFields and encodeElements. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">enc</td><td>Codec that controls the encoding process.</td></tr>
|
|
<tr><td class="paramname">obj</td><td>Object to be encoded.</td></tr>
|
|
<tr><td class="paramname">node</td><td>XML node that contains the encoded object.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="classcom_1_1mxgraph_1_1mxModelCodec.html#acc086a36b6e6fe3119a4db05c73b68c9">com.mxgraph.mxModelCodec</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a126ab2aba3fd6743cc55474b8044296e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void com.mxgraph.mxObjectCodec.EncodeValue </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classcom_1_1mxgraph_1_1mxCodec.html">mxCodec</a> </td>
|
|
<td class="paramname"><em>enc</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Object </td>
|
|
<td class="paramname"><em>obj</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>fieldname</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Object </td>
|
|
<td class="paramname"><em>value</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">XmlNode </td>
|
|
<td class="paramname"><em>node</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Converts the given value according to the mappings and id-refs in this codec and uses writeAttribute to write the attribute into the given node. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">enc</td><td>Codec that controls the encoding process.</td></tr>
|
|
<tr><td class="paramname">obj</td><td>Object whose member is going to be encoded.</td></tr>
|
|
<tr><td class="paramname">fieldname</td><td></td></tr>
|
|
<tr><td class="paramname">value</td><td>Value of the property to be encoded.</td></tr>
|
|
<tr><td class="paramname">node</td><td>XML node that contains the encoded object.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>References <a class="el" href="classcom_1_1mxgraph_1_1mxCodec.html#ab1f1547969b60eaf71b1aa5ac686ea2a">com.mxgraph.mxCodec.IsEncodeDefaults</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aba5c9df342fa7a30ec6ff66daeca37a2"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string com.mxgraph.mxObjectCodec.GetAttributeName </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>fieldname</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the XML node attribute name for the given C# field name. That is, it returns the mapping of the field name. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad0a8e0ce71eca6b42aa1bfcddb1a5b7a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string com.mxgraph.mxObjectCodec.GetFieldName </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>attributename</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the C# field name for the given XML attribute name. That is, it returns the reverse mapping of the attribute name. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">attributename</td><td>The attribute name to be mapped.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>String that represents the mapped field name.</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="afb4f9492d816ae229dec762154cc9cb3"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Object com.mxgraph.mxObjectCodec.GetFieldTemplate </td>
|
|
<td>(</td>
|
|
<td class="paramtype">Object </td>
|
|
<td class="paramname"><em>obj</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">String </td>
|
|
<td class="paramname"><em>fieldname</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">XmlNode </td>
|
|
<td class="paramname"><em>child</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the template instance for the given field. This returns the value of the field, null if the value is an array or an empty collection if the value is a collection. The value is then used to populate the field for a new instance. For strongly typed languages it may be required to override this to return the correct collection instance based on the encoded child. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="add2bd8c96029c73a09282da4b23cbd56"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Object com.mxgraph.mxObjectCodec.GetFieldValue </td>
|
|
<td>(</td>
|
|
<td class="paramtype">Object </td>
|
|
<td class="paramname"><em>obj</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>name</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the value of the field with the specified name in the specified object instance. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="add9b5e9f0c81ddf6a0afaded9709ea61"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string com.mxgraph.mxObjectCodec.GetName </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the name used for the nodenames and lookup of the codec when classes are encoded and nodes are decoded. For classes to work with this the codec registry automatically adds an alias for the classname if that is different than what this returns. The default implementation returns the classname of the template class. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a4fecc4526bae174c5d8f26b55514d328"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool com.mxgraph.mxObjectCodec.IsExcluded </td>
|
|
<td>(</td>
|
|
<td class="paramtype">Object </td>
|
|
<td class="paramname"><em>obj</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>attr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Object </td>
|
|
<td class="paramname"><em>value</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>write</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns true if the given attribute is to be ignored by the codec. This implementation returns true if the given fieldname is in exclude. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">obj</td><td>Object instance that contains the field.</td></tr>
|
|
<tr><td class="paramname">attr</td><td>Fieldname of the field.</td></tr>
|
|
<tr><td class="paramname">value</td><td>Value of the field.</td></tr>
|
|
<tr><td class="paramname">write</td><td>Boolean indicating if the field is being encoded or decoded. write is true if the field is being encoded, else it is being decoded.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns true if the given attribute should be ignored.</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a8644dd4b6c21d680314409628e0eeebc"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool com.mxgraph.mxObjectCodec.IsPrimitiveValue </td>
|
|
<td>(</td>
|
|
<td class="paramtype">Object </td>
|
|
<td class="paramname"><em>value</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns true if the given object is a primitive value. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">value</td><td>Object that should be checked.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns true if the given object is a primitive value.</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a2d45a1f0b46ae0541b5e39c946902d45"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool com.mxgraph.mxObjectCodec.IsReference </td>
|
|
<td>(</td>
|
|
<td class="paramtype">Object </td>
|
|
<td class="paramname"><em>obj</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>attr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Object </td>
|
|
<td class="paramname"><em>value</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>write</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns true if the given fieldname is to be treated as a textual reference (ID). This implementation returns true if the given fieldname is in idrefs. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">obj</td><td>Object instance that contains the field.</td></tr>
|
|
<tr><td class="paramname">attr</td><td>Fieldname of the field.</td></tr>
|
|
<tr><td class="paramname">value</td><td>Value of the field.</td></tr>
|
|
<tr><td class="paramname">write</td><td>Boolean indicating if the field is being encoded or decoded. write is true if the field is being encoded, else it is being decoded.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns true if the given attribute should be handled as a reference.</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ac5c143df7b7b7c9d8b7a77681b2b9815"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool com.mxgraph.mxObjectCodec.ProcessInclude </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classcom_1_1mxgraph_1_1mxCodec.html">mxCodec</a> </td>
|
|
<td class="paramname"><em>dec</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">XmlNode </td>
|
|
<td class="paramname"><em>node</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Object </td>
|
|
<td class="paramname"><em>into</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p></p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">dec</td><td>Codec that controls the encoding/decoding process.</td></tr>
|
|
<tr><td class="paramname">node</td><td>XML node to be checked.</td></tr>
|
|
<tr><td class="paramname">into</td><td>Optional object to pass-thru to the codec.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns true if the given node was processed as an include.</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a5af0d1c3adaa61ff229a2aac70be10f2"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void com.mxgraph.mxObjectCodec.SetFieldValue </td>
|
|
<td>(</td>
|
|
<td class="paramtype">Object </td>
|
|
<td class="paramname"><em>obj</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Object </td>
|
|
<td class="paramname"><em>value</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the value of the field with the specified name in the specified object instance. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="af82997a9553b5ef4c4c72e22ce89aab2"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void com.mxgraph.mxObjectCodec.WriteComplexAttribute </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classcom_1_1mxgraph_1_1mxCodec.html">mxCodec</a> </td>
|
|
<td class="paramname"><em>enc</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Object </td>
|
|
<td class="paramname"><em>obj</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>attr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Object </td>
|
|
<td class="paramname"><em>value</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">XmlNode </td>
|
|
<td class="paramname"><em>node</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Writes the given value as a child node of the given node. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad6b38c3626995256419d0d7f9d537b28"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void com.mxgraph.mxObjectCodec.WritePrimitiveAttribute </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classcom_1_1mxgraph_1_1mxCodec.html">mxCodec</a> </td>
|
|
<td class="paramname"><em>enc</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Object </td>
|
|
<td class="paramname"><em>obj</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>attr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Object </td>
|
|
<td class="paramname"><em>value</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">XmlNode </td>
|
|
<td class="paramname"><em>node</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Writes the given value as an attribute of the given node. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a class="anchor" id="afc2e8997b3371e5ae38ad67e9e404c58"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">List<string> com.mxgraph.mxObjectCodec.exclude</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Array containing the variable names that should be ignored by the codec. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a2c02744b7fd32e18ec3a54683d8ffff3"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">List<string> com.mxgraph.mxObjectCodec.idrefs</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Array containing the variable names that should be turned into or converted from references. See mxCodec.getId and mxCodec.getObject. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a84a82aa104ca8c7402f38f8aae0980c0"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Dictionary<string, string> com.mxgraph.mxObjectCodec.mapping</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Maps from from fieldnames to XML attribute names. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aed0785d4118b05b9b482dbe7f8b7e83c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Dictionary<string, string> com.mxgraph.mxObjectCodec.reverse</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Maps from from XML attribute names to fieldnames. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab96f31d7efa7d5d51a13062e1ba4ddae"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Object com.mxgraph.mxObjectCodec.template</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Holds the template object associated with this codec. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Property Documentation</h2>
|
|
<a class="anchor" id="a52203bf1f50b6384908669ff234edb4b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Object com.mxgraph.mxObjectCodec.Template</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">get</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the template object associated with this codec. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns the template object.</dd></dl>
|
|
|
|
<p>Referenced by <a class="el" href="classcom_1_1mxgraph_1_1mxCodecRegistry.html#a9d516650c7a2051664e84d4bf14bfbd6">com.mxgraph.mxCodecRegistry.Register()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>src/io/mxObjectCodec.cs</li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Thu Oct 9 2014 09:49:42 for mxGraph by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.6
|
|
</small></address>
|
|
</body>
|
|
</html>
|