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

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, InsertPosition

beepAction

Name of the action to create a beep

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.

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.

FOCUS_ACCELERATOR_KEY

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.

model

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.

readOnlyAction

Name of the action to set the editor into read-only mode.

writableAction

Name of the action to set the editor into writeable mode.

JTextComponent()

copy()

Transfer the currently selected range in the associated text model to the system clipboard, leaving the contents in the text model.

cut()

Transfer the currently selected range in the associated text model to the system clipboard, removing the contents from the model.

getActions()

Fetch the command list for the editor.

getCaretPosition()

Returns the position of the text insertion caret for the text component.

getFocusAccelerator()

Return the key accelerator that will cause the receiving text component to get the focus.

getKeymap()

Fetch the keymap being used by the controller

getModel()

Fetch the model associated with the editor.

getSelectedText()

Returns the selected text contained in this TextComponent.

getSelection()

Get the currently selected range in the editor.

getSelectionEnd()

Returns the selected text's end position.

getSelectionStart()

Returns the selected text's start position.

getText()

Returns the text contained in this TextComponent.

getUI()

Fetch the user-interface factory for this text-oriented editor

isEditable()

Returns the boolean indicating whether this TextComponent is editable or not.

isFocusTraversable()

modelToView(Position)

moveCaretPosition(int)

Move the caret to a new position, leaving behind a mark defined by the last time setCaretPosition was called.

paste()

Transfer the contents of the system clipboard into the associated text model.

replaceSelection(String)

Replace the currently selected content with new content represented by the given string.

select(int, int)

Selects the text found between the specified start and end locations.

selectAll()

Selects all the text in the TextComponent.

setCaretPosition(int)

Sets the position of the text insertion caret for the TextComponent

setEditable(boolean)

Sets the specified boolean to indicate whether or not this TextComponent should be editable.

setFocusAccelerator(char)

Set the key accelerator that will cause the receiving text component to get the focus.

setKeymap(Keymap)

Set the keymap to use for binding events to actions.

setModel(Document)

Associate the editor with a text document.

setSelectionEnd(int)

Sets the selection end to the specified position.

setSelectionStart(int)

Sets the selection start to the specified position.

setText(String)

Sets the text of this TextComponent to the specified text.

setUI(TextUI)

Set the user-interface factory for this text-oriented editor

viewToModel(Point)

 public static final String FOCUS_ACCELERATOR_KEY

 protected Document model

 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.

 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.

 public static final String deletePrevCharAction

Name of the action to delete the character of content that precedes the current caret position.

 public static final String deleteNextCharAction

Name of the action to delete the character of content that follows the current caret position.

 public static final String readOnlyAction

Name of the action to set the editor into read-only mode.

 public static final String writableAction

Name of the action to set the editor into writeable mode.

 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

 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

 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

 public static final String beepAction

Name of the action to create a beep

 public static final String pageUpAction

Name of the action to page up vertically.

 public static final String pageDownAction

Name of the action to page down vertically.

 public JTextComponent()

 public TextUI getUI()

Fetch the user-interface factory for this text-oriented editor

 public void setUI(TextUI ui)

Set the user-interface factory for this text-oriented editor

 public void setModel(Document doc)

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

 public Document getModel()

Fetch the model associated with the editor. The editor may be responsible for only a portion of the document. The portion (which may be the entire document) is represented by this element.

 public Action[] getActions()

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

 public Range getSelection()

Get the currently selected range in the editor. If nothing is selected the range will have a length of zero. If there is no document associated with the editor, null will be returned.

 public void replaceSelection(String content)

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

 public Rectangle modelToView(Position pos) throws BadLocation

Throws: BadLocation

If the given position does not represent a valid location in the associated document.

See Also:

modelToView

 public Position viewToModel(Point pt)

See Also:

viewToModel

 public void cut()

Transfer the currently selected range in the associated text model to the system clipboard, removing the contents from the model. The current selection is reset.

 public void copy()

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

 public void paste()

Transfer 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

 public void setKeymap(Keymap map)

Set the keymap to use for binding events to actions.

 public Keymap getKeymap()

Fetch the keymap being used by the controller

 public void moveCaretPosition(int pos)

Move the caret to a new position, leaving behind a mark defined by the last time setCaretPosition was called. This forms a selection.

See Also:

setCaretPosition

 public boolean isFocusTraversable()

Overrides:

isFocusTraversable in class JComponent

 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.

 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.

 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

 public String getText()

Returns the text contained in this TextComponent.

See Also:

setText

 public String getSelectedText()

Returns the selected text contained in this TextComponent.

Throws: IllegalArgumentException

If the selection doesn't have a valid mapping into the document for some reason.

See Also:

setText

 public boolean isEditable()

Returns the boolean indicating whether this TextComponent is editable or not.

See Also:

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

 public synchronized int getSelectionStart()

Returns the selected text's start position.

 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

 public synchronized int getSelectionEnd()

Returns the selected text's end position.

 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

 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

 public synchronized void selectAll()

Selects all the text in the TextComponent.

 public void setFocusAccelerator(char aKey)

Set the key accelerator that will cause the receiving text component to get the focus.

 public char getFocusAccelerator()

Return the key accelerator that will cause the receiving text component to get the focus. Return '\0' if no focus accelerator has been set.

All Packages  Class Hierarchy  This Package  Previous  Next  Index