All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class java.awt.TextComponent

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.TextComponent

public class TextComponent
extends Component
A TextComponent is a component that allows the editing of some text.


Variable Index

 o textListener

Method Index

 o addTextListener(TextListener)
Adds the specified text event listener to recieve text events from this textcomponent.
 o getCaretPosition()
Returns the position of the text insertion caret for the text component.
 o getSelectedText()
Returns the selected text contained in this TextComponent.
 o getSelectionEnd()
Returns the selected text's end position.
 o getSelectionStart()
Returns the selected text's start position.
 o getText()
Returns the text contained in this TextComponent.
 o isEditable()
Returns the boolean indicating whether this TextComponent is editable or not.
 o paramString()
Returns the String of parameters for this TextComponent.
 o processEvent(AWTEvent)
Processes events on this textcomponent.
 o processTextEvent(TextEvent)
Processes text events occurring on this text component by dispatching them to any registered TextListener objects.
 o removeNotify()
Removes the TextComponent's peer.
 o removeTextListener(TextListener)
Removes the specified text event listener so that it no longer receives text events from this textcomponent
 o select(int, int)
Selects the text found between the specified start and end locations.
 o selectAll()
Selects all the text in the TextComponent.
 o setCaretPosition(int)
Sets the position of the text insertion caret for the TextComponent
 o setEditable(boolean)
Sets the specified boolean to indicate whether or not this TextComponent should be editable.
 o setSelectionEnd(int)
Sets the selection end to the specified position.
 o setSelectionStart(int)
Sets the selection start to the specified position.
 o setText(String)
Sets the text of this TextComponent to the specified text.

Variables

 o textListener
 protected transient TextListener textListener

Methods

 o removeNotify
 public void removeNotify()
Removes the TextComponent's peer. The peer allows us to modify the appearance of the TextComponent without changing its functionality.

Overrides:
removeNotify in class Component
 o setText
 public synchronized 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
 o getText
 public synchronized String getText()
Returns the text contained in this TextComponent.

See Also:
setText
 o getSelectedText
 public synchronized String getSelectedText()
Returns the selected text contained in this TextComponent.

See Also:
setText
 o isEditable
 public boolean isEditable()
Returns the boolean indicating whether this TextComponent is editable or not.

See Also:
setEditable
 o 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
 o getSelectionStart
 public synchronized int getSelectionStart()
Returns the selected text's start position.

 o setSelectionStart
 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
 o getSelectionEnd
 public synchronized int getSelectionEnd()
Returns the selected text's end position.

 o setSelectionEnd
 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
 o select
 public synchronized void select(int selectionStart,
                                 int selectionEnd)
Selects the text found between the specified start and end locations.

Parameters:
selectionStart - the start position of the text
selectionEnd - the end position of the text
 o selectAll
 public synchronized void selectAll()
Selects all the text in the TextComponent.

 o setCaretPosition
 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.
 o getCaretPosition
 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.
 o addTextListener
 public synchronized void addTextListener(TextListener l)
Adds the specified text event listener to recieve text events from this textcomponent.

Parameters:
l - the text event listener
 o removeTextListener
 public void removeTextListener(TextListener l)
Removes the specified text event listener so that it no longer receives text events from this textcomponent

 o processEvent
 protected void processEvent(AWTEvent e)
Processes events on this textcomponent. If the event is a TextEvent, it invokes the processTextEvent method, else it invokes its superclass's processEvent.

Parameters:
e - the event
Overrides:
processEvent in class Component
 o processTextEvent
 protected void processTextEvent(TextEvent e)
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: a) A TextListener object is registered via addTextListener() b) Text events are enabled via enableEvents()

Parameters:
e - the text event
See Also:
enableEvents
 o paramString
 protected String paramString()
Returns the String of parameters for this TextComponent.

Overrides:
paramString in class Component

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Submit a bug or feature