javax.swing.text

Class EditorKit

Implemented Interfaces:
Cloneable, Serializable
Known Direct Subclasses:
DefaultEditorKit

public abstract class EditorKit
extends Object
implements Cloneable, Serializable

See Also:
Serialized Form

Constructor Summary

EditorKit()
The basic constructor.

Method Summary

Object
clone()
This method may be called to create a new copy of the Object.
abstract Caret
createCaret()
abstract Document
createDefaultDocument()
void
deinstall(JEditorPane c)
Called when the kit is being removed from the JEditorPane.
abstract Action[]
getActions()
abstract String
getContentType()
abstract ViewFactory
getViewFactory()
void
install(JEditorPane c)
abstract void
read(InputStream in, Document doc, int pos)
abstract void
read(Reader in, Document doc, int pos)
abstract void
write(OutputStream out, Document doc, int pos, int len)
abstract void
write(Writer out, Document doc, int pos, int len)

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

EditorKit

public EditorKit()
The basic constructor. Object is special, because it has no superclass, so there is no call to super().

Method Details

clone

public Object clone()
This method may be called to create a new copy of the Object. The typical behavior is as follows:
  • o == o.clone() is false
  • o.getClass() == o.clone().getClass() is true
  • o.equals(o) is true

However, these are not strict requirements, and may be violated if necessary. Of the three requirements, the last is the most commonly violated, particularly if the subclass does not override Object.equals(Object).

If the Object you call clone() on does not implement Cloneable (which is a placeholder interface), then a CloneNotSupportedException is thrown. Notice that Object does not implement Cloneable; this method exists as a convenience for subclasses that do.

Object's implementation of clone allocates space for the new Object using the correct class, without calling any constructors, and then fills in all of the new field values with the old field values. Thus, it is a shallow copy. However, subclasses are permitted to make a deep copy.

All array types implement Cloneable, and override this method as follows (it should never fail):

 public Object clone()
 {
   try
     {
       super.clone();
     }
   catch (CloneNotSupportedException e)
     {
       throw new InternalError(e.getMessage());
     }
 }
 
Overrides:
clone in interface Object
Returns:
a copy of the Object
See Also:
Cloneable

createCaret

public abstract Caret createCaret()

createDefaultDocument

public abstract Document createDefaultDocument()

deinstall

public void deinstall(JEditorPane c)
Called when the kit is being removed from the JEditorPane.

getActions

public abstract Action[] getActions()

getContentType

public abstract String getContentType()

getViewFactory

public abstract ViewFactory getViewFactory()

install

public void install(JEditorPane c)

read

public abstract void read(InputStream in,
                          Document doc,
                          int pos)
            throws BadLocationException,
                   IOException

read

public abstract void read(Reader in,
                          Document doc,
                          int pos)
            throws BadLocationException,
                   IOException

write

public abstract void write(OutputStream out,
                           Document doc,
                           int pos,
                           int len)
            throws BadLocationException,
                   IOException

write

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

EditorKit.java -- Copyright (C) 2002, 2004 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.