• List Item

• List Item

• List Item

The reader can be configured by registering actions (of type HTMLDocument.HTMLReader.TagAction) that describe how to handle the action. The idea behind the actions provided is that the most natural text editing operations can be provided if the element structure boils down to paragraphs with runs of some kind of style in them. Some things are more naturally specified structurally, so arbitrary structure should be allowed above the paragraphs, but will need to be edited with structural actions. The implication of this is that some of the HTML elements specified in the stream being parsed will be collapsed into attributes, and in some cases paragraphs will be synthesized. When HTML elements have been converted to attributes, the attribute key will be of type HTML.Tag, and the value will be of type AttributeSet so that no information is lost. This enables many of the existing actions to work so that the user can type input, hit the return key, backspace, delete, etc and have a reasonable result. Selections can be created, and attributes applied or removed, etc. With this in mind, the work done by the reader can be categorized into the following kinds of tasks:

Block

Build the structure like it's specified in the stream. This produces elements that contain other elements.

Paragraph

Like block except that it's expected that the element will be used with a paragraph view so a paragraph element won't need to be synthesized.

Character

Contribute the element as an attribute that will start and stop at arbitrary text locations. This will ultimately be mixed into a run of text, with all of the currently flattened HTML character elements.

Special

Produce an embedded graphical element.

Form

Produce an element that is like the embedded graphical element, except that it also has a component model associated with it.

Hidden

Create an element that is hidden from view when the document is being viewed read-only, and visible when the document is being edited. This is useful to keep the model from losing information, and used to store things like comments and unrecognized tags.

Currently, <APPLET>, <PARAM>, <MAP>, <AREA>, <LINK>, <SCRIPT> and <STYLE> are unsupported.

The assignment of the actions described is shown in the following table for the tags defined in HTML.Tag.

Tag	Action
HTML.Tag.A	CharacterAction
HTML.Tag.ADDRESS	CharacterAction
HTML.Tag.APPLET	HiddenAction
HTML.Tag.AREA	AreaAction
HTML.Tag.B	CharacterAction
HTML.Tag.BASE	BaseAction
HTML.Tag.BASEFONT	CharacterAction
HTML.Tag.BIG	CharacterAction
HTML.Tag.BLOCKQUOTE	BlockAction
HTML.Tag.BODY	BlockAction
HTML.Tag.BR	SpecialAction
HTML.Tag.CAPTION	BlockAction
HTML.Tag.CENTER	BlockAction
HTML.Tag.CITE	CharacterAction
HTML.Tag.CODE	CharacterAction
HTML.Tag.DD	BlockAction
HTML.Tag.DFN	CharacterAction
HTML.Tag.DIR	BlockAction
HTML.Tag.DIV	BlockAction
HTML.Tag.DL	BlockAction
HTML.Tag.DT	ParagraphAction
HTML.Tag.EM	CharacterAction
HTML.Tag.FONT	CharacterAction
HTML.Tag.FORM	As of 1.4 a BlockAction
HTML.Tag.FRAME	SpecialAction
HTML.Tag.FRAMESET	BlockAction
HTML.Tag.H1	ParagraphAction
HTML.Tag.H2	ParagraphAction
HTML.Tag.H3	ParagraphAction
HTML.Tag.H4	ParagraphAction
HTML.Tag.H5	ParagraphAction
HTML.Tag.H6	ParagraphAction
HTML.Tag.HEAD	HeadAction
HTML.Tag.HR	SpecialAction
HTML.Tag.HTML	BlockAction
HTML.Tag.I	CharacterAction
HTML.Tag.IMG	SpecialAction
HTML.Tag.INPUT	FormAction
HTML.Tag.ISINDEX	IsndexAction
HTML.Tag.KBD	CharacterAction
HTML.Tag.LI	BlockAction
HTML.Tag.LINK	LinkAction
HTML.Tag.MAP	MapAction
HTML.Tag.MENU	BlockAction
HTML.Tag.META	MetaAction
HTML.Tag.NOFRAMES	BlockAction
HTML.Tag.OBJECT	SpecialAction
HTML.Tag.OL	BlockAction
HTML.Tag.OPTION	FormAction
HTML.Tag.P	ParagraphAction
HTML.Tag.PARAM	HiddenAction
HTML.Tag.PRE	PreAction
HTML.Tag.SAMP	CharacterAction
HTML.Tag.SCRIPT	HiddenAction
HTML.Tag.SELECT	FormAction
HTML.Tag.SMALL	CharacterAction
HTML.Tag.STRIKE	CharacterAction
HTML.Tag.S	CharacterAction
HTML.Tag.STRONG	CharacterAction
HTML.Tag.STYLE	StyleAction
HTML.Tag.SUB	CharacterAction
HTML.Tag.SUP	CharacterAction
HTML.Tag.TABLE	BlockAction
HTML.Tag.TD	BlockAction
HTML.Tag.TEXTAREA	FormAction
HTML.Tag.TH	BlockAction
HTML.Tag.TITLE	TitleAction
HTML.Tag.TR	BlockAction
HTML.Tag.TT	CharacterAction
HTML.Tag.U	CharacterAction
HTML.Tag.UL	BlockAction
HTML.Tag.VAR	CharacterAction

Once </html> is encountered, the Actions are no longer notified. 

 public HTMLDocument() 
{
        this(new GapContent(BUFFER_SIZE_DEFAULT), new StyleSheet());
}

Constructs an HTML document using the default buffer size and a default StyleSheet. This is a convenience method for the constructor HTMLDocument(Content, StyleSheet).

 public HTMLDocument(StyleSheet styles) 
{
        this(new GapContent(BUFFER_SIZE_DEFAULT), styles);
}

Constructs an HTML document with the default content storage implementation and the specified style/attribute storage mechanism. This is a convenience method for the constructor HTMLDocument(Content, StyleSheet).

Parameters:

styles - the styles

 public HTMLDocument(Content c,
    StyleSheet styles) 
{
        super(c, styles);
}

Constructs an HTML document with the given content storage implementation and the given style/attribute storage mechanism.

Parameters:

c - the container for the content

styles - the styles

  void addMap(Map map) 
{
        String     name = map.getName();
        if (name != null) {
            Object     maps = getProperty(MAP_PROPERTY);
            if (maps == null) {
                maps = new Hashtable(11);
                putProperty(MAP_PROPERTY, maps);
            }
            if (maps instanceof Hashtable) {
                ((Hashtable)maps).put("#" + name, map);
            }
        }
}

Adds the specified map, this will remove a Map that has been previously registered with the same name.

 protected  void create(ElementSpec[] data) 
{
        super.create(data);
}

Replaces the contents of the document with the given element specifications. This is called before insert if the loading is done in bursts. This is the only method called if loading the document entirely in one burst.

 protected Element createBranchElement(Element parent,
    AttributeSet a) 
{
        return new BlockElement(parent, a);
}

Creates a document branch element, that can contain other elements. This is implemented to return an element of type HTMLDocument.BlockElement.

 protected AbstractElement createDefaultRoot() 
{
        // grabs a write-lock for this initialization and
        // abandon it during initialization so in normal
        // operation we can detect an illegitimate attempt
        // to mutate attributes.
        writeLock();
        MutableAttributeSet a = new SimpleAttributeSet();
        a.addAttribute(StyleConstants.NameAttribute, HTML.Tag.HTML);
        BlockElement html = new BlockElement(null, a.copyAttributes());
        a.removeAttributes(a);
        a.addAttribute(StyleConstants.NameAttribute, HTML.Tag.BODY);
        BlockElement body = new BlockElement(html, a.copyAttributes());
        a.removeAttributes(a);
        a.addAttribute(StyleConstants.NameAttribute, HTML.Tag.P);
        getStyleSheet().addCSSAttributeFromHTML(a, CSS.Attribute.MARGIN_TOP, "0");
        BlockElement paragraph = new BlockElement(body, a.copyAttributes());
        a.removeAttributes(a);
        a.addAttribute(StyleConstants.NameAttribute, HTML.Tag.CONTENT);
        RunElement brk = new RunElement(paragraph, a, 0, 1);
        Element[] buff = new Element[1];
        buff[0] = brk;
        paragraph.replace(0, 0, buff);
        buff[0] = paragraph;
        body.replace(0, 0, buff);
        buff[0] = body;
        html.replace(0, 0, buff);
        writeUnlock();
        return html;
}

Creates the root element to be used to represent the default document structure.

 protected Element createLeafElement(Element parent,
    AttributeSet a,
    int p0,
    int p1) 
{
        return new RunElement(parent, a, p0, p1);
}

Creates a document leaf element that directly represents text (doesn't have any children). This is implemented to return an element of type HTMLDocument.RunElement.

 protected  void fireChangedUpdate(DocumentEvent e) 
{
        super.fireChangedUpdate(e);
}

Notifies all listeners that have registered interest for notification on this event type. The event instance is lazily created using the parameters passed into the fire method.

 protected  void fireUndoableEditUpdate(UndoableEditEvent e) 
{
        super.fireUndoableEditUpdate(e);
}

Notifies all listeners that have registered interest for notification on this event type. The event instance is lazily created using the parameters passed into the fire method.

 public URL getBase() 
{
        return base;
}

Returns the location to resolve relative URLs against. By default this will be the document's URL if the document was loaded from a URL. If a base tag is found and can be parsed, it will be used as the base location.

 String getBaseTarget() 
{
        return baseTarget;
}

 String getDefaultStyleSheetType() 
{
        String retValue = (String)getProperty(StyleType);
        if (retValue == null) {
            return "text/css";
        }
        return retValue;
}

Returns the content type language used for style sheets. The default is text/css.

 public Element getElement(String id) 
{
        if (id == null) {
            return null;
        }
        return getElement(getDefaultRootElement(), HTML.Attribute.ID, id,
                          true);
}

Returns the element that has the given id Attribute. If the element can't be found, null is returned. Note that this method works on an Attribute, not a character tag. In the following HTML snippet: <a id="HelloThere"> the attribute is 'id' and the character tag is 'a'. This is a convenience method for getElement(RootElement, HTML.Attribute.id, id). This is not thread-safe.

 public Element getElement(Element e,
    Object attribute,
    Object value) 
{
        return getElement(e, attribute, value, true);
}

Returns the child element of e that contains the attribute, attribute with value value, or null if one isn't found. This is not thread-safe.

 public Iterator getIterator(Tag t) 
{
        if (t.isBlock()) {
            // TBD
            return null;
        }
        return new LeafIterator(t, this);
}

Fetches an iterator for the specified HTML tag. This can be used for things like iterating over the set of anchors contained, or iterating over the input elements.

 Map getMap(String name) 
{
        if (name != null) {
            Object     maps = getProperty(MAP_PROPERTY);
            if (maps != null && (maps instanceof Hashtable)) {
                return (Map)((Hashtable)maps).get(name);
            }
        }
        return null;
}

Returns the Map associated with the given name.

 Enumeration getMaps() 
{
        Object     maps = getProperty(MAP_PROPERTY);
        if (maps instanceof Hashtable) {
            return ((Hashtable)maps).elements();
        }
        return null;
}

Returns an Enumeration of the possible Maps.

 public Parser getParser() 
{
        Object p = getProperty("__PARSER__");
        if (p instanceof HTMLEditorKit.Parser) {
            return (HTMLEditorKit.Parser)p;
        }
        return parser;
}

Returns the parser that is used when inserting HTML into the existing document.

 public boolean getPreservesUnknownTags() 
{
        return preservesUnknownTags;
}

Returns the behavior the parser observes when encountering unknown tags.

 public ParserCallback getReader(int pos) 
{
        Object desc = getProperty(Document.StreamDescriptionProperty);
        if (desc instanceof URL) {
            setBase((URL)desc);
        }
        HTMLReader reader = new HTMLReader(pos);
        return reader;
}

Fetches the reader for the parser to use when loading the document with HTML. This is implemented to return an instance of HTMLDocument.HTMLReader. Subclasses can reimplement this method to change how the document gets structured if desired. (For example, to handle custom tags, or structurally represent character style elements.)

 public ParserCallback getReader(int pos,
    int popDepth,
    int pushDepth,
    Tag insertTag) 
{
        return getReader(pos, popDepth, pushDepth, insertTag, true);
}

Returns the reader for the parser to use to load the document with HTML. This is implemented to return an instance of HTMLDocument.HTMLReader. Subclasses can reimplement this method to change how the document gets structured if desired. (For example, to handle custom tags, or structurally represent character style elements.)

This is a convenience method for getReader(int, int, int, HTML.Tag, TRUE).

 ParserCallback getReader(int pos,
    int popDepth,
    int pushDepth,
    Tag insertTag,
    boolean insertInsertTag) 
{
        Object desc = getProperty(Document.StreamDescriptionProperty);
        if (desc instanceof URL) {
            setBase((URL)desc);
        }
        HTMLReader reader = new HTMLReader(pos, popDepth, pushDepth,
                                           insertTag, insertInsertTag, false,
                                           true);
        return reader;
}

Fetches the reader for the parser to use to load the document with HTML. This is implemented to return an instance of HTMLDocument.HTMLReader. Subclasses can reimplement this method to change how the document get structured if desired (e.g. to handle custom tags, structurally represent character style elements, etc.).

 public StyleSheet getStyleSheet() 
{
        return (StyleSheet) getAttributeContext();
}

Fetches the StyleSheet with the document-specific display rules (CSS) that were specified in the HTML document itself.

 public int getTokenThreshold() 
{
        Integer i = (Integer) getProperty(TokenThreshold);
        if (i != null) {
            return i.intValue();
        }
        return Integer.MAX_VALUE;
}

Gets the number of tokens to buffer before trying to update the documents element structure. The default value is Integer.MAX_VALUE.

 boolean hasBaseTag() 
{
        return hasBaseTag;
}

 protected  void insert(int offset,
    ElementSpec[] data) throws BadLocationException 
{
        super.insert(offset, data);
}

Inserts new elements in bulk. This is how elements get created in the document. The parsing determines what structure is needed and creates the specification as a set of tokens that describe the edit while leaving the document free of a write-lock. This method can then be called in bursts by the reader to acquire a write-lock for a shorter duration (i.e. while the document is actually being altered).

 public  void insertAfterEnd(Element elem,
    String htmlText) throws BadLocationException, IOException 
{
        verifyParser();
        if (elem != null) {
            Element parent = elem.getParentElement();
            if (parent != null) {
                int offset = elem.getEndOffset();
                if (offset  > getLength()) {
                    offset--;
                }
                else if (elem.isLeaf() && getText(offset - 1, 1).
                    charAt(0) == NEWLINE[0]) {
                    offset--;
                }
                insertHTML(parent, offset, htmlText, false);
            }
        }
}

Inserts the HTML specified as a string after the the end of the given element.

Consider the following structure (the elem parameter is in bold).

    <body>
      |
    <div>
     /  \
   <p>   <p>

Invoking insertAfterEnd(elem, "<ul><li>") results in the following structure (new elements are in red).

       <body>
        /  \
     <div> <ul>
      / \    \
    <p> <p>  <li>

Unlike the insertBeforeEnd method, new elements become siblings of the specified element, not children.

If either elem or htmlText parameter is null, no changes are made to the document.

For this to work correcty, the document must have an HTMLEditorKit.Parser set. This will be the case if the document was created from an HTMLEditorKit via the createDefaultDocument method.

 public  void insertAfterStart(Element elem,
    String htmlText) throws BadLocationException, IOException 
{
        verifyParser();
        if (elem != null && elem.isLeaf()) {
            throw new IllegalArgumentException
                ("Can not insert HTML after start of a leaf");
        }
        insertHTML(elem, elem.getStartOffset(), htmlText, false);
}

Inserts the HTML specified as a string at the start of the element.

Consider the following structure (the elem parameter is in bold).

    <body>
      |
    <div>
     /  \
   <p>   <p>

Invoking insertAfterStart(elem, "<ul><li>") results in the following structure (new elements are in red).

       <body>
         |
       <div>
      /  |  \
   <ul> <p> <p>
    /
 <li>

Unlike the insertBeforeStart method, new elements become children of the specified element, not siblings.

Parameter elem must not be a leaf element, otherwise an IllegalArgumentException is thrown. If either elem or htmlText parameter is null, no changes are made to the document.

For this to work correcty, the document must have an HTMLEditorKit.Parser set. This will be the case if the document was created from an HTMLEditorKit via the createDefaultDocument method.

 public  void insertBeforeEnd(Element elem,
    String htmlText) throws BadLocationException, IOException 
{
        verifyParser();
        if (elem != null && elem.isLeaf()) {
            throw new IllegalArgumentException
                ("Can not set inner HTML before end of leaf");
        }
        if (elem != null) {
            int offset = elem.getEndOffset();
            if (elem.getElement(elem.getElementIndex(offset - 1)).isLeaf() &&
                getText(offset - 1, 1).charAt(0) == NEWLINE[0]) {
                offset--;
            }
            insertHTML(elem, offset, htmlText, false);
        }
}

Inserts the HTML specified as a string at the end of the element.

If elem's children are leaves, and the character at a elem.getEndOffset() - 1 is a newline, this will insert before the newline so that there isn't text after the newline.

Consider the following structure (the elem parameter is in bold).

    <body>
      |
    <div>
     /  \
   <p>   <p>

Invoking insertBeforeEnd(elem, "<ul><li>") results in the following structure (new elements are in red).

       <body>
         |
       <div>
      /  |  \
    <p> <p> <ul>
              \
              <li>

Unlike the insertAfterEnd method, new elements become children of the specified element, not siblings.

Parameter elem must not be a leaf element, otherwise an IllegalArgumentException is thrown. If either elem or htmlText parameter is null, no changes are made to the document.

For this to work correcty, the document must have an HTMLEditorKit.Parser set. This will be the case if the document was created from an HTMLEditorKit via the createDefaultDocument method.

 public  void insertBeforeStart(Element elem,
    String htmlText) throws BadLocationException, IOException 
{
        verifyParser();
        if (elem != null) {
            Element parent = elem.getParentElement();
            if (parent != null) {
                insertHTML(parent, elem.getStartOffset(), htmlText, false);
            }
        }
}

Inserts the HTML specified as a string before the start of the given element.

Consider the following structure (the elem parameter is in bold).

    <body>
      |
    <div>
     /  \
   <p>   <p>

Invoking insertBeforeStart(elem, "<ul><li>") results in the following structure (new elements are in red).

       <body>
        /  \
     <ul> <div>
      /    /  \
    <li> <p>  <p>

Unlike the insertAfterStart method, new elements become siblings of the specified element, not children.

If either elem or htmlText parameter is null, no changes are made to the document.

For this to work correcty, the document must have an HTMLEditorKit.Parser set. This will be the case if the document was created from an HTMLEditorKit via the createDefaultDocument method.

 protected  void insertUpdate(DefaultDocumentEvent chng,
    AttributeSet attr) 
{
        if(attr == null) {
            attr = contentAttributeSet;
        }
        // If this is the composed text element, merge the content attribute to it
        else if (attr.isDefined(StyleConstants.ComposedTextAttribute)) {
            ((MutableAttributeSet)attr).addAttributes(contentAttributeSet);
        }
        if (attr.isDefined(IMPLIED_CR)) {
            ((MutableAttributeSet)attr).removeAttribute(IMPLIED_CR);
        }
        super.insertUpdate(chng, attr);
}

Updates document structure as a result of text insertion. This will happen within a write lock. This implementation simply parses the inserted content for line breaks and builds up a set of instructions for the element buffer.

 boolean isFrameDocument() 
{
        return frameDocument;
}

Returns true if the document will be viewed in a frame.

 static boolean matchNameAttribute(AttributeSet attr,
    Tag tag) 
{
        Object o = attr.getAttribute(StyleConstants.NameAttribute);
        if (o instanceof HTML.Tag) {
            HTML.Tag name = (HTML.Tag) o;
            if (name == tag) {
                return true;
            }
        }
        return false;
}

Returns true if StyleConstants.NameAttribute is equal to the tag that is passed in as a parameter.

  void obtainLock() 
{
        writeLock();
}

 public  void processHTMLFrameHyperlinkEvent(HTMLFrameHyperlinkEvent e) 
{
        String frameName = e.getTarget();
        Element element = e.getSourceElement();
        String urlStr = e.getURL().toString();
        if (frameName.equals("_self")) {
            /*
              The source and destination elements
              are the same.
            */
            updateFrame(element, urlStr);
        } else if (frameName.equals("_parent")) {
            /*
              The destination is the parent of the frame.
            */
            updateFrameSet(element.getParentElement(), urlStr);
        } else {
            /*
              locate a named frame
            */
            Element targetElement = findFrame(frameName);
            if (targetElement != null) {
                updateFrame(targetElement, urlStr);
            }
        }
}

Processes HyperlinkEvents that are generated by documents in an HTML frame. The HyperlinkEvent type, as the parameter suggests, is HTMLFrameHyperlinkEvent. In addition to the typical information contained in a HyperlinkEvent, this event contains the element that corresponds to the frame in which the click happened (the source element) and the target name. The target name has 4 possible values:
• _self
• _parent
• _top
• a named frame
If target is _self, the action is to change the value of the HTML.Attribute.SRC attribute and fires a ChangedUpdate event.

If the target is _parent, then it deletes the parent element, which is a <FRAMESET> element, and inserts a new <FRAME> element, and sets its HTML.Attribute.SRC attribute to have a value equal to the destination URL and fire a RemovedUpdate and InsertUpdate.

If the target is _top, this method does nothing. In the implementation of the view for a frame, namely the FrameView, the processing of _top is handled. Given that _top implies replacing the entire document, it made sense to handle this outside of the document that it will replace.

If the target is a named frame, then the element hierarchy is searched for an element with a name equal to the target, its HTML.Attribute.SRC attribute is updated and a ChangedUpdate event is fired.

  void releaseLock() 
{
        writeUnlock();
}

  void removeMap(Map map) 
{
        String     name = map.getName();
        if (name != null) {
            Object     maps = getProperty(MAP_PROPERTY);
            if (maps instanceof Hashtable) {
                ((Hashtable)maps).remove("#" + name);
            }
        }
}

Removes a previously registered map.

 public  void setBase(URL u) 
{
        base = u;
        getStyleSheet().setBase(u);
}

Sets the location to resolve relative URLs against. By default this will be the document's URL if the document was loaded from a URL. If a base tag is found and can be parsed, it will be used as the base location.

This also sets the base of the StyleSheet to be u as well as the base of the document.

  void setDefaultStyleSheetType(String contentType) 
{
        putProperty(StyleType, contentType);
}

Sets the content type language used for style sheets that do not explicitly specify the type. The default is text/css.

  void setFrameDocumentState(boolean frameDoc) 
{
        this.frameDocument = frameDoc;
}

Sets a boolean state about whether the document will be viewed in a frame.

 public  void setInnerHTML(Element elem,
    String htmlText) throws BadLocationException, IOException 
{
        verifyParser();
        if (elem != null && elem.isLeaf()) {
            throw new IllegalArgumentException
                ("Can not set inner HTML of a leaf");
        }
        if (elem != null && htmlText != null) {
            int oldCount = elem.getElementCount();
            int insertPosition = elem.getStartOffset();
            insertHTML(elem, elem.getStartOffset(), htmlText, true);
            if (elem.getElementCount()  > oldCount) {
                // Elements were inserted, do the cleanup.
                removeElements(elem, elem.getElementCount() - oldCount,
                               oldCount);
            }
        }
}

Replaces the children of the given element with the contents specified as an HTML string.

This will be seen as at least two events, n inserts followed by a remove.

Consider the following structure (the elem parameter is in bold).

    <body>
      |
    <div>
     /  \
   <p>   <p>

Invoking setInnerHTML(elem, "<ul><li>") results in the following structure (new elements are in red).

    <body>
      |
    <div>
        \
        <ul>
          \
          <li>

Parameter elem must not be a leaf element, otherwise an IllegalArgumentException is thrown. If either elem or htmlText parameter is null, no changes are made to the document.

For this to work correcty, the document must have an HTMLEditorKit.Parser set. This will be the case if the document was created from an HTMLEditorKit via the createDefaultDocument method.

 public  void setOuterHTML(Element elem,
    String htmlText) throws BadLocationException, IOException 
{
        verifyParser();
        if (elem != null && elem.getParentElement() != null &&
            htmlText != null) {
            int start = elem.getStartOffset();
            int end = elem.getEndOffset();
            int startLength = getLength();
            // We don't want a newline if elem is a leaf, and doesn't contain
            // a newline.
            boolean wantsNewline = !elem.isLeaf();
            if (!wantsNewline && (end  > startLength ||
                                 getText(end - 1, 1).charAt(0) == NEWLINE[0])){
                wantsNewline = true;
            }
            Element parent = elem.getParentElement();
            int oldCount = parent.getElementCount();
            insertHTML(parent, start, htmlText, wantsNewline);
            // Remove old.
            int newLength = getLength();
            if (oldCount != parent.getElementCount()) {
                int removeIndex = parent.getElementIndex(start + newLength -
                                                         startLength);
                removeElements(parent, removeIndex, 1);
            }
        }
}

Replaces the given element in the parent with the contents specified as an HTML string.

This will be seen as at least two events, n inserts followed by a remove.

When replacing a leaf this will attempt to make sure there is a newline present if one is needed. This may result in an additional element being inserted. Consider, if you were to replace a character element that contained a newline with <img> this would create two elements, one for the image, ane one for the newline.

If you try to replace the element at length you will most likely end up with two elements, eg setOuterHTML(getCharacterElement (getLength()), "blah") will result in two leaf elements at the end, one representing 'blah', and the other representing the end element.

Consider the following structure (the elem parameter is in bold).

    <body>
      |
    <div>
     /  \
   <p>   <p>

Invoking setOuterHTML(elem, "<ul><li>") results in the following structure (new elements are in red).

   <body>
     |
    <ul>
      \
      <li>

If either elem or htmlText parameter is null, no changes are made to the document.

For this to work correcty, the document must have an HTMLEditorKit.Parser set. This will be the case if the document was created from an HTMLEditorKit via the createDefaultDocument method.

 public  void setParagraphAttributes(int offset,
    int length,
    AttributeSet s,
    boolean replace) 
{
        try {
            writeLock();
            // Make sure we send out a change for the length of the paragraph.
            int end = Math.min(offset + length, getLength());
            Element e = getParagraphElement(offset);
            offset = e.getStartOffset();
            e = getParagraphElement(end);
            length = Math.max(0, e.getEndOffset() - offset);
            DefaultDocumentEvent changes =
                new DefaultDocumentEvent(offset, length,
                                         DocumentEvent.EventType.CHANGE);
            AttributeSet sCopy = s.copyAttributes();
            int lastEnd = Integer.MAX_VALUE;
            for (int pos = offset; pos < = end; pos = lastEnd) {
                Element paragraph = getParagraphElement(pos);
                if (lastEnd == paragraph.getEndOffset()) {
                    lastEnd++;
                }
                else {
                    lastEnd = paragraph.getEndOffset();
                }
                MutableAttributeSet attr =
                    (MutableAttributeSet) paragraph.getAttributes();
                changes.addEdit(new AttributeUndoableEdit(paragraph, sCopy, replace));
                if (replace) {
                    attr.removeAttributes(attr);
                }
                attr.addAttributes(s);
            }
            changes.end();
            fireChangedUpdate(changes);
            fireUndoableEditUpdate(new UndoableEditEvent(this, changes));
        } finally {
            writeUnlock();
        }
}

Sets attributes for a paragraph.

This method is thread safe, although most Swing methods are not. Please see How to Use Threads for more information.

 public  void setParser(Parser parser) 
{
        this.parser = parser;
        putProperty("__PARSER__", null);
}

Sets the parser that is used by the methods that insert html into the existing document, such as setInnerHTML, and setOuterHTML.

HTMLEditorKit.createDefaultDocument will set the parser for you. If you create an HTMLDocument by hand, be sure and set the parser accordingly.

 public  void setPreservesUnknownTags(boolean preservesTags) 
{
        preservesUnknownTags = preservesTags;
}

Determines how unknown tags are handled by the parser. If set to true, unknown tags are put in the model, otherwise they are dropped.

 public  void setTokenThreshold(int n) 
{
        putProperty(TokenThreshold, new Integer(n));
}

Sets the number of tokens to buffer before trying to update the documents element structure.