|
JavaTM 2 Platform Std. Ed. v1.3 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--java.awt.Component | +--java.awt.TextComponent
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.
Inner Class Summary | |
protected class |
TextComponent.AccessibleAWTTextComponent
This class implements accessibility support for the TextComponent class. |
Inner classes inherited from class java.awt.Component |
Component.AccessibleAWTComponent |
Field Summary | |
protected TextListener |
textListener
|
Fields inherited from class java.awt.Component |
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT |
Fields inherited from interface java.awt.image.ImageObserver |
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH |
Method Summary | |
void |
addTextListener(TextListener l)
Adds the specified text event listener to receive text events from this text component. |
AccessibleContext |
getAccessibleContext()
Gets the AccessibleContext associated with this TextComponent. |
Color |
getBackground()
Gets the background color of this text component. |
int |
getCaretPosition()
Gets the position of the text insertion caret for this text component. |
EventListener[] |
getListeners(Class listenerType)
Return an array of all the listeners that were added to the TextComponent with addXXXListener(), where XXX is the name of the listenerType
argument. |
String |
getSelectedText()
Gets the selected text from the text that is presented by this text component. |
int |
getSelectionEnd()
Gets the end position of the selected text in this text component. |
int |
getSelectionStart()
Gets the start position of the selected text in this text component. |
String |
getText()
Gets the text that is presented by this text component. |
boolean |
isEditable()
Indicates whether or not this text component is editable. |
protected String |
paramString()
Returns the parameter string representing the state of this text component. |
protected void |
processEvent(AWTEvent e)
Processes events on this text component. |
protected void |
processTextEvent(TextEvent e)
Processes text events occurring on this text component by dispatching them to any registered TextListener objects. |
void |
removeNotify()
Removes the TextComponent's peer. |
void |
removeTextListener(TextListener l)
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 |
selectAll()
Selects all the text in this text component. |
void |
setBackground(Color c)
Sets the background color of this text component. |
void |
setCaretPosition(int position)
Sets the position of the text insertion caret for this text component. |
void |
setEditable(boolean b)
Sets the flag that determines whether or not this text component is editable. |
void |
setSelectionEnd(int selectionEnd)
Sets the selection end for this text component to the specified position. |
void |
setSelectionStart(int selectionStart)
Sets the selection start for this text component to the specified position. |
void |
setText(String t)
Sets the text that is presented by this text component to be the specified text. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
protected transient TextListener textListener
Method Detail |
public void removeNotify()
removeNotify
in class Component
java.awt.Component
Component.isDisplayable()
,
Component.addNotify()
public void setText(String t)
t
- the new text.
If this parameter is null
then
the text is set to the empty string "".getText()
public String getText()
setText(java.lang.String)
public String getSelectedText()
select(int, int)
public boolean isEditable()
true
if this text component is
editable; false
otherwise.setEditable(boolean)
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.
b
- a flag indicating whether this text component
is user editable.isEditable()
public Color getBackground()
getBackground
in class Component
setBackground
public void setBackground(Color c)
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.getBackground()
public int getSelectionStart()
setSelectionStart(int)
,
getSelectionEnd()
public void setSelectionStart(int selectionStart)
selectionStart
that is out of bounds, the method enforces these constraints
silently, and without failure.selectionStart
- the start position of the
selected text.getSelectionStart()
,
setSelectionEnd(int)
public int getSelectionEnd()
setSelectionEnd(int)
,
getSelectionStart()
public void setSelectionEnd(int selectionEnd)
selectionEnd
that is out of bounds, the method enforces these constraints
silently, and without failure.selectionEnd
- the end position of the
selected text.getSelectionEnd()
,
setSelectionStart(int)
public 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. 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 to be selected.selectionEnd
- the zero-based end position of the
text to be selected. The character at
selectionEnd is not selected.setSelectionStart(int)
,
setSelectionEnd(int)
,
selectAll()
public void selectAll()
select(int, int)
public void setCaretPosition(int position)
position
that is
greater than the end of the component's text,
the caret position is set to the end
of the component's text.
This happens silently and without failure.
The caret position also cannot be set to less than zero,
the beginning of the component's text. If the caller supplies
a value for position
that is less than zero,
an IllegalArgumentException is thrown.position
- the position of the text insertion caret.IllegalArgumentException
- if the value supplied
for position
is less than zero.public int getCaretPosition()
public void addTextListener(TextListener l)
l
- the text event listenerpublic void removeTextListener(TextListener l)
l
- the text listener.TextListener
,
addTextListener(java.awt.event.TextListener)
public EventListener[] getListeners(Class listenerType)
listenerType
argument. For example, to get all of the TextListeners for the
given TextComponent t
, one would write:
TextListener[] tls = (TextListener[])(t.getListeners(TextListener.class))If no such listener list exists, then an empty array is returned.
getListeners
in class Component
listenerType
- Type of listeners requestedprotected void processEvent(AWTEvent e)
processEvent
in class Component
e
- the eventprotected void processTextEvent(TextEvent e)
e
- the text eventComponent.enableEvents(long)
protected String paramString()
paramString
in class Component
public AccessibleContext getAccessibleContext()
getAccessibleContext
in interface Accessible
getAccessibleContext
in class Component
|
JavaTM 2 Platform Std. Ed. v1.3 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Java, Java 2D, and JDBC are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-2000 Sun Microsystems, Inc. 901 San Antonio Road
Palo Alto, California, 94303, U.S.A. All Rights Reserved.