Java Platform 1.2
Beta 4

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

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.
static  HTMLEditorKit.Parser
          Interface to be supported by the parser.
static  HTMLEditorKit.ParserCallback
          The result of parsing drives these callback methods.
 
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 String BOLD_ACTION
          The bold action identifier
static String COLOR_ACTION
          The Color choice action identifier The color is passed as an argument
static String DEFAULT_CSS
          Default Cascading Style Sheet file that sets up the tag views.
static String FONT_CHANGE_BIGGER
          The font size increase to next value action identifier
static String FONT_CHANGE_SMALLER
          The font size decrease to next value action identifier
static String IMG_ALIGN_BOTTOM
          Align images at the bottom.
static String IMG_ALIGN_MIDDLE
          Align images in 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 choice action identifier The logical style is passed in as an argument
static String PARA_INDENT_LEFT
          The paragraph left indent action identifier
static 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
 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.
 String getContentType()
          Get the MIME type of the data that this kit represents support for.
protected  HTMLEditorKit.Parser getParser()
          Fetch the parser to use for reading html streams.
 StyleSheet getStyleSheet()
          Get the set of styles currently being used to render the html elements.
 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(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 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)
          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
getCharacterAttributeRun , getInputAttributes
 
Methods inherited from class com.sun.java.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 String DEFAULT_CSS
Default Cascading Style Sheet file that sets up the tag views.

BOLD_ACTION

public static final String BOLD_ACTION
The bold action identifier

ITALIC_ACTION

public static final String ITALIC_ACTION
The italic action identifier

PARA_INDENT_LEFT

public static final String PARA_INDENT_LEFT
The paragraph left indent action identifier

PARA_INDENT_RIGHT

public static final String PARA_INDENT_RIGHT
The paragraph right indent action identifier

FONT_CHANGE_BIGGER

public static final String FONT_CHANGE_BIGGER
The font size increase to next value action identifier

FONT_CHANGE_SMALLER

public static final String FONT_CHANGE_SMALLER
The font size decrease to next value action identifier

COLOR_ACTION

public static final String COLOR_ACTION
The Color choice action identifier The color is passed as an argument

LOGICAL_STYLE_ACTION

public static final 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 String IMG_ALIGN_TOP
Align images at the top.

IMG_ALIGN_MIDDLE

public static final String IMG_ALIGN_MIDDLE
Align images in the middle.

IMG_ALIGN_BOTTOM

public static final String IMG_ALIGN_BOTTOM
Align images at the bottom.

IMG_BORDER

public static final 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 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 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(Reader in,
                 Document doc,
                 int pos)
          throws 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:
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(Writer out,
                  Document doc,
                  int pos,
                  int len)
           throws 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:
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

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. This should be reimplemented to provide a finer granularity if desired.

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.

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 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 the HotJava parser using an html 3.2 dtd.

Java Platform 1.2
Beta 4

Submit a bug or feature
Submit comments/suggestions about new javadoc look
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-1998 Sun Microsystems, Inc. 901 San Antonio Road,
Palo Alto, California, 94303, U.S.A. All Rights Reserved.
This documentation was generated with a post-Beta4 version of Javadoc.