summaryrefslogtreecommitdiff
path: root/libjava/classpath/javax/swing/text/html/HTMLWriter.java
blob: 55d25ccbb6308f741a0c1ea65fce3f576896b21e (plain)
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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
/* HTMLWriter.java --
   Copyright (C) 2006 Free Software Foundation, Inc.

This file is part of GNU Classpath.

GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.

GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.

Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module.  An independent module is a module which is not derived from
or based on this library.  If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so.  If you do not wish to do so, delete this
exception statement from your version. */

package javax.swing.text.html;

import gnu.java.lang.CPStringBuilder;

import java.io.IOException;
import java.io.Writer;

import java.util.Enumeration;
import java.util.HashSet;

import javax.swing.ComboBoxModel;

import javax.swing.text.AbstractWriter;
import javax.swing.text.AttributeSet;
import javax.swing.text.BadLocationException;
import javax.swing.text.Document;
import javax.swing.text.Element;
import javax.swing.text.StyleConstants;

import javax.swing.text.html.HTML;
import javax.swing.text.html.HTMLDocument;
import javax.swing.text.html.Option;

/**
 * HTMLWriter,
 * A Writer for HTMLDocuments.
 *
 * @author David Fu (fchoong at netbeans.jp)
 */

public class HTMLWriter
  extends AbstractWriter
{
  /**
   * We keep a reference of the writer passed by the construct.
   */
  private Writer outWriter = null;

  /**
   * We keep a reference of the HTMLDocument passed by the construct.
   */
  private HTMLDocument htmlDoc = null;

  /**
   * Used to keep track of which embedded has been written out.
   */
  private HashSet<HTML.Tag> openEmbeddedTagHashSet = null;

  private String new_line_str = "" + NEWLINE;

  private char[] html_entity_char_arr = {'<',    '>',    '&',     '"'};

  private String[] html_entity_escape_str_arr = {"&lt;", "&gt;", "&amp;",
                                                 "&quot;"};

  // variables used to output Html Fragment
  private int doc_pos = -1;
  private int doc_len = -1;
  private int doc_offset_remaining = -1;
  private int doc_len_remaining = -1;
  private HashSet<Element> htmlFragmentParentHashSet = null;
  private Element startElem = null;
  private Element endElem = null;
  private boolean fg_pass_start_elem = false;
  private boolean fg_pass_end_elem = false;

  /**
   * Constructs a HTMLWriter.
   *
   * @param writer writer to write output to
   * @param doc the HTMLDocument to output
   */
  public HTMLWriter(Writer writer, HTMLDocument doc)
  {
    super(writer, doc);
    outWriter = writer;
    htmlDoc = doc;
    openEmbeddedTagHashSet = new HashSet<HTML.Tag>();
  } // public HTMLWriter(Writer writer, HTMLDocument doc)

  /**
   * Constructs a HTMLWriter which outputs a Html Fragment.
   *
   * @param writer <code>Writer</code> to write output to
   * @param doc the <code>javax.swing.text.html.HTMLDocument</code>
   *        to output
   * @param pos position to start outputing the document
   * @param len amount to output the document
   */
  public HTMLWriter(Writer writer, HTMLDocument doc, int pos, int len)
  {
    super(writer, doc, pos, len);
    outWriter = writer;
    htmlDoc = doc;
    openEmbeddedTagHashSet = new HashSet<HTML.Tag>();

    doc_pos = pos;
    doc_offset_remaining = pos;
    doc_len = len;
    doc_len_remaining = len;
    htmlFragmentParentHashSet = new HashSet<Element>();
  } // public HTMLWriter(Writer writer, HTMLDocument doc, int pos, int len)

  /**
   * Call this method to start outputing HTML.
   *
   * @throws IOException on any I/O exceptions
   * @throws BadLocationException if a pos is not a valid position in the
   *                              html doc element
   */
  public void write()
    throws IOException, BadLocationException
  {
    Element rootElem = htmlDoc.getDefaultRootElement();

    if (doc_pos == -1 && doc_len == -1)
      {
        // Normal traversal.
        traverse(rootElem);
      } // if(doc_pos == -1 && doc_len == -1)
    else
      {
        // Html fragment traversal.
        if (doc_pos == -1 || doc_len == -1)
          throw new BadLocationException("Bad Location("
          + doc_pos + ", " + doc_len + ")", doc_pos);

        startElem = htmlDoc.getCharacterElement(doc_pos);

        int start_offset = startElem.getStartOffset();

        // Positions before start_offset will not be traversed, and thus
        // will not be counted.
        if (start_offset > 0)
          doc_offset_remaining = doc_offset_remaining - start_offset;

        Element tempParentElem = startElem;

        while ((tempParentElem = tempParentElem.getParentElement()) != null)
          {
            if (!htmlFragmentParentHashSet.contains(tempParentElem))
              htmlFragmentParentHashSet.add(tempParentElem);
          } // while((tempParentElem = tempParentElem.getParentElement())
            //   != null)

        // NOTE: 20061030 - fchoong - the last index should not be included.
        endElem = htmlDoc.getCharacterElement(doc_pos + doc_len - 1);

        tempParentElem = endElem;

        while ((tempParentElem = tempParentElem.getParentElement()) != null)
          {
            if (!htmlFragmentParentHashSet.contains(tempParentElem))
              htmlFragmentParentHashSet.add(tempParentElem);
          } // while((tempParentElem = tempParentElem.getParentElement())
            //   != null)

        traverseHtmlFragment(rootElem);

      } // else

    // NOTE: close out remaining open embeded tags.
    HTML.Tag[] tag_arr =
      openEmbeddedTagHashSet.toArray(new HTML.Tag[openEmbeddedTagHashSet.size()]);

    for (int i = 0; i < tag_arr.length; i++)
      {
        writeRaw("</" + tag_arr[i].toString() + ">");
      } // for(int i = 0; i < tag_arr.length; i++)

  } // public void write() throws IOException, BadLocationException

  /**
   * Writes all the attributes in the attrSet, except for attrbutes with
   * keys of <code>javax.swing.text.html.HTML.Tag</code>,
   * <code>javax.swing.text.StyleConstants</code> or
   * <code>javax.swing.text.html.HTML.Attribute.ENDTAG</code>.
   *
   * @param attrSet attrSet to write out
   *
   * @throws IOException on any I/O exceptions
   */
  protected void writeAttributes(AttributeSet attrSet)
    throws IOException
  {
    Enumeration<?> attrNameEnum = attrSet.getAttributeNames();

    while (attrNameEnum.hasMoreElements())
      {
        Object key = attrNameEnum.nextElement();
        Object value = attrSet.getAttribute(key);

        // HTML.Attribute.ENDTAG is an instance, not a class.
        if (!((key instanceof HTML.Tag) || (key instanceof StyleConstants)
          || (key == HTML.Attribute.ENDTAG)))
          {
            if (key == HTML.Attribute.SELECTED)
              writeRaw(" selected");
            else if (key == HTML.Attribute.CHECKED)
              writeRaw(" checked");
            else
              writeRaw(" " + key + "=\"" + value + "\"");
          } // if(!((key instanceof HTML.Tag) || (key instanceof
            //   StyleConstants) || (key == HTML.Attribute.ENDTAG)))
      } // while(attrNameEnum.hasMoreElements())

  } // protected void writeAttributes(AttributeSet attrSet) throws IOException

  /**
   * Writes out an empty tag. i.e. a tag without any child elements.
   *
   * @param paramElem the element to output as an empty tag
   *
   * @throws IOException on any I/O exceptions
   * @throws BadLocationException if a pos is not a valid position in the
   *                              html doc element
   */
  protected void emptyTag(Element paramElem)
    throws IOException, BadLocationException
  {
    String elem_name = paramElem.getName();
    AttributeSet attrSet = paramElem.getAttributes();

    writeRaw("<" + elem_name);
    writeAttributes(attrSet);
    writeRaw(">");

    if (isBlockTag(attrSet))
      {
        writeRaw("</" + elem_name + ">");
      } // if(isBlockTag(attrSet))

  } // protected void emptyTag(Element paramElem)
    //   throws IOException, BadLocationException

  /**
   * Determines if it is a block tag or not.
   *
   * @param attrSet the attrSet of the element
   *
   * @return <code>true</code> if it is a block tag
   *         <code>false</code> if it is a not block tag
   */
  protected boolean isBlockTag(AttributeSet attrSet)
  {
    return ((HTML.Tag)
      attrSet.getAttribute(StyleConstants.NameAttribute)).isBlock();
  } // protected boolean isBlockTag(AttributeSet attrSet)

  /**
   * Writes out a start tag. Synthesized elements are skipped.
   *
   * @param paramElem the element to output as a start tag
   * @throws IOException on any I/O exceptions
   * @throws BadLocationException if a pos is not a valid position in the
   *                              html doc element
   */
  protected void startTag(Element paramElem)
    throws IOException, BadLocationException
  {
    // NOTE: Sysnthesized elements do no call this method at all.
    String elem_name = paramElem.getName();
    AttributeSet attrSet = paramElem.getAttributes();

    indent();
    writeRaw("<" + elem_name);
    writeAttributes(attrSet);
    writeRaw(">");
    writeLineSeparator(); // Extra formatting to look more like the RI.
    incrIndent();

  } // protected void startTag(Element paramElem)
    //   throws IOException, BadLocationException

  /**
   * Writes out the contents of a textarea.
   *
   * @param attrSet the attrSet of the element to output as a text area
   * @throws IOException on any I/O exceptions
   * @throws BadLocationException if a pos is not a valid position in the
   *                              html doc element
   */
  protected void textAreaContent(AttributeSet attrSet)
    throws IOException, BadLocationException
  {
    writeLineSeparator(); // Extra formatting to look more like the RI.
    indent();
    writeRaw("<textarea");
    writeAttributes(attrSet);
    writeRaw(">");

    Document tempDocument =
      (Document) attrSet.getAttribute(StyleConstants.ModelAttribute);

    writeRaw(tempDocument.getText(0, tempDocument.getLength()));
    indent();
    writeRaw("</textarea>");

  } // protected void textAreaContent(AttributeSet attrSet)
    //   throws IOException, BadLocationException

  /**
   * Writes out text, within the appropriate range if it is specified.
   *
   * @param paramElem the element to output as a text
   * @throws IOException on any I/O exceptions
   * @throws BadLocationException if a pos is not a valid position in the
   *                              html doc element
   */
  protected void text(Element paramElem)
    throws IOException, BadLocationException
  {
    int offset =  paramElem.getStartOffset();
    int len =  paramElem.getEndOffset() -  paramElem.getStartOffset();
    String txt_value = htmlDoc.getText(offset, len);

    writeContent(txt_value);

  } // protected void text(Element paramElem)
    //   throws IOException, BadLocationException

  /**
   * Writes out the contents of a select element.
   *
   * @param attrSet the attrSet of the element to output as a select box
   *
   * @throws IOException on any I/O exceptions
   */
  protected void selectContent(AttributeSet attrSet)
    throws IOException
  {
    writeLineSeparator(); // Extra formatting to look more like the RI.
    indent();
    writeRaw("<select");
    writeAttributes(attrSet);
    writeRaw(">");
    incrIndent();
    writeLineSeparator(); // extra formatting to look more like the RI.

    ComboBoxModel comboBoxModel =
      (ComboBoxModel) attrSet.getAttribute(StyleConstants.ModelAttribute);

    for (int i = 0; i < comboBoxModel.getSize(); i++)
      {
        writeOption((Option) comboBoxModel.getElementAt(i));
      } // for(int i = 0; i < comboBoxModel.getSize(); i++)

    decrIndent();
    indent();
    writeRaw("</select>");

  } // protected void selectContent(AttributeSet attrSet) throws IOException

  /**
   * Writes out the contents of an option element.
   *
   * @param option the option object to output as a select option
   *
   * @throws IOException on any I/O exceptions
   */
  protected void writeOption(Option option)
    throws IOException
  {
    indent();
    writeRaw("<option");
    writeAttributes(option.getAttributes());
    writeRaw(">");

    writeContent(option.getLabel());

    writeRaw("</option>");
    writeLineSeparator(); // extra formatting to look more like the RI.

  } // protected void writeOption(Option option) throws IOException

  /**
   * Writes out an end tag.
   *
   * @param paramElem the element to output as an end tag
   *
   * @throws IOException on any I/O exceptions
   */
  protected void endTag(Element paramElem)
    throws IOException
  {
    String elem_name = paramElem.getName();

    //writeLineSeparator(); // Extra formatting to look more like the RI.
    decrIndent();
    indent();
    writeRaw("</" + elem_name + ">");
    writeLineSeparator(); // Extra formatting to look more like the RI.

  } // protected void endTag(Element paramElem) throws IOException

  /**
   * Writes out the comment.
   *
   * @param paramElem the element to output as a comment
   */
  protected void comment(Element paramElem)
    throws IOException, BadLocationException
  {
    AttributeSet attrSet = paramElem.getAttributes();

    String comment_str = (String) attrSet.getAttribute(HTML.Attribute.COMMENT);

    writeRaw("<!--" + comment_str + "-->");

  } // protected void comment(Element paramElem)
    //   throws IOException, BadLocationException

  /**
   * Determines if element is a synthesized
   * <code>javax.swing.text.Element</code> or not.
   *
   * @param element the element to test
   *
   * @return <code>true</code> if it is a synthesized element,
   *         <code>false</code> if it is a not synthesized element
   */
  protected boolean synthesizedElement(Element element)
  {
    AttributeSet attrSet = element.getAttributes();
    Object tagType = attrSet.getAttribute(StyleConstants.NameAttribute);

    if (tagType == HTML.Tag.CONTENT || tagType == HTML.Tag.COMMENT
        || tagType == HTML.Tag.IMPLIED)
      return true;
    else
      return false;
  } // protected boolean synthesizedElement(Element element)

  /**
   * Determines if
   * <code>javax.swing.text.StyleConstants.NameAttribute</code>
   * matches tag or not.
   *
   * @param attrSet the <code>javax.swing.text.AttributeSet</code> of
   *        element to be matched
   * @param tag the HTML.Tag to match
   *
   * @return <code>true</code> if it matches,
   *         <code>false</code> if it does not match
   */
  protected boolean matchNameAttribute(AttributeSet attrSet, HTML.Tag tag)
  {
    Object tagType = attrSet.getAttribute(StyleConstants.NameAttribute);

    if (tagType == tag)
      return true;
    else
      return false;
  } // protected boolean matchNameAttribute(AttributeSet attrSet,
    //   HTML.Tag tag)

  /**
   * Writes out an embedded tag. The tags not already in
   * openEmbededTagHashSet will written out.
   *
   * @param attrSet the <code>javax.swing.text.AttributeSet</code> of
   *        the element to write out
   *
   * @throws IOException on any I/O exceptions
   */
  protected void writeEmbeddedTags(AttributeSet attrSet)
    throws IOException
  {
    Enumeration<?> attrNameEnum = attrSet.getAttributeNames();

    while (attrNameEnum.hasMoreElements())
      {
        Object key = attrNameEnum.nextElement();
        Object value = attrSet.getAttribute(key);

        if (key instanceof HTML.Tag)
          {
            if (!openEmbeddedTagHashSet.contains(key))
              {
                writeRaw("<" + key);
                writeAttributes((AttributeSet) value);
                writeRaw(">");
                openEmbeddedTagHashSet.add((HTML.Tag) key);
              } // if(!openEmbededTagHashSet.contains(key))
          } // if(key instanceof HTML.Tag)
      } // while(attrNameEnum.hasMoreElements())

  } // protected void writeEmbeddedTags(AttributeSet attrSet)
    //   throws IOException

  /**
   * Closes out an unwanted embedded tag. The tags from the
   *  openEmbededTagHashSet not found in attrSet will be written out.
   *
   *  @param attrSet the AttributeSet of the element to write out
   *
   *  @throws IOException on any I/O exceptions
   */
  protected void closeOutUnwantedEmbeddedTags(AttributeSet attrSet)
    throws IOException
  {
    HTML.Tag[] tag_arr =
      openEmbeddedTagHashSet.toArray(new HTML.Tag[openEmbeddedTagHashSet.size()]);

    for (int i = 0; i < tag_arr.length; i++)
      {
        HTML.Tag key = tag_arr[i];

        if (!attrSet.isDefined(key))
          {
            writeRaw("</" + key.toString() + ">");
            openEmbeddedTagHashSet.remove(key);
          } // if(!attrSet.isDefined(key))
      } // for(int i = 0; i < tag_arr.length; i++)

  } // protected void closeOutUnwantedEmbeddedTags(AttributeSet attrSet)
    //   throws IOException

  /**
   * Writes out a line separator. Overwrites the parent to write out a new
   * line.
   *
   * @throws IOException on any I/O exceptions.
   */
  protected void writeLineSeparator()
    throws IOException
  {
    writeRaw(new_line_str);
  } // protected void writeLineSeparator() throws IOException

  /**
   * Write to the writer. Character entites such as &lt;, &gt;
   * are escaped appropriately.
   *
   * @param chars char array to write out
   * @param off offset
   * @param len length
   *
   * @throws IOException on any I/O exceptions
   */
  protected void output(char[] chars, int off, int len)
   throws IOException
  {
    CPStringBuilder strBuffer = new CPStringBuilder();

    for (int i = 0; i < chars.length; i++)
      {
        if (isCharHtmlEntity(chars[i]))
          strBuffer.append(escapeCharHtmlEntity(chars[i]));
        else
          strBuffer.append(chars[i]);
      } // for(int i = 0; i < chars.length; i++)

    writeRaw(strBuffer.toString());

  } // protected void output(char[] chars, int off, int len)
    //   throws IOException

  //-------------------------------------------------------------------------
  // private methods

  /**
   * The main method used to traverse through the elements.
   *
   * @param paramElem element to traverse
   *
   * @throws IOException on any I/O exceptions
   */
  private void traverse(Element paramElem)
    throws IOException, BadLocationException
  {
    Element currElem = paramElem;

    AttributeSet attrSet = currElem.getAttributes();

    closeOutUnwantedEmbeddedTags(attrSet);

    // handle the tag
    if (synthesizedElement(paramElem))
      {
        if (matchNameAttribute(attrSet, HTML.Tag.CONTENT))
          {
            writeEmbeddedTags(attrSet);
            text(currElem);
          } // if(matchNameAttribute(attrSet, HTML.Tag.CONTENT))
        else if (matchNameAttribute(attrSet, HTML.Tag.COMMENT))
          {
            comment(currElem);
          } // else if(matchNameAttribute(attrSet, HTML.Tag.COMMENT))
        else if (matchNameAttribute(attrSet, HTML.Tag.IMPLIED))
          {
            int child_elem_count = currElem.getElementCount();

            if (child_elem_count > 0)
              {
                for (int i = 0; i < child_elem_count; i++)
                  {
                    Element childElem = paramElem.getElement(i);

                    traverse(childElem);

                  } // for(int i = 0; i < child_elem_count; i++)
              } // if(child_elem_count > 0)
          } // else if(matchNameAttribute(attrSet, HTML.Tag.IMPLIED))
      } // if(synthesizedElement(paramElem))
    else
      {
        // NOTE: 20061030 - fchoong - title is treated specially here.
        // based on RI behavior.
        if (matchNameAttribute(attrSet, HTML.Tag.TITLE))
          {
            boolean fg_is_end_tag = false;
            Enumeration<?> attrNameEnum = attrSet.getAttributeNames();

            while (attrNameEnum.hasMoreElements())
              {
                Object key = attrNameEnum.nextElement();
                Object value = attrSet.getAttribute(key);

                if (key == HTML.Attribute.ENDTAG && value.equals("true"))
                  fg_is_end_tag = true;
              } // while(attrNameEnum.hasMoreElements())

            if (fg_is_end_tag)
              writeRaw("</title>");
            else
              {
                indent();
                writeRaw("<title>");

                String title_str =
                  (String) htmlDoc.getProperty(HTMLDocument.TitleProperty);

                if (title_str != null)
                  writeContent(title_str);

              } // else
          } // if(matchNameAttribute(attrSet, HTML.Tag.TITLE))
        else if (matchNameAttribute(attrSet, HTML.Tag.PRE))
          {
            // We pursue more stringent formating here.
            attrSet = paramElem.getAttributes();

            indent();
            writeRaw("<pre");
            writeAttributes(attrSet);
            writeRaw(">");

            int child_elem_count = currElem.getElementCount();

            for (int i = 0; i < child_elem_count; i++)
              {
                Element childElem = paramElem.getElement(i);

                traverse(childElem);

              } // for(int i = 0; i < child_elem_count; i++)

            writeRaw("</pre>");

          } // else if(matchNameAttribute(attrSet, HTML.Tag.PRE))
        else if (matchNameAttribute(attrSet, HTML.Tag.SELECT))
          {
            selectContent(attrSet);
          } // else if(matchNameAttribute(attrSet, HTML.Tag.SELECT))
        else if (matchNameAttribute(attrSet, HTML.Tag.TEXTAREA))
          {
            textAreaContent(attrSet);
          } // else if(matchNameAttribute(attrSet, HTML.Tag.TEXTAREA))
        else
          {
            int child_elem_count = currElem.getElementCount();

            if (child_elem_count > 0)
              {
                startTag(currElem);

                for (int i = 0; i < child_elem_count; i++)
                  {
                    Element childElem = paramElem.getElement(i);

                    traverse(childElem);

                  } // for(int i = 0; i < child_elem_count; i++)

                  endTag(currElem);

              } // if(child_elem_count > 0)
            else
              {
                emptyTag(currElem);
              } // else
            } // else
          } // else

  } // private void traverse(Element paramElem)
    //   throws IOException, BadLocationException

  /**
   * The method used to traverse through a html fragment.
   *
   * @param paramElem element to traverse
   *
   * @throws IOException on any I/O exceptions
   */
  private void traverseHtmlFragment(Element paramElem)
    throws IOException, BadLocationException
  {
    // NOTE: This method is similar to traverse(Element paramElem)
    Element currElem = paramElem;

    boolean fg_is_fragment_parent_elem = false;
    boolean fg_is_start_and_end_elem = false;

    if (htmlFragmentParentHashSet.contains(paramElem))
      fg_is_fragment_parent_elem = true;

    if (paramElem == startElem)
      fg_pass_start_elem = true;

    if (paramElem == startElem && paramElem == endElem)
      fg_is_start_and_end_elem = true;

    AttributeSet attrSet = currElem.getAttributes();

    closeOutUnwantedEmbeddedTags(attrSet);

    if (fg_is_fragment_parent_elem || (fg_pass_start_elem
        && fg_pass_end_elem == false) || fg_is_start_and_end_elem)
    {
      // handle the tag
      if (synthesizedElement(paramElem))
        {
          if (matchNameAttribute(attrSet, HTML.Tag.CONTENT))
            {
              writeEmbeddedTags(attrSet);

              int content_offset =  paramElem.getStartOffset();
              int content_length = currElem.getEndOffset() - content_offset;

              if (doc_offset_remaining > 0)
                {
                  if (content_length > doc_offset_remaining)
                    {
                      int split_len = content_length;

                      split_len = split_len - doc_offset_remaining;

                      if (split_len > doc_len_remaining)
                        split_len = doc_len_remaining;

                      // we need to split it.
                      String txt_value = htmlDoc.getText(content_offset
                        + doc_offset_remaining, split_len);

                      writeContent(txt_value);

                      doc_offset_remaining = 0; // the offset is used up.
                      doc_len_remaining = doc_len_remaining - split_len;
                    } // if(content_length > doc_offset_remaining)
                  else
                    {
                      // doc_offset_remaining is greater than the entire
                      //   length of content
                      doc_offset_remaining = doc_offset_remaining
                        - content_length;
                    }  // else
                } // if(doc_offset_remaining > 0)
              else if (content_length <= doc_len_remaining)
                {
                  // we can fit the entire content.
                  text(currElem);
                  doc_len_remaining = doc_len_remaining - content_length;
                } // else if(content_length <= doc_len_remaining)
              else
                {
                  // we need to split it.
                  String txt_value = htmlDoc.getText(content_offset,
                    doc_len_remaining);

                  writeContent(txt_value);

                  doc_len_remaining = 0;
                } // else

            } // if(matchNameAttribute(attrSet, HTML.Tag.CONTENT))
          else if (matchNameAttribute(attrSet, HTML.Tag.COMMENT))
            {
              comment(currElem);
            } // else if(matchNameAttribute(attrSet, HTML.Tag.COMMENT))
          else if (matchNameAttribute(attrSet, HTML.Tag.IMPLIED))
            {
              int child_elem_count = currElem.getElementCount();

              if (child_elem_count > 0)
                {
                  for (int i = 0; i < child_elem_count; i++)
                    {
                      Element childElem = paramElem.getElement(i);

                      traverseHtmlFragment(childElem);

                    } // for(int i = 0; i < child_elem_count; i++)
                } // if(child_elem_count > 0)
            } // else if(matchNameAttribute(attrSet, HTML.Tag.IMPLIED))
        } // if(synthesizedElement(paramElem))
      else
        {
            // NOTE: 20061030 - fchoong - the isLeaf() condition seems to
            // generate the closest behavior to the RI.
            if (paramElem.isLeaf())
              {
                if (doc_offset_remaining > 0)
                  {
                    doc_offset_remaining--;
                  } // if(doc_offset_remaining > 0)
                else if (doc_len_remaining > 0)
                  {
                    doc_len_remaining--;
                  } // else if(doc_len_remaining > 0)
              } // if(paramElem.isLeaf())

          // NOTE: 20061030 - fchoong - title is treated specially here.
          // based on RI behavior.
          if (matchNameAttribute(attrSet, HTML.Tag.TITLE))
            {
              boolean fg_is_end_tag = false;
              Enumeration<?> attrNameEnum = attrSet.getAttributeNames();

              while (attrNameEnum.hasMoreElements())
                {
                  Object key = attrNameEnum.nextElement();
                  Object value = attrSet.getAttribute(key);

                  if (key == HTML.Attribute.ENDTAG && value.equals("true"))
                    fg_is_end_tag = true;
                } // while(attrNameEnum.hasMoreElements())

              if (fg_is_end_tag)
                writeRaw("</title>");
              else
                {
                  indent();
                  writeRaw("<title>");

                  String title_str =
                    (String) htmlDoc.getProperty(HTMLDocument.TitleProperty);

                  if (title_str != null)
                    writeContent(title_str);

                } // else
            } // if(matchNameAttribute(attrSet, HTML.Tag.TITLE))
          else if (matchNameAttribute(attrSet, HTML.Tag.PRE))
            {
              // We pursue more stringent formating here.
              attrSet = paramElem.getAttributes();

              indent();
              writeRaw("<pre");
              writeAttributes(attrSet);
              writeRaw(">");

              int child_elem_count = currElem.getElementCount();

              for (int i = 0; i < child_elem_count; i++)
                {
                  Element childElem = paramElem.getElement(i);

                  traverseHtmlFragment(childElem);

                } // for(int i = 0; i < child_elem_count; i++)

              writeRaw("</pre>");

            } // else if(matchNameAttribute(attrSet, HTML.Tag.PRE))
          else if (matchNameAttribute(attrSet, HTML.Tag.SELECT))
            {
              selectContent(attrSet);
            } // else if(matchNameAttribute(attrSet, HTML.Tag.SELECT))
          else if (matchNameAttribute(attrSet, HTML.Tag.TEXTAREA))
            {
              textAreaContent(attrSet);
            } // else if(matchNameAttribute(attrSet, HTML.Tag.TEXTAREA))
          else
            {
              int child_elem_count = currElem.getElementCount();

              if (child_elem_count > 0)
                {
                  startTag(currElem);

                  for (int i = 0; i < child_elem_count; i++)
                    {
                      Element childElem = paramElem.getElement(i);

                      traverseHtmlFragment(childElem);

                    } // for(int i = 0; i < child_elem_count; i++)

                    endTag(currElem);

                } // if(child_elem_count > 0)
              else
                {
                  emptyTag(currElem);
                } // else
            } // else
        } // else

    } // if(fg_is_fragment_parent_elem || (fg_pass_start_elem
      //   && fg_pass_end_elem == false) || fg_is_start_and_end_elem)

    if (paramElem == endElem)
      fg_pass_end_elem = true;

  } // private void traverseHtmlFragment(Element paramElem)
    //   throws IOException, BadLocationException

  /**
   * Write to the writer without any modifications.
   *
   * @param param_str the str to write out
   *
   * @throws IOException on any I/O exceptions
   */
  private void writeRaw(String param_str)
    throws IOException
  {
    super.output(param_str.toCharArray(), 0, param_str.length());
  } // private void writeRaw(char[] chars, int off, int len)
    //   throws IOException

  /**
   * Write to the writer, escaping HTML character entitie where neccessary.
   *
   * @param param_str the str to write out
   *
   * @throws IOException on any I/O exceptions
   */
  private void writeContent(String param_str)
    throws IOException
  {
    char[] str_char_arr = param_str.toCharArray();

    if (hasHtmlEntity(param_str))
      output(str_char_arr, 0, str_char_arr.length);
    else
      super.output(str_char_arr, 0, str_char_arr.length);

  } // private void writeContent(String param_str) throws IOException

  /**
   * Use this for debugging. Writes out all attributes regardless of type.
   *
   * @param attrSet the <code>javax.swing.text.AttributeSet</code> to
   *        write out
   *
   * @throws IOException on any I/O exceptions
   */
  private void writeAllAttributes(AttributeSet attrSet)
    throws IOException
  {
    Enumeration<?> attrNameEnum = attrSet.getAttributeNames();

    while (attrNameEnum.hasMoreElements())
      {
        Object key = attrNameEnum.nextElement();
        Object value = attrSet.getAttribute(key);

        writeRaw(" " + key + "=\"" + value + "\"");
        writeRaw(" " + key.getClass().toString() + "=\""
          + value.getClass().toString() + "\"");
      } // while(attrNameEnum.hasMoreElements())

  } // private void writeAllAttributes(AttributeSet attrSet)
    //   throws IOException

  /**
   * Tests if the str contains any html entities.
   *
   * @param param_str the str to test
   *
   * @return <code>true</code> if it has a html entity
   *         <code>false</code> if it does not have a html entity
   */
  private boolean hasHtmlEntity(String param_str)
  {
    boolean ret_bool = false;

    for (int i = 0; i < html_entity_char_arr.length; i++)
      {
        if (param_str.indexOf(html_entity_char_arr[i]) != -1)
          {
            ret_bool = true;
            break;
          } // if(param_str.indexOf(html_entity_char_arr[i]) != -1)
      } // for(int i = 0; i < html_entity_char_arr.length; i++)

    return ret_bool;
  } // private boolean hasHtmlEntity(String param_str)

  /**
   * Tests if the char is a html entities.
   *
   * @param param_char the char to test
   *
   * @return <code>true</code> if it is a html entity
   *         <code>false</code> if it is not a html entity.
   */
  private boolean isCharHtmlEntity(char param_char)
  {
    boolean ret_bool = false;

    for (int i = 0; i < html_entity_char_arr.length; i++)
      {
        if (param_char == html_entity_char_arr[i])
          {
            ret_bool = true;
            break;
          } // if(param_char == html_entity_char_arr[i])
      } // for(int i = 0; i < html_entity_char_arr.length; i++)

      return ret_bool;
  } // private boolean hasHtmlEntity(String param_str)

  /**
   * Escape html entities.
   *
   * @param param_char the char to escape
   *
   * @return escaped html entity. Original char is returned as a str if is
   *         is not a html entity
   */
  private String escapeCharHtmlEntity(char param_char)
  {
    String ret_str = "" + param_char;

    for (int i = 0; i < html_entity_char_arr.length; i++)
      {
        if (param_char == html_entity_char_arr[i])
          {
            ret_str = html_entity_escape_str_arr[i];
            break;
          } // if(param_char == html_entity_char_arr[i])
      } // for(int i = 0; i < html_entity_char_arr.length; i++)

      return ret_str;
  } // private String escapeCharHtmlEntity(char param_char)

} // public class HTMLWriter extends AbstractWriter