HTMLEditorKit.HTMLTextAction (GNU Classpath 0.94-pre Documentation)

Class HTMLEditorKit.HTMLTextAction

public abstract static class HTMLEditorKit.HTMLTextAction extends StyledEditorKit.StyledTextAction

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

Constructor Summary
	HTMLTextAction(String name) Constructor

Constructor Summary

HTMLTextAction(String name)

Constructor

Method Summary
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.
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

Method Summary

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.

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

Method Detail

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.

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.

getHTMLDocument

Gets the HTMLDocument from the JEditorPane.

Parameters: e - the editor pane

Returns: the html document.

getHTMLEditorKit

Gets the HTMLEditorKit

Parameters: e - the JEditorPane to get the HTMLEditorKit from.

Returns: the HTMLEditorKit