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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, javax.accessibility.Accessible

public class HTMLEditorKit
extends javax.swing.text.StyledEditorKit
implements java.io.Serializable, java.lang.Cloneable, javax.accessibility.Accessible

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HTMLEditorKit.HTMLFactory A ViewFactory that is able to create Views for the Elements 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

javax.swing.text.StyledEditorKit.AlignmentAction, javax.swing.text.StyledEditorKit.BoldAction, javax.swing.text.StyledEditorKit.FontFamilyAction, javax.swing.text.StyledEditorKit.FontSizeAction, javax.swing.text.StyledEditorKit.ForegroundAction, javax.swing.text.StyledEditorKit.ItalicAction, javax.swing.text.StyledEditorKit.StyledTextAction, javax.swing.text.StyledEditorKit.UnderlineAction

Nested classes/interfaces inherited from class javax.swing.text.DefaultEditorKit

javax.swing.text.DefaultEditorKit.BeepAction, javax.swing.text.DefaultEditorKit.CopyAction, javax.swing.text.DefaultEditorKit.CutAction, javax.swing.text.DefaultEditorKit.DefaultKeyTypedAction, javax.swing.text.DefaultEditorKit.InsertBreakAction, javax.swing.text.DefaultEditorKit.InsertContentAction, javax.swing.text.DefaultEditorKit.InsertTabAction, javax.swing.text.DefaultEditorKit.PasteAction

Field Summary

Fields

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

Fields inherited from class javax.swing.text.DefaultEditorKit

backwardAction, beepAction, beginAction, beginLineAction, beginParagraphAction, beginWordAction, copyAction, cutAction, defaultKeyTypedAction, deleteNextCharAction, deletePrevCharAction, downAction, endAction, endLineAction, EndOfLineStringProperty, endParagraphAction, endWordAction, forwardAction, insertBreakAction, insertContentAction, insertTabAction, nextWordAction, pageDownAction, pageUpAction, pasteAction, previousWordAction, readOnlyAction, selectAllAction, selectionBackwardAction, selectionBeginAction, selectionBeginLineAction, selectionBeginParagraphAction, selectionBeginWordAction, selectionDownAction, selectionEndAction, selectionEndLineAction, selectionEndParagraphAction, selectionEndWordAction, selectionForwardAction, selectionNextWordAction, selectionPreviousWordAction, selectionUpAction, selectLineAction, selectParagraphAction, selectWordAction, upAction, writableAction

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	clone() Creates a copy of the editor kit.
javax.swing.text.Document	createDefaultDocument() Create a text storage model for this type of editor.
protected void	createInputAttributes(javax.swing.text.Element element, javax.swing.text.MutableAttributeSet set) Copies the key/values in elements AttributeSet into set.
void	deinstall(javax.swing.JEditorPane c) Called when the this is removed from the JEditorPane.
javax.accessibility.AccessibleContext	getAccessibleContext() Gets the AccessibleContext associated with this.
javax.swing.Action[]	getActions() Gets the action list.
java.lang.String	getContentType() Gets the content type that the kit supports.
java.awt.Cursor	getDefaultCursor() Returns the default cursor.
javax.swing.text.MutableAttributeSet	getInputAttributes() Gets the input attributes used for the styled editing actions.
java.awt.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.
javax.swing.text.ViewFactory	getViewFactory() Gets a factory suitable for producing views of any models that are produced by this kit.
void	insertHTML(HTMLDocument doc, int offset, java.lang.String html, int popDepth, int pushDepth, HTML.Tag insertTag) Inserts HTML into an existing document.
void	install(javax.swing.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(java.io.Reader in, javax.swing.text.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(java.awt.Cursor cursor) Sets the default cursor.
void	setLinkCursor(java.awt.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(java.io.Writer out, javax.swing.text.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

getCharacterAttributeRun

Methods inherited from class javax.swing.text.DefaultEditorKit

createCaret, read, write

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_CSS

public static final java.lang.String DEFAULT_CSS

Default cascading stylesheed file ("default.css").

See Also:

Constant Field Values

BOLD_ACTION

public static final java.lang.String BOLD_ACTION

The bold action identifier.

See Also:

Constant Field Values

ITALIC_ACTION

public static final java.lang.String ITALIC_ACTION

The italic action identifier.

See Also:

Constant Field Values

COLOR_ACTION

public static final java.lang.String COLOR_ACTION

The color action indentifier (passing the color as an argument).

See Also:

Constant Field Values

FONT_CHANGE_BIGGER

public static final java.lang.String FONT_CHANGE_BIGGER

The increase font action identifier.

See Also:

Constant Field Values

FONT_CHANGE_SMALLER

public static final java.lang.String FONT_CHANGE_SMALLER

The decrease font action identifier.

See Also:

Constant Field Values

IMG_ALIGN_BOTTOM

public static final java.lang.String IMG_ALIGN_BOTTOM

Align images at the bottom.

See Also:

Constant Field Values

IMG_ALIGN_MIDDLE

public static final java.lang.String IMG_ALIGN_MIDDLE

Align images at the middle.

See Also:

Constant Field Values

IMG_ALIGN_TOP

public static final java.lang.String IMG_ALIGN_TOP

Align images at the top.

See Also:

Constant Field Values

IMG_BORDER

public static final java.lang.String IMG_BORDER

Align images at the border.

See Also:

Constant Field Values

LOGICAL_STYLE_ACTION

public static final java.lang.String LOGICAL_STYLE_ACTION

The "logical style" action identifier, passing that style as parameter.

See Also:

Constant Field Values

PARA_INDENT_LEFT

public static final java.lang.String PARA_INDENT_LEFT

The "ident paragraph left" action.

See Also:

Constant Field Values

PARA_INDENT_RIGHT

public static final java.lang.String PARA_INDENT_RIGHT

The "ident paragraph right" action.

See Also:

Constant Field Values

Constructor Detail

HTMLEditorKit

public HTMLEditorKit()

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

Method Detail

getViewFactory

public javax.swing.text.ViewFactory getViewFactory()

Gets a factory suitable for producing views of any models that are produced by this kit.

Overrides:

getViewFactory in class javax.swing.text.StyledEditorKit

Returns:

the view factory suitable for producing views.

createDefaultDocument

public javax.swing.text.Document createDefaultDocument()

Create a text storage model for this type of editor.

Overrides:

createDefaultDocument in class javax.swing.text.StyledEditorKit

Returns:

the model

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).

insertHTML

public void insertHTML(HTMLDocument doc,
              int offset,
              java.lang.String html,
              int popDepth,
              int pushDepth,
              HTML.Tag insertTag)
                throws javax.swing.text.BadLocationException,
                       java.io.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:

java.io.IOException - - on any I/O error

javax.swing.text.BadLocationException - - if pos represents an invalid location within the document

read

public void read(java.io.Reader in,
        javax.swing.text.Document doc,
        int pos)
          throws java.io.IOException,
                 javax.swing.text.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 class javax.swing.text.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:

java.io.IOException - - on any I/O error

javax.swing.text.BadLocationException - - if pos represents an invalid location within the document

write

public void write(java.io.Writer out,
         javax.swing.text.Document doc,
         int pos,
         int len)
           throws java.io.IOException,
                  javax.swing.text.BadLocationException

Writes content from a document to the given stream in an appropriate format.

Overrides:

write in class javax.swing.text.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:

java.io.IOException - - on any I/O error

javax.swing.text.BadLocationException - - if pos represents an invalid location within the document

getContentType

public java.lang.String getContentType()

Gets the content type that the kit supports. This kit supports the type text/html.

Overrides:

getContentType in class javax.swing.text.DefaultEditorKit

Returns:

the content type that this EditorKit supports

clone

public java.lang.Object clone()

Creates a copy of the editor kit.

Overrides:

clone in class javax.swing.text.StyledEditorKit

Returns:

a copy of this.

See Also:

Cloneable

createInputAttributes

protected void createInputAttributes(javax.swing.text.Element element,
                         javax.swing.text.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 class javax.swing.text.StyledEditorKit

Parameters:

element - - the element to create the input attributes for.

set - - the set to copy the values into.

install

public void install(javax.swing.JEditorPane c)

Called when this is installed into the JEditorPane.

Overrides:

install in class javax.swing.text.StyledEditorKit

Parameters:

c - - the JEditorPane installed into.

deinstall

public void deinstall(javax.swing.JEditorPane c)

Called when the this is removed from the JEditorPane. It unregisters any listeners.

Overrides:

deinstall in class javax.swing.text.StyledEditorKit

Parameters:

c - - the JEditorPane being removed from.

getAccessibleContext

public javax.accessibility.AccessibleContext getAccessibleContext()

Gets the AccessibleContext associated with this.

Specified by:

getAccessibleContext in interface javax.accessibility.Accessible

Returns:

the AccessibleContext for this.

getActions

public javax.swing.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 class javax.swing.text.StyledEditorKit

Returns:

an array of all the actions

getDefaultCursor

public java.awt.Cursor getDefaultCursor()

Returns the default cursor.

Returns:

the default cursor

getLinkCursor

public java.awt.Cursor getLinkCursor()

Returns the cursor for links.

Returns:

the cursor for links.

setLinkCursor

public void setLinkCursor(java.awt.Cursor cursor)

Sets the Cursor for links.

Parameters:

cursor - - the new cursor for links.

setDefaultCursor

public void setDefaultCursor(java.awt.Cursor cursor)

Sets the default cursor.

Parameters:

cursor - - the new default cursor.

getInputAttributes

public javax.swing.text.MutableAttributeSet getInputAttributes()

Gets the input attributes used for the styled editing actions.

Overrides:

getInputAttributes in class javax.swing.text.StyledEditorKit

Returns:

the attribute set

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.

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

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

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()