APIdia Launch Partner
Top Description Inners Fields Constructors Methods
javax.swing.text

public Class DefaultEditorKit

extends EditorKit
Class Inheritance
Known Direct Subclasses
javax.swing.text.StyledEditorKit, javax.swing.JEditorPane.PlainEditorKit
Annotations
@SuppressWarnings:serial
Imports
sun.awt.SunToolkit, java.io.*, java.awt.*, java.awt.event.ActionEvent, java.text.*, javax.swing.Action, .KeyStroke, .SwingConstants, .UIManager
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.

Author
Timothy Prinzing

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
DefaultEditorKit.BeepAction

Creates a beep.

pack-priv static class
DefaultEditorKit.BeginAction

pack-priv static class
DefaultEditorKit.BeginLineAction

pack-priv static class
DefaultEditorKit.BeginLineUpAction

pack-priv static class
DefaultEditorKit.BeginParagraphAction

pack-priv static class
DefaultEditorKit.BeginWordAction

public static class
DefaultEditorKit.CopyAction

Copies the selected region and place its contents into the system clipboard.

public static class
DefaultEditorKit.CutAction

Cuts the selected region and place its contents into the system clipboard.

public static class
DefaultEditorKit.DefaultKeyTypedAction

The action that is executed by default if a key typed event is received and there is no keymap entry.

pack-priv static class
DefaultEditorKit.DeleteNextCharAction

pack-priv static class
DefaultEditorKit.DeletePrevCharAction

pack-priv static class
DefaultEditorKit.DeleteWordAction

pack-priv static class
DefaultEditorKit.DumpModelAction

pack-priv static class
DefaultEditorKit.EndAction

pack-priv static class
DefaultEditorKit.EndLineAction

pack-priv static class
DefaultEditorKit.EndLineDownAction

pack-priv static class
DefaultEditorKit.EndParagraphAction

pack-priv static class
DefaultEditorKit.EndWordAction

public static class
DefaultEditorKit.InsertBreakAction

Places a line/paragraph break into the document.

public static class
DefaultEditorKit.InsertContentAction

Places content into the associated document.

public static class
DefaultEditorKit.InsertTabAction

Places a tab character into the document.

pack-priv static class
DefaultEditorKit.NextVisualPositionAction

pack-priv static class
DefaultEditorKit.NextWordAction

pack-priv static class
DefaultEditorKit.PageAction

Pages one view to the left or right.

public static class
DefaultEditorKit.PasteAction

Pastes the contents of the system clipboard into the selected region, or before the caret if nothing is selected.

pack-priv static class
DefaultEditorKit.PreviousWordAction

pack-priv static class
DefaultEditorKit.ReadOnlyAction

pack-priv static class
DefaultEditorKit.SelectAllAction

pack-priv static class
DefaultEditorKit.SelectLineAction

pack-priv static class
DefaultEditorKit.SelectParagraphAction

pack-priv static class
DefaultEditorKit.SelectWordAction

pack-priv static class
DefaultEditorKit.ToggleComponentOrientationAction

pack-priv static class
DefaultEditorKit.UnselectAction

pack-priv static class
DefaultEditorKit.VerticalPageAction

Scrolls up/down vertically.

pack-priv static class
DefaultEditorKit.WritableAction

Field Summary

Modifier and TypeField and Description
public static final String
backwardAction

Name of the Action for moving the caret logically backward one position.

public static final String
beepAction

Name of the action to create a beep.

public static final String
beginAction

Name of the Action for moving the caret to the beginning of the document.

public static final String
beginLineAction

Name of the Action for moving the caret to the beginning of a line.

public static final String
beginLineUpAction

Name of the Action for moving the caret to the beginning of the current line or up to the beginning of the previous line if the caret is already at the beginning of the line.

public static final String
beginParagraphAction

Name of the Action for moving the caret to the beginning of a paragraph.

public static final String
beginWordAction

Name of the Action for moving the caret to the beginning of a word.

public static final String
copyAction

Name of the action to copy the selected region and place the contents into the system clipboard.

public static final String
cutAction

Name of the action to cut the selected region and place the contents into the system clipboard.

private static final Action[]
defaultActions

public static final String
defaultKeyTypedAction

Name of the action that is executed by default if a key typed event is received and there is no keymap entry.

public static final String
deleteNextCharAction

Name of the action to delete the character of content that follows the current caret position.

public static final String
deleteNextWordAction

Name of the action to delete the word that follows the beginning of the selection.

public static final String
deletePrevCharAction

Name of the action to delete the character of content that precedes the current caret position.

public static final String
deletePrevWordAction

Name of the action to delete the word that precedes the beginning of the selection.

public static final String
downAction

Name of the Action for moving the caret logically downward one position.

public static final String
endAction

Name of the Action for moving the caret to the end of the document.

public static final String
endLineAction

Name of the Action for moving the caret to the end of a line.

public static final String
endLineDownAction

Name of the Action for moving the caret to the end of the current line or down to the end of the next line if the caret is already at the end of the line.

public static final String
EndOfLineStringProperty

When reading a document if a CRLF is encountered a property with this name is added and the value will be "\r\n".

public static final String
endParagraphAction

Name of the Action for moving the caret to the end of a paragraph.

public static final String
endWordAction

Name of the Action for moving the caret to the end of a word.

public static final String
forwardAction

Name of the Action for moving the caret logically forward one position.

public static final String
insertBreakAction

Name of the action to place a line/paragraph break into the document.

public static final String
insertContentAction

Name of the action to place content into the associated document.

public static final String
insertTabAction

Name of the action to place a tab character into the document.

public static final String
nextWordAction

Name of the Action for moving the caret to the beginning of the next word.

public static final String
pageDownAction

Name of the action to page down vertically.

public static final String
pageUpAction

Name of the action to page up vertically.

public static final String
pasteAction

Name of the action to paste the contents of the system clipboard into the selected region, or before the caret if nothing is selected.

public static final String
previousWordAction

Name of the Action for moving the caret to the beginning of the previous word.

public static final String
readOnlyAction

Name of the action to set the editor into read-only mode.

public static final String
selectAllAction

Name of the Action for selecting the entire document

public static final String
selectionBackwardAction

Name of the Action for extending the selection by moving the caret logically backward one position.

public static final String
selectionBeginAction

Name of the Action for moving the caret to the beginning of the document.

public static final String
selectionBeginLineAction

Name of the Action for moving the caret to the beginning of a line, extending the selection.

public static final String
selectionBeginParagraphAction

Name of the Action for moving the caret to the beginning of a paragraph, extending the selection.

public static final String
selectionBeginWordAction

Name of the Action for moving the caret to the beginning of a word, extending the selection.

public static final String
selectionDownAction

Name of the Action for moving the caret logically downward one position, extending the selection.

public static final String
selectionEndAction

Name of the Action for moving the caret to the end of the document.

public static final String
selectionEndLineAction

Name of the Action for moving the caret to the end of a line, extending the selection.

public static final String
selectionEndParagraphAction

Name of the Action for moving the caret to the end of a paragraph, extending the selection.

public static final String
selectionEndWordAction

Name of the Action for moving the caret to the end of a word, extending the selection.

public static final String
selectionForwardAction

Name of the Action for extending the selection by moving the caret logically forward one position.

public static final String
selectionNextWordAction

Name of the Action for moving the selection to the beginning of the next word, extending the selection.

pack-priv static final String
selectionPageDownAction

Name of the action to page down vertically, and move the selection.

pack-priv static final String
selectionPageLeftAction

Name of the action to page left horizontally, and move the selection.

pack-priv static final String
selectionPageRightAction

Name of the action to page right horizontally, and move the selection.

pack-priv static final String
selectionPageUpAction

Name of the action to page up vertically, and move the selection.

public static final String
selectionPreviousWordAction

Name of the Action for moving the selection to the beginning of the previous word, extending the selection.

public static final String
selectionUpAction

Name of the Action for moving the caret logically upward one position, extending the selection.

public static final String
selectLineAction

Name of the Action for selecting a line around the caret.

public static final String
selectParagraphAction

Name of the Action for selecting a paragraph around the caret.

public static final String
selectWordAction

Name of the Action for selecting a word around the caret.

pack-priv static final String
toggleComponentOrientationAction

Name of the Action for toggling the component's orientation.

pack-priv static final String
unselectAction

Name of the Action for removing selection

public static final String
upAction

Name of the Action for moving the caret logically upward one position.

public static final String
writableAction

Name of the action to set the editor into writeable mode.

Constructor Summary

AccessConstructor and Description
public
DefaultEditorKit()

default constructor for DefaultEditorKit

Method Summary

Modifier and TypeMethod and Description
public Caret

Returns:

the caret
createCaret()

Implements abstract javax.swing.text.EditorKit.createCaret.

Fetches a caret that can navigate through views produced by the associated ViewFactory.

public Document

Returns:

the model
createDefaultDocument()

Implements abstract javax.swing.text.EditorKit.createDefaultDocument.

Creates an uninitialized text storage model (PlainDocument) that is appropriate for this type of editor.

public Action[]

Returns:

the command list
getActions()

Implements abstract javax.swing.text.EditorKit.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 String

Returns:

the type
getContentType()

Implements abstract javax.swing.text.EditorKit.getContentType.

Gets the MIME type of the data that this kit represents support for.

pack-priv MutableAttributeSet

Returns:

null
getInputAttributes()

Gets the input attributes for the pane.

public ViewFactory

Returns:

the view factory
getViewFactory()

Implements abstract javax.swing.text.EditorKit.getViewFactory.

Fetches a factory that is suitable for producing views of any models that are produced by this kit.

public void
read(InputStream
The stream to read from
in, Document
The destination for the insertion.
doc, int
The location in the document to place the content >=0.
pos)

Implements abstract javax.swing.text.EditorKit.read.

Inserts content from the given stream which is expected to be in a format appropriate for this kind of content handler.

public void
read(Reader
The stream to read from
in, Document
The destination for the insertion.
doc, int
The location in the document to place the content >=0.
pos)

Implements abstract javax.swing.text.EditorKit.read.

Inserts content from the given stream, which will be treated as plain text.

public void
write(OutputStream
The stream to write to
out, Document
The source for the write.
doc, int
The location in the document to fetch the content >=0.
pos, int
The amount to write out >=0.
len)

Implements abstract javax.swing.text.EditorKit.write.

Writes content from a document to the given stream in a format appropriate for this kind of content handler.

public void
write(Writer
The stream to write to
out, Document
The source for the write.
doc, int
The location in the document to fetch the content from >=0.
pos, int
The amount to write out >=0.
len)

Implements abstract javax.swing.text.EditorKit.write.

Writes content from a document to the given stream as plain text.

Inherited from javax.swing.text.EditorKit:
clonedeinstallinstall