ImageObserver
, MenuContainer
, Serializable
, Accessible
, Scrollable
JEditorPane
, JTextArea
, JTextField
@JavaBean(defaultProperty="UI") public abstract class JTextComponent extends JComponent implements Scrollable, Accessible
JTextComponent
is the base class for swing text components. It tries to be compatible with the java.awt.TextComponent
class where it can reasonably do so. Also provided are other services for additional flexibility (beyond the pluggable UI and bean support). You can find information on how to use the functionality this class provides in General Rules for Using Text Components, a section in The Java Tutorial. CaretListener
interface that have been registered with the text component. The UI will install a default caret unless a customized caret has been set. DefaultCaret
tries to make itself visible which may lead to scrolling of a text component within JScrollPane
. The default caret behavior can be changed by the DefaultCaret.setUpdatePolicy(int)
method. Action
interface, using the TextAction
implementation. The set of commands supported by the text component can be found with the getActions()
method. These actions can be bound to key events, fired from buttons, etc. A Keymap
lets an application bind key strokes to actions. In order to allow keymaps to be shared across multiple text components, they can use actions that extend TextAction
. TextAction
can determine which JTextComponent
most recently has or had focus and therefore is the subject of the action (In the case that the ActionEvent
sent to the action doesn't contain the target text component as its source).
The Input Method Framework lets text components interact with input methods, separate software components that preprocess events to let users enter thousands of different characters using keyboards with far fewer keys. JTextComponent
is an active client of the framework, so it implements the preferred user interface for interacting with input methods. As a consequence, some key events do not reach the text component because they are handled by an input method, and some text input reaches the text component as committed text within an InputMethodEvent
instead of as a key event. The complete text input is the combination of the characters in keyTyped
key events and committed text in input method events.
The AWT listener model lets applications attach event listeners to components in order to bind events to actions. Swing encourages the use of keymaps instead of listeners, but maintains compatibility with listeners by giving the listeners a chance to steal an event by consuming it.
Keyboard event and input method events are handled in the following stages, with each stage capable of consuming the event:
Stage | KeyEvent | InputMethodEvent |
---|---|---|
1. | input methods | (generated here) |
2. | focus manager | |
3. | registered key listeners | registered input method listeners |
4. | input method handling in JTextComponent | |
5. | keymap handling using the current keymap | |
6. | keyboard handling in JComponent (e.g. accelerators, component navigation, etc.) |
To maintain compatibility with applications that listen to key events but are not aware of input method events, the input method handling in stage 4 provides a compatibility mode for components that do not process input method events. For these components, the committed text is converted to keyTyped key events and processed in the key event pipeline starting at stage 3 instead of in the input method event pipeline.
By default the component will create a keymap (named DEFAULT_KEYMAP) that is shared by all JTextComponent instances as the default keymap. Typically a look-and-feel implementation will install a different keymap that resolves to the default keymap for those bindings not found in the different keymap. The minimal bindings include:
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. 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. This event is sent to observers that have implemented the DocumentListener
interface and registered interest with the model being observed.
modelToView(int)
and viewToModel(java.awt.Point)
for determining this information. UndoableEdit
records that can be used in conjunction with a history buffer to provide the undo/redo support. The support is provided by the Document model, which allows one to attach UndoableEditListener implementations. AbstractDocument
describes the assumptions of the protection provided. The methods that are safe to call asynchronously are marked with comments. print
methods are provided for basic document printing. If more advanced printing is needed, use the getPrintable(java.text.MessageFormat, java.text.MessageFormat)
method. Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeans has been added to the java.beans
package. Please see XMLEncoder
.
Modifier and Type | Class | Description |
---|---|---|
class |
JTextComponent.AccessibleJTextComponent |
This class implements accessibility support for the JTextComponent class. |
static final class |
JTextComponent.DropLocation |
Represents a drop location for JTextComponent s. |
static class |
JTextComponent.KeyBinding |
Binding record for creating key bindings. |
JComponent.AccessibleJComponent
Container.AccessibleAWTContainer
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
Modifier and Type | Field | Description |
---|---|---|
static final String |
DEFAULT_KEYMAP |
The default keymap that will be shared by all JTextComponent instances unless they have had a different keymap set. |
static final String |
FOCUS_ACCELERATOR_KEY |
The bound property name for the focus accelerator. |
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
Constructor | Description |
---|---|
JTextComponent() |
Creates a new JTextComponent . |
Modifier and Type | Method | Description |
---|---|---|
void |
addCaretListener |
Adds a caret listener for notification of any changes to the caret. |
static Keymap |
addKeymap |
Adds a new keymap into the keymap hierarchy. |
void |
copy() |
Transfers the currently selected range in the associated text model to the system clipboard, leaving the contents in the text model. |
void |
cut() |
Transfers the currently selected range in the associated text model to the system clipboard, removing the contents from the model. |
protected void |
fireCaretUpdate |
Notifies all listeners that have registered interest for notification on this event type. |
AccessibleContext |
getAccessibleContext() |
Gets the AccessibleContext associated with this JTextComponent . |
Action[] |
getActions() |
Fetches the command list for the editor. |
Caret |
getCaret() |
Fetches the caret that allows text-oriented navigation over the view. |
Color |
getCaretColor() |
Fetches the current color used to render the caret. |
CaretListener[] |
getCaretListeners() |
Returns an array of all the caret listeners registered on this text component. |
int |
getCaretPosition() |
Returns the position of the text insertion caret for the text component. |
Color |
getDisabledTextColor() |
Fetches the current color used to render the disabled text. |
Document |
getDocument() |
Fetches the model associated with the editor. |
boolean |
getDragEnabled() |
Returns whether or not automatic drag handling is enabled. |
final JTextComponent.DropLocation |
getDropLocation() |
Returns the location that this component should visually indicate as the drop location during a DnD operation over the component, or null if no location is to currently be shown. |
final DropMode |
getDropMode() |
Returns the drop mode for this component. |
char |
getFocusAccelerator() |
Returns the key accelerator that will cause the receiving text component to get the focus. |
Highlighter |
getHighlighter() |
Fetches the object responsible for making highlights. |
InputMethodRequests |
getInputMethodRequests() |
Gets the input method request handler which supports requests from input methods for this component. |
Keymap |
getKeymap() |
Fetches the keymap currently active in this text component. |
static Keymap |
getKeymap |
Fetches a named keymap previously added to the document. |
Insets |
getMargin() |
Returns the margin between the text component's border and its text. |
NavigationFilter |
getNavigationFilter() |
Returns the NavigationFilter . |
Dimension |
getPreferredScrollableViewportSize() |
Returns the preferred size of the viewport for a view component. |
Printable |
getPrintable |
Returns a Printable to use for printing the content of this JTextComponent . |
int |
getScrollableBlockIncrement |
Components that display logical rows or columns should compute the scroll increment that will completely expose one block of rows or columns, depending on the value of orientation. |
boolean |
getScrollableTracksViewportHeight() |
Returns true if a viewport should always force the height of this Scrollable to match the height of the viewport. |
boolean |
getScrollableTracksViewportWidth() |
Returns true if a viewport should always force the width of this Scrollable to match the width of the viewport. |
int |
getScrollableUnitIncrement |
Components that display logical rows or columns should compute the scroll increment that will completely expose one new row or column, depending on the value of orientation. |
String |
getSelectedText() |
Returns the selected text contained in this TextComponent . |
Color |
getSelectedTextColor() |
Fetches the current color used to render the selected text. |
Color |
getSelectionColor() |
Fetches the current color used to render the selection. |
int |
getSelectionEnd() |
Returns the selected text's end position. |
int |
getSelectionStart() |
Returns the selected text's start position. |
String |
getText() |
Returns the text contained in this TextComponent . |
String |
getText |
Fetches a portion of the text represented by the component. |
String |
getToolTipText |
Returns the string to be used as the tooltip for event . |
TextUI |
getUI() |
Fetches the user-interface factory for this text-oriented editor. |
boolean |
isEditable() |
Returns the boolean indicating whether this TextComponent is editable or not. |
static void |
loadKeymap |
Loads a keymap with a bunch of bindings. |
Rectangle |
modelToView |
Deprecated. |
Rectangle2D |
modelToView2D |
Converts the given location in the model to a place in the view coordinate system. |
void |
moveCaretPosition |
Moves the caret to a new position, leaving behind a mark defined by the last time setCaretPosition was called. |
protected String |
paramString() |
Returns a string representation of this JTextComponent . |
void |
paste() |
Transfers the contents of the system clipboard into the associated text model. |
boolean |
print() |
A convenience print method that displays a print dialog, and then prints this JTextComponent in interactive mode with no header or footer text. |
boolean |
print |
A convenience print method that displays a print dialog, and then prints this JTextComponent in interactive mode with the specified header and footer text. |
boolean |
print |
Prints the content of this JTextComponent . |
void |
read |
Initializes from a stream. |
void |
removeCaretListener |
Removes a caret listener. |
static Keymap |
removeKeymap |
Removes a named keymap previously added to the document. |
void |
replaceSelection |
Replaces the currently selected content with new content represented by the given string. |
protected void |
restoreComposedText() |
Restores composed text previously saved by saveComposedText . |
protected boolean |
saveComposedText |
Saves composed text around the specified position. |
void |
select |
Selects the text between the specified start and end positions. |
void |
selectAll() |
Selects all the text in the TextComponent . |
void |
setCaret |
Sets the caret to be used. |
void |
setCaretColor |
Sets the current color used to render the caret. |
void |
setCaretPosition |
Sets the position of the text insertion caret for the TextComponent . |
void |
setDisabledTextColor |
Sets the current color used to render the disabled text. |
void |
setDocument |
Associates the editor with a text document. |
void |
setDragEnabled |
Turns on or off automatic drag handling. |
final void |
setDropMode |
Sets the drop mode for this component. |
void |
setEditable |
Sets the specified boolean to indicate whether or not this TextComponent should be editable. |
void |
setFocusAccelerator |
Sets the key accelerator that will cause the receiving text component to get the focus. |
void |
setHighlighter |
Sets the highlighter to be used. |
void |
setKeymap |
Sets the keymap to use for binding events to actions. |
void |
setMargin |
Sets margin space between the text component's border and its text. |
void |
setNavigationFilter |
Sets the NavigationFilter . |
void |
setSelectedTextColor |
Sets the current color used to render the selected text. |
void |
setSelectionColor |
Sets the current color used to render the selection. |
void |
setSelectionEnd |
Sets the selection end to the specified position. |
void |
setSelectionStart |
Sets the selection start to the specified position. |
void |
setText |
Sets the text of this TextComponent to the specified text. |
void |
setUI |
Sets the user-interface factory for this text-oriented editor. |
void |
updateUI() |
Reloads the pluggable UI. |
int |
viewToModel |
Deprecated. replaced by viewToModel2D(Point2D)
|
int |
viewToModel2D |
Converts the given place in the view coordinate system to the nearest representative location in the model. |
void |
write |
Stores the contents of the model into the given stream. |
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
public static final String FOCUS_ACCELERATOR_KEY
public static final String DEFAULT_KEYMAP
JTextComponent
instances unless they have had a different keymap set.public JTextComponent()
JTextComponent
. Listeners for caret events are established, and the pluggable UI installed. The component is marked as editable. No layout manager is used, because layout is managed by the view subsystem of text. The document model is set to null
.public TextUI getUI()
getUI
in class JComponent
public void setUI(TextUI ui)
ui
- the factorypublic void updateUI()
getUIClassID()
. The type of the UI is TextUI
. invalidate
is called after setting the UI.updateUI
in class JComponent
public void addCaretListener(CaretListener listener)
listener
- the listener to be addedpublic void removeCaretListener(CaretListener listener)
listener
- the listener to be removed@BeanProperty(bound=false) public CaretListener[] getCaretListeners()
CaretListener
s or an empty array if no caret listeners are currently registeredprotected void fireCaretUpdate(CaretEvent e)
e
- the event@BeanProperty(expert=true, description="the text document model") public void setDocument(Document doc)
doc
- the document to display/editpublic Document getDocument()
@BeanProperty(bound=false) public Action[] getActions()
@BeanProperty(description="desired space between the border and text area") public void setMargin(Insets m)
Border
object will use this value to create the proper margin. However, if a non-default border is set on the text component, it is that Border
object's responsibility to create the appropriate margin space (else this property will effectively be ignored). This causes a redraw of the component. A PropertyChange event ("margin") is sent to all listeners.m
- the space between the border and the textpublic Insets getMargin()
public Caret getCaret()
@BeanProperty(expert=true, description="the caret used to select/navigate") public void setCaret(Caret c)
c
- the caretpublic Highlighter getHighlighter()
@BeanProperty(expert=true, description="object responsible for background highlights") public void setHighlighter(Highlighter h)
null
to disable it. A PropertyChange event ("highlighter") is fired when a new highlighter is installed.h
- the highlighter@BeanProperty(description="set of key event to action bindings to use") public void setKeymap(Keymap map)
null
effectively disables keyboard input. A PropertyChange event ("keymap") is fired when a new keymap is installed.map
- the keymap@BeanProperty(bound=false, description="determines whether automatic drag handling is enabled") public void setDragEnabled(boolean b)
true
, and the component's TransferHandler
needs to be non-null
. The default value of the dragEnabled
property is false
. The job of honoring this property, and recognizing a user drag gesture, lies with the look and feel implementation, and in particular, the component's TextUI
. When automatic drag handling is enabled, most look and feels (including those that subclass BasicLookAndFeel
) begin a drag and drop operation whenever the user presses the mouse button over a selection and then moves the mouse a few pixels. Setting this property to true
can therefore have a subtle effect on how selections behave.
If a look and feel is used that ignores this property, you can still begin a drag and drop operation by calling exportAsDrag
on the component's TransferHandler
.
b
- whether or not to enable automatic drag handlingHeadlessException
- if b
is true
and GraphicsEnvironment.isHeadless()
returns true
public boolean getDragEnabled()
dragEnabled
propertypublic final void setDropMode(DropMode dropMode)
DropMode.USE_SELECTION
. Usage of DropMode.INSERT
is recommended, however, for an improved user experience. It offers similar behavior of dropping between text locations, but does so without affecting the actual text selection and caret location. JTextComponents
support the following drop modes:
DropMode.USE_SELECTION
DropMode.INSERT
The drop mode is only meaningful if this component has a TransferHandler
that accepts drops.
dropMode
- the drop mode to useIllegalArgumentException
- if the drop mode is unsupported or null
public final DropMode getDropMode()
@BeanProperty(bound=false) public final JTextComponent.DropLocation getDropLocation()
null
if no location is to currently be shown. This method is not meant for querying the drop location from a TransferHandler
, as the drop location is only set after the TransferHandler
's canImport
has returned and has allowed for the location to be shown.
When this property changes, a property change event with name "dropLocation" is fired by the component.
public Keymap getKeymap()
public static Keymap addKeymap(String nm, Keymap parent)
nm
- the name of the keymap (must be unique within the collection of named keymaps in the document); the name may be null
if the keymap is unnamed, but the caller is responsible for managing the reference returned as an unnamed keymap can't be fetched by nameparent
- the parent keymap; this may be null
if unspecified bindings need not be resolved in some other keymappublic static Keymap removeKeymap(String nm)
null
names may not be removed in this way.nm
- the name of the keymap to removepublic static Keymap getKeymap(String nm)
null
-named keymaps.nm
- the name of the keymappublic static void loadKeymap(Keymap map, JTextComponent.KeyBinding[] bindings, Action[] actions)
Loads a keymap with a bunch of bindings. This can be used to take a static table of definitions and load them into some keymap. The following example illustrates an example of binding some keys to the cut, copy, and paste actions associated with a JTextComponent. A code fragment to accomplish this might look as follows:
static final JTextComponent.KeyBinding[] defaultBindings = {
new JTextComponent.KeyBinding(
KeyStroke.getKeyStroke(KeyEvent.VK_C, InputEvent.CTRL_MASK),
DefaultEditorKit.copyAction),
new JTextComponent.KeyBinding(
KeyStroke.getKeyStroke(KeyEvent.VK_V, InputEvent.CTRL_MASK),
DefaultEditorKit.pasteAction),
new JTextComponent.KeyBinding(
KeyStroke.getKeyStroke(KeyEvent.VK_X, InputEvent.CTRL_MASK),
DefaultEditorKit.cutAction),
};
JTextComponent c = new JTextPane();
Keymap k = c.getKeymap();
JTextComponent.loadKeymap(k, defaultBindings, c.getActions());
The sets of bindings and actions may be empty but must be non-null
.map
- the keymapbindings
- the bindingsactions
- the set of actionspublic Color getCaretColor()
@BeanProperty(preferred=true, description="the color used to render the caret") public void setCaretColor(Color c)
null
effectively restores the default color. Setting the color results in a PropertyChange event ("caretColor") being fired.c
- the colorpublic Color getSelectionColor()
@BeanProperty(preferred=true, description="color used to render selection background") public void setSelectionColor(Color c)
null
is the same as setting Color.white
. Setting the color results in a PropertyChange event ("selectionColor").c
- the colorpublic Color getSelectedTextColor()
@BeanProperty(preferred=true, description="color used to render selected text") public void setSelectedTextColor(Color c)
null
is the same as Color.black
. Setting the color results in a PropertyChange event ("selectedTextColor") being fired.c
- the colorpublic Color getDisabledTextColor()
@BeanProperty(preferred=true, description="color used to render disabled text") public void setDisabledTextColor(Color c)
c
- the colorpublic void replaceSelection(String content)
This is the method that is used by the default implementation of the action for inserting content that gets bound to the keymap actions.
content
- the content to replace the selection withpublic String getText(int offs, int len) throws BadLocationException
offs
- the offset ≥ 0len
- the length ≥ 0BadLocationException
- if the offset or length are invalid@Deprecated(since="9") public Rectangle modelToView(int pos) throws BadLocationException
modelToView2D(int)
pos
- the position ≥ 0BadLocationException
- if the given position does not represent a valid location in the associated documentpublic Rectangle2D modelToView2D(int pos) throws BadLocationException
pos
- the position >= 0
BadLocationException
- if the given position does not represent a valid location in the associated document@Deprecated(since="9") public int viewToModel(Point pt)
viewToModel2D(Point2D)
pt
- the location in the view to translatepublic int viewToModel2D(Point2D pt)
pt
- the location in the view to translate>= 0
from the start of the document, or -1
if the component does not yet have a positive size.public void cut()
null
selections.public void copy()
null
selections.public void paste()
public void moveCaretPosition(int pos)
setCaretPosition
was called. This forms a selection. If the document is null
, does nothing. The position must be between 0 and the length of the component's text or else an exception is thrown.pos
- the positionIllegalArgumentException
- if the value supplied for position
is less than zero or greater than the component's text length@BeanProperty(description="accelerator character used to grab focus") public void setFocusAccelerator(char aKey)
aKey
- the keypublic char getFocusAccelerator()
public void read(Reader in, Object desc) throws IOException
in
- the stream to read fromdesc
- an object describing the stream; this might be a string, a File, a URL, etc. Some kinds of documents (such as html for example) might be able to make use of this information; if non-null
, it is added as a property of the documentIOException
- as thrown by the stream being used to initializepublic void write(Writer out) throws IOException
out
- the output streamIOException
- on any I/O error@BeanProperty(bound=false, description="the caret position") public void setCaretPosition(int position)
TextComponent
. Note that the caret tracks change, so this may move if the underlying text of the component is changed. If the document is null
, does nothing. The position must be between 0 and the length of the component's text or else an exception is thrown.position
- the positionIllegalArgumentException
- if the value supplied for position
is less than zero or greater than the component's text lengthpublic int getCaretPosition()
@BeanProperty(bound=false, description="the text of this component") public void setText(String t)
TextComponent
to the specified text. If the text is null
or empty, has the effect of simply deleting the old text. When text has been inserted, the resulting caret location is determined by the implementation of the caret class. Note that text is not a bound property, so no PropertyChangeEvent
is fired when it changes. To listen for changes to the text, use DocumentListener
.
t
- the new text to be setpublic String getText()
TextComponent
. If the underlying document is null
, will give a NullPointerException
. Note that text is not a bound property, so no PropertyChangeEvent
is fired when it changes. To listen for changes to the text, use DocumentListener
.NullPointerException
- if the document is null
@BeanProperty(bound=false) public String getSelectedText()
TextComponent
. If the selection is null
or the document empty, returns null
.IllegalArgumentException
- if the selection doesn't have a valid mapping into the document for some reasonpublic boolean isEditable()
TextComponent
is editable or not.@BeanProperty(description="specifies if the text can be edited") public void setEditable(boolean b)
TextComponent
should be editable. A PropertyChange event ("editable") is fired when the state is changed.b
- the boolean to be setpublic int getSelectionStart()
@BeanProperty(bound=false, description="starting location of the selection.") public void setSelectionStart(int selectionStart)
This is available for backward compatibility to code that called this method on java.awt.TextComponent
. This is implemented to forward to the Caret
implementation which is where the actual selection is maintained.
selectionStart
- the start position of the text ≥ 0public int getSelectionEnd()
@BeanProperty(bound=false, description="ending location of the selection.") public void setSelectionEnd(int selectionEnd)
This is available for backward compatibility to code that called this method on java.awt.TextComponent
. This is implemented to forward to the Caret
implementation which is where the actual selection is maintained.
selectionEnd
- the end position of the text ≥ 0public void select(int selectionStart, int selectionEnd)
This method sets the start and end positions of the selected text, enforcing the restriction that the start position must be greater than or equal to zero. The end position must be greater than or equal to the start position, and less than or equal to the length of the text component's text.
If the caller supplies values that are inconsistent or out of bounds, the method enforces these constraints silently, and without failure. Specifically, if the start position or end position is greater than the length of the text, it is reset to equal the text length. If the start position is less than zero, it is reset to zero, and if the end position is less than the start position, it is reset to the start position.
This call is provided for backward compatibility. It is routed to a call to setCaretPosition
followed by a call to moveCaretPosition
. The preferred way to manage selection is by calling those methods directly.
selectionStart
- the start position of the textselectionEnd
- the end position of the textpublic void selectAll()
TextComponent
. Does nothing on a null
or empty document.public String getToolTipText(MouseEvent event)
event
. This will return one of: setToolTipText
has been invoked with a non-null
value, it will be returned, otherwise getToolTipText
on the UI will be returned. JTextComponent
does not register itself with the ToolTipManager
. This means that tooltips will NOT be shown from the TextUI
unless registerComponent
has been invoked on the ToolTipManager
.getToolTipText
in class JComponent
event
- the event in questionevent
@BeanProperty(bound=false) public Dimension getPreferredScrollableViewportSize()
getPreferredScrollableViewportSize
in interface Scrollable
preferredSize
of a JViewport
whose view is this Scrollable
public int getScrollableUnitIncrement(Rectangle visibleRect, int orientation, int direction)
The default implementation of this is to simply return 10% of the visible area. Subclasses are likely to be able to provide a much more reasonable value.
getScrollableUnitIncrement
in interface Scrollable
visibleRect
- the view area visible within the viewportorientation
- either SwingConstants.VERTICAL
or SwingConstants.HORIZONTAL
direction
- less than zero to scroll up/left, greater than zero for down/rightIllegalArgumentException
- for an invalid orientationpublic int getScrollableBlockIncrement(Rectangle visibleRect, int orientation, int direction)
The default implementation of this is to simply return the visible area. Subclasses will likely be able to provide a much more reasonable value.
getScrollableBlockIncrement
in interface Scrollable
visibleRect
- the view area visible within the viewportorientation
- either SwingConstants.VERTICAL
or SwingConstants.HORIZONTAL
direction
- less than zero to scroll up/left, greater than zero for down/rightIllegalArgumentException
- for an invalid orientation@BeanProperty(bound=false) public boolean getScrollableTracksViewportWidth()
Scrollable
to match the width of the viewport. For example a normal text view that supported line wrapping would return true here, since it would be undesirable for wrapped lines to disappear beyond the right edge of the viewport. Note that returning true for a Scrollable
whose ancestor is a JScrollPane
effectively disables horizontal scrolling. Scrolling containers, like JViewport
, will use this method each time they are validated.
getScrollableTracksViewportWidth
in interface Scrollable
Scrollable
s width to match its own@BeanProperty(bound=false) public boolean getScrollableTracksViewportHeight()
Scrollable
to match the height of the viewport. For example a columnar text view that flowed text in left to right columns could effectively disable vertical scrolling by returning true here. Scrolling containers, like JViewport
, will use this method each time they are validated.
getScrollableTracksViewportHeight
in interface Scrollable
public boolean print() throws PrinterException
JTextComponent
in interactive mode with no header or footer text. Note: this method blocks until printing is done. Note: In headless mode, no dialogs will be shown.
This method calls the full featured print
method to perform printing.
true
, unless printing is canceled by the userPrinterException
- if an error in the print system causes the job to be abortedSecurityException
- if this thread is not allowed to initiate a print job requestpublic boolean print(MessageFormat headerFormat, MessageFormat footerFormat) throws PrinterException
JTextComponent
in interactive mode with the specified header and footer text. Note: this method blocks until printing is done. Note: In headless mode, no dialogs will be shown.
This method calls the full featured print
method to perform printing.
headerFormat
- the text, in MessageFormat
, to be used as the header, or null
for no headerfooterFormat
- the text, in MessageFormat
, to be used as the footer, or null
for no footertrue
, unless printing is canceled by the userPrinterException
- if an error in the print system causes the job to be abortedSecurityException
- if this thread is not allowed to initiate a print job requestpublic boolean print(MessageFormat headerFormat, MessageFormat footerFormat, boolean showPrintDialog, PrintService service, PrintRequestAttributeSet attributes, boolean interactive) throws PrinterException
JTextComponent
. Note: this method blocks until printing is done. Page header and footer text can be added to the output by providing MessageFormat
arguments. The printing code requests Strings
from the formats, providing a single item which may be included in the formatted string: an Integer
representing the current page number.
showPrintDialog boolean
parameter allows you to specify whether a print dialog is displayed to the user. When it is, the user may use the dialog to change printing attributes or even cancel the print.
service
allows you to provide the initial PrintService
for the print dialog, or to specify PrintService
to print to when the dialog is not shown.
attributes
can be used to provide the initial values for the print dialog, or to supply any needed attributes when the dialog is not shown. attributes
can be used to control how the job will print, for example duplex or single-sided.
interactive boolean
parameter allows you to specify whether to perform printing in interactive mode. If true
, a progress dialog, with an abort option, is displayed for the duration of printing. This dialog is modal when print
is invoked on the Event Dispatch Thread and non-modal otherwise. Warning: calling this method on the Event Dispatch Thread with
interactive false
blocks all events, including repaints, from being processed until printing is complete. It is only recommended when printing from an application with no visible GUI.
Note: In headless mode, showPrintDialog
and interactive
parameters are ignored and no dialogs are shown.
This method ensures the document
is not mutated during printing. To indicate it visually, setEnabled(false)
is set for the duration of printing.
This method uses getPrintable(java.text.MessageFormat, java.text.MessageFormat)
to render document content.
This method is thread-safe, although most Swing methods are not. Please see Concurrency in Swing for more information.
Sample Usage. This code snippet shows a cross-platform print dialog and then prints the JTextComponent
in interactive mode unless the user cancels the dialog:
textComponent.print(new MessageFormat("My text component header"), new MessageFormat("Footer. Page - {0}"), true, null, null, true);
Executing this code off the Event Dispatch Thread performs printing on the background. The following pattern might be used for background printing:
FutureTask<Boolean> future = new FutureTask<Boolean>( new Callable<Boolean>() { public Boolean call() { return textComponent.print(.....); } }); executor.execute(future);
headerFormat
- the text, in MessageFormat
, to be used as the header, or null
for no headerfooterFormat
- the text, in MessageFormat
, to be used as the footer, or null
for no footershowPrintDialog
- true
to display a print dialog, false
otherwiseservice
- initial PrintService
, or null
for the defaultattributes
- the job attributes to be applied to the print job, or null
for noneinteractive
- whether to print in an interactive modetrue
, unless printing is canceled by the userPrinterException
- if an error in the print system causes the job to be abortedSecurityException
- if this thread is not allowed to initiate a print job requestpublic Printable getPrintable(MessageFormat headerFormat, MessageFormat footerFormat)
Printable
to use for printing the content of this JTextComponent
. The returned Printable
prints the document as it looks on the screen except being reformatted to fit the paper. The returned Printable
can be wrapped inside another Printable
in order to create complex reports and documents. The returned Printable
shares the document
with this JTextComponent
. It is the responsibility of the developer to ensure that the document
is not mutated while this Printable
is used. Printing behavior is undefined when the document
is mutated during printing.
Page header and footer text can be added to the output by providing MessageFormat
arguments. The printing code requests Strings
from the formats, providing a single item which may be included in the formatted string: an Integer
representing the current page number.
The returned Printable
when printed, formats the document content appropriately for the page size. For correct line wrapping the imageable width
of all pages must be the same. See PageFormat.getImageableWidth()
.
This method is thread-safe, although most Swing methods are not. Please see Concurrency in Swing for more information.
The returned Printable
can be printed on any thread.
This implementation returned Printable
performs all painting on the Event Dispatch Thread, regardless of what thread it is used on.
headerFormat
- the text, in MessageFormat
, to be used as the header, or null
for no headerfooterFormat
- the text, in MessageFormat
, to be used as the footer, or null
for no footerPrintable
for use in printing content of this JTextComponent
@BeanProperty(bound=false) public AccessibleContext getAccessibleContext()
AccessibleContext
associated with this JTextComponent
. For text components, the AccessibleContext
takes the form of an AccessibleJTextComponent
. A new AccessibleJTextComponent
instance is created if necessary.getAccessibleContext
in interface Accessible
getAccessibleContext
in class Component
AccessibleJTextComponent
that serves as the AccessibleContext
of this JTextComponent
protected String paramString()
JTextComponent
. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not be null
. Overriding paramString
to provide information about the specific new aspects of the JFC components.
paramString
in class JComponent
JTextComponent
@BeanProperty(bound=false) public InputMethodRequests getInputMethodRequests()
Component
InputMethodRequests
instance. At the same time, it also has to handle input method events.getInputMethodRequests
in class Component
null
by defaultprotected boolean saveComposedText(int pos)
pos
- document position to identify the composed text locationtrue
if the composed text exists and is saved, false
otherwiseprotected void restoreComposedText()
saveComposedText
. The saved composed text is inserted back into the document. This method should be invoked only if saveComposedText
returns true
.
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/javax/swing/text/JTextComponent.html
modelToView2D(int)