JavaTM 2 Platform
Std. Ed. v1.3.1

javax.swing.text
Class DefaultEditorKit

java.lang.Object
  |
  +--javax.swing.text.EditorKit
        |
        +--javax.swing.text.DefaultEditorKit
All Implemented Interfaces:
Cloneable, Serializable
Direct Known 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 a simple editor.

See Also:
Serialized Form

Inner Class Summary
static class DefaultEditorKit.BeepAction
          Creates a beep.
static class DefaultEditorKit.CopyAction
          Coies the selected region and place its contents into the system clipboard.
static class DefaultEditorKit.CutAction
          Cuts the selected region and place its contents into the system clipboard.
static class DefaultEditorKit.DefaultKeyTypedAction
          The action that is executed by default if a key typed event is received and there is no keymap entry.
static class DefaultEditorKit.InsertBreakAction
          Places a line/paragraph break into the document.
static class DefaultEditorKit.InsertContentAction
          Places content into the associated document.
static class DefaultEditorKit.InsertTabAction
          Places a tab character into the document.
static class DefaultEditorKit.PasteAction
          Pastes 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 a line.
static String beginParagraphAction
          Name of the Action for moving the caret to the begining of a paragraph.
static String beginWordAction
          Name of the Action for moving the caret to the begining of a word.
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 a line.
static 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".
static String endParagraphAction
          Name of the Action for moving the caret to the end of a paragraph.
static String endWordAction
          Name of the Action for moving the caret to the end of a word.
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 a line, extending the selection.
static String selectionBeginParagraphAction
          Name of the Action for moving the caret to the begining of a paragraph, extending the selection.
static String selectionBeginWordAction
          Name of the Action for moving the caret to the begining of a word, extending the selection.
static String selectionDownAction
          Name of the Action for moving the caret logically downward one position, extending the selection.
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 a line, extending the selection.
static String selectionEndParagraphAction
          Name of the Action for moving the caret to the end of a paragraph, extending the selection.
static String selectionEndWordAction
          Name of the Action for moving the caret to the end of a word, extending the selection.
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, extending the selection.
static String selectionPreviousWordAction
          Name of the Action for moving the selection to the begining of the previous word, extending the selection.
static String selectionUpAction
          Name of the Action for moving the caret logically upward one position, extending the selection.
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()
          default constructor for DefaultEditorKit
 
Method Summary
 Caret createCaret()
          Fetches a caret that can navigate through views produced by the associated ViewFactory.
 Document createDefaultDocument()
          Creates an uninitialized text storage model (PlainDocument) 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 javax.swing.text.EditorKit
clone, deinstall, install
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

EndOfLineStringProperty

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".

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:
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:
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:
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:
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:
getActions()

readOnlyAction

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

writableAction

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

beepAction

public static final String beepAction
Name of the action to create a beep.
See Also:
getActions()

pageUpAction

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

pageDownAction

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

forwardAction

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

backwardAction

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

upAction

public static final String upAction
Name of the Action for moving the caret logically upward one position.
See Also:
getActions()

downAction

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

selectionUpAction

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

selectionDownAction

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

beginWordAction

public static final String beginWordAction
Name of the Action for moving the caret to the begining of a word.
See Also:
getActions()

endWordAction

public static final String endWordAction
Name of the Action for moving the caret to the end of a word.
See Also:
getActions()

selectionBeginWordAction

public static final String selectionBeginWordAction
Name of the Action for moving the caret to the begining of a word, extending the selection.
See Also:
getActions()

selectionEndWordAction

public static final String selectionEndWordAction
Name of the Action for moving the caret to the end of a word, extending the selection.
See Also:
getActions()

previousWordAction

public static final String previousWordAction
Name of the Action for moving the caret to the begining of the previous word.
See Also:
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:
getActions()

selectionPreviousWordAction

public static final String selectionPreviousWordAction
Name of the Action for moving the selection to the begining of the previous word, extending the selection.
See Also:
getActions()

selectionNextWordAction

public static final String selectionNextWordAction
Name of the Action for moving the selection to the begining of the next word, extending the selection.
See Also:
getActions()

beginLineAction

public static final String beginLineAction
Name of the Action for moving the caret to the begining of a line.
See Also:
getActions()

endLineAction

public static final String endLineAction
Name of the Action for moving the caret to the end of a line.
See Also:
getActions()

selectionBeginLineAction

public static final String selectionBeginLineAction
Name of the Action for moving the caret to the begining of a line, extending the selection.
See Also:
getActions()

selectionEndLineAction

public static final String selectionEndLineAction
Name of the Action for moving the caret to the end of a line, extending the selection.
See Also:
getActions()

beginParagraphAction

public static final String beginParagraphAction
Name of the Action for moving the caret to the begining of a paragraph.
See Also:
getActions()

endParagraphAction

public static final String endParagraphAction
Name of the Action for moving the caret to the end of a paragraph.
See Also:
getActions()

selectionBeginParagraphAction

public static final String selectionBeginParagraphAction
Name of the Action for moving the caret to the begining of a paragraph, extending the selection.
See Also:
getActions()

selectionEndParagraphAction

public static final String selectionEndParagraphAction
Name of the Action for moving the caret to the end of a paragraph, extending the selection.
See Also:
getActions()

beginAction

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

endAction

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

selectionBeginAction

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

selectionEndAction

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

selectWordAction

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

selectLineAction

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

selectParagraphAction

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

selectAllAction

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

DefaultEditorKit

public DefaultEditorKit()
default constructor for DefaultEditorKit
Method Detail

getContentType

public String getContentType()
Gets the MIME type of the data that this kit represents support for. The default is text/plain.
Overrides:
getContentType in class EditorKit
Returns:
the type

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.
Overrides:
getViewFactory in class EditorKit
Returns:
the view factory

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.
Overrides:
getActions in class EditorKit
Returns:
the command list

createCaret

public Caret createCaret()
Fetches a caret that can navigate through views produced by the associated ViewFactory.
Overrides:
createCaret in class EditorKit
Returns:
the caret

createDefaultDocument

public Document createDefaultDocument()
Creates an uninitialized text storage model (PlainDocument) that is appropriate for this type of editor.
Overrides:
createDefaultDocument in class EditorKit
Returns:
the model

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.
Overrides:
read in class EditorKit
Parameters:
in - The stream to read from
doc - The destination for the insertion.
pos - The location in the document to place the content >= 0.
Throws:
IOException - on any I/O error
BadLocationException - if pos represents an invalid location within the document.

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.
Overrides:
write in class EditorKit
Parameters:
out - The stream to write to
doc - 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 error
BadLocationException - if pos represents an invalid location within the document.

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.
Overrides:
read in class EditorKit
Parameters:
in - The stream to read from
doc - The destination for the insertion.
pos - The location in the document to place the content >= 0.
Throws:
IOException - on any I/O error
BadLocationException - if pos represents an invalid location within the document.

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.
Overrides:
write in class EditorKit
Parameters:
out - The stream to write to
doc - 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 error
BadLocationException - if pos is not within 0 and the length of the document.

JavaTM 2 Platform
Std. Ed. v1.3.1

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Java, Java 2D, and JDBC are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-2001 Sun Microsystems, Inc. 901 San Antonio Road
Palo Alto, California, 94303, U.S.A. All Rights Reserved.



Spec-Zone.ru - all specs in one place



free hit counter