Overview | Package | Class | Tree | Deprecated | Index | Help			Java Platform 1.1.7
PREV CLASS | NEXT CLASS	FRAMES | NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

Class com.sun.java.swing.text.html.HTMLEditorKit

java.lang.Object
  |
  +--com.sun.java.swing.text.EditorKit
        |
        +--com.sun.java.swing.text.DefaultEditorKit
              |
              +--com.sun.java.swing.text.StyledEditorKit
                    |
                    +--com.sun.java.swing.text.html.HTMLEditorKit

public class HTMLEditorKit

extends StyledEditorKit

This is the default implementation of html editing functionality. The primary goal with this is to be small, but flexible. It is not intended to be an all singing and all dancing html implementation. This is provided to meet more modest needs, with the idea that more substantial needs can be met with alternative implementations.

See Also:

Serialized Form

Inner Class Summary

static	HTMLEditorKit.HTMLFactory A factory to build view fragments for html.
static	HTMLEditorKit.LinkController Class to watch the associated component and fire hyperlink events on it when appropriate.

Inner classes inherited from class com.sun.java.swing.text.StyledEditorKit

StyledEditorKit.AlignmentAction, StyledEditorKit.BoldAction, StyledEditorKit.FontFamilyAction, StyledEditorKit.FontSizeAction, StyledEditorKit.ForegroundAction, StyledEditorKit.ItalicAction, StyledEditorKit.StyledTextAction, StyledEditorKit.UnderlineAction

Inner classes inherited from class com.sun.java.swing.text.DefaultEditorKit

DefaultEditorKit.BeepAction, DefaultEditorKit.CopyAction, DefaultEditorKit.CutAction, DefaultEditorKit.DefaultKeyTypedAction, DefaultEditorKit.InsertBreakAction, DefaultEditorKit.InsertContentAction, DefaultEditorKit.InsertTabAction, DefaultEditorKit.PasteAction

Field Summary

static java.lang.String	BOLD_ACTION The bold action identifier
static java.lang.String	COLOR_ACTION The Color choice action identifier The color is passed as an argument
static java.lang.String	DEFAULT_CSS Default Cascading Style Sheet file that sets up the tag views.
static java.lang.String	FONT_CHANGE_BIGGER The font size increase to next value action identifier
static java.lang.String	FONT_CHANGE_SMALLER The font size decrease to next value action identifier
static java.lang.String	IMG_ALIGN_BOTTOM Align images at the bottom.
static java.lang.String	IMG_ALIGN_MIDDLE Align images in 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 choice action identifier The logical style is passed in as an argument
static java.lang.String	PARA_INDENT_LEFT The paragraph left indent action identifier
static java.lang.String	PARA_INDENT_RIGHT The paragraph right indent action identifier

Fields inherited from class com.sun.java.swing.text.DefaultEditorKit

backwardAction, beepAction, beginAction, beginLineAction, beginParagraphAction, beginWordAction, copyAction, cutAction, defaultKeyTypedAction, deleteNextCharAction, deletePrevCharAction, downAction, endAction, endLineAction, 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

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

Method Summary

java.lang.Object	clone() Create a copy of the editor kit.
Document	createDefaultDocument() Create an uninitialized text storage model that is appropriate for this type of editor.
void	deinstall(JEditorPane c) Called when the kit is being removed from the JEditorPane.
Action[]	getActions() Fetches the command list for the editor.
java.lang.String	getContentType() Get the MIME type of the data that this kit represents support for.
com.sun.java.swing.text.html.HTMLEditorKit.Parser	getParser() Fetch the parser to use for reading html streams.
ViewFactory	getViewFactory() Fetch a factory that is suitable for producing views of any models that are produced by this kit.
void	install(JEditorPane c) Called when the kit is being installed into the a JEditorPane.
void	read(java.io.Reader in, Document doc, int pos) Create and initialize a model from the given stream which is expected to be in a format appropriate for this kind of editor.
void	write(java.io.Writer out, Document doc, int pos, int len) Write content from a document to the given stream in a format appropriate for this kind of content handler.

Methods inherited from class com.sun.java.swing.text.StyledEditorKit

clone, createDefaultDocument, deinstall, getActions, getCharacterAttributeRun, getInputAttributes, getViewFactory, install

Methods inherited from class com.sun.java.swing.text.DefaultEditorKit

clone, createCaret, createDefaultDocument, getActions, getContentType, getViewFactory, read, read, write, write

Methods inherited from class com.sun.java.swing.text.EditorKit

clone, createCaret, createDefaultDocument, deinstall, getActions, getContentType, getViewFactory, install, read, read, write, write

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CSS

public static final java.lang.String DEFAULT_CSS

Default Cascading Style Sheet file that sets up the tag views.

BOLD_ACTION

public static final java.lang.String BOLD_ACTION

The bold action identifier

ITALIC_ACTION

public static final java.lang.String ITALIC_ACTION

The italic action identifier

PARA_INDENT_LEFT

public static final java.lang.String PARA_INDENT_LEFT

The paragraph left indent action identifier

PARA_INDENT_RIGHT

public static final java.lang.String PARA_INDENT_RIGHT

The paragraph right indent action identifier

FONT_CHANGE_BIGGER

public static final java.lang.String FONT_CHANGE_BIGGER

The font size increase to next value action identifier

FONT_CHANGE_SMALLER

public static final java.lang.String FONT_CHANGE_SMALLER

The font size decrease to next value action identifier

COLOR_ACTION

public static final java.lang.String COLOR_ACTION

The Color choice action identifier The color is passed as an argument

LOGICAL_STYLE_ACTION

public static final java.lang.String LOGICAL_STYLE_ACTION

The logical style choice action identifier The logical style is passed in as an argument

IMG_ALIGN_TOP

public static final java.lang.String IMG_ALIGN_TOP

Align images at the top.

IMG_ALIGN_MIDDLE

public static final java.lang.String IMG_ALIGN_MIDDLE

Align images in the middle.

IMG_ALIGN_BOTTOM

public static final java.lang.String IMG_ALIGN_BOTTOM

Align images at the bottom.

IMG_BORDER

public static final java.lang.String IMG_BORDER

Align images at the border.

Constructor Detail

HTMLEditorKit

public HTMLEditorKit()

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

Method Detail

clone

public java.lang.Object clone()

Create a copy of the editor kit. This allows an implementation to serve as a prototype for others, so that they can be quickly created.

Returns:

the copy

Overrides:

clone in class StyledEditorKit

getContentType

public java.lang.String getContentType()

Get the MIME type of the data that this kit represents support for. This kit supports the type text/html.

Returns:

the type

Overrides:

getContentType in class DefaultEditorKit

getViewFactory

public ViewFactory getViewFactory()

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

Returns:

the factory

Overrides:

getViewFactory in class StyledEditorKit

createDefaultDocument

public Document createDefaultDocument()

Create an uninitialized text storage model that is appropriate for this type of editor.

Returns:

the model

Overrides:

createDefaultDocument in class StyledEditorKit

read

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

Create and initialize a model from the given stream which is expected to be in a format appropriate for this kind of editor. This is implemented to read html 3.2 text.

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

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

Overrides:

read in class DefaultEditorKit

write

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

Write content from a document to the given stream in a format appropriate for this kind of content handler.

Parameters:

out - The stream to write to

doc - The source for the write.

pos - The location in the document to fetch the content.

len - The amount to write out.

Throws:

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

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

Overrides:

write in class DefaultEditorKit

install

public void install(JEditorPane c)

Called when the kit is being installed into the a JEditorPane.

Parameters:

c - the JEditorPane

Overrides:

install in class StyledEditorKit

deinstall

public void deinstall(JEditorPane c)

Called when the kit is being removed from the JEditorPane. This is used to unregister any listeners that were attached.

Parameters:

c - the JEditorPane

Overrides:

deinstall in class StyledEditorKit

getActions

public Action[] getActions()

Fetches the command list for the editor. This is the list of commands supported by the superclass augmented by the collection of commands defined locally for style operations.

Returns:

the command list

Overrides:

getActions in class StyledEditorKit

getParser

protected com.sun.java.swing.text.html.HTMLEditorKit.Parser getParser()

Fetch the parser to use for reading html streams. This can be reimplemented to provide a different parser. The default implementation is loaded dynamically to avoid the overhead of loading the default parser if it's not used. The default parser is based upon JavaCC, with the grammar defined in the file html-3.2.jj. One can replace the parser using a customized grammar, or replace the parser with one that doesn't use the JavaCC parser generator.