javax.swing.text.html

Class HTMLEditorKit.HTMLTextAction

Enclosing Class:
HTMLEditorKit
Implemented Interfaces:
Action, ActionListener, Cloneable, EventListener, Serializable
Known Direct Subclasses:
HTMLEditorKit.InsertHTMLTextAction

public static abstract class HTMLEditorKit.HTMLTextAction
extends StyledEditorKit.StyledTextAction

Abstract Action class that helps inserting HTML into an existing document.
See Also:
Serialized Form

Field Summary

Fields inherited from class javax.swing.AbstractAction

changeSupport, enabled

Fields inherited from interface javax.swing.Action

ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SHORT_DESCRIPTION, SMALL_ICON

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

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

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

HTMLTextAction

public HTMLTextAction(String name)
Constructor

Method Details

elementCountToTag

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

protected HTMLDocument getHTMLDocument(JEditorPane e)
Gets the HTMLDocument from the JEditorPane.
Parameters:
e - - the editor pane
Returns:
the html document.

getHTMLEditorKit

protected HTMLEditorKit getHTMLEditorKit(JEditorPane e)
Gets the HTMLEditorKit
Parameters:
e - - the JEditorPane to get the HTMLEditorKit from.
Returns:
the HTMLEditorKit

HTMLEditorKit.java -- Copyright (C) 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.