java.awt

Class TextArea

public class TextArea extends TextComponent implements Serializable

A TextArea is a text component capable of displaying multiple lines of user-editable text. A TextArea handles its own scrolling and can display vertical and horizontal scrollbars as navigation aids.

Nested Class Summary
protected class	TextArea.AccessibleAWTTextArea

Field Summary
static int	SCROLLBARS_BOTH Display both horiztonal and vertical scroll bars.
static int	SCROLLBARS_HORIZONTAL_ONLY Display horizatonal scroll bar only.
static int	SCROLLBARS_NONE Do not display scrollbars.
static int	SCROLLBARS_VERTICAL_ONLY Display vertical scroll bar only.

Constructor Summary
	TextArea() Initialize a new instance of `TextArea` that is empty.
	TextArea(String text) Initialize a new instance of `TextArea` that contains the specified text.
	TextArea(int rows, int columns) Initialize a new instance of `TextArea` that is empty and can display the specified number of rows and columns of text, without the need to scroll.
	TextArea(String text, int rows, int columns) Initialize a new instance of `TextArea` that can display the specified number of rows and columns of text, without the need to scroll.
	TextArea(String text, int rows, int columns, int scrollbarVisibility) Initialize a new instance of `TextArea` that initially contains the specified text.

Method Summary
void	addNotify() Notify this object that it should create its native peer.
void	append(String str) Append the specified text to the end of the current text.
void	appendText(String str) Append the specified text to the end of the current text.
AccessibleContext	getAccessibleContext() Gets the AccessibleContext associated with this `TextArea`.
int	getColumns() Retrieve the number of columns that this text area would prefer to display.
Dimension	getMinimumSize() Retrieve the minimum size for this text area.
Dimension	getMinimumSize(int rows, int columns) Retrieve the minimum size for this text area.
Dimension	getPreferredSize() Retrieve the preferred size for this text area.
Dimension	getPreferredSize(int rows, int columns) Retrieve the preferred size for this text area.
int	getRows() Retrieve the number of rows that this text area would prefer to display.
int	getScrollbarVisibility() Retrieve the scroll bar display policy -- one of SCROLLBARS_BOTH, SCROLLBARS_VERTICAL_ONLY, SCROLLBARS_HORIZONTAL_ONLY, SCROLLBARS_NONE.
void	insert(String str, int pos) Insert the specified text at the specified position.
void	insertText(String str, int pos) Insert the specified text at the specified position.
Dimension	minimumSize() Retrieve the minimum size for this text area.
Dimension	minimumSize(int rows, int columns) Retrieve the minimum size for this text area.
protected String	paramString() Retrieve a debugging string for this text area.
Dimension	preferredSize() Retrieve the preferred size for this text area.
Dimension	preferredSize(int rows, int columns) Retrieve the preferred size for this text area.
void	replaceRange(String str, int start, int end) Replace a range of characters with the specified text.
void	replaceText(String str, int start, int end) Replace a range of characters with the specified text.
void	setColumns(int columns) Set the preferred number of columns for this text area.
void	setRows(int rows) Set the preferred number of rows for this text area.

Field Detail

SCROLLBARS_BOTH

public static final int SCROLLBARS_BOTH

Display both horiztonal and vertical scroll bars.

SCROLLBARS_HORIZONTAL_ONLY

public static final int SCROLLBARS_HORIZONTAL_ONLY

Display horizatonal scroll bar only.

SCROLLBARS_NONE

public static final int SCROLLBARS_NONE

Do not display scrollbars.

SCROLLBARS_VERTICAL_ONLY

public static final int SCROLLBARS_VERTICAL_ONLY

Display vertical scroll bar only.

Initialize a new instance of TextArea that is empty. Conceptually the TextArea has 0 rows and 0 columns but its initial bounds are defined by its peer or by the container in which it is packed. Both horizontal and vertical scrollbars will be displayed.

Throws: HeadlessException if GraphicsEnvironment.isHeadless () is true

TextArea

public TextArea(String text)

Initialize a new instance of TextArea that contains the specified text. Conceptually the TextArea has 0 rows and 0 columns but its initial bounds are defined by its peer or by the container in which it is packed. Both horizontal and veritcal scrollbars will be displayed. The TextArea initially contains the specified text. If text specified as

null, it will
 be set to "".
Parameters: text The text to display in this text area (null permitted).
 
Throws: HeadlessException if GraphicsEnvironment.isHeadless () is true




   TextArea
   public  TextArea(int rows, int columns)
   
 Initialize a new instance of TextArea that is empty
 and can display the specified number of rows and columns of text,
 without the need to scroll.  Both horizontal and vertical
 scrollbars will be displayed.
Parameters: rows The number of rows in this text area. columns The number of columns in this text area.
 
Throws: HeadlessException if GraphicsEnvironment.isHeadless () is true 



   TextArea
   public  TextArea(String text, int rows, int columns)
   
 Initialize a new instance of TextArea that can
 display the specified number of rows and columns of text, without
 the need to scroll.  The TextArea initially contains the
 specified text.  If text specified as null, it will
 be set to "".
Parameters: text The text to display in this text area (null permitted). rows The number of rows in this text area. columns The number of columns in this text area.
 
Throws: HeadlessException if GraphicsEnvironment.isHeadless () is true 



   TextArea
   public  TextArea(String text, int rows, int columns, int scrollbarVisibility)
   
 Initialize a new instance of TextArea that initially
 contains the specified text.  The TextArea can display the
 specified number of rows and columns of text, without the need to
 scroll.  This constructor allows specification of the scroll bar
 display policy.  The TextArea initially contains the specified text.  
 If text specified as null, it will be set to "". 
Parameters: text The text to display in this text area (null permitted). rows The number of rows in this text area. columns The number of columns in this text area. scrollbarVisibility The scroll bar display policy. One of
 SCROLLBARS_BOTH, SCROLLBARS_VERTICAL_ONLY,
 SCROLLBARS_HORIZONTAL_ONLY, SCROLLBARS_NONE.
 
Throws: HeadlessException if GraphicsEnvironment.isHeadless () is true 





   Method Detail

   addNotify
   public  void addNotify()
   
 Notify this object that it should create its native peer.


   append
   public  void append(String str)
   
 Append the specified text to the end of the current text.
Parameters: str The text to append. 



   appendText
   public  void appendText(String str)
   Deprecated: This method is deprecated in favor of
 append (). 

 Append the specified text to the end of the current text.
Parameters: str The text to append.
 



   getAccessibleContext
   public  AccessibleContext getAccessibleContext()
   
 Gets the AccessibleContext associated with this TextArea.
 The context is created, if necessary.
Returns: the associated context 



   getColumns
   public  int getColumns()
   
 Retrieve the number of columns that this text area would prefer
 to display.  This value may or may not correspond to the number
 of columns that are actually displayed.
Returns: The preferred number of columns. 



   getMinimumSize
   public  Dimension getMinimumSize()
   
 Retrieve the minimum size for this text area.
Returns: The minimum size for this text field. 



   getMinimumSize
   public  Dimension getMinimumSize(int rows, int columns)
   
 Retrieve the minimum size for this text area.  If the minimum
 size has been set, then rows and columns are used in the calculation.
Parameters: rows The number of rows to use in the minimum size
 calculation. columns The number of columns to use in the minimum size
 calculation.
 
Returns: The minimum size for this text area. 



   getPreferredSize
   public  Dimension getPreferredSize()
   
 Retrieve the preferred size for this text area.
Returns: The preferred size for this text field. 



   getPreferredSize
   public  Dimension getPreferredSize(int rows, int columns)
   
 Retrieve the preferred size for this text area.  If the preferred
 size has been set, then rows and columns are used in the calculation.
Parameters: rows The number of rows to use in the preferred size
 calculation. columns The number of columns to use in the preferred size
 calculation.
 
Returns: The preferred size for this text area. 



   getRows
   public  int getRows()
   
 Retrieve the number of rows that this text area would prefer to
 display.  This value may or may not correspond to the number of
 rows that are actually displayed.
Returns: The preferred number of rows. 



   getScrollbarVisibility
   public  int getScrollbarVisibility()
   
 Retrieve the scroll bar display policy -- one of SCROLLBARS_BOTH,
 SCROLLBARS_VERTICAL_ONLY, SCROLLBARS_HORIZONTAL_ONLY,
 SCROLLBARS_NONE.
Returns: The current scroll bar display policy. 



   insert
   public  void insert(String str, int pos)
   
 Insert the specified text at the specified position.  The first
 character in the text area is at position zero.
Parameters: str The text to insert. pos The position at which to insert text. 



   insertText
   public  void insertText(String str, int pos)
   Deprecated: This method is deprecated in favor of
 insert (). 

 Insert the specified text at the specified position.  The first
 character in the text area is at position zero.
Parameters: str The text to insert. pos The position at which to insert text.
 



   minimumSize
   public  Dimension minimumSize()
   Deprecated: This method is deprecated in favor of
 getMinimumSize (). 

 Retrieve the minimum size for this text area.
Returns: The minimum size for this text area.
 



   minimumSize
   public  Dimension minimumSize(int rows, int columns)
   Deprecated: This method is deprecated in favor of
 getMinimumSize (int, int). 

 Retrieve the minimum size for this text area.  If the minimum
 size has been set, then rows and columns are used in the calculation.
Parameters: rows The number of rows to use in the minimum size
 calculation. columns The number of columns to use in the minimum size
 calculation.
 
Returns: The minimum size for this text area.
 



   paramString
   protected  String paramString()
   
 Retrieve a debugging string for this text area.
Returns: A debugging string for this text area. 



   preferredSize
   public  Dimension preferredSize()
   Deprecated: This method is deprecated in favor of
 getPreferredSize (). 

 Retrieve the preferred size for this text area.
Returns: The preferred size for this text field.
 



   preferredSize
   public  Dimension preferredSize(int rows, int columns)
   Deprecated: This method is deprecated in favor of
 getPreferredSize (int, int). 

 Retrieve the preferred size for this text area.  If the preferred
 size has been set, then rows and columns are used in the calculation.
Parameters: rows The number of rows to use in the preferred size
 calculation. columns The number of columns to use in the preferred size
 calculation.
 
Returns: The preferred size for this text area.
 



   replaceRange
   public  void replaceRange(String str, int start, int end)
   
 Replace a range of characters with the specified text.  The
 character at the start position will be replaced, unless start ==
 end.  The character at the end posistion will not be replaced.
 The first character in the text area is at position zero.  The
 length of the replacement text may differ from the length of the
 text that is replaced.
Parameters: str The new text for the range. start The start position of the replacement range. end The end position of the replacement range. 



   replaceText
   public  void replaceText(String str, int start, int end)
   Deprecated: This method is deprecated in favor of
 replaceRange (). 

 Replace a range of characters with the specified text.  The
 character at the start position will be replaced, unless start ==
 end.  The character at the end posistion will not be replaced.
 The first character in the text area is at position zero.  The
 length of the replacement text may differ from the length of the
 text that is replaced.
Parameters: str The new text for the range. start The start position of the replacement range. end The end position of the replacement range.
 



   setColumns
   public  void setColumns(int columns)
   
 Set the preferred number of columns for this text area.  This
 method does not cause the number of columns displayed by the text
 area to be updated, if the text area is currently visible.
Parameters: columns The preferred number of columns.
 
Throws: IllegalArgumentException If columns is less than zero. 



   setRows
   public  void setRows(int rows)
   
 Set the preferred number of rows for this text area.  This method
 does not cause the number of columns displayed by the text area
 to be updated, if the text area is currently visible.
Parameters: rows The preferred number of rows.
 
Throws: IllegalArgumentException If rows is less than zero. 


   
   
    
      Overview
      Package
      Class
      Use
      Tree
      Deprecated
      Index
      Help
    
    
      
       Prev Class
       Next Class
      
      
       Frames
       NoFrames
      
      All Classes
   
   
      Summary:
       Nested
       Field
       Constr
       Method
      
      Detail:
       Field
       Constr
       Method
      
   
    
     GNU Classpath (0.94-pre)