ImageObserver, MenuContainer, Serializable, Accessible
TextArea, TextField
The
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.
Nested Classes
protected class
This class implements accessibility support for the TextComponent class.
Fields
A list of listeners that will receive events from this object.
void
Makes this Component displayable by connecting it to a native screen resource.
void
Adds the specified text event listener to receive text events from this text component.
void
Enables or disables input method support for this text component.
Gets the AccessibleContext associated with this TextComponent.
Gets the background color of this text component.
int
Returns the position of the text insertion caret.
Returns an array of all the objects currently registered as FooListeners upon this TextComponent.
Returns the selected text from the text that is presented by this text component.
int
Gets the end position of the selected text in this text component.
int
Gets the start position of the selected text in this text component.
Returns the text that is presented by this text component.
Returns an array of all the text listeners registered on this text component.
boolean
Indicates whether or not this text component is editable.
Returns a string representing the state of this TextComponent.
protected void
Processes events on this text component.
protected void
Processes text events occurring on this text component by dispatching them to any registered TextListener objects.
void
Removes the TextComponent's peer.
void
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.
void
select(int selectionStart, int selectionEnd)
Selects the text between the specified start and end positions.
void
Selects all the text in this text component.
void
Sets the background color of this text component.
void
Sets the position of the text insertion caret.
void
Sets the flag that determines whether or not this text component is editable.
void
Sets the selection end for this text component to the specified position.
void
Sets the selection start for this text component to the specified position.
void
Sets the text that is presented by this text component to be the specified text.
Methods declared in class java.awt.Componentaction, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAlignmentX, getAlignmentY, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusCycleRoot, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paint, paintAll, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, revalidate, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setMixingCutoutShape, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle, update, validateA list of listeners that will receive events from this object.
public void enableInputMethods(boolean enable)
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.
enableInputMethods in class Component
enable - true to enable, false to disable
public void addNotify()
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 removeNotify()
Removes the TextComponent's peer. The peer allows us to modify the appearance of the TextComponent without changing its functionality.
removeNotify in class Component
Sets the text that is presented by this text component to be the specified text.
t - the new text; if this parameter is null then the text is set to the empty string ""
Returns the text that is presented by this text component. By default, this is an empty string.
TextComponent
()
Returns the selected text from the text that is presented by this text component.
public boolean isEditable()
Indicates whether or not this text component is editable.
true if this text component is editable; false otherwise.
public void setEditable(boolean b)
If the flag is set to true, this text component becomes user editable. If the flag is set to false, the user cannot change the text 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.
b - a flag indicating whether this text component is user editable.
()
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.
getBackground in class Component
Sets the background color of this text component.
setBackground in class Component
c - The color to become this text component's color. If this parameter is null then this text component will inherit the background color of its parent.
public int getSelectionStart()
Gets the start position of the selected text in this text component.
public void setSelectionStart(int selectionStart)
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.
selectionStart - the start position of the selected text
public int getSelectionEnd()
Gets the end position of the selected text in this text component.
public void setSelectionEnd(int selectionEnd)
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.
selectionEnd - the end position of the selected text
public void select(int selectionStart, int selectionEnd)
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 endPosition - startPosition, so the character at endPosition is not selected. If the start and end positions of the selected text are equal, all text is deselected.
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.
selectionStart - the zero-based index of the first character (char value) to be selected
selectionEnd - the zero-based end position of the text to be selected; the character (char value) at selectionEnd is not selected
public void selectAll()
Selects all the text in this text component.
public void setCaretPosition(int position)
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.
position - the position of the text insertion caret
IllegalArgumentException - if position is less than zero
public int getCaretPosition()
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.
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.
l - the text event listener
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.
l - the text listener
Returns an array of all the text listeners registered on this text component.
TextListeners or an empty array if no text listeners are currently registered
Returns an array of all the objects currently registered as
FooListener
s upon this
TextComponent
.
FooListener
s are registered using the
addFooListener
method.
You can specify the listenerType argument with a class literal, such as FooListener.class. For example, you can query a TextComponent t for its text listeners with the following code:
TextListener[] tls = (TextListener[])(t.getListeners(TextListener.class));
If no such listeners exist, this method returns an empty array.
getListeners in class Component
T - the type of the listeners
listenerType - the type of listeners requested; this parameter should specify an interface that descends from java.util.EventListener
FooListeners on this text component, or an empty array if no such listeners have been added
ClassCastException - if listenerType doesn't specify a class or interface that implements java.util.EventListener
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 null the behavior is unspecified and may result in an exception.
processEvent in class Component
e - the event
Component.processComponentEvent(java.awt.event.ComponentEvent)Component.processFocusEvent(java.awt.event.FocusEvent)Component.processKeyEvent(java.awt.event.KeyEvent)Component.processMouseEvent(java.awt.event.MouseEvent)Component.processMouseMotionEvent(java.awt.event.MouseEvent)Component.processInputMethodEvent(java.awt.event.InputMethodEvent)Component.processHierarchyEvent(java.awt.event.HierarchyEvent)Component.processMouseWheelEvent(java.awt.event.MouseWheelEvent)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:
TextListener object is registered via addTextListenerenableEventsNote that if the event parameter is null the behavior is unspecified and may result in an exception.
e - the text event
()
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.
paramString in class Component
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.
getAccessibleContext in interface Accessible
getAccessibleContext in class Component
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4