| java.lang.Object
 java.awt.Component
java.awt.TextComponent
All known Subclasses: java.awt.TextField, java.awt.TextArea,
| TextComponent | | public class TextComponent extends Component (Code) | | 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.
version:
1.43, 08/19/02
author:
Sami Shaio
author:
Arthur van Hoff
since:
JDK1.0 |
| Constructor Summary | |
| | TextComponent(String text)
Constructs a new text component initialized with the
specified text. |
| Method Summary | |
| public void | addNotify()
Makes this Component displayable by connecting it to a
native screen resource. | | public synchronized void | addTextListener(TextListener l)
Adds the specified text event listener to recieve text events
from this textcomponent. | | boolean | areInputMethodsEnabled()
| | public void | enableInputMethods(boolean enable)
| | boolean | eventEnabled(AWTEvent e)
| | public Color | getBackground()
Gets the background color of this text component.
By default, non-editable text components have a background color
of SystemColor.control. | | public synchronized int | getCaretPosition()
Gets the position of the text insertion caret for
this text component. | | public synchronized String | getSelectedText()
Gets the selected text from the text that is
presented by this text component. | | public synchronized int | getSelectionEnd()
Gets the end position of the selected text in
this text component. | | public synchronized int | getSelectionStart()
Gets the start position of the selected text in
this text component. | | public synchronized String | getText()
Gets the text that is presented by this text component. | | public synchronized TextListener[] | getTextListeners()
Returns an array of all the text listeners
registered on this text component. | | public 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 textcomponent. | | protected void | processTextEvent(TextEvent e)
Processes text events occurring on this text component by
dispatching them to any registered TextListener objects. | | public void | removeNotify()
Removes the TextComponent's peer. | | public synchronized void | removeTextListener(TextListener l)
| | public synchronized 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 end
position must be greater than or equal to the start position.
The start position must be greater than zero, and the
end position must be less that or equal to the length
of the text component's text. | | public synchronized void | selectAll()
Selects all the text in this text component. | | public void | setBackground(Color c)
Sets the background color of this text component. | | public synchronized void | setCaretPosition(int position)
Sets the position of the text insertion caret for
this text component. | | public synchronized void | setEditable(boolean b)
Sets the flag that determines whether or not this
text component is editable.
If the flag is set to true, this text component
becomes user editable. | | public synchronized void | setSelectionEnd(int selectionEnd)
Sets the selection end for this text component to
the specified position. | | public synchronized void | setSelectionStart(int selectionStart)
Sets the selection start for this text component to
the specified position. | | public synchronized void | setText(String t)
Sets the text that is presented by this
text component to be the specified text. |
| backgroundSetByClientCode | | boolean backgroundSetByClientCode(Code) | | |
| editable | | boolean editable(Code) | | A boolean indicating whether or not this TextComponent is editable.
|
| selectionEnd | | int selectionEnd(Code) | | The selection end.
|
| selectionStart | | int selectionStart(Code) | | The selection start.
|
| TextComponent | | TextComponent(String text)(Code) | | Constructs a new text component initialized with the
specified text. Sets the value of the cursor to
Cursor.TEXT_CURSOR.
The insertion caret is initially placed before the first
character and the text is left justified.
Parameters:
text - the initial text that the component presents.
See Also: java.awt.Cursor
since:
JDK1.0 |
| addNotify | | public void addNotify()(Code) | | 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.
See Also: java.awt.TextComponent.removeNotify |
| addTextListener | | public synchronized void addTextListener(TextListener l)(Code) | | Adds the specified text event listener to recieve text events
from this textcomponent.
Parameters:
l - the text event listener |
| areInputMethodsEnabled | | boolean areInputMethodsEnabled()(Code) | | |
| enableInputMethods | | public void enableInputMethods(boolean enable)(Code) | | |
| getBackground | | public Color getBackground()(Code) | | 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.
This text component's background color.If this text component does not have a background color,the background color of its parent is returned.
See Also: setBackground
since:
JDK1.0 |
| getCaretPosition | | public synchronized int getCaretPosition()(Code) | | Gets the position of the text insertion caret for
this text component.
the position of the text insertion caret.
since:
JDK1.1 |
| getSelectedText | | public synchronized String getSelectedText()(Code) | | Gets the selected text from the text that is
presented by this text component.
the selected text of this text component.
See Also: java.awt.TextComponent.select
since:
JDK1.0 |
| isEditable | | public boolean isEditable()(Code) | | Indicates whether or not this text component is editable.
true if this text component iseditable; false otherwise.
See Also: java.awt.TextComponent.setEditable
since:
JDK1ble |
| paramString | | protected String paramString()(Code) | | Returns the parameter string representing the state of this text
component. This string is useful for debugging.
the parameter string of this text component.
since:
JDK1.0 |
| processEvent | | protected void processEvent(AWTEvent e)(Code) | | 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 |
| processTextEvent | | protected void processTextEvent(TextEvent e)(Code) | | 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()
See Also: Component.enableEvents
Parameters:
e - the text event |
| removeNotify | | public void removeNotify()(Code) | | Removes the TextComponent's peer. The peer allows us to modify
the appearance of the TextComponent without changing its
functionality.
|
| removeTextListener | | public synchronized void removeTextListener(TextListener l)(Code) | | Removes the specified text event listener so that it no longer
receives text events from this textcomponent
|
| select | | public synchronized void select(int selectionStart, int selectionEnd)(Code) | | 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 end
position must be greater than or equal to the start position.
The start position must be greater than zero, and the
end position must be less that 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.
Parameters:
selectionStart - the start position of thetext to select.
Parameters:
selectionEnd - the end position of thetext to select.
See Also: java.awt.TextComponent.setSelectionStart
See Also: java.awt.TextComponent.setSelectionEnd
See Also: java.awt.TextComponent.selectAll
since:
JDK1.0 |
| setBackground | | public void setBackground(Color c)(Code) | | Sets the background color of this text component.
Parameters:
c - The color to become this text component's color.If this parameter is null then this text componentwill inherit the background color of its parent.
See Also: TextComponent.getBackground
since:
JDK1.0 |
| setCaretPosition | | public synchronized void setCaretPosition(int position)(Code) | | Sets the position of the text insertion caret for
this text component.
Parameters:
position - the position of the text insertion caret.
exception:
IllegalArgumentException - if the value suppliedfor position is less than zero.
since:
JDK1.1 |
| setEditable | | public synchronized void setEditable(boolean b)(Code) | | Sets the flag that determines whether or not this
text component is editable.
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.
Parameters:
t - a flag indicating whether this text componentshould be user editable.
See Also: java.awt.TextComponent.isEditable
since:
JDK1.0 |
| setSelectionEnd | | public synchronized void setSelectionEnd(int selectionEnd)(Code) | | 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.
Parameters:
selectionEnd - the end position of theselected text.
See Also: java.awt.TextComponent.getSelectionEnd
See Also: java.awt.TextComponent.setSelectionStart
since:
JDK1.1 |
| setSelectionStart | | public synchronized void setSelectionStart(int selectionStart)(Code) | | 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.
Parameters:
selectionStart - the start position of theselected text.
See Also: java.awt.TextComponent.getSelectionStart
See Also: java.awt.TextComponent.setSelectionEnd
since:
JDK1.1 |
| setText | | public synchronized void setText(String t)(Code) | | Sets the text that is presented by this
text component to be the specified text.
Parameters:
t - the new text.
See Also: java.awt.TextComponent.getText
since:
JDK1.0 |
| Methods inherited from java.awt.Component | public boolean action(Event evt, Object what)(Code)(Java Doc)
public synchronized void add(PopupMenu popup)(Code)(Java Doc)
public synchronized void addComponentListener(ComponentListener l)(Code)(Java Doc)
public synchronized void addFocusListener(FocusListener l)(Code)(Java Doc)
public synchronized void addKeyListener(KeyListener l)(Code)(Java Doc)
public synchronized void addMouseListener(MouseListener l)(Code)(Java Doc)
public synchronized void addMouseMotionListener(MouseMotionListener l)(Code)(Java Doc)
public void addNotify()(Code)(Java Doc)
boolean areInputMethodsEnabled()(Code)(Java Doc)
public Rectangle bounds()(Code)(Java Doc)
final void checkEnableNewEventsOnly(Object listener)(Code)(Java Doc)
public int checkImage(Image image, ImageObserver observer)(Code)(Java Doc)
public int checkImage(Image image, int width, int height, ImageObserver observer)(Code)(Java Doc)
protected AWTEvent coalesceEvents(AWTEvent existingEvent, AWTEvent newEvent)(Code)(Java Doc)
String constructComponentName()(Code)(Java Doc)
public boolean contains(int x, int y)(Code)(Java Doc)
public boolean contains(Point p)(Code)(Java Doc)
public Image createImage(ImageProducer producer)(Code)(Java Doc)
public Image createImage(int width, int height)(Code)(Java Doc)
ComponentXWindow createXWindow()(Code)(Java Doc)
public void deliverEvent(Event e)(Code)(Java Doc)
public void disable()(Code)(Java Doc)
final protected void disableEvents(long eventsToDisable)(Code)(Java Doc)
final public void dispatchEvent(AWTEvent e)(Code)(Java Doc)
void dispatchEventImpl(AWTEvent e)(Code)(Java Doc)
public void doLayout()(Code)(Java Doc)
public void enable()(Code)(Java Doc)
public void enable(boolean b)(Code)(Java Doc)
final protected synchronized void enableEvents(long eventsToEnable)(Code)(Java Doc)
boolean eventEnabled(AWTEvent e)(Code)(Java Doc)
Component findFocusDelegate(Container container)(Code)(Java Doc)
public float getAlignmentX()(Code)(Java Doc)
public float getAlignmentY()(Code)(Java Doc)
public Color getBackground()(Code)(Java Doc)
public Rectangle getBounds()(Code)(Java Doc)
public ColorModel getColorModel()(Code)(Java Doc)
public Component getComponentAt(int x, int y)(Code)(Java Doc)
public Component getComponentAt(Point p)(Code)(Java Doc)
public Cursor getCursor()(Code)(Java Doc)
Component getFocusDelegate()(Code)(Java Doc)
public Font getFont()(Code)(Java Doc)
Component getFontAndColorDelegate()(Code)(Java Doc)
public FontMetrics getFontMetrics(Font font)(Code)(Java Doc)
public Color getForeground()(Code)(Java Doc)
public Graphics getGraphics()(Code)(Java Doc)
InputContext getInputContext()(Code)(Java Doc)
public Locale getLocale()(Code)(Java Doc)
public Point getLocation()(Code)(Java Doc)
public Point getLocationOnScreen()(Code)(Java Doc)
public Dimension getMaximumSize()(Code)(Java Doc)
public Dimension getMinimumSize()(Code)(Java Doc)
public String getName()(Code)(Java Doc)
Container getNativeContainer()(Code)(Java Doc)
public Container getParent()(Code)(Java Doc)
public Dimension getPreferredSize()(Code)(Java Doc)
public Dimension getSize()(Code)(Java Doc)
public Toolkit getToolkit()(Code)(Java Doc)
final public Object getTreeLock()(Code)(Java Doc)
public boolean gotFocus(Event evt, Object what)(Code)(Java Doc)
public boolean handleEvent(Event evt)(Code)(Java Doc)
public void hide()(Code)(Java Doc)
public boolean imageUpdate(Image img, int flags, int x, int y, int w, int h)(Code)(Java Doc)
public boolean inside(int x, int y)(Code)(Java Doc)
public void invalidate()(Code)(Java Doc)
static void invokeAndWait(Runnable runnable)(Code)(Java Doc)
public boolean isDisplayable()(Code)(Java Doc)
public boolean isEnabled()(Code)(Java Doc)
public boolean isFocusTraversable()(Code)(Java Doc)
public boolean isLightweight()(Code)(Java Doc)
boolean isLightweightWhenDisplayable()(Code)(Java Doc)
public boolean isOpaque()(Code)(Java Doc)
public boolean isShowing()(Code)(Java Doc)
public boolean isValid()(Code)(Java Doc)
public boolean isVisible()(Code)(Java Doc)
public boolean keyDown(Event evt, int key)(Code)(Java Doc)
public boolean keyUp(Event evt, int key)(Code)(Java Doc)
public void layout()(Code)(Java Doc)
void lightweightPrint(Graphics g)(Code)(Java Doc)
public void list()(Code)(Java Doc)
public void list(PrintStream out)(Code)(Java Doc)
public void list(PrintStream out, int indent)(Code)(Java Doc)
public void list(PrintWriter out)(Code)(Java Doc)
public void list(PrintWriter out, int indent)(Code)(Java Doc)
public Component locate(int x, int y)(Code)(Java Doc)
public Point location()(Code)(Java Doc)
public boolean lostFocus(Event evt, Object what)(Code)(Java Doc)
public Dimension minimumSize()(Code)(Java Doc)
public boolean mouseDown(Event evt, int x, int y)(Code)(Java Doc)
public boolean mouseDrag(Event evt, int x, int y)(Code)(Java Doc)
public boolean mouseEnter(Event evt, int x, int y)(Code)(Java Doc)
public boolean mouseExit(Event evt, int x, int y)(Code)(Java Doc)
public boolean mouseMove(Event evt, int x, int y)(Code)(Java Doc)
public boolean mouseUp(Event evt, int x, int y)(Code)(Java Doc)
public void move(int x, int y)(Code)(Java Doc)
public void nextFocus()(Code)(Java Doc)
public void paint(Graphics g)(Code)(Java Doc)
public void paintAll(Graphics g)(Code)(Java Doc)
protected String paramString()(Code)(Java Doc)
public boolean postEvent(Event e)(Code)(Java Doc)
public Dimension preferredSize()(Code)(Java Doc)
public boolean prepareImage(Image image, ImageObserver observer)(Code)(Java Doc)
public boolean prepareImage(Image image, int width, int height, ImageObserver observer)(Code)(Java Doc)
public void print(Graphics g)(Code)(Java Doc)
public void printAll(Graphics g)(Code)(Java Doc)
protected void processComponentEvent(ComponentEvent e)(Code)(Java Doc)
protected void processEvent(AWTEvent e)(Code)(Java Doc)
protected void processFocusEvent(FocusEvent e)(Code)(Java Doc)
protected void processKeyEvent(KeyEvent e)(Code)(Java Doc)
protected void processMouseEvent(MouseEvent e)(Code)(Java Doc)
protected void processMouseMotionEvent(MouseEvent e)(Code)(Java Doc)
public synchronized void remove(MenuComponent popup)(Code)(Java Doc)
public synchronized void removeComponentListener(ComponentListener l)(Code)(Java Doc)
public synchronized void removeFocusListener(FocusListener l)(Code)(Java Doc)
public synchronized void removeKeyListener(KeyListener l)(Code)(Java Doc)
public synchronized void removeMouseListener(MouseListener l)(Code)(Java Doc)
public synchronized void removeMouseMotionListener(MouseMotionListener l)(Code)(Java Doc)
public void removeNotify()(Code)(Java Doc)
public void repaint()(Code)(Java Doc)
public void repaint(long tm)(Code)(Java Doc)
public void repaint(int x, int y, int width, int height)(Code)(Java Doc)
public void repaint(long tm, int x, int y, int width, int height)(Code)(Java Doc)
public void requestFocus()(Code)(Java Doc)
public void reshape(int x, int y, int width, int height)(Code)(Java Doc)
public void resize(int width, int height)(Code)(Java Doc)
public void resize(Dimension d)(Code)(Java Doc)
public void setBackground(Color c)(Code)(Java Doc)
public void setBounds(int x, int y, int width, int height)(Code)(Java Doc)
public void setBounds(Rectangle r)(Code)(Java Doc)
public synchronized void setCursor(Cursor cursor)(Code)(Java Doc)
public void setEnabled(boolean b)(Code)(Java Doc)
public void setFont(Font f)(Code)(Java Doc)
public void setForeground(Color c)(Code)(Java Doc)
public void setLocale(Locale l)(Code)(Java Doc)
public void setLocation(int x, int y)(Code)(Java Doc)
public void setLocation(Point p)(Code)(Java Doc)
public void setName(String name)(Code)(Java Doc)
public void setSize(int width, int height)(Code)(Java Doc)
public void setSize(Dimension d)(Code)(Java Doc)
public void setVisible(boolean b)(Code)(Java Doc)
public void show()(Code)(Java Doc)
public void show(boolean b)(Code)(Java Doc)
public Dimension size()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
public void transferFocus()(Code)(Java Doc)
public void update(Graphics g)(Code)(Java Doc)
public void validate()(Code)(Java Doc)
|
|
|