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 AbstractAction
changeSupport, enabled
Modifier and TypeFieldDescriptionprotected SwingPropertyChangeSupport
If anyPropertyChangeListeners
have been registered, thechangeSupport
field describes them.protected boolean
Specifies whether action is enabled; the default is true.Fields declared in interface 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
Modifier and TypeFieldDescriptionstatic final String
The key used for storing aKeyStroke
to be used as the accelerator for the action.static final String
The key used to determine the commandString
for theActionEvent
that will be created when anAction
is going to be notified as the result of residing in aKeymap
associated with aJComponent
.static final String
Not currently used.static final String
The key used for storing anInteger
that corresponds to the index in the text (identified by theNAME
property) that the decoration for a mnemonic should be rendered at.static final String
The key used for storing anIcon
.static final String
The key used for storing a longerString
description for the action, could be used for context-sensitive help.static final String
The key used for storing anInteger
that corresponds to one of theKeyEvent
key codes.static final String
The key used for storing theString
name for the action, used for a menu or button.static final String
The key used for storing aBoolean
that corresponds to the selected state.static final String
The key used for storing a shortString
description for the action, used for tooltip text.static final String
The key used for storing a smallIcon
, such asImageIcon
. -
Constructor Summary
ConstructorsConstructorDescriptionHTMLTextAction
(String name) Creates a new HTMLTextAction from a string action name. -
Method Summary
Modifier and TypeMethodDescriptionprotected int
elementCountToTag
(HTMLDocument doc, int offset, HTML.Tag tag) Returns number of elements, starting at the deepest leaf, needed to get to an element representingtag
.protected Element
findElementMatchingTag
(HTMLDocument doc, int offset, HTML.Tag tag) Returns the deepest element atoffset
matchingtag
.protected Element[]
getElementsAt
(HTMLDocument doc, int offset) Returns an array of the Elements that containoffset
.protected HTMLDocument
ReturnsHTMLDocument
of the givenJEditorPane
.protected HTMLEditorKit
ReturnsHTMLEditorKit
of the givenJEditorPane
.Methods declared in class StyledEditorKit.StyledTextAction
getEditor, getStyledDocument, getStyledEditorKit, setCharacterAttributes, setParagraphAttributes
Modifier and TypeMethodDescriptionprotected final JEditorPane
Gets the target editor for an action.protected final StyledDocument
Gets the document associated with an editor pane.protected final StyledEditorKit
Gets the editor kit associated with an editor pane.protected final void
setCharacterAttributes
(JEditorPane editor, AttributeSet attr, boolean replace) Applies the given attributes to character content.protected final void
setParagraphAttributes
(JEditorPane editor, AttributeSet attr, boolean replace) Applies the given attributes to paragraphs.Methods declared in class TextAction
augmentList, getFocusedComponent, getTextComponent
Modifier and TypeMethodDescriptionstatic final Action[]
augmentList
(Action[] list1, Action[] list2) Takes one list of commands and augments it with another list of commands.protected final JTextComponent
Fetches the text component that currently has focus.protected final JTextComponent
Determines the component to use for the action.Methods declared in class AbstractAction
addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled
Modifier and TypeMethodDescriptionvoid
Adds aPropertyChangeListener
to the listener list.protected Object
clone()
Clones the abstract action.protected void
firePropertyChange
(String propertyName, Object oldValue, Object newValue) Supports reporting bound property changes.Object[]
getKeys()
Returns an array ofObject
s which are keys for which values have been set for thisAbstractAction
, ornull
if no keys have values set.Returns an array of all thePropertyChangeListener
s added to this AbstractAction with addPropertyChangeListener().Gets theObject
associated with the specified key.boolean
Returns true if the action is enabled.void
Sets theValue
associated with the specified key.void
Removes aPropertyChangeListener
from the listener list.void
setEnabled
(boolean newValue) Sets whether theAction
is enabled.Methods declared in class Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Modifier and TypeMethodDescriptionboolean
Indicates whether some other object is "equal to" this one.protected void
finalize()
Deprecated, for removal: This API element is subject to removal in a future version.Finalization is deprecated and subject to removal in a future release.final Class
<?> getClass()
Returns the runtime class of thisObject
.int
hashCode()
Returns a hash code value for this object.final void
notify()
Wakes up a single thread that is waiting on this object's monitor.final void
Wakes up all threads that are waiting on this object's monitor.toString()
Returns a string representation of the object.final void
wait()
Causes the current thread to wait until it is awakened, typically by being notified or interrupted.final void
wait
(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.final void
wait
(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.Methods declared in interface ActionListener
actionPerformed
Modifier and TypeMethodDescriptionvoid
Invoked when an action occurs.
-
Constructor Details
-
HTMLTextAction
Creates a new HTMLTextAction from a string action name.- Parameters:
name
- the name of the action
-
-
Method Details
-
getHTMLDocument
ReturnsHTMLDocument
of the givenJEditorPane
.- Parameters:
e
- the JEditorPane- Returns:
- HTMLDocument of
e
.
-
getHTMLEditorKit
ReturnsHTMLEditorKit
of 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 atoffset
representstag
.- Parameters:
doc
- an instance of HTMLDocumentoffset
- an offset to start fromtag
- tag to represent- Returns:
- number of elements
-
findElementMatchingTag
Returns the deepest element atoffset
matchingtag
.- Parameters:
doc
- an instance of HTMLDocumentoffset
- the specified offset >= 0tag
- an instance of HTML.Tag- Returns:
- the deepest element
-