javax.swing.text.html
class HTMLEditorKit.InsertHTMLTextAction

java.lang.Object javax.swing.AbstractAction javax.swing.text.TextAction javax.swing.text.StyledEditorKit.StyledTextAction javax.swing.text.html.HTMLEditorKit.HTMLTextAction javax.swing.text.html.HTMLEditorKit.InsertHTMLTextAction

All Implemented Interfaces:

Serializable, Cloneable, Action

Enclosing class:

HTMLEditorKit

public static class HTMLEditorKit.InsertHTMLTextAction
extends HTMLEditorKit.HTMLTextAction

InsertHTMLTextAction can be used to insert an arbitrary string of HTML into an existing HTML document. At least two HTML.Tags need to be supplied. The first Tag, parentTag, identifies the parent in the document to add the elements to. The second tag, addTag, identifies the first tag that should be added to the document as seen in the HTML string. One important thing to remember, is that the parser is going to generate all the appropriate tags, even if they aren't in the HTML string passed in.

For example, lets say you wanted to create an action to insert a table into the body. The parentTag would be HTML.Tag.BODY, addTag would be HTML.Tag.TABLE, and the string could be something like <table><tr><td></td></tr></table>.

There is also an option to supply an alternate parentTag and addTag. These will be checked for if there is no parentTag at offset.

addTag

protected HTML.Tag addTag

Tag in HTML to start adding tags from.

alternateAddTag

protected HTML.Tag alternateAddTag

Alternate tag in HTML to start adding tags from if parentTag is not found and alternateParentTag is found.

alternateParentTag

protected HTML.Tag alternateParentTag

Alternate Tag to check for in the document if parentTag is not found.

html

protected String html

HTML to insert.

parentTag

protected HTML.Tag parentTag

Tag to check for in the document.

HTMLEditorKit.InsertHTMLTextAction

public HTMLEditorKit.InsertHTMLTextAction(String name,
                                          String html,
                                          HTML.Tag parentTag,
                                          HTML.Tag addTag)

Parameters:

name

html

parentTag

addTag

HTMLEditorKit.InsertHTMLTextAction

public HTMLEditorKit.InsertHTMLTextAction(String name,
                                          String html,
                                          HTML.Tag parentTag,
                                          HTML.Tag addTag,
                                          HTML.Tag alternateParentTag,
                                          HTML.Tag alternateAddTag)

Parameters:

name

html

parentTag

addTag

alternateParentTag

alternateAddTag

actionPerformed

public void actionPerformed(ActionEvent ae)

Inserts the HTML into the document.

Parameters:

ae - the event

insertAtBoundary

protected void insertAtBoundary(JEditorPane editor,
                                HTMLDocument doc,
                                int offset,
                                Element insertElement,
                                String html,
                                HTML.Tag parentTag,
                                HTML.Tag addTag)

This is invoked when inserting at a boundary. It determines the number of pops, and then the number of pushes that need to be performed, and then invokes insertHTML.

Parameters:

editor

doc

offset

insertElement

html

parentTag

addTag

insertAtBoundry

protected void insertAtBoundry(JEditorPane editor,
                               HTMLDocument doc,
                               int offset,
                               Element insertElement,
                               String html,
                               HTML.Tag parentTag,
                               HTML.Tag addTag)

This is invoked when inserting at a boundary. It determines the number of pops, and then the number of pushes that need to be performed, and then invokes insertHTML.

Parameters:

editor

doc

offset

insertElement

html

parentTag

addTag

insertHTML

protected void insertHTML(JEditorPane editor,
                          HTMLDocument doc,
                          int offset,
                          String html,
                          int popDepth,
                          int pushDepth,
                          HTML.Tag addTag)

A cover for HTMLEditorKit.insertHTML. If an exception it thrown it is wrapped in a RuntimeException and thrown.

Parameters:

editor

doc

offset

html

popDepth

pushDepth

addTag