net.thevpc.echo.swing.util

Class CustomHTMLAction

java.lang.Object

javax.swing.AbstractAction

javax.swing.text.TextAction

javax.swing.text.StyledEditorKit.StyledTextAction

javax.swing.text.html.HTMLEditorKit.HTMLTextAction

net.thevpc.echo.swing.util.CustomHTMLAction

All Implemented Interfaces:

ActionListener, Serializable, Cloneable, EventListener, Action

public class CustomHTMLAction
extends HTMLEditorKit.HTMLTextAction

Author:

thevpc

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected HTML.Tag	addTag Tag in HTML to start adding tags from.
protected HTML.Tag	alternateAddTag Alternate tag in HTML to start adding tags from if parentTag is not found and alternateParentTag is found.
protected HTML.Tag	alternateParentTag Alternate Tag to check for in the document if parentTag is not found.
protected String	html HTML to insert.
protected HTML.Tag	parentTag Tag to check for in the document.

Fields inherited from class javax.swing.AbstractAction

changeSupport, enabled

Fields inherited from 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

Constructors

Constructor and Description
CustomHTMLAction(String name, String html, HTML.Tag parentTag, HTML.Tag addTag)
CustomHTMLAction(String name, String html, HTML.Tag parentTag, HTML.Tag addTag, HTML.Tag alternateParentTag, HTML.Tag alternateAddTag)

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent ae) Inserts the HTML into the document.
protected Element	commonParent(JEditorPane editor, HTMLDocument doc, int offset)
protected void	insertAtBoundary(JEditorPane editor, HTMLDocument doc, int offset, Element insertElement, String html, HTML.Tag parentTag, HTML.Tag addTag) This is invoked when inserting at a boundary.
protected void	insertHTML(JEditorPane editor, HTMLDocument doc, int offset, String html, int popDepth, int pushDepth, HTML.Tag addTag) A cover for HTMLEditorKit.insertHTML.If an exception it thrown it is wrapped in a RuntimeException and thrown.

Methods inherited from class javax.swing.text.html.HTMLEditorKit.HTMLTextAction

elementCountToTag, findElementMatchingTag, getElementsAt, getHTMLDocument, getHTMLEditorKit

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

Field Detail

html

protected String html

HTML to insert.

parentTag

protected HTML.Tag parentTag

Tag to check for in the document.

addTag

protected HTML.Tag addTag

Tag in HTML to start adding tags from.

alternateParentTag

protected HTML.Tag alternateParentTag

Alternate Tag to check for in the document if parentTag is not found.

alternateAddTag

protected HTML.Tag alternateAddTag

Alternate tag in HTML to start adding tags from if parentTag is not found and alternateParentTag is found.

Constructor Detail

CustomHTMLAction

public CustomHTMLAction(String name,
                        String html,
                        HTML.Tag parentTag,
                        HTML.Tag addTag)

CustomHTMLAction

public CustomHTMLAction(String name,
                        String html,
                        HTML.Tag parentTag,
                        HTML.Tag addTag,
                        HTML.Tag alternateParentTag,
                        HTML.Tag alternateAddTag)

Method Detail

insertHTML

protected void insertHTML(JEditorPane editor,
                          HTMLDocument doc,
                          int offset,
                          String html,
                          int popDepth,
                          int pushDepth,
                          HTML.Tag addTag)

A cover for HTMLEditorKit.insertHTML.If an exception it thrown it is wrapped in a RuntimeException and thrown.

Parameters:

editor - editor

doc - doc

offset - offset

html - html

popDepth - popDepth

pushDepth - pushDepth

addTag - addTag

commonParent

protected Element commonParent(JEditorPane editor,
                               HTMLDocument doc,
                               int offset)

insertAtBoundary

protected void insertAtBoundary(JEditorPane editor,
                                HTMLDocument doc,
                                int offset,
                                Element insertElement,
                                String html,
                                HTML.Tag parentTag,
                                HTML.Tag addTag)

This is invoked when inserting at a boundary. It determines the number of pops, and then the number of pushes that need to be performed, and then invokes insertHTML.

Parameters:

editor - editor

doc - doc

offset - offset

html - html

insertElement - insertElement

parentTag - parentTag

addTag - addTag

Since:

1.3

actionPerformed

public void actionPerformed(ActionEvent ae)

Inserts the HTML into the document.

Parameters:

ae - the event