HTMLEditorKit.InsertHTMLTextAction

Class Overview

InsertHTMLTextAction can be used to insert an arbitrary string of HTML into an existing HTML document. At least two HTML.Tags need to be supplied. The first Tag, parentTag, identifies the parent in the document to add the elements to. The second tag, addTag, identifies the first tag that should be added to the document as seen in the HTML string. One important thing to remember, is that the parser is going to generate all the appropriate tags, even if they aren't in the HTML string passed in.

For example, lets say you wanted to create an action to insert a table into the body. The parentTag would be HTML.Tag.BODY, addTag would be HTML.Tag.TABLE, and the string could be something like <table><tr><td></td></tr></table>.

There is also an option to supply an alternate parentTag and addTag. These will be checked for if there is no parentTag at offset.

Summary

[Expand] Inherited Constants

From interface javax.swing.Action String ACCELERATOR_KEY The key used for storing a KeyStroke to be used as the accelerator for the action. String ACTION_COMMAND_KEY The key used to determine the command String for the ActionEvent that will be created when an Action is going to be notified as the result of residing in a Keymap associated with a JComponent. String DEFAULT Not currently used. String DISPLAYED_MNEMONIC_INDEX_KEY The key used for storing an Integer that corresponds to the index in the text (identified by the NAME property) that the decoration for a mnemonic should be rendered at. String LARGE_ICON_KEY The key used for storing an Icon. String LONG_DESCRIPTION The key used for storing a longer String description for the action, could be used for context-sensitive help. String MNEMONIC_KEY The key used for storing an Integer that corresponds to one of the KeyEvent key codes. String NAME The key used for storing the String name for the action, used for a menu or button. String SELECTED_KEY The key used for storing a Boolean that corresponds to the selected state. String SHORT_DESCRIPTION The key used for storing a short String description for the action, used for tooltip text. String SMALL_ICON The key used for storing a small Icon, such as ImageIcon.

[Expand] Inherited Fields
From class javax.swing.AbstractAction protected SwingPropertyChangeSupport changeSupport If any PropertyChangeListeners have been registered, the changeSupport field describes them. protected boolean enabled Specifies whether action is enabled; the default is true.

[Expand] Inherited Methods
From class javax.swing.text.html.HTMLEditorKit.HTMLTextAction 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. Element findElementMatchingTag(HTMLDocument doc, int offset, HTML.Tag tag) Returns the deepest element at offset matching tag. Element[] getElementsAt(HTMLDocument doc, int offset) Returns an array of the Elements that contain offset. HTMLDocument getHTMLDocument(JEditorPane e) HTMLEditorKit getHTMLEditorKit(JEditorPane e)
From class javax.swing.text.StyledEditorKit.StyledTextAction final JEditorPane getEditor(ActionEvent e) Gets the target editor for an action. final StyledDocument getStyledDocument(JEditorPane e) Gets the document associated with an editor pane. final StyledEditorKit getStyledEditorKit(JEditorPane e) Gets the editor kit associated with an editor pane. final void setCharacterAttributes(JEditorPane editor, AttributeSet attr, boolean replace) Applies the given attributes to character content. final void setParagraphAttributes(JEditorPane editor, AttributeSet attr, boolean replace) Applies the given attributes to paragraphs.
From class javax.swing.text.TextAction final static Action[] augmentList(Action[] list1, Action[] list2) Takes one list of commands and augments it with another list of commands. final JTextComponent getFocusedComponent() Fetches the text component that currently has focus. final JTextComponent getTextComponent(ActionEvent e) Determines the component to use for the action.
From class javax.swing.AbstractAction synchronized void addPropertyChangeListener(PropertyChangeListener listener) Adds a PropertyChangeListener to the listener list. Object clone() Clones the abstract action. void firePropertyChange(String propertyName, Object oldValue, Object newValue) Supports reporting bound property changes. Object[] getKeys() Returns an array of Objects which are keys for which values have been set for this AbstractAction, or null if no keys have values set. synchronized PropertyChangeListener[] getPropertyChangeListeners() Returns an array of all the PropertyChangeListeners added to this AbstractAction with addPropertyChangeListener(). Object getValue(String key) Gets the Object associated with the specified key. boolean isEnabled() Returns true if the action is enabled. void putValue(String key, Object newValue) Sets the Value associated with the specified key. synchronized void removePropertyChangeListener(PropertyChangeListener listener) Removes a PropertyChangeListener from the listener list. void setEnabled(boolean newValue) Sets whether the Action is enabled.
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait() Causes the current thread to wait until another thread invokes the notify() method or the notifyAll() method for this object. final void wait(long timeout, int nanos) Causes the current thread to wait until another thread invokes the notify() method or the notifyAll() method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed. final void wait(long timeout) Causes the current thread to wait until either another thread invokes the notify() method or the notifyAll() method for this object, or a specified amount of time has elapsed.
From interface java.awt.event.ActionListener abstract void actionPerformed(ActionEvent e) Invoked when an action occurs.
From interface javax.swing.Action abstract void addPropertyChangeListener(PropertyChangeListener listener) Adds a PropertyChange listener. abstract Object getValue(String key) Gets one of this object's properties using the associated key. abstract boolean isEnabled() Returns the enabled state of the Action. abstract void putValue(String key, Object value) Sets one of this object's properties using the associated key. abstract void removePropertyChangeListener(PropertyChangeListener listener) Removes a PropertyChange listener. abstract void setEnabled(boolean b) Sets the enabled state of the Action.