javax.swing.text.html

Class HTMLEditorKit.HTMLTextAction

java.lang.Object

javax.swing.AbstractAction

javax.swing.text.TextAction

javax.swing.text.StyledEditorKit.StyledTextAction

javax.swing.text.html.HTMLEditorKit.HTMLTextAction

All Implemented Interfaces:

ActionListener, Serializable, Cloneable, EventListener, Action

Direct Known Subclasses:

HTMLEditorKit.InsertHTMLTextAction

Enclosing class:

HTMLEditorKit

public abstract static class HTMLEditorKit.HTMLTextAction
extends StyledEditorKit.StyledTextAction

Abstract Action class that helps inserting HTML into an existing document.

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

Constructors

Constructor and Description
HTMLEditorKit.HTMLTextAction(String name) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
protected int	elementCountToTag(HTMLDocument doc, int offset, HTML.Tag tag) Returns the number of elements, starting at the deepest point, needed to get an element representing tag. -1 if no elements are found, 0 if the parent of the leaf at offset represents the tag.
protected Element	findElementMatchingTag(HTMLDocument doc, int offset, HTML.Tag tag) Gets the deepest element at offset with the matching tag.
protected Element[]	getElementsAt(HTMLDocument doc, int offset) Returns an array of Elements that contain the offset.
protected HTMLDocument	getHTMLDocument(JEditorPane e) Gets the HTMLDocument from the JEditorPane.
protected HTMLEditorKit	getHTMLEditorKit(JEditorPane e) Gets the HTMLEditorKit

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

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.awt.event.ActionListener

actionPerformed

Constructor Detail

HTMLEditorKit.HTMLTextAction

public HTMLEditorKit.HTMLTextAction(String name)

Constructor

Method Detail

getHTMLDocument

protected HTMLDocument getHTMLDocument(JEditorPane e)

Gets the HTMLDocument from the JEditorPane.

Parameters:

e - - the editor pane

Returns:

the html document.

getHTMLEditorKit

protected HTMLEditorKit getHTMLEditorKit(JEditorPane e)

Gets the HTMLEditorKit

Parameters:

e - - the JEditorPane to get the HTMLEditorKit from.

Returns:

the HTMLEditorKit

getElementsAt

protected Element[] getElementsAt(HTMLDocument doc,
                      int offset)

Returns an array of Elements that contain the offset. The first elements corresponds to the roots of the doc.

Parameters:

doc - - the document to get the Elements from.

offset - - the offset the Elements must contain

Returns:

an array of all the elements containing the offset.

elementCountToTag

protected int elementCountToTag(HTMLDocument doc,
                    int offset,
                    HTML.Tag tag)

Returns the number of elements, starting at the deepest point, needed to get an element representing tag. -1 if no elements are found, 0 if the parent of the leaf at offset represents the tag.

Parameters:

doc - - the document to search

offset - - the offset to check

tag - - the tag to look for

Returns:

- the number of elements needed to get an element representing tag.

findElementMatchingTag

protected Element findElementMatchingTag(HTMLDocument doc,
                             int offset,
                             HTML.Tag tag)

Gets the deepest element at offset with the matching tag.

Parameters:

doc - - the document to search

offset - - the offset to check for

tag - - the tag to match

Returns:

- the element that is found, null if not found.