<ahref="#pub-methods">Public Member Functions</a>|
<ahref="#pro-methods">Protected Member Functions</a>|
<ahref="classcom_1_1mxgraph_1_1mxModelCodec-members.html">List of all members</a></div>
<divclass="headertitle">
<divclass="title">com.mxgraph.mxModelCodec Class Reference</div></div>
</div><!--header-->
<divclass="contents">
<p>Codec for mxGraphModels. This class is created and registered dynamically at load time and used implicitely via <aclass="el"href="classcom_1_1mxgraph_1_1mxCodec.html"title="XML codec for .NET object graphs. In order to resolve forward references when reading files the XML d...">mxCodec</a> and the <aclass="el"href="classcom_1_1mxgraph_1_1mxCodecRegistry.html"title="Static class that acts as a global registry for codecs. See mxCodec for an example of using this clas...">mxCodecRegistry</a>.
<areahref="classcom_1_1mxgraph_1_1mxObjectCodec.html"title="Generic codec for C# objects. See below for a detailed description of the encoding/decoding scheme..."alt="com.mxgraph.mxObjectCodec"shape="rect"coords="0,0,180,24"/>
<trclass="memdesc:a34594105ccead527e72ffb2763940d07"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Constructs a new model codec. <ahref="#a34594105ccead527e72ffb2763940d07">More...</a><br/></td></tr>
<trclass="memdesc:aef538f1f3a9165e93f78c054ac2b374b"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Constructs a new model codec for the given template. <ahref="#aef538f1f3a9165e93f78c054ac2b374b">More...</a><br/></td></tr>
<trclass="memdesc:a80f3c85cd4a26832277a6442477cc0e9"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Constructs a new model codec for the given arguments. <ahref="#a80f3c85cd4a26832277a6442477cc0e9">More...</a><br/></td></tr>
<trclass="memdesc:a87ebd28e84d602ec87f411744bbe0ef8"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Reads the cells into the graph model. All cells are children of the root element in the node. <ahref="#a87ebd28e84d602ec87f411744bbe0ef8">More...</a><br/></td></tr>
<trclass="inherit_header pub_methods_classcom_1_1mxgraph_1_1mxObjectCodec"><tdcolspan="2"onclick="javascript:toggleInherit('pub_methods_classcom_1_1mxgraph_1_1mxObjectCodec')"><imgsrc="closed.png"alt="-"/> Public Member Functions inherited from <aclass="el"href="classcom_1_1mxgraph_1_1mxObjectCodec.html">com.mxgraph.mxObjectCodec</a></td></tr>
<trclass="memdesc:a6bd06a133a05a66263c1106f3dd1a666 inherit pub_methods_classcom_1_1mxgraph_1_1mxObjectCodec"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Constructs a new codec for the specified template object. <ahref="#a6bd06a133a05a66263c1106f3dd1a666">More...</a><br/></td></tr>
<trclass="memdesc:a52e93d79c9543f837cec9f8ab316e549 inherit pub_methods_classcom_1_1mxgraph_1_1mxObjectCodec"><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 inherit pub_methods_classcom_1_1mxgraph_1_1mxObjectCodec"><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 inherit pub_methods_classcom_1_1mxgraph_1_1mxObjectCodec"><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 inherit pub_methods_classcom_1_1mxgraph_1_1mxObjectCodec"><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 inherit pub_methods_classcom_1_1mxgraph_1_1mxObjectCodec"><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 inherit pub_methods_classcom_1_1mxgraph_1_1mxObjectCodec"><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 inherit pub_methods_classcom_1_1mxgraph_1_1mxObjectCodec"><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 inherit pub_methods_classcom_1_1mxgraph_1_1mxObjectCodec"><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 inherit pub_methods_classcom_1_1mxgraph_1_1mxObjectCodec"><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:a9670ef9eb8653e95387bc4e93ccb6db0 inherit pub_methods_classcom_1_1mxgraph_1_1mxObjectCodec"><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:acc086a36b6e6fe3119a4db05c73b68c9"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Encodes the given <aclass="el"href="classcom_1_1mxgraph_1_1mxGraphModel.html"title="Implements a graph model. The graph model acts as a wrapper around the cells which are in charge of s...">mxGraphModel</a> by writing a (flat) XML sequence of cell nodes as produced by the <aclass="el"href="classcom_1_1mxgraph_1_1mxCellCodec.html"title="Codec for mxCells. This class is created and registered dynamically at load time and used implicitely...">mxCellCodec</a>. The sequence is wrapped-up in a node with the name root. <ahref="#acc086a36b6e6fe3119a4db05c73b68c9">More...</a><br/></td></tr>
<trclass="inherit_header pro_methods_classcom_1_1mxgraph_1_1mxObjectCodec"><tdcolspan="2"onclick="javascript:toggleInherit('pro_methods_classcom_1_1mxgraph_1_1mxObjectCodec')"><imgsrc="closed.png"alt="-"/> Protected Member Functions inherited from <aclass="el"href="classcom_1_1mxgraph_1_1mxObjectCodec.html">com.mxgraph.mxObjectCodec</a></td></tr>
<trclass="memdesc:a428da11a0f67b9b35d6ba6a350972151 inherit pro_methods_classcom_1_1mxgraph_1_1mxObjectCodec"><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:a6050c05b6f5f64479777aad6edd0fecd inherit pro_methods_classcom_1_1mxgraph_1_1mxObjectCodec"><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 inherit pro_methods_classcom_1_1mxgraph_1_1mxObjectCodec"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Encodes the child objects of arrays, dictionaries and enumerables. <ahref="#adbd8cdb1423064796dc9efda5aac359f">More...</a><br/></td></tr>
<trclass="memdesc:a126ab2aba3fd6743cc55474b8044296e inherit pro_methods_classcom_1_1mxgraph_1_1mxObjectCodec"><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 inherit pro_methods_classcom_1_1mxgraph_1_1mxObjectCodec"><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 inherit pro_methods_classcom_1_1mxgraph_1_1mxObjectCodec"><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 inherit pro_methods_classcom_1_1mxgraph_1_1mxObjectCodec"><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 inherit pro_methods_classcom_1_1mxgraph_1_1mxObjectCodec"><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 inherit pro_methods_classcom_1_1mxgraph_1_1mxObjectCodec"><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 inherit pro_methods_classcom_1_1mxgraph_1_1mxObjectCodec"><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 inherit pro_methods_classcom_1_1mxgraph_1_1mxObjectCodec"><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 inherit pro_methods_classcom_1_1mxgraph_1_1mxObjectCodec"><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 inherit pro_methods_classcom_1_1mxgraph_1_1mxObjectCodec"><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 inherit pro_methods_classcom_1_1mxgraph_1_1mxObjectCodec"><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 inherit pro_methods_classcom_1_1mxgraph_1_1mxObjectCodec"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Calls decodeAttributes and decodeChildren for the given node. <ahref="#a89d21dbe19f669563fdb219eed890b78">More...</a><br/></td></tr>
<trclass="memdesc:ad97f11e9b24539d8dab390ab8b80e43d inherit pro_methods_classcom_1_1mxgraph_1_1mxObjectCodec"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Decodes all attributes of the given node using decodeAttribute. <ahref="#ad97f11e9b24539d8dab390ab8b80e43d">More...</a><br/></td></tr>
<trclass="memdesc:a438a81b33fc988dc9e43e76cf2f1a248 inherit pro_methods_classcom_1_1mxgraph_1_1mxObjectCodec"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Reads the given attribute into the specified object. <ahref="#a438a81b33fc988dc9e43e76cf2f1a248">More...</a><br/></td></tr>
<trclass="memdesc:ab89216e04b622642e41426b93202baac inherit pro_methods_classcom_1_1mxgraph_1_1mxObjectCodec"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Reads the given attribute into the specified object. <ahref="#ab89216e04b622642e41426b93202baac">More...</a><br/></td></tr>
<trclass="memdesc:a7690c0e1b9d4e2e3a84d5811dca5ed10 inherit pro_methods_classcom_1_1mxgraph_1_1mxObjectCodec"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Reads the specified child into the given object. <ahref="#a7690c0e1b9d4e2e3a84d5811dca5ed10">More...</a><br/></td></tr>
<trclass="memdesc:afb4f9492d816ae229dec762154cc9cb3 inherit pro_methods_classcom_1_1mxgraph_1_1mxObjectCodec"><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 inherit pro_methods_classcom_1_1mxgraph_1_1mxObjectCodec"><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 inherit pro_attribs_classcom_1_1mxgraph_1_1mxObjectCodec"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Holds the template object associated with this codec. <ahref="#ab96f31d7efa7d5d51a13062e1ba4ddae">More...</a><br/></td></tr>
<trclass="memdesc:afc2e8997b3371e5ae38ad67e9e404c58 inherit pro_attribs_classcom_1_1mxgraph_1_1mxObjectCodec"><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 inherit pro_attribs_classcom_1_1mxgraph_1_1mxObjectCodec"><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 inherit pro_attribs_classcom_1_1mxgraph_1_1mxObjectCodec"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Maps from from fieldnames to XML attribute names. <ahref="#a84a82aa104ca8c7402f38f8aae0980c0">More...</a><br/></td></tr>
<trclass="memdesc:aed0785d4118b05b9b482dbe7f8b7e83c inherit pro_attribs_classcom_1_1mxgraph_1_1mxObjectCodec"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Maps from from XML attribute names to fieldnames. <ahref="#aed0785d4118b05b9b482dbe7f8b7e83c">More...</a><br/></td></tr>
<trclass="inherit_header properties_classcom_1_1mxgraph_1_1mxObjectCodec"><tdcolspan="2"onclick="javascript:toggleInherit('properties_classcom_1_1mxgraph_1_1mxObjectCodec')"><imgsrc="closed.png"alt="-"/> Properties inherited from <aclass="el"href="classcom_1_1mxgraph_1_1mxObjectCodec.html">com.mxgraph.mxObjectCodec</a></td></tr>
<trclass="memdesc:a52203bf1f50b6384908669ff234edb4b inherit properties_classcom_1_1mxgraph_1_1mxObjectCodec"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Returns the template object associated with this codec. <ahref="#a52203bf1f50b6384908669ff234edb4b">More...</a><br/></td></tr>
<divclass="textblock"><p>Codec for mxGraphModels. This class is created and registered dynamically at load time and used implicitely via <aclass="el"href="classcom_1_1mxgraph_1_1mxCodec.html"title="XML codec for .NET object graphs. In order to resolve forward references when reading files the XML d...">mxCodec</a> and the <aclass="el"href="classcom_1_1mxgraph_1_1mxCodecRegistry.html"title="Static class that acts as a global registry for codecs. See mxCodec for an example of using this clas...">mxCodecRegistry</a>. </p>
</div><h2class="groupheader">Constructor & Destructor Documentation</h2>
<p>Reads the cells into the graph model. All cells are children of the root element in the node. </p>
<p>Reimplemented from <aclass="el"href="classcom_1_1mxgraph_1_1mxObjectCodec.html#a164fbdf1d3283051873590addbdd524a">com.mxgraph.mxObjectCodec</a>.</p>
<p>References <aclass="el"href="classcom_1_1mxgraph_1_1mxCodec.html#a824d4ca6eaa4cf228e055c4485b7ea52">com.mxgraph.mxCodec.DecodeCell()</a>, and <aclass="el"href="interfacecom_1_1mxgraph_1_1mxICell.html#a941936fb7b521cb9e1258e236be4d0ff">com.mxgraph.mxICell.Parent</a>.</p>
<p>Encodes the given <aclass="el"href="classcom_1_1mxgraph_1_1mxGraphModel.html"title="Implements a graph model. The graph model acts as a wrapper around the cells which are in charge of s...">mxGraphModel</a> by writing a (flat) XML sequence of cell nodes as produced by the <aclass="el"href="classcom_1_1mxgraph_1_1mxCellCodec.html"title="Codec for mxCells. This class is created and registered dynamically at load time and used implicitely...">mxCellCodec</a>. The sequence is wrapped-up in a node with the name root. </p>
<p>Reimplemented from <aclass="el"href="classcom_1_1mxgraph_1_1mxObjectCodec.html#a9f6a46c7f5d672663352742e7379f042">com.mxgraph.mxObjectCodec</a>.</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#a52442cecf5ce690681d95496c9673f87">com.mxgraph.mxCodec.EncodeCell()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
