Module java.desktop

Class DefaultEditorKit

java.lang.Object
javax.swing.text.EditorKit
javax.swing.text.DefaultEditorKit
All Implemented Interfaces:
Serializable, Cloneable
Direct Known Subclasses:
StyledEditorKit

public class DefaultEditorKit
extends EditorKit
This is the set of things needed by a text component to be a reasonably functioning editor for some type of text document. This implementation provides a default implementation which treats text as plain text and provides a minimal set of actions for a simple editor.
Newlines
There are two properties which deal with newlines. The system property, line.separator, is defined to be platform-dependent, either "\n", "\r", or "\r\n". There is also a property defined in DefaultEditorKit, called EndOfLineStringProperty, which is defined automatically when a document is loaded, to be the first occurrence of any of the newline characters. When a document is loaded, EndOfLineStringProperty is set appropriately, and when the document is written back out, the EndOfLineStringProperty is used. But while the document is in memory, the "\n" character is used to define a newline, regardless of how the newline is defined when the document is on disk. Therefore, for searching purposes, "\n" should always be used. When a new document is created, and the EndOfLineStringProperty has not been defined, it will use the System property when writing out the document.

Note that EndOfLineStringProperty is set on the Document using the get/putProperty methods. Subclasses may override this behavior.

  • Field Details

  • Constructor Details

    • DefaultEditorKit

      public DefaultEditorKit()
      default constructor for DefaultEditorKit
  • Method Details

    • getContentType

      public String getContentType()
      Gets the MIME type of the data that this kit represents support for. The default is text/plain.
      Specified by:
      getContentType in class EditorKit
      Returns:
      the type
    • getViewFactory

      public ViewFactory getViewFactory()
      Fetches a factory that is suitable for producing views of any models that are produced by this kit. The default is to have the UI produce the factory, so this method has no implementation.
      Specified by:
      getViewFactory in class EditorKit
      Returns:
      the view factory
    • getActions

      public 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.
      Specified by:
      getActions in class EditorKit
      Returns:
      the command list
    • createCaret

      public Caret createCaret()
      Fetches a caret that can navigate through views produced by the associated ViewFactory.
      Specified by:
      createCaret in class EditorKit
      Returns:
      the caret
    • createDefaultDocument

      public Document createDefaultDocument()
      Creates an uninitialized text storage model (PlainDocument) that is appropriate for this type of editor.
      Specified by:
      createDefaultDocument in class EditorKit
      Returns:
      the model
    • read

      public 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.
      Specified by:
      read in class EditorKit
      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.
    • write

      public 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.
      Specified by:
      write in class EditorKit
      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.
    • read

      public void read(Reader in, Document doc, int pos) throws IOException, BadLocationException
      Inserts content from the given stream, which will be treated as plain text.
      Specified by:
      read in class EditorKit
      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.
    • write

      public void write(Writer out, Document doc, int pos, int len) throws IOException, BadLocationException
      Writes content from a document to the given stream as plain text.
      Specified by:
      write in class EditorKit
      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 is not within 0 and the length of the document.