forked from jgraph/mxgraph
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmxObjectCodec.html
More file actions
1473 lines (1461 loc) · 69.6 KB
/
mxObjectCodec.html
File metadata and controls
1473 lines (1461 loc) · 69.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_171) on Fri Jul 06 13:50:03 UTC 2018 -->
<title>mxObjectCodec (mxGraph 3.9.8 API Specification)</title>
<meta name="date" content="2018-07-06">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="mxObjectCodec (mxGraph 3.9.8 API Specification)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/mxObjectCodec.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><p><b>mxGraph 3.9.8</b></p></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../com/mxgraph/io/mxModelCodec.html" title="class in com.mxgraph.io"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../com/mxgraph/io/mxRootChangeCodec.html" title="class in com.mxgraph.io"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/mxgraph/io/mxObjectCodec.html" target="_top">Frames</a></li>
<li><a href="mxObjectCodec.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field.summary">Field</a> | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field.detail">Field</a> | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.mxgraph.io</div>
<h2 title="Class mxObjectCodec" class="title">Class mxObjectCodec</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.mxgraph.io.mxObjectCodec</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../com/mxgraph/io/mxCellCodec.html" title="class in com.mxgraph.io">mxCellCodec</a>, <a href="../../../com/mxgraph/io/mxChildChangeCodec.html" title="class in com.mxgraph.io">mxChildChangeCodec</a>, <a href="../../../com/mxgraph/io/mxGenericChangeCodec.html" title="class in com.mxgraph.io">mxGenericChangeCodec</a>, <a href="../../../com/mxgraph/io/mxModelCodec.html" title="class in com.mxgraph.io">mxModelCodec</a>, <a href="../../../com/mxgraph/io/mxRootChangeCodec.html" title="class in com.mxgraph.io">mxRootChangeCodec</a>, <a href="../../../com/mxgraph/io/mxStylesheetCodec.html" title="class in com.mxgraph.io">mxStylesheetCodec</a>, <a href="../../../com/mxgraph/io/mxTerminalChangeCodec.html" title="class in com.mxgraph.io">mxTerminalChangeCodec</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">mxObjectCodec</span>
extends java.lang.Object</pre>
<div class="block">Generic codec for Java 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.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.util.Map<java.lang.String,java.lang.reflect.Method></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/io/mxObjectCodec.html#accessors">accessors</a></span></code>
<div class="block">Caches accessors for the given method names.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.util.Set<java.lang.String></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/io/mxObjectCodec.html#exclude">exclude</a></span></code>
<div class="block">Array containing the variable names that should be ignored by the codec.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.util.Map<java.lang.Class,java.util.Map<java.lang.String,java.lang.reflect.Field>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/io/mxObjectCodec.html#fields">fields</a></span></code>
<div class="block">Caches fields for faster access.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.util.Set<java.lang.String></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/io/mxObjectCodec.html#idrefs">idrefs</a></span></code>
<div class="block">Array containing the variable names that should be turned into or
converted from references.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.util.Map<java.lang.String,java.lang.String></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/io/mxObjectCodec.html#mapping">mapping</a></span></code>
<div class="block">Maps from from fieldnames to XML attribute names.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.util.Map<java.lang.String,java.lang.String></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/io/mxObjectCodec.html#reverse">reverse</a></span></code>
<div class="block">Maps from from XML attribute names to fieldnames.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/io/mxObjectCodec.html#template">template</a></span></code>
<div class="block">Holds the template object associated with this codec.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../com/mxgraph/io/mxObjectCodec.html#mxObjectCodec-java.lang.Object-">mxObjectCodec</a></span>(java.lang.Object template)</code>
<div class="block">Constructs a new codec for the specified template object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../com/mxgraph/io/mxObjectCodec.html#mxObjectCodec-java.lang.Object-java.lang.String:A-java.lang.String:A-java.util.Map-">mxObjectCodec</a></span>(java.lang.Object template,
java.lang.String[] exclude,
java.lang.String[] idrefs,
java.util.Map<java.lang.String,java.lang.String> mapping)</code>
<div class="block">Constructs a new codec for the specified template object.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/io/mxObjectCodec.html#addObjectValue-java.lang.Object-java.lang.String-java.lang.Object-java.lang.Object-">addObjectValue</a></span>(java.lang.Object obj,
java.lang.String fieldname,
java.lang.Object value,
java.lang.Object template)</code>
<div class="block">Sets the decoded child node as a value of the given object.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/io/mxObjectCodec.html#afterDecode-com.mxgraph.io.mxCodec-org.w3c.dom.Node-java.lang.Object-">afterDecode</a></span>(<a href="../../../com/mxgraph/io/mxCodec.html" title="class in com.mxgraph.io">mxCodec</a> dec,
org.w3c.dom.Node node,
java.lang.Object obj)</code>
<div class="block">Hook for subclassers to post-process the object after decoding.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>org.w3c.dom.Node</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/io/mxObjectCodec.html#afterEncode-com.mxgraph.io.mxCodec-java.lang.Object-org.w3c.dom.Node-">afterEncode</a></span>(<a href="../../../com/mxgraph/io/mxCodec.html" title="class in com.mxgraph.io">mxCodec</a> enc,
java.lang.Object obj,
org.w3c.dom.Node node)</code>
<div class="block">Hook for subclassers to post-process the node for the given object after
encoding and return the post-processed node.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>org.w3c.dom.Node</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/io/mxObjectCodec.html#beforeDecode-com.mxgraph.io.mxCodec-org.w3c.dom.Node-java.lang.Object-">beforeDecode</a></span>(<a href="../../../com/mxgraph/io/mxCodec.html" title="class in com.mxgraph.io">mxCodec</a> dec,
org.w3c.dom.Node node,
java.lang.Object obj)</code>
<div class="block">Hook for subclassers to pre-process the node for the specified object
and return the node to be used for further processing by
<a href="../../../com/mxgraph/io/mxObjectCodec.html#decode-com.mxgraph.io.mxCodec-org.w3c.dom.Node-"><code>decode(mxCodec, Node)</code></a>.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/io/mxObjectCodec.html#beforeEncode-com.mxgraph.io.mxCodec-java.lang.Object-org.w3c.dom.Node-">beforeEncode</a></span>(<a href="../../../com/mxgraph/io/mxCodec.html" title="class in com.mxgraph.io">mxCodec</a> enc,
java.lang.Object obj,
org.w3c.dom.Node node)</code>
<div class="block">Hook for subclassers to pre-process the object before encoding.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/io/mxObjectCodec.html#cloneTemplate-org.w3c.dom.Node-">cloneTemplate</a></span>(org.w3c.dom.Node node)</code>
<div class="block">Returns a new instance of the template object for representing the given
node.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>protected java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/io/mxObjectCodec.html#convertValueFromXml-java.lang.Class-java.lang.Object-">convertValueFromXml</a></span>(java.lang.Class<?> type,
java.lang.Object value)</code>
<div class="block">Converts XML attribute values to object of the given type.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>protected java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/io/mxObjectCodec.html#convertValueToXml-java.lang.Object-">convertValueToXml</a></span>(java.lang.Object value)</code>
<div class="block">Converts true to "1" and false to "0".</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/io/mxObjectCodec.html#decode-com.mxgraph.io.mxCodec-org.w3c.dom.Node-">decode</a></span>(<a href="../../../com/mxgraph/io/mxCodec.html" title="class in com.mxgraph.io">mxCodec</a> dec,
org.w3c.dom.Node node)</code>
<div class="block">Parses the given node into the object or returns a new object
representing the given node.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/io/mxObjectCodec.html#decode-com.mxgraph.io.mxCodec-org.w3c.dom.Node-java.lang.Object-">decode</a></span>(<a href="../../../com/mxgraph/io/mxCodec.html" title="class in com.mxgraph.io">mxCodec</a> dec,
org.w3c.dom.Node node,
java.lang.Object into)</code>
<div class="block">Parses the given node into the object or returns a new object
representing the given node.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/io/mxObjectCodec.html#decodeAttribute-com.mxgraph.io.mxCodec-org.w3c.dom.Node-java.lang.Object-">decodeAttribute</a></span>(<a href="../../../com/mxgraph/io/mxCodec.html" title="class in com.mxgraph.io">mxCodec</a> dec,
org.w3c.dom.Node attr,
java.lang.Object obj)</code>
<div class="block">Reads the given attribute into the specified object.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/io/mxObjectCodec.html#decodeAttributes-com.mxgraph.io.mxCodec-org.w3c.dom.Node-java.lang.Object-">decodeAttributes</a></span>(<a href="../../../com/mxgraph/io/mxCodec.html" title="class in com.mxgraph.io">mxCodec</a> dec,
org.w3c.dom.Node node,
java.lang.Object obj)</code>
<div class="block">Decodes all attributes of the given node using decodeAttribute.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/io/mxObjectCodec.html#decodeChild-com.mxgraph.io.mxCodec-org.w3c.dom.Node-java.lang.Object-">decodeChild</a></span>(<a href="../../../com/mxgraph/io/mxCodec.html" title="class in com.mxgraph.io">mxCodec</a> dec,
org.w3c.dom.Node child,
java.lang.Object obj)</code>
<div class="block">Reads the specified child into the given object.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/io/mxObjectCodec.html#decodeChildren-com.mxgraph.io.mxCodec-org.w3c.dom.Node-java.lang.Object-">decodeChildren</a></span>(<a href="../../../com/mxgraph/io/mxCodec.html" title="class in com.mxgraph.io">mxCodec</a> dec,
org.w3c.dom.Node node,
java.lang.Object obj)</code>
<div class="block">Decodec all children of the given node using decodeChild.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/io/mxObjectCodec.html#decodeNode-com.mxgraph.io.mxCodec-org.w3c.dom.Node-java.lang.Object-">decodeNode</a></span>(<a href="../../../com/mxgraph/io/mxCodec.html" title="class in com.mxgraph.io">mxCodec</a> dec,
org.w3c.dom.Node node,
java.lang.Object obj)</code>
<div class="block">Calls decodeAttributes and decodeChildren for the given node.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>org.w3c.dom.Node</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/io/mxObjectCodec.html#encode-com.mxgraph.io.mxCodec-java.lang.Object-">encode</a></span>(<a href="../../../com/mxgraph/io/mxCodec.html" title="class in com.mxgraph.io">mxCodec</a> enc,
java.lang.Object obj)</code>
<div class="block">Encodes the specified object and returns a node representing then given
object.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/io/mxObjectCodec.html#encodeElements-com.mxgraph.io.mxCodec-java.lang.Object-org.w3c.dom.Node-">encodeElements</a></span>(<a href="../../../com/mxgraph/io/mxCodec.html" title="class in com.mxgraph.io">mxCodec</a> enc,
java.lang.Object obj,
org.w3c.dom.Node node)</code>
<div class="block">Encodes the child objects of arrays, maps and collections.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/io/mxObjectCodec.html#encodeFields-com.mxgraph.io.mxCodec-java.lang.Object-org.w3c.dom.Node-">encodeFields</a></span>(<a href="../../../com/mxgraph/io/mxCodec.html" title="class in com.mxgraph.io">mxCodec</a> enc,
java.lang.Object obj,
org.w3c.dom.Node node)</code>
<div class="block">Encodes the declared fields of the given object into the given node.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/io/mxObjectCodec.html#encodeObject-com.mxgraph.io.mxCodec-java.lang.Object-org.w3c.dom.Node-">encodeObject</a></span>(<a href="../../../com/mxgraph/io/mxCodec.html" title="class in com.mxgraph.io">mxCodec</a> enc,
java.lang.Object obj,
org.w3c.dom.Node node)</code>
<div class="block">Encodes the value of each member in then given obj
into the given node using <a href="../../../com/mxgraph/io/mxObjectCodec.html#encodeFields-com.mxgraph.io.mxCodec-java.lang.Object-org.w3c.dom.Node-"><code>encodeFields(mxCodec, Object, Node)</code></a>
and <a href="../../../com/mxgraph/io/mxObjectCodec.html#encodeElements-com.mxgraph.io.mxCodec-java.lang.Object-org.w3c.dom.Node-"><code>encodeElements(mxCodec, Object, Node)</code></a>.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/io/mxObjectCodec.html#encodeValue-com.mxgraph.io.mxCodec-java.lang.Object-java.lang.String-java.lang.Object-org.w3c.dom.Node-">encodeValue</a></span>(<a href="../../../com/mxgraph/io/mxCodec.html" title="class in com.mxgraph.io">mxCodec</a> enc,
java.lang.Object obj,
java.lang.String fieldname,
java.lang.Object value,
org.w3c.dom.Node node)</code>
<div class="block">Converts the given value according to the mappings
and id-refs in this codec and uses
<a href="../../../com/mxgraph/io/mxObjectCodec.html#writeAttribute-com.mxgraph.io.mxCodec-java.lang.Object-java.lang.String-java.lang.Object-org.w3c.dom.Node-"><code>writeAttribute(mxCodec, Object, String, Object, Node)</code></a>
to write the attribute into the given node.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>protected java.lang.reflect.Method</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/io/mxObjectCodec.html#getAccessor-java.lang.Object-java.lang.reflect.Field-boolean-">getAccessor</a></span>(java.lang.Object obj,
java.lang.reflect.Field field,
boolean isGetter)</code>
<div class="block">Returns the accessor (getter, setter) for the specified field.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/io/mxObjectCodec.html#getAttributeName-java.lang.String-">getAttributeName</a></span>(java.lang.String fieldname)</code>
<div class="block">Returns the XML node attribute name for the given Java field name.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>protected java.lang.reflect.Field</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/io/mxObjectCodec.html#getField-java.lang.Object-java.lang.String-">getField</a></span>(java.lang.Object obj,
java.lang.String fieldname)</code>
<div class="block">Returns the field with the specified name.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/io/mxObjectCodec.html#getFieldName-java.lang.String-">getFieldName</a></span>(java.lang.String attributename)</code>
<div class="block">Returns the Java field name for the given XML attribute name.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>protected java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/io/mxObjectCodec.html#getFieldTemplate-java.lang.Object-java.lang.String-org.w3c.dom.Node-">getFieldTemplate</a></span>(java.lang.Object obj,
java.lang.String fieldname,
org.w3c.dom.Node child)</code>
<div class="block">Returns the template instance for the given field.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>protected java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/io/mxObjectCodec.html#getFieldValue-java.lang.Object-java.lang.String-">getFieldValue</a></span>(java.lang.Object obj,
java.lang.String fieldname)</code>
<div class="block">Returns the value of the field with the specified name in the specified
object instance.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>protected java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/io/mxObjectCodec.html#getFieldValueWithAccessor-java.lang.Object-java.lang.reflect.Field-">getFieldValueWithAccessor</a></span>(java.lang.Object obj,
java.lang.reflect.Field field)</code>
<div class="block">Returns the value of the field using the accessor for the field if one exists.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>protected java.lang.reflect.Method</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/io/mxObjectCodec.html#getMethod-java.lang.Object-java.lang.String-java.lang.Class:A-">getMethod</a></span>(java.lang.Object obj,
java.lang.String methodname,
java.lang.Class[] params)</code>
<div class="block">Returns the method with the specified signature.</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/io/mxObjectCodec.html#getName--">getName</a></span>()</code>
<div class="block">Returns the name used for the nodenames and lookup of the codec when
classes are encoded and nodes are decoded.</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/io/mxObjectCodec.html#getTemplate--">getTemplate</a></span>()</code>
<div class="block">Returns the template object associated with this codec.</div>
</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/io/mxObjectCodec.html#isExcluded-java.lang.Object-java.lang.String-java.lang.Object-boolean-">isExcluded</a></span>(java.lang.Object obj,
java.lang.String attr,
java.lang.Object value,
boolean write)</code>
<div class="block">Returns true if the given attribute is to be ignored by the codec.</div>
</td>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/io/mxObjectCodec.html#isPrimitiveValue-java.lang.Object-">isPrimitiveValue</a></span>(java.lang.Object value)</code>
<div class="block">Returns true if the given object is a primitive value.</div>
</td>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/io/mxObjectCodec.html#isReference-java.lang.Object-java.lang.String-java.lang.Object-boolean-">isReference</a></span>(java.lang.Object obj,
java.lang.String attr,
java.lang.Object value,
boolean isWrite)</code>
<div class="block">Returns true if the given fieldname is to be treated as a textual
reference (ID).</div>
</td>
</tr>
<tr id="i33" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/io/mxObjectCodec.html#processInclude-com.mxgraph.io.mxCodec-org.w3c.dom.Node-java.lang.Object-">processInclude</a></span>(<a href="../../../com/mxgraph/io/mxCodec.html" title="class in com.mxgraph.io">mxCodec</a> dec,
org.w3c.dom.Node node,
java.lang.Object into)</code>
<div class="block">Returns true if the given node is an include directive and executes the
include by decoding the XML document.</div>
</td>
</tr>
<tr id="i34" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/io/mxObjectCodec.html#setFieldValue-java.lang.Object-java.lang.String-java.lang.Object-">setFieldValue</a></span>(java.lang.Object obj,
java.lang.String fieldname,
java.lang.Object value)</code>
<div class="block">Sets the value of the field with the specified name
in the specified object instance.</div>
</td>
</tr>
<tr id="i35" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/io/mxObjectCodec.html#setFieldValueWithAccessor-java.lang.Object-java.lang.reflect.Field-java.lang.Object-">setFieldValueWithAccessor</a></span>(java.lang.Object obj,
java.lang.reflect.Field field,
java.lang.Object value)</code>
<div class="block">Sets the value of the given field using the accessor if one exists.</div>
</td>
</tr>
<tr id="i36" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/io/mxObjectCodec.html#writeAttribute-com.mxgraph.io.mxCodec-java.lang.Object-java.lang.String-java.lang.Object-org.w3c.dom.Node-">writeAttribute</a></span>(<a href="../../../com/mxgraph/io/mxCodec.html" title="class in com.mxgraph.io">mxCodec</a> enc,
java.lang.Object obj,
java.lang.String attr,
java.lang.Object value,
org.w3c.dom.Node node)</code>
<div class="block">Writes the given value into node using writePrimitiveAttribute
or writeComplexAttribute depending on the type of the value.</div>
</td>
</tr>
<tr id="i37" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/io/mxObjectCodec.html#writeComplexAttribute-com.mxgraph.io.mxCodec-java.lang.Object-java.lang.String-java.lang.Object-org.w3c.dom.Node-">writeComplexAttribute</a></span>(<a href="../../../com/mxgraph/io/mxCodec.html" title="class in com.mxgraph.io">mxCodec</a> enc,
java.lang.Object obj,
java.lang.String attr,
java.lang.Object value,
org.w3c.dom.Node node)</code>
<div class="block">Writes the given value as a child node of the given node.</div>
</td>
</tr>
<tr id="i38" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/mxgraph/io/mxObjectCodec.html#writePrimitiveAttribute-com.mxgraph.io.mxCodec-java.lang.Object-java.lang.String-java.lang.Object-org.w3c.dom.Node-">writePrimitiveAttribute</a></span>(<a href="../../../com/mxgraph/io/mxCodec.html" title="class in com.mxgraph.io">mxCodec</a> enc,
java.lang.Object obj,
java.lang.String attr,
java.lang.Object value,
org.w3c.dom.Node node)</code>
<div class="block">Writes the given value as an attribute of the given node.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="template">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>template</h4>
<pre>protected java.lang.Object template</pre>
<div class="block">Holds the template object associated with this codec.</div>
</li>
</ul>
<a name="exclude">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>exclude</h4>
<pre>protected java.util.Set<java.lang.String> exclude</pre>
<div class="block">Array containing the variable names that should be ignored by the codec.</div>
</li>
</ul>
<a name="idrefs">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>idrefs</h4>
<pre>protected java.util.Set<java.lang.String> idrefs</pre>
<div class="block">Array containing the variable names that should be turned into or
converted from references. See <mxCodec.getId> and <mxCodec.getObject>.</div>
</li>
</ul>
<a name="mapping">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mapping</h4>
<pre>protected java.util.Map<java.lang.String,java.lang.String> mapping</pre>
<div class="block">Maps from from fieldnames to XML attribute names.</div>
</li>
</ul>
<a name="reverse">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reverse</h4>
<pre>protected java.util.Map<java.lang.String,java.lang.String> reverse</pre>
<div class="block">Maps from from XML attribute names to fieldnames.</div>
</li>
</ul>
<a name="accessors">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>accessors</h4>
<pre>protected java.util.Map<java.lang.String,java.lang.reflect.Method> accessors</pre>
<div class="block">Caches accessors for the given method names.</div>
</li>
</ul>
<a name="fields">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>fields</h4>
<pre>protected java.util.Map<java.lang.Class,java.util.Map<java.lang.String,java.lang.reflect.Field>> fields</pre>
<div class="block">Caches fields for faster access.</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="mxObjectCodec-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mxObjectCodec</h4>
<pre>public mxObjectCodec(java.lang.Object template)</pre>
<div class="block">Constructs a new codec for the specified template object.</div>
</li>
</ul>
<a name="mxObjectCodec-java.lang.Object-java.lang.String:A-java.lang.String:A-java.util.Map-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>mxObjectCodec</h4>
<pre>public mxObjectCodec(java.lang.Object template,
java.lang.String[] exclude,
java.lang.String[] idrefs,
java.util.Map<java.lang.String,java.lang.String> mapping)</pre>
<div class="block">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. The argument is created as follows:</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>template</code> - Prototypical instance of the object to be encoded/decoded.</dd>
<dd><code>exclude</code> - Optional array of fieldnames to be ignored.</dd>
<dd><code>idrefs</code> - Optional array of fieldnames to be converted to/from references.</dd>
<dd><code>mapping</code> - Optional mapping from field- to attributenames.</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre>public java.lang.String getName()</pre>
<div class="block">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.
Here is an example on how to use this for renaming mxCell nodes:
<code>
mxCodecRegistry.register(new mxCellCodec()
{
public String getName()
{
return "anotherName";
}
});
</code></div>
</li>
</ul>
<a name="getTemplate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTemplate</h4>
<pre>public java.lang.Object getTemplate()</pre>
<div class="block">Returns the template object associated with this codec.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Returns the template object.</dd>
</dl>
</li>
</ul>
<a name="cloneTemplate-org.w3c.dom.Node-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cloneTemplate</h4>
<pre>protected java.lang.Object cloneTemplate(org.w3c.dom.Node node)</pre>
<div class="block">Returns a new instance of the template object for representing the given
node.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>node</code> - XML node that the object is going to represent.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Returns a new template instance.</dd>
</dl>
</li>
</ul>
<a name="isExcluded-java.lang.Object-java.lang.String-java.lang.Object-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isExcluded</h4>
<pre>public boolean isExcluded(java.lang.Object obj,
java.lang.String attr,
java.lang.Object value,
boolean write)</pre>
<div class="block">Returns true if the given attribute is to be ignored by the codec. This
implementation returns true if the given fieldname is in
<a href="../../../com/mxgraph/io/mxObjectCodec.html#exclude"><code>exclude</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>obj</code> - Object instance that contains the field.</dd>
<dd><code>attr</code> - Fieldname of the field.</dd>
<dd><code>value</code> - Value of the field.</dd>
<dd><code>write</code> - Boolean indicating if the field is being encoded or
decoded. write is true if the field is being encoded, else it is
being decoded.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Returns true if the given attribute should be ignored.</dd>
</dl>
</li>
</ul>
<a name="isReference-java.lang.Object-java.lang.String-java.lang.Object-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isReference</h4>
<pre>public boolean isReference(java.lang.Object obj,
java.lang.String attr,
java.lang.Object value,
boolean isWrite)</pre>
<div class="block">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 <a href="../../../com/mxgraph/io/mxObjectCodec.html#idrefs"><code>idrefs</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>obj</code> - Object instance that contains the field.</dd>
<dd><code>attr</code> - Fieldname of the field.</dd>
<dd><code>value</code> - Value of the field.</dd>
<dd><code>isWrite</code> - Boolean indicating if the field is being encoded or
decoded. isWrite is true if the field is being encoded, else it is being
decoded.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Returns true if the given attribute should be handled as a
reference.</dd>
</dl>
</li>
</ul>
<a name="encode-com.mxgraph.io.mxCodec-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encode</h4>
<pre>public org.w3c.dom.Node encode(<a href="../../../com/mxgraph/io/mxCodec.html" title="class in com.mxgraph.io">mxCodec</a> enc,
java.lang.Object obj)</pre>
<div class="block">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.
This implementation encodes all variables of an object according to the
following rules:
<ul>
<li>If the variable name is in <a href="../../../com/mxgraph/io/mxObjectCodec.html#exclude"><code>exclude</code></a> then it is ignored.</li>
<li>If the variable name is in <a href="../../../com/mxgraph/io/mxObjectCodec.html#idrefs"><code>idrefs</code></a> then
<a href="../../../com/mxgraph/io/mxCodec.html#getId-java.lang.Object-"><code>mxCodec.getId(Object)</code></a> is used to replace the object with its ID.
</li>
<li>The variable name is mapped using <a href="../../../com/mxgraph/io/mxObjectCodec.html#mapping"><code>mapping</code></a>.</li>
<li>If obj is an array and the variable name is numeric (ie. an index) then it
is not encoded.</li>
<li>If the value is an object, then the codec is used to create a child
node with the variable name encoded into the "as" attribute.</li>
<li>Else, if <a href="../../../com/mxgraph/io/mxCodec.html#isEncodeDefaults--"><code>mxCodec.isEncodeDefaults()</code></a> is true or
the value differs from the template value, then ...
<ul>
<li>... if obj is not an array, then the value is mapped to an
attribute.</li>
<li>... else if obj is an array, the value is mapped to an add child
with a value attribute or a text child node, if the value is a function.
</li>
</ul>
</li>
</ul>
If no ID exists for a variable in <a href="../../../com/mxgraph/io/mxObjectCodec.html#idrefs"><code>idrefs</code></a> or if an object cannot be
encoded, a warning is logged.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>enc</code> - Codec that controls the encoding process.</dd>
<dd><code>obj</code> - Object to be encoded.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Returns the resulting XML node that represents the given object.</dd>
</dl>
</li>
</ul>
<a name="encodeObject-com.mxgraph.io.mxCodec-java.lang.Object-org.w3c.dom.Node-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encodeObject</h4>
<pre>protected void encodeObject(<a href="../../../com/mxgraph/io/mxCodec.html" title="class in com.mxgraph.io">mxCodec</a> enc,
java.lang.Object obj,
org.w3c.dom.Node node)</pre>
<div class="block">Encodes the value of each member in then given obj
into the given node using <a href="../../../com/mxgraph/io/mxObjectCodec.html#encodeFields-com.mxgraph.io.mxCodec-java.lang.Object-org.w3c.dom.Node-"><code>encodeFields(mxCodec, Object, Node)</code></a>
and <a href="../../../com/mxgraph/io/mxObjectCodec.html#encodeElements-com.mxgraph.io.mxCodec-java.lang.Object-org.w3c.dom.Node-"><code>encodeElements(mxCodec, Object, Node)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>enc</code> - Codec that controls the encoding process.</dd>
<dd><code>obj</code> - Object to be encoded.</dd>
<dd><code>node</code> - XML node that contains the encoded object.</dd>
</dl>
</li>
</ul>
<a name="encodeFields-com.mxgraph.io.mxCodec-java.lang.Object-org.w3c.dom.Node-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encodeFields</h4>
<pre>protected void encodeFields(<a href="../../../com/mxgraph/io/mxCodec.html" title="class in com.mxgraph.io">mxCodec</a> enc,
java.lang.Object obj,
org.w3c.dom.Node node)</pre>
<div class="block">Encodes the declared fields of the given object into the given node.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>enc</code> - Codec that controls the encoding process.</dd>
<dd><code>obj</code> - Object whose fields should be encoded.</dd>
<dd><code>node</code> - XML node that contains the encoded object.</dd>
</dl>
</li>
</ul>
<a name="encodeElements-com.mxgraph.io.mxCodec-java.lang.Object-org.w3c.dom.Node-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encodeElements</h4>
<pre>protected void encodeElements(<a href="../../../com/mxgraph/io/mxCodec.html" title="class in com.mxgraph.io">mxCodec</a> enc,
java.lang.Object obj,
org.w3c.dom.Node node)</pre>
<div class="block">Encodes the child objects of arrays, maps and collections.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>enc</code> - Codec that controls the encoding process.</dd>
<dd><code>obj</code> - Object whose child objects should be encoded.</dd>
<dd><code>node</code> - XML node that contains the encoded object.</dd>
</dl>
</li>
</ul>
<a name="encodeValue-com.mxgraph.io.mxCodec-java.lang.Object-java.lang.String-java.lang.Object-org.w3c.dom.Node-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encodeValue</h4>
<pre>protected void encodeValue(<a href="../../../com/mxgraph/io/mxCodec.html" title="class in com.mxgraph.io">mxCodec</a> enc,
java.lang.Object obj,
java.lang.String fieldname,
java.lang.Object value,
org.w3c.dom.Node node)</pre>
<div class="block">Converts the given value according to the mappings
and id-refs in this codec and uses
<a href="../../../com/mxgraph/io/mxObjectCodec.html#writeAttribute-com.mxgraph.io.mxCodec-java.lang.Object-java.lang.String-java.lang.Object-org.w3c.dom.Node-"><code>writeAttribute(mxCodec, Object, String, Object, Node)</code></a>
to write the attribute into the given node.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>enc</code> - Codec that controls the encoding process.</dd>
<dd><code>obj</code> - Object whose field is going to be encoded.</dd>
<dd><code>fieldname</code> - Name if the field to be encoded.</dd>
<dd><code>value</code> - Value of the property to be encoded.</dd>
<dd><code>node</code> - XML node that contains the encoded object.</dd>
</dl>
</li>
</ul>
<a name="isPrimitiveValue-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPrimitiveValue</h4>
<pre>protected boolean isPrimitiveValue(java.lang.Object value)</pre>
<div class="block">Returns true if the given object is a primitive value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - Object that should be checked.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Returns true if the given object is a primitive value.</dd>
</dl>
</li>
</ul>
<a name="writeAttribute-com.mxgraph.io.mxCodec-java.lang.Object-java.lang.String-java.lang.Object-org.w3c.dom.Node-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeAttribute</h4>
<pre>protected void writeAttribute(<a href="../../../com/mxgraph/io/mxCodec.html" title="class in com.mxgraph.io">mxCodec</a> enc,
java.lang.Object obj,
java.lang.String attr,
java.lang.Object value,
org.w3c.dom.Node node)</pre>
<div class="block">Writes the given value into node using writePrimitiveAttribute
or writeComplexAttribute depending on the type of the value.</div>
</li>
</ul>
<a name="writePrimitiveAttribute-com.mxgraph.io.mxCodec-java.lang.Object-java.lang.String-java.lang.Object-org.w3c.dom.Node-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writePrimitiveAttribute</h4>
<pre>protected void writePrimitiveAttribute(<a href="../../../com/mxgraph/io/mxCodec.html" title="class in com.mxgraph.io">mxCodec</a> enc,
java.lang.Object obj,
java.lang.String attr,
java.lang.Object value,
org.w3c.dom.Node node)</pre>
<div class="block">Writes the given value as an attribute of the given node.</div>
</li>
</ul>
<a name="writeComplexAttribute-com.mxgraph.io.mxCodec-java.lang.Object-java.lang.String-java.lang.Object-org.w3c.dom.Node-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeComplexAttribute</h4>
<pre>protected void writeComplexAttribute(<a href="../../../com/mxgraph/io/mxCodec.html" title="class in com.mxgraph.io">mxCodec</a> enc,
java.lang.Object obj,
java.lang.String attr,
java.lang.Object value,
org.w3c.dom.Node node)</pre>
<div class="block">Writes the given value as a child node of the given node.</div>
</li>
</ul>
<a name="convertValueToXml-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>convertValueToXml</h4>
<pre>protected java.lang.Object convertValueToXml(java.lang.Object value)</pre>
<div class="block">Converts true to "1" and false to "0". All other values are ignored.</div>
</li>
</ul>