javax.swing.text.html

Class HTMLEditorKit

java.lang.Object
- javax.swing.text.EditorKit
- - javax.swing.text.DefaultEditorKit
  - - javax.swing.text.StyledEditorKit
    - - javax.swing.text.html.HTMLEditorKit

Implemented Interfaces:: Accessible, Cloneable, Serializable

public class HTMLEditorKit

extends StyledEditorKit

implements Serializable, Cloneable, Accessible

See Also:: Serialized Form

Nested Class Summary
`static class`	`HTMLEditorKit.HTMLFactory` A `ViewFactory` that is able to create `View`s for the `Element`s that are supported.
`static class`	`HTMLEditorKit.HTMLTextAction` Abstract Action class that helps inserting HTML into an existing document.
`static class`	`HTMLEditorKit.InsertHTMLTextAction` This class is used to insert a string of HTML into an existing document.
`static class`	`HTMLEditorKit.LinkController` Fires the hyperlink events on the associated component when needed.
`static class`	`HTMLEditorKit.Parser` The abstract HTML parser declaration.
`static class`	`HTMLEditorKit.ParserCallback` The "hook" that receives all information about the HTML document structure while parsing it.

Nested classes/interfaces inherited from class javax.swing.text.StyledEditorKit
`StyledEditorKit.AlignmentAction`, `StyledEditorKit.BoldAction`, `StyledEditorKit.FontFamilyAction`, `StyledEditorKit.FontSizeAction`, `StyledEditorKit.ForegroundAction`, `StyledEditorKit.ItalicAction`, `StyledEditorKit.StyledTextAction`, `StyledEditorKit.UnderlineAction`

Nested classes/interfaces inherited from class javax.swing.text.DefaultEditorKit
`DefaultEditorKit.BeepAction`, `DefaultEditorKit.CopyAction`, `DefaultEditorKit.CutAction`, `DefaultEditorKit.DefaultKeyTypedAction`, `DefaultEditorKit.InsertBreakAction`, `DefaultEditorKit.InsertContentAction`, `DefaultEditorKit.InsertTabAction`, `DefaultEditorKit.PasteAction`

Field Summary
`static String`	`BOLD_ACTION` The bold action identifier.
`static String`	`COLOR_ACTION` The color action indentifier (passing the color as an argument).
`static String`	`DEFAULT_CSS` Default cascading stylesheed file ("default.css").
`static String`	`FONT_CHANGE_BIGGER` The increase font action identifier.
`static String`	`FONT_CHANGE_SMALLER` The decrease font action identifier.
`static String`	`IMG_ALIGN_BOTTOM` Align images at the bottom.
`static String`	`IMG_ALIGN_MIDDLE` Align images at the middle.
`static String`	`IMG_ALIGN_TOP` Align images at the top.
`static String`	`IMG_BORDER` Align images at the border.
`static String`	`ITALIC_ACTION` The italic action identifier.
`static String`	`LOGICAL_STYLE_ACTION` The "logical style" action identifier, passing that style as parameter.
`static String`	`PARA_INDENT_LEFT` The "ident paragraph left" action.
`static String`	`PARA_INDENT_RIGHT` The "ident paragraph right" action.

Constructor Summary
`HTMLEditorKit()` Constructs an HTMLEditorKit, creates a StyleContext, and loads the style sheet.

Method Summary
`Object`	`clone()` Creates a copy of the editor kit.
`Document`	`createDefaultDocument()` Create a text storage model for this type of editor.
`protected void`	`createInputAttributes(Element element, MutableAttributeSet set)` Copies the key/values in elements AttributeSet into set.
`void`	`deinstall(JEditorPane c)` Called when the this is removed from the JEditorPane.
`AccessibleContext`	`getAccessibleContext()` Gets the AccessibleContext associated with this.
`Action[]`	`getActions()` Gets the action list.
`String`	`getContentType()` Gets the content type that the kit supports.
`Cursor`	`getDefaultCursor()` Returns the default cursor.
`MutableAttributeSet`	`getInputAttributes()` Gets the input attributes used for the styled editing actions.
`Cursor`	`getLinkCursor()` Returns the cursor for links.
`protected HTMLEditorKit.Parser`	`getParser()` Get the parser that this editor kit uses for reading HTML streams.
`StyleSheet`	`getStyleSheet()` Get the set of styles currently being used to render the HTML elements.
`ViewFactory`	`getViewFactory()` Gets a factory suitable for producing views of any models that are produced by this kit.
`void`	`insertHTML(HTMLDocument doc, int offset, String html, int popDepth, int pushDepth, HTML.Tag insertTag)` Inserts HTML into an existing document.
`void`	`install(JEditorPane c)` Called when this is installed into the JEditorPane.
`boolean`	`isAutoFormSubmission()` Returns `true` when forms should be automatically submitted by the editor kit.
`void`	`read(Reader in, Document doc, int pos)` Inserts content from the given stream.
`void`	`setAutoFormSubmission(boolean auto)` Sets whether or not the editor kit should automatically submit forms.
`void`	`setDefaultCursor(Cursor cursor)` Sets the default cursor.
`void`	`setLinkCursor(Cursor cursor)` Sets the Cursor for links.
`void`	`setStyleSheet(StyleSheet s)` Set the set of styles to be used to render the various HTML elements.
`void`	`write(Writer out, Document doc, int pos, int len)` Writes content from a document to the given stream in an appropriate format.

Methods inherited from class javax.swing.text.StyledEditorKit
`clone`, `createDefaultDocument`, `createInputAttributes`, `deinstall`, `getActions`, `getCharacterAttributeRun`, `getInputAttributes`, `getViewFactory`, `install`

Methods inherited from class javax.swing.text.DefaultEditorKit
`createCaret`, `createDefaultDocument`, `getActions`, `getContentType`, `getViewFactory`, `read`, `read`, `write`, `write`

Methods inherited from class javax.swing.text.EditorKit
`clone`, `createCaret`, `createDefaultDocument`, `deinstall`, `getActions`, `getContentType`, `getViewFactory`, `install`, `read`, `read`, `write`, `write`

Methods inherited from class java.lang.Object
`clone`, `equals`, `extends Object> getClass`, `finalize`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait`

BOLD_ACTION

public static final String BOLD_ACTION

The bold action identifier.
Field Value:
"html-bold-action"

COLOR_ACTION

public static final String COLOR_ACTION

The color action indentifier (passing the color as an argument).
Field Value:
"html-color-action"

DEFAULT_CSS

public static final String DEFAULT_CSS

Default cascading stylesheed file ("default.css").
Field Value:
"default.css"

FONT_CHANGE_BIGGER

public static final String FONT_CHANGE_BIGGER

The increase font action identifier.
Field Value:
"html-font-bigger"

FONT_CHANGE_SMALLER

public static final String FONT_CHANGE_SMALLER

The decrease font action identifier.
Field Value:
"html-font-smaller"

IMG_ALIGN_BOTTOM

public static final String IMG_ALIGN_BOTTOM

Align images at the bottom.
Field Value:
"html-image-align-bottom"

IMG_ALIGN_MIDDLE

public static final String IMG_ALIGN_MIDDLE

Align images at the middle.
Field Value:
"html-image-align-middle"

IMG_ALIGN_TOP

public static final String IMG_ALIGN_TOP

Align images at the top.
Field Value:
"html-image-align-top"

IMG_BORDER

public static final String IMG_BORDER

Align images at the border.
Field Value:
"html-image-border"

ITALIC_ACTION

public static final String ITALIC_ACTION

The italic action identifier.
Field Value:
"html-italic-action"

LOGICAL_STYLE_ACTION

public static final String LOGICAL_STYLE_ACTION

The "logical style" action identifier, passing that style as parameter.
Field Value:
"html-logical-style-action"

PARA_INDENT_LEFT

public static final String PARA_INDENT_LEFT

The "ident paragraph left" action.
Field Value:
"html-para-indent-left"

PARA_INDENT_RIGHT

public static final String PARA_INDENT_RIGHT

The "ident paragraph right" action.
Field Value:
"html-para-indent-right"

HTMLEditorKit

public HTMLEditorKit()

Constructs an HTMLEditorKit, creates a StyleContext, and loads the style sheet.

clone

public Object clone()

Creates a copy of the editor kit.
Overrides:
clone in interface StyledEditorKit
Returns:
a copy of this.

createDefaultDocument

public Document createDefaultDocument()

Create a text storage model for this type of editor.
Overrides:
createDefaultDocument in interface StyledEditorKit
Returns:
the model

createInputAttributes

protected void createInputAttributes(Element element,
                                     MutableAttributeSet set)

Copies the key/values in elements AttributeSet into set. This does not copy component, icon, or element names attributes. This is called anytime the caret moves over a different location.
Overrides:
createInputAttributes in interface StyledEditorKit
Parameters:
element - - the element to create the input attributes for.
set - - the set to copy the values into.

deinstall

public void deinstall(JEditorPane c)

Called when the this is removed from the JEditorPane. It unregisters any listeners.
Overrides:
deinstall in interface StyledEditorKit
Parameters:
c - - the JEditorPane being removed from.

getAccessibleContext

public AccessibleContext getAccessibleContext()

Gets the AccessibleContext associated with this.
Specified by:
getAccessibleContext in interface Accessible
Returns:
the AccessibleContext for this.

getActions

public Action[] getActions()

Gets the action list. This list is supported by the superclass augmented by the collection of actions defined locally for style operations.
Overrides:
getActions in interface StyledEditorKit
Returns:
an array of all the actions

getContentType

public String getContentType()

Gets the content type that the kit supports. This kit supports the type text/html.
Overrides:
getContentType in interface DefaultEditorKit

getDefaultCursor

public Cursor getDefaultCursor()

Returns the default cursor.
Returns:
the default cursor

getInputAttributes

public MutableAttributeSet getInputAttributes()

Gets the input attributes used for the styled editing actions.
Overrides:
getInputAttributes in interface StyledEditorKit
Returns:
the attribute set

getLinkCursor

public Cursor getLinkCursor()

Returns the cursor for links.
Returns:
the cursor for links.

getParser

protected HTMLEditorKit.Parser getParser()

Get the parser that this editor kit uses for reading HTML streams. This method can be overridden to use the alternative parser.
Returns:
the HTML parser (by default, ParserDelegator).

getStyleSheet

public StyleSheet getStyleSheet()

Get the set of styles currently being used to render the HTML elements. By default the resource specified by DEFAULT_CSS gets loaded, and is shared by all HTMLEditorKit instances.
Returns:
the style sheet.

getViewFactory

public ViewFactory getViewFactory()

Gets a factory suitable for producing views of any models that are produced by this kit.
Overrides:
getViewFactory in interface StyledEditorKit
Returns:
the view factory suitable for producing views.

insertHTML

public void insertHTML(HTMLDocument doc,
                       int offset,
                       String html,
                       int popDepth,
                       int pushDepth,
                       HTML.Tag insertTag)
            throws BadLocationException,
                   IOException

Inserts HTML into an existing document.
Parameters:
doc - - the Document to insert the HTML into.
offset - - where to begin inserting the HTML.
html - - the String to insert
popDepth - - the number of ElementSpec.EndTagTypes to generate before inserting
pushDepth - - the number of ElementSpec.StartTagTypes with a direction of ElementSpec.JoinNextDirection that should be generated before
insertTag - - the first tag to start inserting into document
Throws:
IOException - - on any I/O error
BadLocationException - - if pos represents an invalid location within the document

install

public void install(JEditorPane c)

Called when this is installed into the JEditorPane.
Overrides:
install in interface StyledEditorKit
Parameters:
c - - the JEditorPane installed into.

isAutoFormSubmission

public boolean isAutoFormSubmission()

Returns true when forms should be automatically submitted by the editor kit. Set this to false when you want to intercept form submission. In this case you'd want to listen for hyperlink events on the document and handle FormSubmitEvents specially. The default is true.
Returns:
true when forms should be automatically submitted by the editor kit, false otherwise
Since:
1.5
See Also:
setAutoFormSubmission(boolean), FormSubmitEvent

read

public void read(Reader in,
                 Document doc,
                 int pos)
            throws IOException,
                   BadLocationException

Inserts content from the given stream. Inserting HTML into a non-empty document must be inside the body Element, if you do not insert into the body an exception will be thrown. When inserting into a non-empty document all tags outside of the body (head, title) will be dropped.
Overrides:
read in interface DefaultEditorKit
Parameters:
in - - the stream to read from
doc - - the destination for the insertion
pos - - the location in the document to place the content
Throws:
IOException - - on any I/O error
BadLocationException - - if pos represents an invalid location within the document

setAutoFormSubmission

public void setAutoFormSubmission(boolean auto)

Sets whether or not the editor kit should automatically submit forms.
Parameters:
auto - true when the editor kit should handle form submission, false otherwise
Since:
1.5
See Also:
isAutoFormSubmission()

setDefaultCursor

public void setDefaultCursor(Cursor cursor)

Sets the default cursor.
Parameters:
cursor - - the new default cursor.

setLinkCursor

public void setLinkCursor(Cursor cursor)

Sets the Cursor for links.
Parameters:
cursor - - the new cursor for links.

setStyleSheet

public void setStyleSheet(StyleSheet s)

Set the set of styles to be used to render the various HTML elements. These styles are specified in terms of CSS specifications. Each document produced by the kit will have a copy of the sheet which it can add the document specific styles to. By default, the StyleSheet specified is shared by all HTMLEditorKit instances.
Parameters:
s - - the new style sheet

write

public void write(Writer out,
                  Document doc,
                  int pos,
                  int len)
            throws IOException,
                   BadLocationException

Writes content from a document to the given stream in an appropriate format.
Overrides:
write in interface DefaultEditorKit
Parameters:
out - - the stream to write to
doc - - the source for the write
pos - - the location in the document to get the content.
len - - the amount to write out
Throws:
IOException - - on any I/O error
BadLocationException - - if pos represents an invalid location within the document

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.

Overview Package Class Use Source Tree Index Deprecated About	GNU Classpath (0.95)
Prev Class \| Next Class	GNU Classpath (0.95)	Frames \| No Frames
Summary: Nested \| Field \| Method \| Constr	Detail: Nested \| Field \| Method \| Constr