javax.swing.text.html

Class HTMLEditorKit.HTMLTextAction

Enclosing Class:
HTMLEditorKit
Implemented Interfaces:
Action, ActionListener, Cloneable, EventListener, Serializable
Known Direct Subclasses:
HTMLEditorKit.InsertHTMLTextAction

public static abstract class HTMLEditorKit.HTMLTextAction
extends StyledEditorKit.StyledTextAction

An abstract Action providing some convenience methods that may be useful in inserting HTML into an existing document.

NOTE: None of the convenience methods obtain a lock on the document. If you have another thread modifying the text these methods may have inconsistent behavior, or return the wrong thing.

See Also:
Serialized Form

Field Summary

Fields inherited from class javax.swing.AbstractAction

changeSupport, enabled

Fields inherited from interface javax.swing.Action

ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SHORT_DESCRIPTION, SMALL_ICON

Constructor Summary

HTMLTextAction(String name)
Creates a new JTextAction object.

Method Summary

protected int
elementCountToTag(HTMLDocument doc, int offset, HTML.Tag tag)
Returns number of elements, starting at the deepest leaf, needed to get to an element representing tag.
protected Element
findElementMatchingTag(HTMLDocument doc, int offset, HTML.Tag tag)
Returns the deepest element at offset matching tag.
protected Element[]
getElementsAt(HTMLDocument doc, int offset)
Returns an array of the Elements that contain offset.
protected HTMLDocument
getHTMLDocument(JEditorPane e)
protected HTMLEditorKit
getHTMLEditorKit(JEditorPane e)

Methods inherited from class javax.swing.text.StyledEditorKit.StyledTextAction

getEditor, getStyledDocument, getStyledEditorKit, setCharacterAttributes, setParagraphAttributes

Methods inherited from class javax.swing.text.TextAction

augmentList, getFocusedComponent, getTextComponent

Methods inherited from class javax.swing.AbstractAction

addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

HTMLTextAction

public HTMLTextAction(String name)
Creates a new JTextAction object.
Parameters:
name - the name of the action

Method Details

elementCountToTag

protected int elementCountToTag(HTMLDocument doc,
                                int offset,
                                HTML.Tag tag)
Returns number of elements, starting at the deepest leaf, needed to get to an element representing tag. This will return -1 if no elements is found representing tag, or 0 if the parent of the leaf at offset represents tag.

findElementMatchingTag

protected Element findElementMatchingTag(HTMLDocument doc,
                                         int offset,
                                         HTML.Tag tag)
Returns the deepest element at offset matching tag.

getElementsAt

protected Element[] getElementsAt(HTMLDocument doc,
                                  int offset)
Returns an array of the Elements that contain offset. The first elements corresponds to the root.

getHTMLDocument

protected HTMLDocument getHTMLDocument(JEditorPane e)
Returns:
HTMLDocument of e.

getHTMLEditorKit

protected HTMLEditorKit getHTMLEditorKit(JEditorPane e)
Returns:
HTMLEditorKit for e.