java.lang.Object
javax.swing.text.EditorKit
javax.swing.text.DefaultEditorKit
- All Implemented Interfaces:
Serializable
,Cloneable
- Direct Known Subclasses:
StyledEditorKit
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 inDefaultEditorKit
, calledEndOfLineStringProperty
, 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, theEndOfLineStringProperty
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 theEndOfLineStringProperty
has not been defined, it will use the System property when writing out the document.Note that
EndOfLineStringProperty
is set on theDocument
using theget/putProperty
methods. Subclasses may override this behavior.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
Creates a beep.static class
Copies the selected region and place its contents into the system clipboard.static class
Cuts the selected region and place its contents into the system clipboard.static class
The action that is executed by default if a key typed event is received and there is no keymap entry.static class
Places a line/paragraph break into the document.static class
Places content into the associated document.static class
Places a tab character into the document.static class
Pastes the contents of the system clipboard into the selected region, or before the caret if nothing is selected. -
Field Summary
Modifier and TypeFieldDescriptionstatic String
Name of the Action for moving the caret logically backward one position.static String
Name of the action to create a beep.static String
Name of theAction
for moving the caret to the beginning of the document.static String
Name of theAction
for moving the caret to the beginning of a line.static String
Name of theAction
for moving the caret to the beginning of a paragraph.static String
Name of theAction
for moving the caret to the beginning of a word.static String
Name of the action to copy the selected region and place the contents into the system clipboard.static String
Name of the action to cut the selected region and place the contents into the system clipboard.static String
Name of the action that is executed by default if a key typed event is received and there is no keymap entry.static String
Name of the action to delete the character of content that follows the current caret position.static String
Name of the action to delete the word that follows the beginning of the selection.static String
Name of the action to delete the character of content that precedes the current caret position.static String
Name of the action to delete the word that precedes the beginning of the selection.static String
Name of the Action for moving the caret logically downward one position.static String
Name of theAction
for moving the caret to the end of the document.static String
Name of theAction
for moving the caret to the end of a line.static String
When reading a document if a CRLF is encountered a property with this name is added and the value will be "\r\n".static String
Name of theAction
for moving the caret to the end of a paragraph.static String
Name of the Action for moving the caret to the end of a word.static String
Name of the Action for moving the caret logically forward one position.static String
Name of the action to place a line/paragraph break into the document.static String
Name of the action to place content into the associated document.static String
Name of the action to place a tab character into the document.static String
Name of theAction
for moving the caret to the beginning of the next word.static String
Name of the action to page down vertically.static String
Name of the action to page up vertically.static String
Name of the action to paste the contents of the system clipboard into the selected region, or before the caret if nothing is selected.static String
Name of theAction
for moving the caret to the beginning of the previous word.static String
Name of the action to set the editor into read-only mode.static String
Name of the Action for selecting the entire documentstatic String
Name of the Action for extending the selection by moving the caret logically backward one position.static String
Name of theAction
for moving the caret to the beginning of the document.static String
Name of theAction
for moving the caret to the beginning of a line, extending the selection.static String
Name of theAction
for moving the caret to the beginning of a paragraph, extending the selection.static String
Name of theAction
for moving the caret to the beginning of a word, extending the selection.static String
Name of the Action for moving the caret logically downward one position, extending the selection.static String
Name of the Action for moving the caret to the end of the document.static String
Name of theAction
for moving the caret to the end of a line, extending the selection.static String
Name of theAction
for moving the caret to the end of a paragraph, extending the selection.static String
Name of the Action for moving the caret to the end of a word, extending the selection.static String
Name of the Action for extending the selection by moving the caret logically forward one position.static String
Name of theAction
for moving the selection to the beginning of the next word, extending the selection.static String
Name of theAction
for moving the selection to the beginning of the previous word, extending the selection.static String
Name of the Action for moving the caret logically upward one position, extending the selection.static String
Name of the Action for selecting a line around the caret.static String
Name of the Action for selecting a paragraph around the caret.static String
Name of the Action for selecting a word around the caret.static String
Name of the Action for moving the caret logically upward one position.static String
Name of the action to set the editor into writeable mode. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionFetches a caret that can navigate through views produced by the associated ViewFactory.Creates an uninitialized text storage model (PlainDocument) that is appropriate for this type of editor.Action[]
Fetches the set of commands that can be used on a text component that is using a model and view produced by this kit.Gets the MIME type of the data that this kit represents support for.Fetches a factory that is suitable for producing views of any models that are produced by this kit.void
read(InputStream in, Document doc, int pos)
Inserts content from the given stream which is expected to be in a format appropriate for this kind of content handler.void
Inserts content from the given stream, which will be treated as plain text.void
write(OutputStream out, Document doc, int pos, int len)
Writes content from a document to the given stream in a format appropriate for this kind of content handler.void
Writes content from a document to the given stream as plain text.
-
Field Details
-
EndOfLineStringProperty
When reading a document if a CRLF is encountered a property with this name is added and the value will be "\r\n".- See Also:
- Constant Field Values
-
insertContentAction
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:
getActions()
, Constant Field Values
-
insertBreakAction
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:
getActions()
, Constant Field Values
-
insertTabAction
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:
getActions()
, Constant Field Values
-
deletePrevCharAction
Name of the action to delete the character of content that precedes the current caret position.- See Also:
getActions()
, Constant Field Values
-
deleteNextCharAction
Name of the action to delete the character of content that follows the current caret position.- See Also:
getActions()
, Constant Field Values
-
deleteNextWordAction
Name of the action to delete the word that follows the beginning of the selection.- Since:
- 1.6
- See Also:
getActions()
,JTextComponent.getSelectionStart()
, Constant Field Values
-
deletePrevWordAction
Name of the action to delete the word that precedes the beginning of the selection.- Since:
- 1.6
- See Also:
getActions()
,JTextComponent.getSelectionStart()
, Constant Field Values
-
readOnlyAction
Name of the action to set the editor into read-only mode.- See Also:
getActions()
, Constant Field Values
-
writableAction
Name of the action to set the editor into writeable mode.- See Also:
getActions()
, Constant Field Values
-
cutAction
Name of the action to cut the selected region and place the contents into the system clipboard.- See Also:
JTextComponent.cut()
,getActions()
, Constant Field Values
-
copyAction
Name of the action to copy the selected region and place the contents into the system clipboard.- See Also:
JTextComponent.copy()
,getActions()
, Constant Field Values
-
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.- See Also:
JTextComponent.paste()
,getActions()
, Constant Field Values
-
beepAction
Name of the action to create a beep.- See Also:
getActions()
, Constant Field Values
-
pageUpAction
Name of the action to page up vertically.- See Also:
getActions()
, Constant Field Values
-
pageDownAction
Name of the action to page down vertically.- See Also:
getActions()
, Constant Field Values
-
forwardAction
Name of the Action for moving the caret logically forward one position.- See Also:
getActions()
, Constant Field Values
-
backwardAction
Name of the Action for moving the caret logically backward one position.- See Also:
getActions()
, Constant Field Values
-
selectionForwardAction
Name of the Action for extending the selection by moving the caret logically forward one position.- See Also:
getActions()
, Constant Field Values
-
selectionBackwardAction
Name of the Action for extending the selection by moving the caret logically backward one position.- See Also:
getActions()
, Constant Field Values
-
upAction
Name of the Action for moving the caret logically upward one position.- See Also:
getActions()
, Constant Field Values
-
downAction
Name of the Action for moving the caret logically downward one position.- See Also:
getActions()
, Constant Field Values
-
selectionUpAction
Name of the Action for moving the caret logically upward one position, extending the selection.- See Also:
getActions()
, Constant Field Values
-
selectionDownAction
Name of the Action for moving the caret logically downward one position, extending the selection.- See Also:
getActions()
, Constant Field Values
-
beginWordAction
Name of theAction
for moving the caret to the beginning of a word.- See Also:
getActions()
, Constant Field Values
-
endWordAction
Name of the Action for moving the caret to the end of a word.- See Also:
getActions()
, Constant Field Values
-
selectionBeginWordAction
Name of theAction
for moving the caret to the beginning of a word, extending the selection.- See Also:
getActions()
, Constant Field Values
-
selectionEndWordAction
Name of the Action for moving the caret to the end of a word, extending the selection.- See Also:
getActions()
, Constant Field Values
-
previousWordAction
Name of theAction
for moving the caret to the beginning of the previous word.- See Also:
getActions()
, Constant Field Values
-
nextWordAction
Name of theAction
for moving the caret to the beginning of the next word.- See Also:
getActions()
, Constant Field Values
-
selectionPreviousWordAction
Name of theAction
for moving the selection to the beginning of the previous word, extending the selection.- See Also:
getActions()
, Constant Field Values
-
selectionNextWordAction
Name of theAction
for moving the selection to the beginning of the next word, extending the selection.- See Also:
getActions()
, Constant Field Values
-
beginLineAction
Name of theAction
for moving the caret to the beginning of a line.- See Also:
getActions()
, Constant Field Values
-
endLineAction
Name of theAction
for moving the caret to the end of a line.- See Also:
getActions()
, Constant Field Values
-
selectionBeginLineAction
Name of theAction
for moving the caret to the beginning of a line, extending the selection.- See Also:
getActions()
, Constant Field Values
-
selectionEndLineAction
Name of theAction
for moving the caret to the end of a line, extending the selection.- See Also:
getActions()
, Constant Field Values
-
beginParagraphAction
Name of theAction
for moving the caret to the beginning of a paragraph.- See Also:
getActions()
, Constant Field Values
-
endParagraphAction
Name of theAction
for moving the caret to the end of a paragraph.- See Also:
getActions()
, Constant Field Values
-
selectionBeginParagraphAction
Name of theAction
for moving the caret to the beginning of a paragraph, extending the selection.- See Also:
getActions()
, Constant Field Values
-
selectionEndParagraphAction
Name of theAction
for moving the caret to the end of a paragraph, extending the selection.- See Also:
getActions()
, Constant Field Values
-
beginAction
Name of theAction
for moving the caret to the beginning of the document.- See Also:
getActions()
, Constant Field Values
-
endAction
Name of theAction
for moving the caret to the end of the document.- See Also:
getActions()
, Constant Field Values
-
selectionBeginAction
Name of theAction
for moving the caret to the beginning of the document.- See Also:
getActions()
, Constant Field Values
-
selectionEndAction
Name of the Action for moving the caret to the end of the document.- See Also:
getActions()
, Constant Field Values
-
selectWordAction
Name of the Action for selecting a word around the caret.- See Also:
getActions()
, Constant Field Values
-
selectLineAction
Name of the Action for selecting a line around the caret.- See Also:
getActions()
, Constant Field Values
-
selectParagraphAction
Name of the Action for selecting a paragraph around the caret.- See Also:
getActions()
, Constant Field Values
-
selectAllAction
Name of the Action for selecting the entire document- See Also:
getActions()
, Constant Field Values
-
defaultKeyTypedAction
Name of the action that is executed by default if a key typed event is received and there is no keymap entry.- See Also:
getActions()
, Constant Field Values
-
-
Constructor Details
-
DefaultEditorKit
public DefaultEditorKit()default constructor for DefaultEditorKit
-
-
Method Details
-
getContentType
Gets the MIME type of the data that this kit represents support for. The default istext/plain
.- Specified by:
getContentType
in classEditorKit
- Returns:
- the type
-
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 classEditorKit
- Returns:
- the view factory
-
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 classEditorKit
- Returns:
- the command list
-
createCaret
Fetches a caret that can navigate through views produced by the associated ViewFactory.- Specified by:
createCaret
in classEditorKit
- Returns:
- the caret
-
createDefaultDocument
Creates an uninitialized text storage model (PlainDocument) that is appropriate for this type of editor.- Specified by:
createDefaultDocument
in classEditorKit
- Returns:
- the model
-
read
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 classEditorKit
- Parameters:
in
- The stream to read fromdoc
- The destination for the insertion.pos
- The location in the document to place the content >=0.- Throws:
IOException
- on any I/O errorBadLocationException
- if pos represents an invalid location within the document.
-
write
public void write(OutputStream out, Document doc, int pos, int len) throws IOException, BadLocationExceptionWrites content from a document to the given stream in a format appropriate for this kind of content handler.- Specified by:
write
in classEditorKit
- Parameters:
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.- Throws:
IOException
- on any I/O errorBadLocationException
- if pos represents an invalid location within the document.
-
read
Inserts content from the given stream, which will be treated as plain text.- Specified by:
read
in classEditorKit
- Parameters:
in
- The stream to read fromdoc
- The destination for the insertion.pos
- The location in the document to place the content >=0.- Throws:
IOException
- on any I/O errorBadLocationException
- if pos represents an invalid location within the document.
-
write
public void write(Writer out, Document doc, int pos, int len) throws IOException, BadLocationExceptionWrites content from a document to the given stream as plain text.- Specified by:
write
in classEditorKit
- Parameters:
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.- Throws:
IOException
- on any I/O errorBadLocationException
- if pos is not within 0 and the length of the document.
-