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/setProperty methods. Subclasses may override this behavior.

@author
Timothy Prinzing
@version
1.67 12/19/03
default constructor for DefaultEditorKit
Name of the Action for moving the caret logically backward one position.
See Also
Name of the action to create a beep.
See Also
Name of the Action for moving the caret to the beginning of the document.
See Also
Name of the Action for moving the caret to the beginning of a line.
See Also
Name of the Action for moving the caret to the beginning of a paragraph.
See Also
Name of the Action for moving the caret to the beginning of a word.
See Also
Name of the action to copy the selected region and place the contents into the system clipboard.
Name of the action to cut the selected region and place the contents into the system clipboard.
Name of the action that is executed by default if a key typed event is received and there is no keymap entry.
See Also
Name of the action to delete the character of content that follows the current caret position.
See Also
Name of the action to delete the character of content that precedes the current caret position.
See Also
Name of the Action for moving the caret logically downward one position.
See Also
Name of the Action for moving the caret to the end of the document.
See Also
Name of the Action for moving the caret to the end of a line.
See Also
When reading a document if a CRLF is encountered a property with this name is added and the value will be "\r\n".
Name of the Action for moving the caret to the end of a paragraph.
See Also
Name of the Action for moving the caret to the end of a word.
See Also
Name of the Action for moving the caret logically forward one position.
See Also
Name of the action to place a line/paragraph break into the document. If there is a selection, it is removed before the break is added.
See Also
Name of the action to place content into the associated document. If there is a selection, it is removed before the new content is added.
See Also
Name of the action to place a tab character into the document. If there is a selection, it is removed before the tab is added.
See Also
Name of the Action for moving the caret to the beginning of the next word.
See Also
Name of the action to page down vertically.
See Also
Name of the action to page up vertically.
See Also
Name of the action to paste the contents of the system clipboard into the selected region, or before the caret if nothing is selected.
Name of the Action for moving the caret to the beginning of the previous word.
See Also
Name of the action to set the editor into read-only mode.
See Also
Name of the Action for selecting the entire document
See Also
Name of the Action for extending the selection by moving the caret logically backward one position.
See Also
Name of the Action for moving the caret to the beginning of the document.
See Also
Name of the Action for moving the caret to the beginning of a line, extending the selection.
See Also
Name of the Action for moving the caret to the beginning of a paragraph, extending the selection.
See Also
Name of the Action for moving the caret to the beginning of a word, extending the selection.
See Also
Name of the Action for moving the caret logically downward one position, extending the selection.
See Also
Name of the Action for moving the caret to the end of the document.
See Also
Name of the Action for moving the caret to the end of a line, extending the selection.
See Also
Name of the Action for moving the caret to the end of a paragraph, extending the selection.
See Also
Name of the Action for moving the caret to the end of a word, extending the selection.
See Also
Name of the Action for extending the selection by moving the caret logically forward one position.
See Also
Name of the Action for moving the selection to the beginning of the next word, extending the selection.
See Also
Name of the Action for moving the selection to the beginning of the previous word, extending the selection.
See Also
Name of the Action for moving the caret logically upward one position, extending the selection.
See Also
Name of the Action for selecting a line around the caret.
See Also
Name of the Action for selecting a paragraph around the caret.
See Also
Name of the Action for selecting a word around the caret.
See Also
Name of the Action for moving the caret logically upward one position.
See Also
Name of the action to set the editor into writeable mode.
See Also
Creates a copy of the editor kit. This is implemented to use Object.clone. If the kit cannot be cloned, null is returned.
Return
the copy
Fetches a caret that can navigate through views produced by the associated ViewFactory.
Return
the caret
Creates an uninitialized text storage model (PlainDocument) that is appropriate for this type of editor.
Return
the model
Called when the kit is being removed from the JEditorPane. This is used to unregister any listeners that were attached.
Parameters
cthe JEditorPane
Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Parameters
objthe reference object with which to compare.
Return
true if this object is the same as the obj argument; false otherwise.
Fetches the set of commands that can be used on a text component that is using a model and view produced by this kit.
Return
the command list
Returns the runtime class of an object. That Class object is the object that is locked by static synchronized methods of the represented class.
Return
The java.lang.Class object that represents the runtime class of the object. The result is of type {@code Class} where X is the erasure of the static type of the expression on which getClass is called.
Gets the MIME type of the data that this kit represents support for. The default is text/plain.
Return
the type
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.
Return
the view factory
Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hashtables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the JavaTM programming language.)

Return
a hash code value for this object.
Called when the kit is being installed into the a JEditorPane.
Parameters
cthe JEditorPane
Wakes up a single thread that is waiting on this object's monitor. If any threads are waiting on this object, one of them is chosen to be awakened. The choice is arbitrary and occurs at the discretion of the implementation. A thread waits on an object's monitor by calling one of the wait methods.

The awakened thread will not be able to proceed until the current thread relinquishes the lock on this object. The awakened thread will compete in the usual manner with any other threads that might be actively competing to synchronize on this object; for example, the awakened thread enjoys no reliable privilege or disadvantage in being the next thread to lock this object.

This method should only be called by a thread that is the owner of this object's monitor. A thread becomes the owner of the object's monitor in one of three ways:

  • By executing a synchronized instance method of that object.
  • By executing the body of a synchronized statement that synchronizes on the object.
  • For objects of type Class, by executing a synchronized static method of that class.

Only one thread at a time can own an object's monitor.

Throws
IllegalMonitorStateExceptionif the current thread is not the owner of this object's monitor.
Wakes up all threads that are waiting on this object's monitor. A thread waits on an object's monitor by calling one of the wait methods.

The awakened threads will not be able to proceed until the current thread relinquishes the lock on this object. The awakened threads will compete in the usual manner with any other threads that might be actively competing to synchronize on this object; for example, the awakened threads enjoy no reliable privilege or disadvantage in being the next thread to lock this object.

This method should only be called by a thread that is the owner of this object's monitor. See the notify method for a description of the ways in which a thread can become the owner of a monitor.

Throws
IllegalMonitorStateExceptionif the current thread is not the owner of this object's monitor.
Inserts content from the given stream which is expected to be in a format appropriate for this kind of content handler.
Parameters
inThe stream to read from
docThe destination for the insertion.
posThe location in the document to place the content >= 0.
Throws
IOExceptionon any I/O error
BadLocationExceptionif pos represents an invalid location within the document.
Inserts content from the given stream, which will be treated as plain text.
Parameters
inThe stream to read from
docThe destination for the insertion.
posThe location in the document to place the content >= 0.
Throws
IOExceptionon any I/O error
BadLocationExceptionif pos represents an invalid location within the document.
Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 
Return
a string representation of the object.
Causes current thread to wait until another thread invokes the method or the method for this object. In other words, this method behaves exactly as if it simply performs the call wait(0).

The current thread must own this object's monitor. The thread releases ownership of this monitor and waits until another thread notifies threads waiting on this object's monitor to wake up either through a call to the notify method or the notifyAll method. The thread then waits until it can re-obtain ownership of the monitor and resumes execution.

As in the one argument version, interrupts and spurious wakeups are possible, and this method should always be used in a loop:

     synchronized (obj) {
         while (<condition does not hold>)
             obj.wait();
         ... // Perform action appropriate to condition
     }
 
This method should only be called by a thread that is the owner of this object's monitor. See the notify method for a description of the ways in which a thread can become the owner of a monitor.
Throws
IllegalMonitorStateExceptionif the current thread is not the owner of the object's monitor.
InterruptedExceptionif another thread interrupted the current thread before or while the current thread was waiting for a notification. The interrupted status of the current thread is cleared when this exception is thrown.
Causes current thread to wait until either another thread invokes the method or the method for this object, or a specified amount of time has elapsed.

The current thread must own this object's monitor.

This method causes the current thread (call it T) to place itself in the wait set for this object and then to relinquish any and all synchronization claims on this object. Thread T becomes disabled for thread scheduling purposes and lies dormant until one of four things happens:

  • Some other thread invokes the notify method for this object and thread T happens to be arbitrarily chosen as the thread to be awakened.
  • Some other thread invokes the notifyAll method for this object.
  • Some other thread interrupts thread T.
  • The specified amount of real time has elapsed, more or less. If timeout is zero, however, then real time is not taken into consideration and the thread simply waits until notified.
The thread T is then removed from the wait set for this object and re-enabled for thread scheduling. It then competes in the usual manner with other threads for the right to synchronize on the object; once it has gained control of the object, all its synchronization claims on the object are restored to the status quo ante - that is, to the situation as of the time that the wait method was invoked. Thread T then returns from the invocation of the wait method. Thus, on return from the wait method, the synchronization state of the object and of thread T is exactly as it was when the wait method was invoked.

A thread can also wake up without being notified, interrupted, or timing out, a so-called spurious wakeup. While this will rarely occur in practice, applications must guard against it by testing for the condition that should have caused the thread to be awakened, and continuing to wait if the condition is not satisfied. In other words, waits should always occur in loops, like this one:

     synchronized (obj) {
         while (<condition does not hold>)
             obj.wait(timeout);
         ... // Perform action appropriate to condition
     }
 
(For more information on this topic, see Section 3.2.3 in Doug Lea's "Concurrent Programming in Java (Second Edition)" (Addison-Wesley, 2000), or Item 50 in Joshua Bloch's "Effective Java Programming Language Guide" (Addison-Wesley, 2001).

If the current thread is interrupted by another thread while it is waiting, then an InterruptedException is thrown. This exception is not thrown until the lock status of this object has been restored as described above.

Note that the wait method, as it places the current thread into the wait set for this object, unlocks only this object; any other objects on which the current thread may be synchronized remain locked while the thread waits.

This method should only be called by a thread that is the owner of this object's monitor. See the notify method for a description of the ways in which a thread can become the owner of a monitor.

Parameters
timeoutthe maximum time to wait in milliseconds.
Throws
IllegalArgumentExceptionif the value of timeout is negative.
IllegalMonitorStateExceptionif the current thread is not the owner of the object's monitor.
InterruptedExceptionif another thread interrupted the current thread before or while the current thread was waiting for a notification. The interrupted status of the current thread is cleared when this exception is thrown.
Causes current thread to wait until another thread invokes the method or the method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.

This method is similar to the wait method of one argument, but it allows finer control over the amount of time to wait for a notification before giving up. The amount of real time, measured in nanoseconds, is given by:

 1000000*timeout+nanos

In all other respects, this method does the same thing as the method of one argument. In particular, wait(0, 0) means the same thing as wait(0).

The current thread must own this object's monitor. The thread releases ownership of this monitor and waits until either of the following two conditions has occurred:

  • Another thread notifies threads waiting on this object's monitor to wake up either through a call to the notify method or the notifyAll method.
  • The timeout period, specified by timeout milliseconds plus nanos nanoseconds arguments, has elapsed.

The thread then waits until it can re-obtain ownership of the monitor and resumes execution.

As in the one argument version, interrupts and spurious wakeups are possible, and this method should always be used in a loop:

     synchronized (obj) {
         while (<condition does not hold>)
             obj.wait(timeout, nanos);
         ... // Perform action appropriate to condition
     }
 
This method should only be called by a thread that is the owner of this object's monitor. See the notify method for a description of the ways in which a thread can become the owner of a monitor.
Parameters
timeoutthe maximum time to wait in milliseconds.
nanosadditional time, in nanoseconds range 0-999999.
Throws
IllegalArgumentExceptionif the value of timeout is negative or the value of nanos is not in the range 0-999999.
IllegalMonitorStateExceptionif the current thread is not the owner of this object's monitor.
InterruptedExceptionif another thread interrupted the current thread before or while the current thread was waiting for a notification. The interrupted status of the current thread is cleared when this exception is thrown.
Writes content from a document to the given stream in a format appropriate for this kind of content handler.
Parameters
outThe stream to write to
docThe source for the write.
posThe location in the document to fetch the content >= 0.
lenThe amount to write out >= 0.
Throws
IOExceptionon any I/O error
BadLocationExceptionif pos represents an invalid location within the document.
Writes content from a document to the given stream as plain text.
Parameters
outThe stream to write to
docThe source for the write.
posThe location in the document to fetch the content from >= 0.
lenThe amount to write out >= 0.
Throws
IOExceptionon any I/O error
BadLocationExceptionif pos is not within 0 and the length of the document.