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 it's setComponent method called to establish it's relationship with a JTextComponent.
public EditorKit()
Construct an EditorKit.
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.
public void install(JEditorPane c)
Called when the kit is being installed into the a JEditorPane.
c - the JEditorPanepublic void deinstall(JEditorPane c)
Called when the kit is being removed from the JEditorPane. This is used to unregister any listeners that were attached.
c - the JEditorPanepublic abstract String getContentType()
Gets the MIME type of the data that this kit represents support for.
public abstract ViewFactory getViewFactory()
Fetches a factory that is suitable for producing views of any models that are produced by this kit.
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.
public abstract Caret createCaret()
Fetches a caret that can navigate through views produced by the associated ViewFactory.
public abstract Document createDefaultDocument()
Creates an uninitialized text storage model that is appropriate for this type of editor.
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.
in - The stream to read fromdoc - The destination for the insertion.pos - The location in the document to place the content >= 0.IOException - on any I/O errorBadLocationException - if pos represents an invalid location within the document.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.
out - The stream to write todoc - The source for the write.pos - The location in the document to fetch the content from >= 0.len - The amount to write out >= 0.IOException - on any I/O errorBadLocationException - if pos represents an invalid location within the document.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.
in - The stream to read fromdoc - The destination for the insertion.pos - The location in the document to place the content >= 0.IOException - on any I/O errorBadLocationException - if pos represents an invalid location within the document.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.
out - The stream to write todoc - The source for the write.pos - The location in the document to fetch the content >= 0.len - The amount to write out >= 0.IOException - on any I/O errorBadLocationException - if pos represents an invalid location within the document.
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.