All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.sun.java.swing.text.JTextComponent

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Container
                   |
                   +----com.sun.java.swing.JComponent
                           |
                           +----com.sun.java.swing.text.JTextComponent

public class JTextComponent
extends JComponent
implements Accessible, AccessibleText

A text-oriented editor is defined to pull together the components used to represent the model, view, and controller. The text document model may be shared by other views which act as observers of the model. Each modification to the document causes notification of the details of the change to be sent to all observers in the form of a DocumentEvent which allows the views to stay up to date with the model. User interface events are sent to the editors controller which determines if and how it will deal with the events. Some events result in modifications to the model which subsequently cause notifcation to the view which updates itself to reflect the modified model. Some events modify the view directly, such as a mouse sweep being used to highlight an area of the view or moving an insert position.

The model is defined by the Document interface. This is intended to provide a flexible text storage mechanism that tracks change during edits and can be extended to more sophisticated models. The model interfaces are meant to capture the capabilities of expression given by SGML, a system used to express a wide variety of content. Changes to the model are sent in the form of a DocumentEvent which is sent to observers that have implemented the interface and registered interest with the model being observed.

See Also:
Document, DocumentEvent, DocumentListener, TextUI, ViewFactory, Highlighter, Caret

Variable Index

 o beepAction
Name of the action to create a beep
 o copyAction
Name of the action to copy the selected region and place the contents into the system clipboard.
 o cutAction
Name of the action to cut the selected region and place the contents into the system clipboard.
 o deleteNextCharAction
Name of the action to delete the character of content that follows the current caret position.
 o deletePrevCharAction
Name of the action to delete the character of content that precedes the current caret position.
 o FOCUS_ACCELERATOR_KEY
 o insertBreakAction
Name of the action to place a line/paragraph break into the document.
 o insertContentAction
Name of the action to place content into the associated document.
 o model
 o pageDownAction
Name of the action to page down vertically.
 o pageUpAction
Name of the action to page up vertically.
 o 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.
 o readOnlyAction
Name of the action to set the editor into read-only mode.
 o writableAction
Name of the action to set the editor into writeable mode.

Constructor Index

 o JTextComponent()
Creates a new JTextComponent.

Method Index

 o copy()
Transfers the currently selected range in the associated text model to the system clipboard, leaving the contents in the text model.
 o cut()
Transfers the currently selected range in the associated text model to the system clipboard, removing the contents from the model.
 o getAccessibleRole()
Get the role of this object.
 o getAccessibleText()
Gets the AccessibleText interface for the component.
 o getActions()
Fetches the command list for the editor.
 o getAfterIndex(int, int)
Return the object after a given index.
 o getAtIndex(int, int)
Return the object at a given index.
 o getBeforeIndex(int, int)
Return the object before a given index.
 o getCaretPosition()
Returns the position of the text insertion caret for the text component.
 o getCharacterAttribute(int)
Return the AttributeSet for a given character (at a given index)
 o getCharacterBounds(int)
Given an index into the String, determine the bounding box of the character at that index.
 o getCharCount()
Return the number of characters (valid indicies)
 o getDocument()
Fetches the model associated with the editor.
 o getFocusAccelerator()
Returns the key accelerator that will cause the receiving text component to get the focus.
 o getIndexAtPoint(Point)
Given a point in local coordinates, return the zero-based index of the character under that Point.
 o getKeymap()
Fetches the keymap being used by the controller
 o getSelectedText()
Returns the selected text contained in this TextComponent.
 o getSelectionEnd()
Returns the selected text's end position.
 o getSelectionStart()
Returns the selected text's start position.
 o getText()
Returns the text contained in this TextComponent.
 o getUI()
Fetches the user-interface factory for this text-oriented editor.
 o isEditable()
Returns the boolean indicating whether this TextComponent is editable or not.
 o isFocusTraversable()
Returns true if the focus can be traversed.
 o modelToView(int)
Converts the given location in the model to a place in the view coordinate system.
 o moveCaretPosition(int)
Moves the caret to a new position, leaving behind a mark defined by the last time setCaretPosition was called.
 o paste()
Transfers the contents of the system clipboard into the associated text model.
 o replaceSelection(String)
Replaces the currently selected content with new content represented by the given string.
 o select(int, int)
Selects the text found between the specified start and end locations.
 o selectAll()
Selects all the text in the TextComponent.
 o setCaretPosition(int)
Sets the position of the text insertion caret for the TextComponent
 o setDocument(Document)
Associates the editor with a text document.
 o setEditable(boolean)
Sets the specified boolean to indicate whether or not this TextComponent should be editable.
 o setFocusAccelerator(char)
Sets the key accelerator that will cause the receiving text component to get the focus.
 o setKeymap(Keymap)
Sets the keymap to use for binding events to actions.
 o setSelectionEnd(int)
Sets the selection end to the specified position.
 o setSelectionStart(int)
Sets the selection start to the specified position.
 o setText(String)
Sets the text of this TextComponent to the specified text.
 o setUI(TextUI)
Sets the user-interface factory for this text-oriented editor
 o viewToModel(Point)
Converts the given place in the view coordinate system to the nearest representative location in the model.

Variables

 o FOCUS_ACCELERATOR_KEY
 public static final String FOCUS_ACCELERATOR_KEY
 o model
 protected Document model
 o 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.

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

 o deletePrevCharAction
 public static final String deletePrevCharAction
Name of the action to delete the character of content that precedes the current caret position.

 o deleteNextCharAction
 public static final String deleteNextCharAction
Name of the action to delete the character of content that follows the current caret position.

 o readOnlyAction
 public static final String readOnlyAction
Name of the action to set the editor into read-only mode.

 o writableAction
 public static final String writableAction
Name of the action to set the editor into writeable mode.

 o 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
 o 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
 o 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
 o beepAction
 public static final String beepAction
Name of the action to create a beep

 o pageUpAction
 public static final String pageUpAction
Name of the action to page up vertically.

 o pageDownAction
 public static final String pageDownAction
Name of the action to page down vertically.

Constructors

 o JTextComponent
 public JTextComponent()
Creates a new JTextComponent.

Methods

 o getUI
 public TextUI getUI()
Fetches the user-interface factory for this text-oriented editor.

Returns:
the factory
 o setUI
 public void setUI(TextUI ui)
Sets the user-interface factory for this text-oriented editor

Parameters:
ui - the factory
 o setDocument
 public void setDocument(Document doc)
Associates the editor with a text document. The currently registered factory is used to build a view for the document, which gets displayed by the editor.

Parameters:
doc - the document to display/edit
 o getDocument
 public Document getDocument()
Fetches the model associated with the editor. This is primarily for the UI to get at the minimal amount of state required to be a text editor. Subclasses will return the actual type of the model which will typically be something that extends Document.

Returns:
the model
 o getActions
 public Action[] getActions()
Fetches the command list for the editor. This is the list of commands supported by the plugged-in UI augmented by the collection of commands that the editor itself supports. These are useful for binding to events, such as in a keymap.

Returns:
the command list
 o replaceSelection
 public void replaceSelection(String content)
Replaces the currently selected content with new content represented by the given string. If there is no selection this amounts to an insert of the given text. If there is no replacement text this amounts to a removal of the current selection. This is the method that is used by the default implementation of the action for inserting content that gets bound to the keyboard.

Parameters:
content - the content to replace the selection with
 o modelToView
 public Rectangle modelToView(int pos) throws BadLocationException
Converts the given location in the model to a place in the view coordinate system.

Parameters:
pos - the position
Returns:
the coordinates as a rectangle
Throws: BadLocation
if the given position does not represent a valid location in the associated document
See Also:
modelToView
 o viewToModel
 public int viewToModel(Point pt)
Converts the given place in the view coordinate system to the nearest representative location in the model.

Parameters:
pt - the location in the view to translate
Returns:
the offset from the start of the document
See Also:
viewToModel
 o cut
 public void cut()
Transfers the currently selected range in the associated text model to the system clipboard, removing the contents from the model. The current selection is reset.

 o copy
 public void copy()
Transfers the currently selected range in the associated text model to the system clipboard, leaving the contents in the text model. The current selection is remains intact.

 o paste
 public void paste()
Transfers the contents of the system clipboard into the associated text model. If there is a selection in the associated view, it is replaced with the contents of the clipboard. If there is no selection, the clipboard contents are inserted in front of the current insert position in the associated view.

See Also:
replaceSelection
 o setKeymap
 public void setKeymap(Keymap map)
Sets the keymap to use for binding events to actions.

Parameters:
the - keymap
 o getKeymap
 public Keymap getKeymap()
Fetches the keymap being used by the controller

Returns:
the keymap
 o moveCaretPosition
 public void moveCaretPosition(int pos)
Moves the caret to a new position, leaving behind a mark defined by the last time setCaretPosition was called. This forms a selection.

Parameters:
pos - the position
See Also:
setCaretPosition
 o isFocusTraversable
 public boolean isFocusTraversable()
Returns true if the focus can be traversed.

Returns:
true if the focus is traversable
Overrides:
isFocusTraversable in class JComponent
 o setCaretPosition
 public void setCaretPosition(int position)
Sets the position of the text insertion caret for the TextComponent

Parameters:
position - the position
Throws: IllegalArgumentException
if position is less than 0 or greater than the length of the associated document
 o getCaretPosition
 public int getCaretPosition()
Returns the position of the text insertion caret for the text component.

Returns:
the position of the text insertion caret for the text component
 o setText
 public void setText(String t)
Sets the text of this TextComponent to the specified text.

Parameters:
t - the new text to be set
See Also:
getText
 o getText
 public String getText()
Returns the text contained in this TextComponent.

Returns:
the text
See Also:
setText
 o getSelectedText
 public String getSelectedText()
Returns the selected text contained in this TextComponent.

Returns:
the text
Throws: IllegalArgumentException
if the selection doesn't have a valid mapping into the document for some reason
See Also:
setText
 o isEditable
 public boolean isEditable()
Returns the boolean indicating whether this TextComponent is editable or not.

Returns:
the boolean value
See Also:
setEditable
 o setEditable
 public synchronized void setEditable(boolean b)
Sets the specified boolean to indicate whether or not this TextComponent should be editable.

Parameters:
b - the boolean to be set
See Also:
isEditable
 o getSelectionStart
 public synchronized int getSelectionStart()
Returns the selected text's start position.

Returns:
the start position
 o setSelectionStart
 public synchronized void setSelectionStart(int selectionStart)
Sets the selection start to the specified position. The new starting point is constrained to be before or at the current selection end.

Parameters:
selectionStart - the start position of the text
 o getSelectionEnd
 public synchronized int getSelectionEnd()
Returns the selected text's end position.

Returns:
the end position
 o setSelectionEnd
 public synchronized void setSelectionEnd(int selectionEnd)
Sets the selection end to the specified position. The new end point is constrained to be at or after the current selection start.

Parameters:
selectionEnd - the start position of the text
 o select
 public void select(int selectionStart,
                    int selectionEnd)
Selects the text found between the specified start and end locations. This call is provided for backward compatibility. It is routed to a call to setCaretPosition followed by a call to moveCaretPostion. The preferred way to manage selection is by calling those methods directly.

Parameters:
selectionStart - the start position of the text
selectionEnd - the end position of the text
See Also:
setCaretPosition, moveCaretPosition
 o selectAll
 public synchronized void selectAll()
Selects all the text in the TextComponent.

 o setFocusAccelerator
 public void setFocusAccelerator(char aKey)
Sets the key accelerator that will cause the receiving text component to get the focus.

Parameters:
aKey - the key
 o getFocusAccelerator
 public char getFocusAccelerator()
Returns the key accelerator that will cause the receiving text component to get the focus. Return '\0' if no focus accelerator has been set.

Returns:
the key
 o getAccessibleRole
 public AccessibleRole getAccessibleRole()
Get the role of this object.

Returns:
an instance of AccessibleRole describing the role of the object
Overrides:
getAccessibleRole in class JComponent
See Also:
AccessibleRole
 o getAccessibleText
 public AccessibleText getAccessibleText()
Gets the AccessibleText interface for the component.

Returns:
the AccessibleText of the object.
Overrides:
getAccessibleText in class JComponent
See Also:
AccessibleText
 o getIndexAtPoint
 public int getIndexAtPoint(Point p)
Given a point in local coordinates, return the zero-based index of the character under that Point. If the point is invalid, this method returns -1.

Parameters:
p - the Point in screen coordinates
Returns:
the zero-based index of the character under Point p.
 o getCharacterBounds
 public Rectangle getCharacterBounds(int i)
Given an index into the String, determine the bounding box of the character at that index. The bounds are returned in local coordinates. If the index is invalid, returns an empty rectangle.

Parameters:
i - the index into the String
Returns:
the bounding box, in screen coordinates, of the character
 o getCharCount
 public int getCharCount()
Return the number of characters (valid indicies)

Returns:
the number of characters
 o getAtIndex
 public Object getAtIndex(int chunk,
                          int index)
Return the object at a given index. Use instanceof() to determine whether this is a String (common), or either an Accessible, or an inaccessible Object.

Parameters:
chunk - the letter, word, or sentence to retrieve
index - an index within the text
Returns:
the current object
 o getAfterIndex
 public Object getAfterIndex(int chunk,
                             int index)
Return the object after a given index. Use instanceof() to determine whether this is a String (common), or either an Accessible, or an inaccessible Object.

Parameters:
chunk - the letter, word, or sentence to retrieve
index - an index within the text
Returns:
the next object
 o getBeforeIndex
 public Object getBeforeIndex(int chunk,
                              int index)
Return the object before a given index. Use instanceof() to determine whether this is a String (common), or either an Accessible, or an inaccessible Object.

Parameters:
chunk - the letter, word, or sentence to retrieve
index - an index within the text
Returns:
the previous object
 o getCharacterAttribute
 public AttributeSet getCharacterAttribute(int i)
Return the AttributeSet for a given character (at a given index)

Parameters:
i - the zero-based index into the text
Returns:
the AttributeSet

All Packages  Class Hierarchy  This Package  Previous  Next  Index