All Packages Class Hierarchy This Package Previous Next Index
Class com.sun.java.swing.text.DefaultEditorKit
java.lang.Object
|
+----com.sun.java.swing.text.EditorKit
|
+----com.sun.java.swing.text.DefaultEditorKit
- public class DefaultEditorKit
- extends EditorKit
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 simple editor.
-
backwardAction
- Name of the Action for moving the caret
logically backward one position.
-
beepAction
- Name of the action to create a beep.
-
beginAction
- Name of the Action for moving the caret
to the begining of the document.
-
beginLineAction
- Name of the Action for moving the caret
to the begining of the document.
-
beginParagraphAction
- Name of the Action for moving the caret
to the begining of the document.
-
beginWordAction
- Name of the Action for moving the caret
to the begining of the document.
-
copyAction
- Name of the action to copy the selected region
and place the contents into the system clipboard.
-
cutAction
- Name of the action to cut the selected region
and place the contents into the system clipboard.
-
defaultKeyTypedAction
- Name of the action that is executed by default if
a key typed event is received and there
is no keymap entry.
-
deleteNextCharAction
- Name of the action to delete the character of content that
follows the current caret position.
-
deletePrevCharAction
- Name of the action to delete the character of content that
precedes the current caret position.
-
downAction
- Name of the Action for moving the caret
logically downward one position.
-
endAction
- Name of the Action for moving the caret
to the end of the document.
-
endLineAction
- Name of the Action for moving the caret
to the end of the document.
-
endParagraphAction
- Name of the Action for moving the caret
to the end of the document.
-
endWordAction
- Name of the Action for moving the caret
to the end of the document.
-
forwardAction
- Name of the Action for moving the caret
logically forward one position.
-
insertBreakAction
- Name of the action to place a line/paragraph break into
the document.
-
insertContentAction
- Name of the action to place content into the associated
document.
-
insertTabAction
- Name of the action to place a tab character into
the document.
-
nextWordAction
- Name of the Action for moving the caret to the begining of the
next word.
-
pageDownAction
- Name of the action to page down vertically.
-
pageUpAction
- Name of the action to page up vertically.
-
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.
-
previousWordAction
- Name of the Action for moving the caret to the begining of the
previous word.
-
readOnlyAction
- Name of the action to set the editor into read-only
mode.
-
selectAllAction
- Name of the Action for selecting the entire document
-
selectionBackwardAction
- Name of the Action for extending the selection
by moving the caret logically backward one position.
-
selectionBeginAction
- Name of the Action for moving the caret
to the begining of the document.
-
selectionBeginLineAction
- Name of the Action for moving the caret
to the begining of the document.
-
selectionBeginParagraphAction
- Name of the Action for moving the caret
to the begining of the document.
-
selectionBeginWordAction
- Name of the Action for moving the caret
to the begining of the document.
-
selectionDownAction
- Name of the Action for moving the caret
logically downward one position.
-
selectionEndAction
- Name of the Action for moving the caret
to the end of the document.
-
selectionEndLineAction
- Name of the Action for moving the caret
to the end of the document.
-
selectionEndParagraphAction
- Name of the Action for moving the caret
to the end of the document.
-
selectionEndWordAction
- Name of the Action for moving the caret
to the end of the document.
-
selectionForwardAction
- Name of the Action for extending the selection
by moving the caret logically forward one position.
-
selectionNextWordAction
- Name of the Action for moving the selection to the begining of the
next word.
-
selectionPreviousWordAction
- Name of the Action for moving the selection to the begining of the
previous word.
-
selectionUpAction
- Name of the Action for moving the caret
logically upward one position.
-
selectLineAction
- Name of the Action for selecting a line around the caret.
-
selectParagraphAction
- Name of the Action for selecting a paragraph around the caret.
-
selectWordAction
- Name of the Action for selecting a word around the caret.
-
upAction
- Name of the Action for moving the caret
logically upward one position.
-
writableAction
- Name of the action to set the editor into writeable
mode.
-
DefaultEditorKit()
-
-
clone()
- Create a copy of the editor kit.
-
createCaret()
- Fetches a caret that can navigate through views
produced by the associated ViewFactory.
-
createDefaultDocument()
- Creates an uninitialized text storage model
that is appropriate for this type of editor.
-
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.
-
getContentType()
- Gets the MIME type of the data that this
kit represents support for.
-
getViewFactory()
- Fetches a factory that is suitable for producing
views of any models that are produced by this
kit.
-
read(InputStream, Document, int)
- Inserts content from the given stream which is expected
to be in a format appropriate for this kind of content
handler.
-
read(Reader, Document, int)
- Inserts content from the given stream, which will be
treated as plain text.
-
write(OutputStream, Document, int, int)
- Writes content from a document to the given stream
in a format appropriate for this kind of content handler.
-
write(Writer, Document, int, int)
- Writes content from a document to the given stream
as plain text.
insertContentAction
public static final String 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:
- DefaultEditorKit. InsertContentAction, getActions
insertBreakAction
public static final String 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:
- DefaultEditorKit. InsertBreakAction, getActions
insertTabAction
public static final String 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:
- DefaultEditorKit. InsertTabAction, getActions
deletePrevCharAction
public static final String deletePrevCharAction
- Name of the action to delete the character of content that
precedes the current caret position.
- See Also:
- DefaultEditorKit. DeletePrevCharAction, getActions
deleteNextCharAction
public static final String deleteNextCharAction
- Name of the action to delete the character of content that
follows the current caret position.
- See Also:
- DefaultEditorKit. DeleteNextCharAction, getActions
readOnlyAction
public static final String readOnlyAction
- Name of the action to set the editor into read-only
mode.
- See Also:
- DefaultEditorKit. ReadOnlyAction, getActions
writableAction
public static final String writableAction
- Name of the action to set the editor into writeable
mode.
- See Also:
- DefaultEditorKit. WritableAction, getActions
cutAction
public static final String cutAction
- Name of the action to cut the selected region
and place the contents into the system clipboard.
- See Also:
- cut, getActions
copyAction
public static final String copyAction
- Name of the action to copy the selected region
and place the contents into the system clipboard.
- See Also:
- copy, getActions
pasteAction
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.
- See Also:
- paste, getActions
beepAction
public static final String beepAction
- Name of the action to create a beep.
- See Also:
- DefaultEditorKit. BeepAction, getActions
pageUpAction
public static final String pageUpAction
- Name of the action to page up vertically.
- See Also:
- DefaultEditorKit. PageUpAction, getActions
pageDownAction
public static final String pageDownAction
- Name of the action to page down vertically.
- See Also:
- DefaultEditorKit. PageDownAction, getActions
forwardAction
public static final String forwardAction
- Name of the Action for moving the caret
logically forward one position.
- See Also:
- DefaultEditorKit. ForwardAction, getActions
backwardAction
public static final String backwardAction
- Name of the Action for moving the caret
logically backward one position.
- See Also:
- DefaultEditorKit. BackwardAction, getActions
selectionForwardAction
public static final String selectionForwardAction
- Name of the Action for extending the selection
by moving the caret logically forward one position.
- See Also:
- SelectionForwardAction, getActions
selectionBackwardAction
public static final String selectionBackwardAction
- Name of the Action for extending the selection
by moving the caret logically backward one position.
- See Also:
- SelectionBackwardAction, getActions
upAction
public static final String upAction
- Name of the Action for moving the caret
logically upward one position.
- See Also:
- DefaultEditorKit. UpAction, getActions
downAction
public static final String downAction
- Name of the Action for moving the caret
logically downward one position.
- See Also:
- DefaultEditorKit. DownAction, getActions
selectionUpAction
public static final String selectionUpAction
- Name of the Action for moving the caret
logically upward one position.
- See Also:
- DefaultEditorKit. UpAction, getActions
selectionDownAction
public static final String selectionDownAction
- Name of the Action for moving the caret
logically downward one position.
- See Also:
- DefaultEditorKit. DownAction, getActions
beginWordAction
public static final String beginWordAction
- Name of the Action for moving the caret
to the begining of the document.
- See Also:
- DefaultEditorKit. BeginAction, getActions
endWordAction
public static final String endWordAction
- Name of the Action for moving the caret
to the end of the document.
- See Also:
- DefaultEditorKit. EndAction, getActions
selectionBeginWordAction
public static final String selectionBeginWordAction
- Name of the Action for moving the caret
to the begining of the document.
- See Also:
- DefaultEditorKit. BeginWordAction, getActions
selectionEndWordAction
public static final String selectionEndWordAction
- Name of the Action for moving the caret
to the end of the document.
- See Also:
- DefaultEditorKit. EndWordAction, getActions
previousWordAction
public static final String previousWordAction
- Name of the Action for moving the caret to the begining of the
previous word.
- See Also:
- DefaultEditorKit. PreviousWordAction, getActions
nextWordAction
public static final String nextWordAction
- Name of the Action for moving the caret to the begining of the
next word.
to the next of the document.
- See Also:
- DefaultEditorKit. NextWordAction, getActions
selectionPreviousWordAction
public static final String selectionPreviousWordAction
- Name of the Action for moving the selection to the begining of the
previous word.
- See Also:
- DefaultEditorKit. PreviousWordAction, getActions
selectionNextWordAction
public static final String selectionNextWordAction
- Name of the Action for moving the selection to the begining of the
next word.
- See Also:
- DefaultEditorKit. NextWordAction, getActions
beginLineAction
public static final String beginLineAction
- Name of the Action for moving the caret
to the begining of the document.
- See Also:
- DefaultEditorKit. BeginAction, getActions
endLineAction
public static final String endLineAction
- Name of the Action for moving the caret
to the end of the document.
- See Also:
- DefaultEditorKit. EndAction, getActions
selectionBeginLineAction
public static final String selectionBeginLineAction
- Name of the Action for moving the caret
to the begining of the document.
- See Also:
- DefaultEditorKit. BeginLineAction, getActions
selectionEndLineAction
public static final String selectionEndLineAction
- Name of the Action for moving the caret
to the end of the document.
- See Also:
- DefaultEditorKit. EndLineAction, getActions
beginParagraphAction
public static final String beginParagraphAction
- Name of the Action for moving the caret
to the begining of the document.
- See Also:
- DefaultEditorKit. BeginAction, getActions
endParagraphAction
public static final String endParagraphAction
- Name of the Action for moving the caret
to the end of the document.
- See Also:
- DefaultEditorKit. EndAction, getActions
selectionBeginParagraphAction
public static final String selectionBeginParagraphAction
- Name of the Action for moving the caret
to the begining of the document.
- See Also:
- DefaultEditorKit. BeginParagraphAction, getActions
selectionEndParagraphAction
public static final String selectionEndParagraphAction
- Name of the Action for moving the caret
to the end of the document.
- See Also:
- DefaultEditorKit. EndParagraphAction, getActions
beginAction
public static final String beginAction
- Name of the Action for moving the caret
to the begining of the document.
- See Also:
- DefaultEditorKit. BeginAction, getActions
endAction
public static final String endAction
- Name of the Action for moving the caret
to the end of the document.
- See Also:
- DefaultEditorKit. EndAction, getActions
selectionBeginAction
public static final String selectionBeginAction
- Name of the Action for moving the caret
to the begining of the document.
- See Also:
- DefaultEditorKit. BeginAction, getActions
selectionEndAction
public static final String selectionEndAction
- Name of the Action for moving the caret
to the end of the document.
- See Also:
- DefaultEditorKit. EndAction, getActions
selectWordAction
public static final String selectWordAction
- Name of the Action for selecting a word around the caret.
- See Also:
- DefaultEditorKit. SelectWordAction, getActions
selectLineAction
public static final String selectLineAction
- Name of the Action for selecting a line around the caret.
- See Also:
- DefaultEditorKit. SelectLineAction, getActions
selectParagraphAction
public static final String selectParagraphAction
- Name of the Action for selecting a paragraph around the caret.
- See Also:
- DefaultEditorKit. SelectParagraphAction, getActions
selectAllAction
public static final String selectAllAction
- Name of the Action for selecting the entire document
- See Also:
- DefaultEditorKit. SelectAllAction, getActions
defaultKeyTypedAction
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.
- See Also:
- DefaultEditorKit. DefaultKeyTypedAction, getActions
DefaultEditorKit
public DefaultEditorKit()
clone
public Object clone()
- Create a copy of the editor kit. This
allows an implementation to serve as a prototype
for others, so that they can be quickly created.
- Overrides:
- clone in class EditorKit
getContentType
public String getContentType()
- Gets the MIME type of the data that this
kit represents support for. The default
is
text/plain
.
- Returns:
- the type
- Overrides:
- getContentType in class EditorKit
getViewFactory
public ViewFactory 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.
- Returns:
- the view factory
- Overrides:
- getViewFactory in class EditorKit
getActions
public 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.
- Returns:
- the command list
- Overrides:
- getActions in class EditorKit
createCaret
public Caret createCaret()
- Fetches a caret that can navigate through views
produced by the associated ViewFactory.
- Returns:
- the caret
- Overrides:
- createCaret in class EditorKit
createDefaultDocument
public Document createDefaultDocument()
- Creates an uninitialized text storage model
that is appropriate for this type of editor.
- Returns:
- the model
- Overrides:
- createDefaultDocument in class EditorKit
read
public 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.
- Parameters:
- in - The stream to read from
- doc - The destination for the insertion.
- pos - The location in the document to place the
content.
- Throws: IOException
- on any I/O error
- Throws: BadLocationException
- if pos represents an invalid
location within the document.
- Overrides:
- read in class EditorKit
write
public 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.
- Parameters:
- out - The stream to write to
- doc - The source for the write.
- pos - The location in the document to fetch the
content.
- len - The amount to write out.
- Throws: IOException
- on any I/O error
- Throws: BadLocationException
- if pos represents an invalid
location within the document.
- Overrides:
- write in class EditorKit
read
public void read(Reader in,
Document doc,
int pos) throws IOException, BadLocationException
- Inserts content from the given stream, which will be
treated as plain text.
- Parameters:
- in - The stream to read from
- doc - The destination for the insertion.
- pos - The location in the document to place the
content.
- Throws: IOException
- on any I/O error
- Throws: BadLocationException
- if pos represents an invalid
location within the document.
- Overrides:
- read in class EditorKit
write
public void write(Writer out,
Document doc,
int pos,
int len) throws IOException, BadLocationException
- Writes content from a document to the given stream
as plain text.
- Parameters:
- out - The stream to write to
- doc - The source for the write.
- pos - The location in the document to fetch the
content.
- len - The amount to write out.
- Throws: IOException
- on any I/O error
- Throws: BadLocationException
- if pos represents an invalid
location within the document.
- Overrides:
- write in class EditorKit
All Packages Class Hierarchy This Package Previous Next Index