public static class

HTMLEditorKit.InsertHTMLTextAction

extends HTMLEditorKit.HTMLTextAction
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

Class Overview

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.

Summary

[Expand]
Inherited Constants
From interface javax.swing.Action
Fields
protected HTML.Tag addTag Tag in HTML to start adding tags from.
protected HTML.Tag alternateAddTag Alternate tag in HTML to start adding tags from if parentTag is not found and alternateParentTag is found.
protected HTML.Tag alternateParentTag Alternate Tag to check for in the document if parentTag is not found.
protected String html HTML to insert.
protected HTML.Tag parentTag Tag to check for in the document.
[Expand]
Inherited Fields
From class javax.swing.AbstractAction
Public Constructors
HTMLEditorKit.InsertHTMLTextAction(String name, String html, HTML.Tag parentTag, HTML.Tag addTag)
HTMLEditorKit.InsertHTMLTextAction(String name, String html, HTML.Tag parentTag, HTML.Tag addTag, HTML.Tag alternateParentTag, HTML.Tag alternateAddTag)
Public Methods
void actionPerformed(ActionEvent ae)
Inserts the HTML into the document.
Protected Methods
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.
void insertAtBoundry(JEditorPane editor, HTMLDocument doc, int offset, Element insertElement, String html, HTML.Tag parentTag, HTML.Tag addTag)
This method is deprecated. As of Java 2 platform v1.3, use insertAtBoundary
void insertHTML(JEditorPane editor, HTMLDocument doc, int offset, String html, int popDepth, int pushDepth, HTML.Tag addTag)
A cover for HTMLEditorKit.insertHTML.
[Expand]
Inherited Methods
From class javax.swing.text.html.HTMLEditorKit.HTMLTextAction
From class javax.swing.text.StyledEditorKit.StyledTextAction
From class javax.swing.text.TextAction
From class javax.swing.AbstractAction
From class java.lang.Object
From interface java.awt.event.ActionListener
From interface javax.swing.Action

Fields

protected HTML.Tag addTag

Tag in HTML to start adding tags from.

protected HTML.Tag alternateAddTag

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

protected HTML.Tag alternateParentTag

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

protected String html

HTML to insert.

protected HTML.Tag parentTag

Tag to check for in the document.

Public Constructors

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

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

Public Methods

public void actionPerformed (ActionEvent ae)

Inserts the HTML into the document.

Parameters
ae the event

Protected Methods

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.

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

This method is deprecated.
As of Java 2 platform v1.3, use insertAtBoundary

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.

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.