| public class java.awt TextComponent
|
Java SE 6 |
TextComponent class is the superclass of
any component that allows the editing of some text.
A text component embodies a string of text. The
TextComponent class defines a set of methods
that determine whether or not this text is editable. If the
component is editable, it defines another set of methods
that supports a text insertion caret.
In addition, the class defines methods that are used to maintain a current selection from the text. The text selection, a substring of the component's text, is the target of editing operations. It is also referred to as the selected text.
| version | 1.90, 07/11/06 |
| since | JDK1.0 |
| Fields | |
|---|---|
| protected TextListener | textListener |
| Methods | |||||||
|---|---|---|---|---|---|---|---|
| public void | addNotify() Details
Makes this Component displayable by connecting it to a
native screen resource.
This method is called internally by the toolkit and should
not be called directly by programs.
| ||||||
| public void | addTextListener(TextListener l) Details
Adds the specified text event listener to receive text events
from this text component.
If l is null, no exception is
thrown and no action is performed.
Refer to AWT Threading Issues for details on AWT's threading model.
| ||||||
| public void | enableInputMethods(boolean enable) Details
Enables or disables input method support for this text component. If input
method support is enabled and the text component also processes key events,
incoming events are offered to the current input method and will only be
processed by the component or dispatched to its listeners if the input method
does not consume them. Whether and how input method support for this text
component is enabled or disabled by default is implementation dependent.
| ||||||
| protected String | paramString() Details
Returns a string representing the state of this
TextComponent. 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.
| ||||||
| protected void | processEvent(AWTEvent e) Details
Processes events on this text component. If the event is a
TextEvent, it invokes the processTextEvent
method else it invokes its superclass's processEvent.
Note that if the event parameter is
| ||||||
| protected void | processTextEvent(TextEvent e) Details
Processes text events occurring on this text component by
dispatching them to any registered TextListener objects.
NOTE: This method will not be called unless text events are enabled for this component. This happens when one of the following occurs:
Note that if the event parameter is
| ||||||
| public void | removeNotify() Removes the TextComponent's peer.
The peer allows us to modify the appearance of the
TextComponent without changing its
functionality.
| ||||||
| public void | removeTextListener(TextListener l) Details
Removes the specified text event listener so that it no longer
receives text events from this text component
If l is null, no exception is
thrown and no action is performed.
Refer to AWT Threading Issues for details on AWT's threading model.
| ||||||
| public void | select(int selectionStart, int selectionEnd) Details
Selects the text between the specified start and end positions.
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. The
character positions are indexed starting with zero.
The length of the selection is
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.
| ||||||
| public void | selectAll() Details
Selects all the text in this text component.
| ||||||
| Properties | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| public AccessibleContext | getAccessibleContext() Details
Gets the AccessibleContext associated with this TextComponent.
For text components, the AccessibleContext takes the form of an
AccessibleAWTTextComponent.
A new AccessibleAWTTextComponent instance is created if necessary.
| ||||||||||
| public void | setBackground(Color c) Details
Sets the background color of this text component.
| ||||||||||
| public Color | getBackground() Details
Gets the background color of this text component.
By default, non-editable text components have a background color
of SystemColor.control. This default can be overridden by
calling setBackground.
| ||||||||||
| public void | setCaretPosition(int position) Details
Sets the position of the text insertion caret.
The caret position is constrained to be between 0
and the last character of the text, inclusive.
If the passed-in value is greater than this range,
the value is set to the last character (or 0 if
the TextComponent contains no text)
and no error is returned. If the passed-in value is
less than 0, an IllegalArgumentException
is thrown.
| ||||||||||
| public int | getCaretPosition() Details
Returns the position of the text insertion caret.
The caret position is constrained to be between 0
and the last character of the text, inclusive.
If the text or caret have not been set, the default
caret position is 0.
| ||||||||||
| public void | setEditable(boolean b) Details
Sets the flag that determines whether or not this
text component is editable.
If the flag is set to
| ||||||||||
| public boolean | isEditable() Details
Indicates whether or not this text component is editable.
| ||||||||||
| public InputMethodRequests | getInputMethodRequests() | ||||||||||
| public EventListener[]<T> | getListeners(Class listenerType) Details
Returns an array of all the objects currently registered
as FooListeners
upon this TextComponent.
FooListeners are registered using the
addFooListener method.
You can specify the TextListener[] tls = (TextListener[])(t.getListeners(TextListener.class));If no such listeners exist, this method returns an empty array.
| ||||||||||
| public String | getSelectedText() Details
Returns the selected text from the text that is
presented by this text component.
| ||||||||||
| public void | setSelectionEnd(int selectionEnd) Details
Sets the selection end for this text component to
the specified position. The new end point is constrained
to be at or after the current selection start. It also
cannot be set beyond the end of the component's text.
If the caller supplies a value for selectionEnd
that is out of bounds, the method enforces these constraints
silently, and without failure.
| ||||||||||
| public int | getSelectionEnd() Details
Gets the end position of the selected text in
this text component.
| ||||||||||
| public void | setSelectionStart(int selectionStart) Details
Sets the selection start for this text component to
the specified position. The new start point is constrained
to be at or before the current selection end. It also
cannot be set to less than zero, the beginning of the
component's text.
If the caller supplies a value for selectionStart
that is out of bounds, the method enforces these constraints
silently, and without failure.
| ||||||||||
| public int | getSelectionStart() Details
Gets the start position of the selected text in
this text component.
| ||||||||||
| public void | setText(String t) Details
Sets the text that is presented by this
text component to be the specified text.
| ||||||||||
| public String | getText() Details
Returns the text that is presented by this text component.
By default, this is an empty string.
| ||||||||||
| public TextListener[] | getTextListeners() Details
Returns an array of all the text listeners
registered on this text component.
| ||||||||||
| About DocWeb · Bundles · Export · Export All | Top 10 · Statistics · Login |
| About Sun · Contact · Privacy · Terms of Use · Trademarks | Java SE 6 · Copyright © 1994-2013 Sun Microsystems, Inc.All rights reserved. Use is subject to license terms |
![]() |
![]() |
|