<ahref="classcom_1_1mxgraph_1_1mxObjectCodec-members.html">List of all members</a></div>
<divclass="headertitle">
<divclass="title">com.mxgraph.mxObjectCodec Class Reference</div></div>
</div><!--header-->
<divclass="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.
<areahref="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"/>
<areahref="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"/>
<areahref="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"/>
<trclass="memdesc:a6bd06a133a05a66263c1106f3dd1a666"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Constructs a new codec for the specified template object. <ahref="#a6bd06a133a05a66263c1106f3dd1a666">More...</a><br/></td></tr>
<trclass="memdesc:a52e93d79c9543f837cec9f8ab316e549"><tdclass="mdescLeft"> </td><tdclass="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. <ahref="#a52e93d79c9543f837cec9f8ab316e549">More...</a><br/></td></tr>
<trclass="memdesc:add9b5e9f0c81ddf6a0afaded9709ea61"><tdclass="mdescLeft"> </td><tdclass="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. <ahref="#add9b5e9f0c81ddf6a0afaded9709ea61">More...</a><br/></td></tr>
<trclass="memdesc:a4fecc4526bae174c5d8f26b55514d328"><tdclass="mdescLeft"> </td><tdclass="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. <ahref="#a4fecc4526bae174c5d8f26b55514d328">More...</a><br/></td></tr>
<trclass="memdesc:a2d45a1f0b46ae0541b5e39c946902d45"><tdclass="mdescLeft"> </td><tdclass="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. <ahref="#a2d45a1f0b46ae0541b5e39c946902d45">More...</a><br/></td></tr>
<trclass="memdesc:af54fb528308bc68c772398c0f42862ff"><tdclass="mdescLeft"> </td><tdclass="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. <ahref="#af54fb528308bc68c772398c0f42862ff">More...</a><br/></td></tr>
<trclass="memdesc:a94291cac63586be6e1a7f740ec145729"><tdclass="mdescLeft"> </td><tdclass="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. <ahref="#a94291cac63586be6e1a7f740ec145729">More...</a><br/></td></tr>
<trclass="memdesc:a02a1b8988cd5b2617ad63ecd63db3db6"><tdclass="mdescLeft"> </td><tdclass="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. <ahref="#a02a1b8988cd5b2617ad63ecd63db3db6">More...</a><br/></td></tr>
<trclass="memdesc:a1ecf4a9e08d688c9041d97b6af1c2df0"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Parses the given node into the object or returns a new object representing the given node. <ahref="#a1ecf4a9e08d688c9041d97b6af1c2df0">More...</a><br/></td></tr>
<trclass="memdesc:a27db4f4c90305c7707198e7e29ba1d09"><tdclass="mdescLeft"> </td><tdclass="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 <aclass="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: <ahref="#a27db4f4c90305c7707198e7e29ba1d09">More...</a><br/></td></tr>
<trclass="memdesc:a164fbdf1d3283051873590addbdd524a"><tdclass="mdescLeft"> </td><tdclass="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. <ahref="#a164fbdf1d3283051873590addbdd524a">More...</a><br/></td></tr>
<trclass="memdesc:a9670ef9eb8653e95387bc4e93ccb6db0"><tdclass="mdescLeft"> </td><tdclass="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. <ahref="#a9670ef9eb8653e95387bc4e93ccb6db0">More...</a><br/></td></tr>
<trclass="memdesc:a428da11a0f67b9b35d6ba6a350972151"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Returns a new instance of the template object for representing the given node. <ahref="#a428da11a0f67b9b35d6ba6a350972151">More...</a><br/></td></tr>
<trclass="memdesc:a9f6a46c7f5d672663352742e7379f042"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Encodes the value of each member in then given obj into the given node using encodeFields and encodeElements. <ahref="#a9f6a46c7f5d672663352742e7379f042">More...</a><br/></td></tr>
<trclass="memdesc:a6050c05b6f5f64479777aad6edd0fecd"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Encodes the members of the given object into the given node. <ahref="#a6050c05b6f5f64479777aad6edd0fecd">More...</a><br/></td></tr>
<trclass="memdesc:adbd8cdb1423064796dc9efda5aac359f"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Encodes the child objects of arrays, dictionaries and enumerables. <ahref="#adbd8cdb1423064796dc9efda5aac359f">More...</a><br/></td></tr>
<trclass="memdesc:a126ab2aba3fd6743cc55474b8044296e"><tdclass="mdescLeft"> </td><tdclass="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. <ahref="#a126ab2aba3fd6743cc55474b8044296e">More...</a><br/></td></tr>
<trclass="memdesc:a8644dd4b6c21d680314409628e0eeebc"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Returns true if the given object is a primitive value. <ahref="#a8644dd4b6c21d680314409628e0eeebc">More...</a><br/></td></tr>
<trclass="memdesc:a7364522cd513fd242b56783a92cbffeb"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Writes the given value into node using writePrimitiveAttribute or writeComplexAttribute depending on the type of the value. <br/></td></tr>
<trclass="memdesc:ad6b38c3626995256419d0d7f9d537b28"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Writes the given value as an attribute of the given node. <ahref="#ad6b38c3626995256419d0d7f9d537b28">More...</a><br/></td></tr>
<trclass="memdesc:af82997a9553b5ef4c4c72e22ce89aab2"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Writes the given value as a child node of the given node. <ahref="#af82997a9553b5ef4c4c72e22ce89aab2">More...</a><br/></td></tr>
<trclass="memdesc:a9b19cfed5f9e6d2411cbc9e4834ef3d4"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Converts true to "1" and false to "0". All other values are ignored. <ahref="#a9b19cfed5f9e6d2411cbc9e4834ef3d4">More...</a><br/></td></tr>
<trclass="memdesc:a9ee20d6a987f32bbe6be8e3bdc9427ab"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Converts XML attribute values to object of the given type. <ahref="#a9ee20d6a987f32bbe6be8e3bdc9427ab">More...</a><br/></td></tr>
<trclass="memdesc:aba5c9df342fa7a30ec6ff66daeca37a2"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Returns the XML node attribute name for the given C# field name. That is, it returns the mapping of the field name. <ahref="#aba5c9df342fa7a30ec6ff66daeca37a2">More...</a><br/></td></tr>
<trclass="memdesc:ad0a8e0ce71eca6b42aa1bfcddb1a5b7a"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Returns the C# field name for the given XML attribute name. That is, it returns the reverse mapping of the attribute name. <ahref="#ad0a8e0ce71eca6b42aa1bfcddb1a5b7a">More...</a><br/></td></tr>
<trclass="memdesc:add2bd8c96029c73a09282da4b23cbd56"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Returns the value of the field with the specified name in the specified object instance. <ahref="#add2bd8c96029c73a09282da4b23cbd56">More...</a><br/></td></tr>
<trclass="memdesc:a5af0d1c3adaa61ff229a2aac70be10f2"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Sets the value of the field with the specified name in the specified object instance. <ahref="#a5af0d1c3adaa61ff229a2aac70be10f2">More...</a><br/></td></tr>
<trclass="memdesc:a89d21dbe19f669563fdb219eed890b78"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Calls decodeAttributes and decodeChildren for the given node. <ahref="#a89d21dbe19f669563fdb219eed890b78">More...</a><br/></td></tr>
<trclass="memdesc:ad97f11e9b24539d8dab390ab8b80e43d"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Decodes all attributes of the given node using decodeAttribute. <ahref="#ad97f11e9b24539d8dab390ab8b80e43d">More...</a><br/></td></tr>
<trclass="memdesc:a438a81b33fc988dc9e43e76cf2f1a248"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Reads the given attribute into the specified object. <ahref="#a438a81b33fc988dc9e43e76cf2f1a248">More...</a><br/></td></tr>
<trclass="memdesc:ab89216e04b622642e41426b93202baac"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Reads the given attribute into the specified object. <ahref="#ab89216e04b622642e41426b93202baac">More...</a><br/></td></tr>
<trclass="memdesc:a7690c0e1b9d4e2e3a84d5811dca5ed10"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Reads the specified child into the given object. <ahref="#a7690c0e1b9d4e2e3a84d5811dca5ed10">More...</a><br/></td></tr>
<trclass="memdesc:afb4f9492d816ae229dec762154cc9cb3"><tdclass="mdescLeft"> </td><tdclass="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. <ahref="#afb4f9492d816ae229dec762154cc9cb3">More...</a><br/></td></tr>
<trclass="memdesc:ad972bc0c7e66dc3cf752ed93a0166a42"><tdclass="mdescLeft"> </td><tdclass="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. <ahref="#ad972bc0c7e66dc3cf752ed93a0166a42">More...</a><br/></td></tr>
<trclass="memdesc:ab96f31d7efa7d5d51a13062e1ba4ddae"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Holds the template object associated with this codec. <ahref="#ab96f31d7efa7d5d51a13062e1ba4ddae">More...</a><br/></td></tr>
<trclass="memdesc:afc2e8997b3371e5ae38ad67e9e404c58"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Array containing the variable names that should be ignored by the codec. <ahref="#afc2e8997b3371e5ae38ad67e9e404c58">More...</a><br/></td></tr>
<trclass="memdesc:a2c02744b7fd32e18ec3a54683d8ffff3"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Array containing the variable names that should be turned into or converted from references. See mxCodec.getId and mxCodec.getObject. <ahref="#a2c02744b7fd32e18ec3a54683d8ffff3">More...</a><br/></td></tr>
<trclass="memdesc:a84a82aa104ca8c7402f38f8aae0980c0"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Maps from from fieldnames to XML attribute names. <ahref="#a84a82aa104ca8c7402f38f8aae0980c0">More...</a><br/></td></tr>
<trclass="memdesc:aed0785d4118b05b9b482dbe7f8b7e83c"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Maps from from XML attribute names to fieldnames. <ahref="#aed0785d4118b05b9b482dbe7f8b7e83c">More...</a><br/></td></tr>
<trclass="memdesc:a52203bf1f50b6384908669ff234edb4b"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Returns the template object associated with this codec. <ahref="#a52203bf1f50b6384908669ff234edb4b">More...</a><br/></td></tr>
<divclass="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><h2class="groupheader">Constructor & Destructor Documentation</h2>
<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>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramname">template</td><td>Prototypical instance of the object to be encoded/decoded.</td></tr>
<tr><tdclass="paramname">exclude</td><td>Optional array of fieldnames to be ignored.</td></tr>
<tr><tdclass="paramname">idrefs</td><td>Optional array of fieldnames to be converted to/from references.</td></tr>
<tr><tdclass="paramname">mapping</td><td>Optional mapping from field- to attributenames.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2class="groupheader">Member Function Documentation</h2>
<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>
<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>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramname">dec</td><td>Codec that controls the decoding process.</td></tr>
<tr><tdclass="paramname">node</td><td>XML node to be decoded.</td></tr>
<tr><tdclass="paramname">obj</td><td>Object that represents the default decoding.</td></tr>
</table>
</dd>
</dl>
<dlclass="section return"><dt>Returns</dt><dd>Returns the result of the decoding process.</dd></dl>
<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>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramname">enc</td><td>Codec that controls the encoding process.</td></tr>
<tr><tdclass="paramname">obj</td><td>Object to be encoded.</td></tr>
<tr><tdclass="paramname">node</td><td>XML node that represents the default encoding.</td></tr>
</table>
</dd>
</dl>
<dlclass="section return"><dt>Returns</dt><dd>Returns the resulting node of the encoding.</dd></dl>
<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>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramname">dec</td><td>Codec that controls the decoding process.</td></tr>
<tr><tdclass="paramname">node</td><td>XML node to be decoded.</td></tr>
<tr><tdclass="paramname">obj</td><td>Object to encode the node into.</td></tr>
</table>
</dd>
</dl>
<dlclass="section return"><dt>Returns</dt><dd>Returns the node used for the default decoding.</dd></dl>
<p>Reimplemented in <aclass="el"href="classcom_1_1mxgraph_1_1mxModelCodec.html#a87ebd28e84d602ec87f411744bbe0ef8">com.mxgraph.mxModelCodec</a>.</p>
<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>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramname">enc</td><td>Codec that controls the encoding process.</td></tr>
<tr><tdclass="paramname">obj</td><td>Object to be encoded.</td></tr>
<tr><tdclass="paramname">node</td><td>XML node to encode the object into.</td></tr>
</table>
</dd>
</dl>
<dlclass="section return"><dt>Returns</dt><dd>Returns the object to be encoded by the default encoding.</dd></dl>
<p>Parses the given node into the object or returns a new object representing the given node. </p>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramname">dec</td><td>Codec that controls the encoding process.</td></tr>
<tr><tdclass="paramname">node</td><td>XML node to be decoded.</td></tr>
</table>
</dd>
</dl>
<dlclass="section return"><dt>Returns</dt><dd>Returns the resulting object that represents the given XML node.</dd></dl>
<p>Referenced by <aclass="el"href="classcom_1_1mxgraph_1_1mxCodec.html#aa4d103574f3b6b379d7d7cca995a2a3d">com.mxgraph.mxCodec.Decode()</a>, and <aclass="el"href="classcom_1_1mxgraph_1_1mxCodec.html#a824d4ca6eaa4cf228e055c4485b7ea52">com.mxgraph.mxCodec.DecodeCell()</a>.</p>
<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 <aclass="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>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramname">dec</td><td>Codec that controls the encoding process.</td></tr>
<tr><tdclass="paramname">node</td><td>XML node to be decoded.</td></tr>
<tr><tdclass="paramname">into</td><td>Optional objec to encode the node into.</td></tr>
</table>
</dd>
</dl>
<dlclass="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 <aclass="el"href="classcom_1_1mxgraph_1_1mxStylesheetCodec.html#a0b91a548bbfba3a0c29b929ca223f7a4">com.mxgraph.mxStylesheetCodec</a>.</p>
<p>References <aclass="el"href="classcom_1_1mxgraph_1_1mxCodec.html#ad5808ca1e07460f138eb34b3ae244e27">com.mxgraph.mxCodec.Objects</a>, and <aclass="el"href="classcom_1_1mxgraph_1_1mxCodec.html#a662c18d5b7a3c7d31031653baec1c9fa">com.mxgraph.mxCodec.PutObject()</a>.</p>
<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>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramname">enc</td><td>Codec that controls the encoding process.</td></tr>
<tr><tdclass="paramname">obj</td><td>Object to be encoded.</td></tr>
</table>
</dd>
</dl>
<dlclass="section return"><dt>Returns</dt><dd>Returns the resulting XML node that represents the given object.</dd></dl>
<p>Reimplemented in <aclass="el"href="classcom_1_1mxgraph_1_1mxStylesheetCodec.html#a0d1d57effb1d0827d40ef39af0f4a5aa">com.mxgraph.mxStylesheetCodec</a>.</p>
<p>Encodes the value of each member in then given obj into the given node using encodeFields and encodeElements. </p>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramname">enc</td><td>Codec that controls the encoding process.</td></tr>
<tr><tdclass="paramname">obj</td><td>Object to be encoded.</td></tr>
<tr><tdclass="paramname">node</td><td>XML node that contains the encoded object.</td></tr>
</table>
</dd>
</dl>
<p>Reimplemented in <aclass="el"href="classcom_1_1mxgraph_1_1mxModelCodec.html#acc086a36b6e6fe3119a4db05c73b68c9">com.mxgraph.mxModelCodec</a>.</p>
<p>References <aclass="el"href="classcom_1_1mxgraph_1_1mxCodec.html#ae259ea85ae98f767a6ebfb15468652ca">com.mxgraph.mxCodec.GetId()</a>, and <aclass="el"href="classcom_1_1mxgraph_1_1mxCodec.html#a799403c766d5a6c12525fb0278c50e74">com.mxgraph.mxCodec.SetAttribute()</a>.</p>
<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>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramname">enc</td><td>Codec that controls the encoding process.</td></tr>
<tr><tdclass="paramname">obj</td><td>Object whose member is going to be encoded.</td></tr>
<tr><tdclass="paramname">value</td><td>Value of the property to be encoded.</td></tr>
<tr><tdclass="paramname">node</td><td>XML node that contains the encoded object.</td></tr>
</table>
</dd>
</dl>
<p>References <aclass="el"href="classcom_1_1mxgraph_1_1mxCodec.html#ae259ea85ae98f767a6ebfb15468652ca">com.mxgraph.mxCodec.GetId()</a>, and <aclass="el"href="classcom_1_1mxgraph_1_1mxCodec.html#ab1f1547969b60eaf71b1aa5ac686ea2a">com.mxgraph.mxCodec.IsEncodeDefaults</a>.</p>
<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>
<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>
<p>Referenced by <aclass="el"href="classcom_1_1mxgraph_1_1mxCodecRegistry.html#a9d516650c7a2051664e84d4bf14bfbd6">com.mxgraph.mxCodecRegistry.Register()</a>.</p>
<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>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramname">obj</td><td>Object instance that contains the field.</td></tr>
<tr><tdclass="paramname">attr</td><td>Fieldname of the field.</td></tr>
<tr><tdclass="paramname">value</td><td>Value of the field.</td></tr>
<tr><tdclass="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>
<dlclass="section return"><dt>Returns</dt><dd>Returns true if the given attribute should be ignored.</dd></dl>
<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>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramname">obj</td><td>Object instance that contains the field.</td></tr>
<tr><tdclass="paramname">attr</td><td>Fieldname of the field.</td></tr>
<tr><tdclass="paramname">value</td><td>Value of the field.</td></tr>
<tr><tdclass="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>
<dlclass="section return"><dt>Returns</dt><dd>Returns true if the given attribute should be handled as a reference.</dd></dl>
<tr><tdclass="paramname">dec</td><td>Codec that controls the encoding/decoding process.</td></tr>
<tr><tdclass="paramname">node</td><td>XML node to be checked.</td></tr>
<tr><tdclass="paramname">into</td><td>Optional object to pass-thru to the codec.</td></tr>
</table>
</dd>
</dl>
<dlclass="section return"><dt>Returns</dt><dd>Returns true if the given node was processed as an include.</dd></dl>
<p>References <aclass="el"href="classcom_1_1mxgraph_1_1mxCodec.html#aa0ad136f46f6a2b29360bd1537ff30fc">com.mxgraph.mxCodec.Decode()</a>, and <aclass="el"href="classcom_1_1mxgraph_1_1mxUtils.html#a1f677c92a3d20dcfc5001ab4e18a9b2c">com.mxgraph.mxUtils.LoadDocument()</a>.</p>
<p>Writes the given value as a child node of the given node. </p>
<p>References <aclass="el"href="classcom_1_1mxgraph_1_1mxCodec.html#a3088b2e442dd7ea6f92a7ccba3b12251">com.mxgraph.mxCodec.Encode()</a>, and <aclass="el"href="classcom_1_1mxgraph_1_1mxCodec.html#a799403c766d5a6c12525fb0278c50e74">com.mxgraph.mxCodec.SetAttribute()</a>.</p>
<p>Writes the given value as an attribute of the given node. </p>
<p>References <aclass="el"href="classcom_1_1mxgraph_1_1mxCodec.html#ad62be275d2f44acaf2e8be0a4a07ee4e">com.mxgraph.mxCodec.Document</a>, and <aclass="el"href="classcom_1_1mxgraph_1_1mxCodec.html#a799403c766d5a6c12525fb0278c50e74">com.mxgraph.mxCodec.SetAttribute()</a>.</p>
</div>
</div>
<h2class="groupheader">Member Data Documentation</h2>
<p>Returns the template object associated with this codec. </p>
<dlclass="section return"><dt>Returns</dt><dd>Returns the template object.</dd></dl>
<p>Referenced by <aclass="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>
