Contents | Package | Class | Tree | Deprecated | Index | Help Java 1.2 Beta 3
PREV | NEXT SHOW LISTS | HIDE LISTS

Class java.awt.swing.text.DefaultEditorKit

java.lang.Object
    |
    +----java.awt.swing.text.EditorKit
            |
            +----java.awt.swing.text.DefaultEditorKit
Subclasses:
StyledEditorKit

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.


Inner Class Summary
static   DefaultEditorKit.BeepAction
Create a beep.
static   DefaultEditorKit.CopyAction
Copy the selected region and place its contents into the system clipboard.
static   DefaultEditorKit.CutAction
Cut the selected region and place its contents into the system clipboard.
static   DefaultEditorKit.DefaultKeyTypedAction
The action that is executed by default if a key typed event is received and there is no keymap entry.
static   DefaultEditorKit.InsertBreakAction
Place a line/paragraph break into the document.
static   DefaultEditorKit.InsertContentAction
Place content into the associated document.
static   DefaultEditorKit.InsertTabAction
Place a tab character into the document.
static   DefaultEditorKit.PasteAction
Paste the contents of the system clipboard into the selected region, or before the caret if nothing is selected.
 

Field Summary
static String  backwardAction
Name of the Action for moving the caret logically backward one position.
static String  beepAction
Name of the action to create a beep.
static String  beginAction
Name of the Action for moving the caret to the begining of the document.
static String  beginLineAction
Name of the Action for moving the caret to the begining of the document.
static String  beginParagraphAction
Name of the Action for moving the caret to the begining of the document.
static String  beginWordAction
Name of the Action for moving the caret to the begining of the document.
static String  copyAction
Name of the action to copy the selected region and place the contents into the system clipboard.
static String  cutAction
Name of the action to cut the selected region and place the contents into the system clipboard.
static String  defaultKeyTypedAction
Name of the action that is executed by default if a key typed event is received and there is no keymap entry.
static String  deleteNextCharAction
Name of the action to delete the character of content that follows the current caret position.
static String  deletePrevCharAction
Name of the action to delete the character of content that precedes the current caret position.
static String  downAction
Name of the Action for moving the caret logically downward one position.
static String  endAction
Name of the Action for moving the caret to the end of the document.
static String  endLineAction
Name of the Action for moving the caret to the end of the document.
static String  endParagraphAction
Name of the Action for moving the caret to the end of the document.
static String  endWordAction
Name of the Action for moving the caret to the end of the document.
static String  forwardAction
Name of the Action for moving the caret logically forward one position.
static String  insertBreakAction
Name of the action to place a line/paragraph break into the document.
static String  insertContentAction
Name of the action to place content into the associated document.
static String  insertTabAction
Name of the action to place a tab character into the document.
static String  nextWordAction
Name of the Action for moving the caret to the begining of the next word.
static String  pageDownAction
Name of the action to page down vertically.
static String  pageUpAction
Name of the action to page up vertically.
static 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.
static String  previousWordAction
Name of the Action for moving the caret to the begining of the previous word.
static String  readOnlyAction
Name of the action to set the editor into read-only mode.
static String  selectAllAction
Name of the Action for selecting the entire document
static String  selectionBackwardAction
Name of the Action for extending the selection by moving the caret logically backward one position.
static String  selectionBeginAction
Name of the Action for moving the caret to the begining of the document.
static String  selectionBeginLineAction
Name of the Action for moving the caret to the begining of the document.
static String  selectionBeginParagraphAction
Name of the Action for moving the caret to the begining of the document.
static String  selectionBeginWordAction
Name of the Action for moving the caret to the begining of the document.
static String  selectionDownAction
Name of the Action for moving the caret logically downward one position.
static String  selectionEndAction
Name of the Action for moving the caret to the end of the document.
static String  selectionEndLineAction
Name of the Action for moving the caret to the end of the document.
static String  selectionEndParagraphAction
Name of the Action for moving the caret to the end of the document.
static String  selectionEndWordAction
Name of the Action for moving the caret to the end of the document.
static String  selectionForwardAction
Name of the Action for extending the selection by moving the caret logically forward one position.
static String  selectionNextWordAction
Name of the Action for moving the selection to the begining of the next word.
static String  selectionPreviousWordAction
Name of the Action for moving the selection to the begining of the previous word.
static String  selectionUpAction
Name of the Action for moving the caret logically upward one position.
static String  selectLineAction
Name of the Action for selecting a line around the caret.
static String  selectParagraphAction
Name of the Action for selecting a paragraph around the caret.
static String  selectWordAction
Name of the Action for selecting a word around the caret.
static String  upAction
Name of the Action for moving the caret logically upward one position.
static String  writableAction
Name of the action to set the editor into writeable mode.
 

Constructor Summary
 DefaultEditorKit()
 
 

Method Summary
Object  clone()
Create a copy of the editor kit.
Caret  createCaret()
Fetches a caret that can navigate through views produced by the associated ViewFactory.
Document  createDefaultDocument()
Creates an uninitialized text storage model that is appropriate for this type of editor.
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.
String  getContentType()
Gets the MIME type of the data that this kit represents support for.
ViewFactory  getViewFactory()
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  read(Reader in, Document doc, int pos)
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  write(Writer out, Document doc, int pos, int len)
Writes content from a document to the given stream as plain text.
 
Methods inherited from class java.awt.swing.text.EditorKit
 clone, createCaret, createDefaultDocument, deinstall, getActions, getContentType, getViewFactory, install, read, read, write, write
 
Methods inherited from class java.lang.Object
 clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

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:
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:
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:
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:
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:
DeleteNextCharAction, getActions

readOnlyAction

public static final String readOnlyAction
Name of the action to set the editor into read-only mode.
See Also:
ReadOnlyAction, getActions

writableAction

public static final String writableAction
Name of the action to set the editor into writeable mode.
See Also:
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:
BeepAction, getActions

pageUpAction

public static final String pageUpAction
Name of the action to page up vertically.
See Also:
PageUpAction, getActions

pageDownAction

public static final String pageDownAction
Name of the action to page down vertically.
See Also:
PageDownAction, getActions

forwardAction

public static final String forwardAction
Name of the Action for moving the caret logically forward one position.
See Also:
ForwardAction, getActions

backwardAction

public static final String backwardAction
Name of the Action for moving the caret logically backward one position.
See Also:
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:
UpAction, getActions

downAction

public static final String downAction
Name of the Action for moving the caret logically downward one position.
See Also:
DownAction, getActions

selectionUpAction

public static final String selectionUpAction
Name of the Action for moving the caret logically upward one position.
See Also:
UpAction, getActions

selectionDownAction

public static final String selectionDownAction
Name of the Action for moving the caret logically downward one position.
See Also:
DownAction, getActions

beginWordAction

public static final String beginWordAction
Name of the Action for moving the caret to the begining of the document.
See Also:
BeginAction, getActions

endWordAction

public static final String endWordAction
Name of the Action for moving the caret to the end of the document.
See Also:
EndAction, getActions

selectionBeginWordAction

public static final String selectionBeginWordAction
Name of the Action for moving the caret to the begining of the document.
See Also:
BeginWordAction, getActions

selectionEndWordAction

public static final String selectionEndWordAction
Name of the Action for moving the caret to the end of the document.
See Also:
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:
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:
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:
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:
NextWordAction, getActions

beginLineAction

public static final String beginLineAction
Name of the Action for moving the caret to the begining of the document.
See Also:
BeginAction, getActions

endLineAction

public static final String endLineAction
Name of the Action for moving the caret to the end of the document.
See Also:
EndAction, getActions

selectionBeginLineAction

public static final String selectionBeginLineAction
Name of the Action for moving the caret to the begining of the document.
See Also:
BeginLineAction, getActions

selectionEndLineAction

public static final String selectionEndLineAction
Name of the Action for moving the caret to the end of the document.
See Also:
EndLineAction, getActions

beginParagraphAction

public static final String beginParagraphAction
Name of the Action for moving the caret to the begining of the document.
See Also:
BeginAction, getActions

endParagraphAction

public static final String endParagraphAction
Name of the Action for moving the caret to the end of the document.
See Also:
EndAction, getActions

selectionBeginParagraphAction

public static final String selectionBeginParagraphAction
Name of the Action for moving the caret to the begining of the document.
See Also:
BeginParagraphAction, getActions

selectionEndParagraphAction

public static final String selectionEndParagraphAction
Name of the Action for moving the caret to the end of the document.
See Also:
EndParagraphAction, getActions

beginAction

public static final String beginAction
Name of the Action for moving the caret to the begining of the document.
See Also:
BeginAction, getActions

endAction

public static final String endAction
Name of the Action for moving the caret to the end of the document.
See Also:
EndAction, getActions

selectionBeginAction

public static final String selectionBeginAction
Name of the Action for moving the caret to the begining of the document.
See Also:
BeginAction, getActions

selectionEndAction

public static final String selectionEndAction
Name of the Action for moving the caret to the end of the document.
See Also:
EndAction, getActions

selectWordAction

public static final String selectWordAction
Name of the Action for selecting a word around the caret.
See Also:
SelectWordAction, getActions

selectLineAction

public static final String selectLineAction
Name of the Action for selecting a line around the caret.
See Also:
SelectLineAction, getActions

selectParagraphAction

public static final String selectParagraphAction
Name of the Action for selecting a paragraph around the caret.
See Also:
SelectParagraphAction, getActions

selectAllAction

public static final String selectAllAction
Name of the Action for selecting the entire document
See Also:
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:
DefaultKeyTypedAction, getActions
Constructor Detail

DefaultEditorKit

public DefaultEditorKit()
Method Detail

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
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
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
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
BadLocationException - if pos represents an invalid location within the document.
Overrides:
write in class EditorKit

Contents | Package | Class | Tree | Deprecated | Index | Help Java 1.2 Beta 3
PREV | NEXT SHOW LISTS | HIDE LISTS

Submit a bug or feature
Submit comments/suggestions about new javadoc look.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-1998 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.