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
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.
-
Field Summary
Fields declared in class javax.swing.AbstractAction
changeSupport, enabledFields declared in interface javax.swing.Action
ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, DISPLAYED_MNEMONIC_INDEX_KEY, LARGE_ICON_KEY, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SELECTED_KEY, SHORT_DESCRIPTION, SMALL_ICON -
Constructor Summary
ConstructorsConstructorDescriptionHTMLTextAction(String name) Creates a new HTMLTextAction from a string action name. -
Method Summary
Modifier and TypeMethodDescriptionprotected intelementCountToTag(HTMLDocument doc, int offset, HTML.Tag tag) Returns number of elements, starting at the deepest leaf, needed to get to an element representingtag.protected ElementfindElementMatchingTag(HTMLDocument doc, int offset, HTML.Tag tag) Returns the deepest element atoffsetmatchingtag.protected Element[]getElementsAt(HTMLDocument doc, int offset) Returns an array of the Elements that containoffset.protected HTMLDocumentReturnsHTMLDocumentof the givenJEditorPane.protected HTMLEditorKitReturnsHTMLEditorKitof the givenJEditorPane.Methods declared in class javax.swing.text.StyledEditorKit.StyledTextAction
getEditor, getStyledDocument, getStyledEditorKit, setCharacterAttributes, setParagraphAttributesMethods declared in class javax.swing.text.TextAction
augmentList, getFocusedComponent, getTextComponentMethods declared in class javax.swing.AbstractAction
addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabledMethods declared in class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods declared in interface java.awt.event.ActionListener
actionPerformed
-
Constructor Details
-
HTMLTextAction
Creates a new HTMLTextAction from a string action name.- Parameters:
name- the name of the action
-
-
Method Details
-
getHTMLDocument
ReturnsHTMLDocumentof the givenJEditorPane.- Parameters:
e- the JEditorPane- Returns:
- HTMLDocument of
e.
-
getHTMLEditorKit
ReturnsHTMLEditorKitof the givenJEditorPane.- Parameters:
e- the JEditorPane- Returns:
- HTMLEditorKit for
e.
-
getElementsAt
Returns an array of the Elements that containoffset. The first elements corresponds to the root.- Parameters:
doc- an instance of HTMLDocumentoffset- value of offset- Returns:
- an array of the Elements that contain
offset
-
elementCountToTag
Returns number of elements, starting at the deepest leaf, needed to get to an element representingtag. This will return -1 if no elements is found representingtag, or 0 if the parent of the leaf atoffsetrepresentstag.- Parameters:
doc- an instance of HTMLDocumentoffset- an offset to start fromtag- tag to represent- Returns:
- number of elements
-
findElementMatchingTag
Returns the deepest element atoffsetmatchingtag.- Parameters:
doc- an instance of HTMLDocumentoffset- the specified offset >= 0tag- an instance of HTML.Tag- Returns:
- the deepest element
-