Package Summary  Overview Summary

class:EditorKit [NONE]

All Implemented Interfaces:
Serializable, Cloneable
Direct Known Subclasses:
DefaultEditorKit

public abstract class EditorKit
extends Object
implements Cloneable, Serializable
Establishes the set of things needed by a text component to be a reasonably functioning editor for some type of text content. The EditorKit acts as a factory for some kind of policy. For example, an implementation of html and rtf can be provided that is replaceable with other implementations.

A kit can safely store editing state as an instance of the kit will be dedicated to a text component. New kits will normally be created by cloning a prototype kit. The kit will have its setComponent method called to establish its relationship with a JTextComponent.

constructor:EditorKit() [NONE]

  • EditorKit

    public EditorKit()
    Construct an EditorKit.

method:clone() [NONE]

  • clone

    public Object clone()
    Creates a copy of the editor kit. This is implemented to use Object.clone(). If the kit cannot be cloned, null is returned.
    Overrides:
    clone in class Object
    Returns:
    the copy
    See Also:
    Cloneable
  • method:install(javax.swing.JEditorPane) [NONE]

    install

    public void install?(JEditorPane c)
    Called when the kit is being installed into the a JEditorPane.
    Parameters:
    c - the JEditorPane

    method:deinstall(javax.swing.JEditorPane) [NONE]

    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

    method:getContentType() [NONE]

    getContentType

    public abstract  String getContentType()
    Gets the MIME type of the data that this kit represents support for.
    Returns:
    the type

    method:getViewFactory() [NONE]

    getViewFactory

    public abstract  ViewFactory getViewFactory()
    Fetches a factory that is suitable for producing views of any models that are produced by this kit.
    Returns:
    the factory

    method:getActions() [NONE]

    getActions

    public abstract  Action[] getActions()
    Fetches the set of commands that can be used on a text component that is using a model and view produced by this kit.
    Returns:
    the set of actions

    method:createCaret() [NONE]

    createCaret

    public abstract  Caret createCaret()
    Fetches a caret that can navigate through views produced by the associated ViewFactory.
    Returns:
    the caret

    method:createDefaultDocument() [NONE]

    createDefaultDocument

    public abstract  Document createDefaultDocument()
    Creates an uninitialized text storage model that is appropriate for this type of editor.
    Returns:
    the model

    method:read(java.io.InputStream,javax.swing.text.Document,int) [NONE]

    read

    public abstract  void read?(InputStream in, Document doc, int pos) throws IOException, BadLocationException
    Inserts content from the given stream which is expected to be in a format appropriate for this kind of content handler.
    Parameters:
    in - The stream to read from
    doc - The destination for the insertion.
    pos - The location in the document to place the content >= 0.
    Throws:
    IOException - on any I/O error
    BadLocationException - if pos represents an invalid location within the document.

    method:write(java.io.OutputStream,javax.swing.text.Document,int,int) [NONE]

    write

    public abstract  void write?(OutputStream out, Document doc, int pos, int len) throws IOException, BadLocationException
    Writes 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 from >= 0.
    len - The amount to write out >= 0.
    Throws:
    IOException - on any I/O error
    BadLocationException - if pos represents an invalid location within the document.

    method:read(java.io.Reader,javax.swing.text.Document,int) [NONE]

    read

    public abstract  void read?(Reader in, Document doc, int pos) throws IOException, BadLocationException
    Inserts content from the given stream which is expected to be in a format appropriate for this kind of content handler.

    Since actual text editing is unicode based, this would generally be the preferred way to read in the data. Some types of content are stored in an 8-bit form however, and will favor the InputStream.

    Parameters:
    in - The stream to read from
    doc - The destination for the insertion.
    pos - The location in the document to place the content >= 0.
    Throws:
    IOException - on any I/O error
    BadLocationException - if pos represents an invalid location within the document.

    method:write(java.io.Writer,javax.swing.text.Document,int,int) [NONE]

    write

    public abstract  void write?(Writer out, Document doc, int pos, int len) throws IOException, BadLocationException
    Writes content from a document to the given stream in a format appropriate for this kind of content handler.

    Since actual text editing is unicode based, this would generally be the preferred way to write the data. Some types of content are stored in an 8-bit form however, and will favor the OutputStream.

    Parameters:
    out - The stream to write to
    doc - The source for the write.
    pos - The location in the document to fetch the content >= 0.
    len - The amount to write out >= 0.
    Throws:
    IOException - on any I/O error
    BadLocationException - if pos represents an invalid location within the document.

    © 2021 Oracle Corporation and/or its affiliates