diff options
author | Thomas Fitzsimmons <fitzsim@redhat.com> | 2004-01-25 18:36:04 +0000 |
---|---|---|
committer | Thomas Fitzsimmons <fitzsim@gcc.gnu.org> | 2004-01-25 18:36:04 +0000 |
commit | 062732fd2bb522673907db270c43b6b070bf1769 (patch) | |
tree | f561232c5777aa50173676d00dfa4e0155a9039c /libjava | |
parent | 0058a7d875d6eebaaab9602278d0e44254fe63c7 (diff) | |
download | gcc-062732fd2bb522673907db270c43b6b070bf1769.zip gcc-062732fd2bb522673907db270c43b6b070bf1769.tar.gz gcc-062732fd2bb522673907db270c43b6b070bf1769.tar.bz2 |
TextArea.java: Fix indentation.
2004-01-25 Thomas Fitzsimmons <fitzsim@redhat.com>
* java/awt/TextArea.java: Fix indentation. Flesh out javadocs.
(getMinimumSize (int, int)): Fix FIXME -- return Dimension (0,0)
when peer is null.
(setColumns): Remove FIXME -- peer will retrieve number of
columns by calling getColumns.
(setRows): Likewise for number of rows.
(next_text_number): New field.
(paramString): Fix param string.
(generateName): New method.
(getUniqueLong): New method.
From-SVN: r76577
Diffstat (limited to 'libjava')
-rw-r--r-- | libjava/ChangeLog | 13 | ||||
-rw-r--r-- | libjava/java/awt/TextArea.java | 1132 |
2 files changed, 591 insertions, 554 deletions
diff --git a/libjava/ChangeLog b/libjava/ChangeLog index 9739254..fc7ee9c 100644 --- a/libjava/ChangeLog +++ b/libjava/ChangeLog @@ -1,5 +1,18 @@ 2004-01-25 Thomas Fitzsimmons <fitzsim@redhat.com> + * java/awt/TextArea.java: Fix indentation. Flesh out javadocs. + (getMinimumSize (int, int)): Fix FIXME -- return Dimension (0,0) + when peer is null. + (setColumns): Remove FIXME -- peer will retrieve number of + columns by calling getColumns. + (setRows): Likewise for number of rows. + (next_text_number): New field. + (paramString): Fix param string. + (generateName): New method. + (getUniqueLong): New method. + +2004-01-25 Thomas Fitzsimmons <fitzsim@redhat.com> + * gnu/java/awt/peer/gtk/GtkToolkit.java (checkImage): Inform image observer of image loading status. (getImage (String)): Start image production. diff --git a/libjava/java/awt/TextArea.java b/libjava/java/awt/TextArea.java index f724753..356efeb 100644 --- a/libjava/java/awt/TextArea.java +++ b/libjava/java/awt/TextArea.java @@ -1,565 +1,589 @@ -/* TextArea.java -- A multi-line text entry widget - Copyright (C) 1999 Free Software Foundation, Inc. - -This file is part of GNU Classpath. - -GNU Classpath is free software; you can redistribute it and/or modify -it under the terms of the GNU General Public License as published by -the Free Software Foundation; either version 2, or (at your option) -any later version. - -GNU Classpath is distributed in the hope that it will be useful, but -WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -General Public License for more details. - -You should have received a copy of the GNU General Public License -along with GNU Classpath; see the file COPYING. If not, write to the -Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA -02111-1307 USA. - -Linking this library statically or dynamically with other modules is -making a combined work based on this library. Thus, the terms and -conditions of the GNU General Public License cover the whole -combination. - -As a special exception, the copyright holders of this library give you -permission to link this library with independent modules to produce an -executable, regardless of the license terms of these independent -modules, and to copy and distribute the resulting executable under -terms of your choice, provided that you also meet, for each linked -independent module, the terms and conditions of the license of that -module. An independent module is a module which is not derived from -or based on this library. If you modify this library, you may extend -this exception to your version of the library, but you are not -obligated to do so. If you do not wish to do so, delete this -exception statement from your version. */ - +/* TextArea.java -- A multi-line text entry component + Copyright (C) 1999, 2004 Free Software Foundation, Inc. + + This file is part of GNU Classpath. + + GNU Classpath is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2, or (at your option) + any later version. + + GNU Classpath is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + General Public License for more details. + + You should have received a copy of the GNU General Public License + along with GNU Classpath; see the file COPYING. If not, write to the + Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA + 02111-1307 USA. + + Linking this library statically or dynamically with other modules is + making a combined work based on this library. Thus, the terms and + conditions of the GNU General Public License cover the whole + combination. + + As a special exception, the copyright holders of this library give you + permission to link this library with independent modules to produce an + executable, regardless of the license terms of these independent + modules, and to copy and distribute the resulting executable under + terms of your choice, provided that you also meet, for each linked + independent module, the terms and conditions of the license of that + module. An independent module is a module which is not derived from + or based on this library. If you modify this library, you may extend + this exception to your version of the library, but you are not + obligated to do so. If you do not wish to do so, delete this + exception statement from your version. */ package java.awt; import java.awt.peer.ComponentPeer; import java.awt.peer.TextAreaPeer; -/** - * This implements a multi-line text entry widget. - * - * @author Aaron M. Renn (arenn@urbanophile.com) - */ -public class TextArea extends TextComponent implements java.io.Serializable -{ - -/* - * Static Variables - */ - -/** - * Use both horiztonal and vertical scroll bars. - */ -public static final int SCROLLBARS_BOTH = 0; - -/** - * Use vertical scroll bars only. - */ -public static final int SCROLLBARS_VERTICAL_ONLY = 1; - -/** - * Use horizatonal scroll bars only. - */ -public static final int SCROLLBARS_HORIZONTAL_ONLY = 2; - -/** - * Use no scrollbars. - */ -public static final int SCROLLBARS_NONE = 3; - -// Serialization constant -private static final long serialVersionUID = 3692302836626095722L; - -/*************************************************************************/ - -/* - * Instance Variables - */ - -/** - * @serial The number of columns in this text area. - */ -private int columns; - -/** - * @serial The number of rows in this text area. - */ -private int rows; - -/** - * @serial The type of scrollbars to display, which will be one of - * the contstants from this class. - */ -private int scrollbarVisibility; - -/*************************************************************************/ - -/* - * Constructors - */ - -/** - * Initialize a new instance of <code>TextArea</code> that is empty - * and is one row and one column. Both horizontal and vertical - * scrollbars will be used. - * - * @exception HeadlessException If GraphicsEnvironment.isHeadless() is true, - */ -public -TextArea() -{ - this("", 1, 1, SCROLLBARS_BOTH); -} - -/*************************************************************************/ - -/** - * Initializes a new instance of <code>TextArea</code> that - * contains the specified string. Both horizontal and veritcal - * scrollbars will be used. - * - * @param text The text to display in this text area. - * - * @exception HeadlessException If GraphicsEnvironment.isHeadless() is true, - */ -public -TextArea(String text) -{ - this(text, 1, text.length(), SCROLLBARS_BOTH); -} - -/*************************************************************************/ - -/** - * Initializes a new instance of <code>TextArea</code> that is empty - * and has the specified number of rows and columns. Both - * horizontal and vertical scrollbars will be used. - * - * @param rows The number of rows in this text area. - * @param columns The number of columns in this text area. - * - * @exception HeadlessException If GraphicsEnvironment.isHeadless() is true, - */ -public -TextArea(int rows, int columns) -{ - this("", rows, columns, SCROLLBARS_BOTH); -} - -/*************************************************************************/ /** - * Initializes a new instance of <code>TextArea</code> that is the - * specified size and has the specified text. - * - * @param text The text to display in this text area. - * @param rows The number of rows in this text area. - * @param columns The number of columns in this text area. - * - * @exception HeadlessException If GraphicsEnvironment.isHeadless() is true, - */ -public -TextArea(String text, int rows, int columns) -{ - this(text, rows, columns, SCROLLBARS_BOTH); -} - -/*************************************************************************/ - -/** - * Initializes a new instance of <code>TextArea</code> with the - * specified values. The scrollbar visibility value must be one - * of the constants in this class. - * - * @param text The text to display in this text area. - * @param rows The number of rows in this text area. - * @param columns The number of columns in this text area. - * @param scrollbarVisibility Which scrollbars to display. - * - * @exception HeadlessException If GraphicsEnvironment.isHeadless() is true, - */ -public -TextArea(String text, int rows, int columns, int scrollbarVisibility) -{ - super(text); - - if (GraphicsEnvironment.isHeadless()) - throw new HeadlessException (); - - if ((rows < 1) || (columns < 0)) - throw new IllegalArgumentException("Bad row or column value"); - - if ((scrollbarVisibility != SCROLLBARS_BOTH) && - (scrollbarVisibility != SCROLLBARS_VERTICAL_ONLY) && - (scrollbarVisibility != SCROLLBARS_HORIZONTAL_ONLY) && - (scrollbarVisibility != SCROLLBARS_NONE)) - throw new IllegalArgumentException("Bad scrollbar visibility value"); - - this.rows = rows; - this.columns = columns; - this.scrollbarVisibility = scrollbarVisibility; -} - -/*************************************************************************/ - -/* - * Instance Variables + * 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. + * + * @author Aaron M. Renn (arenn@urbanophile.com) */ - -/** - * Returns the number of columns in the field. - * - * @return The number of columns in the field. - */ -public int -getColumns() -{ - return(columns); -} - -/*************************************************************************/ - -/** - * Sets the number of columns in this field to the specified value. - * - * @param columns The new number of columns in the field. - * - * @exception IllegalArgumentException If columns is less than zero. - */ -public synchronized void -setColumns(int columns) -{ - if (columns < 0) - throw new IllegalArgumentException("Value is less than zero: " + - columns); - - this.columns = columns; - // FIXME: How to we communicate this to our peer? -} - -/*************************************************************************/ - -/** - * Returns the number of rows in the field. - * - * @return The number of rows in the field. - */ -public int -getRows() -{ - return(rows); -} - -/*************************************************************************/ - -/** - * Sets the number of rows in this field to the specified value. - * - * @param rows The new number of rows in the field. - * - * @exception IllegalArgumentException If rows is less than zero. - */ -public synchronized void -setRows(int rows) -{ - if (rows < 1) - throw new IllegalArgumentException("Value is less than one: " + - rows); - - this.rows = rows; - // FIXME: How to we communicate this to our peer? -} - -/*************************************************************************/ - -/** - * Returns the minimum size for this text field. - * - * @return The minimum size for this text field. - */ -public Dimension -getMinimumSize() -{ - return(getMinimumSize(getRows(), getColumns())); -} - -/*************************************************************************/ - -/** - * Returns the minimum size of a text field with the specified number - * of rows and columns. - * - * @param rows The number of rows to get the minimum size for. - * @param columns The number of columns to get the minimum size for. - */ -public Dimension -getMinimumSize(int rows, int columns) -{ - TextAreaPeer tap = (TextAreaPeer)getPeer(); - if (tap == null) - return(null); // FIXME: What do we do if there is no peer? - - return(tap.getMinimumSize(rows, columns)); -} - -/*************************************************************************/ - -/** - * Returns the minimum size for this text field. - * - * @return The minimum size for this text field. - * - * @deprecated This method is depcreated in favor of - * <code>getMinimumSize()</code>. - */ -public Dimension -minimumSize() -{ - return(getMinimumSize(getRows(), getColumns())); -} - -/*************************************************************************/ - -/** - * Returns the minimum size of a text field with the specified number - * of rows and columns. - * - * @param rows The number of rows to get the minimum size for. - * @param columns The number of columns to get the minimum size for. - * - * @deprecated This method is deprecated in favor of - * <code>getMinimumSize(int)</code>. - */ -public Dimension -minimumSize(int rows, int columns) -{ - return(getMinimumSize(rows, columns)); -} - -/*************************************************************************/ - -/** - * Returns the preferred size for this text field. - * - * @return The preferred size for this text field. - */ -public Dimension -getPreferredSize() -{ - return(getPreferredSize(getRows(), getColumns())); -} - -/*************************************************************************/ - -/** - * Returns the preferred size of a text field with the specified number - * of rows and columns. - * - * @param rows The number of rows to get the preferred size for. - * @param columns The number of columns to get the preferred size for. - */ -public Dimension -getPreferredSize(int rows, int columns) -{ - TextAreaPeer tap = (TextAreaPeer)getPeer(); - if (tap == null) - { - // Sun's JDK just seems to return Dimension(0,0) in this case. - // we do the same. - return new Dimension(0, 0); - } - - return(tap.getPreferredSize(rows, columns)); -} - -/*************************************************************************/ - -/** - * Returns the preferred size for this text field. - * - * @return The preferred size for this text field. - * - * @deprecated This method is deprecated in favor of - * <code>getPreferredSize()</code>. - */ -public Dimension -preferredSize() -{ - return(getPreferredSize(getRows(), getColumns())); -} - -/*************************************************************************/ - -/** - * Returns the preferred size of a text field with the specified number - * of rows and columns. - * - * @param rows The number of rows to get the preferred size for. - * @param columns The number of columns to get the preferred size for. - * - * @deprecated This method is deprecated in favor of - * <code>getPreferredSize(int)</code>. - */ -public Dimension -preferredSize(int rows, int columns) -{ - return(getPreferredSize(rows, columns)); -} - -/*************************************************************************/ - -/** - * Returns one of the constants from this class indicating which - * types of scrollbars this object uses, if any. - * - * @return The scrollbar type constant for this object. - */ -public int -getScrollbarVisibility() -{ - return(scrollbarVisibility); -} - -/*************************************************************************/ - -/** - * Notify this object that it should create its native peer. - */ -public void -addNotify() -{ - if (getPeer() != null) - return; - - setPeer((ComponentPeer)getToolkit().createTextArea(this)); -} - -/*************************************************************************/ - -/** - * Appends the specified text to the end of the current text. - * - * @param text The text to append. - */ -public void -append(String str) -{ - TextAreaPeer tap = (TextAreaPeer)getPeer(); - if (tap == null) - return; - - tap.insert(str, tap.getText().length()); -} - -/*************************************************************************/ - -/** - * Appends the specified text to the end of the current text. - * - * @param text The text to append. - * - * @deprecated This method is deprecated in favor of - * <code>append()</code>. - */ -public void -appendText(String text) -{ - append(text); -} - -/*************************************************************************/ - -/** - * Inserts the specified text at the specified location. - * - * @param text The text to insert. - * @param pos The insert position. - */ -public void -insert(String text, int pos) -{ - TextAreaPeer tap = (TextAreaPeer)getPeer(); - if (tap == null) - return; - - tap.insert(text, pos); -} - -/*************************************************************************/ - -/** - * Inserts the specified text at the specified location. - * - * @param text The text to insert. - * @param pos The insert position. - * - * @deprecated This method is depcreated in favor of <code>insert()</code>. - */ -public void -insertText(String text, int pos) -{ - insert(text, pos); -} - -/*************************************************************************/ - -/** - * Replaces the text bounded by the specified start and end positions - * with the specified text. - * - * @param text The new text for the range. - * @param start The start position of the replacement range. - * @param end The end position of the replacement range. - */ -public void -replaceRange(String text, int start, int end) -{ - TextAreaPeer tap = (TextAreaPeer)getPeer(); - if (tap == null) - return; - - tap.replaceRange(text, start, end); -} - -/*************************************************************************/ - -/** - * Replaces the text bounded by the specified start and end positions - * with the specified text. - * - * @param text The new text for the range. - * @param start The start position of the replacement range. - * @param end The end position of the replacement range. - * - * @deprecated This method is deprecated in favor of - * <code>replaceRange()</code>. - */ -public void -replaceText(String text, int start, int end) -{ - replaceRange(text, start, end); -} - -/*************************************************************************/ - -/** - * Returns a debugging string for this text area. - * - * @return A debugging string for this text area. - */ -protected String -paramString() +public class TextArea extends TextComponent implements java.io.Serializable { - return(getClass().getName() + "(rows=" + getRows() + ",columns=" + - getColumns() + ",scrollbars=" + getScrollbarVisibility() + - ")"); + /** + * Display both horiztonal and vertical scroll bars. + */ + public static final int SCROLLBARS_BOTH = 0; + + /** + * Display vertical scroll bar only. + */ + public static final int SCROLLBARS_VERTICAL_ONLY = 1; + + /** + * Display horizatonal scroll bar only. + */ + public static final int SCROLLBARS_HORIZONTAL_ONLY = 2; + + /** + * Do not display scrollbars. + */ + public static final int SCROLLBARS_NONE = 3; + + /** + * Serialization constant. + */ + private static final long serialVersionUID = 3692302836626095722L; + + /** + * @serial The number of columns used in this text area's preferred + * and minimum size calculations. + */ + private int columns; + + /** + * @serial The number of rows used in this text area's preferred and + * minimum size calculations. + */ + private int rows; + + /** + * @serial The scrollbar display policy. One of SCROLLBARS_BOTH, + * SCROLLBARS_VERTICAL_ONLY, SCROLLBARS_HORIZONTAL_ONLY, + * SCROLLBARS_NONE. + */ + private int scrollbarVisibility; + + /* + * The number used to generate the name returned by getName. + */ + private static transient long next_text_number = 0; + + /** + * Initialize a new instance of <code>TextArea</code> that is empty + * and is one row by one column. Both horizontal and vertical + * scrollbars will be displayed. + * + * @exception HeadlessException If GraphicsEnvironment.isHeadless () is true, + */ + public TextArea () + { + this ("", 1, 1, SCROLLBARS_BOTH); + } + + /** + * Initialize a new instance of <code>TextArea</code> that initially + * contains the specified text. Both horizontal and veritcal + * scrollbars will be displayed. + * + * @param text The text to display in this text area. + * + * @exception HeadlessException If GraphicsEnvironment.isHeadless () is true, + */ + public TextArea (String text) + { + this (text, 1, text.length (), SCROLLBARS_BOTH); + } + + /** + * Initialize a new instance of <code>TextArea</code> 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. + * + * @param rows The number of rows in this text area. + * @param columns The number of columns in this text area. + * + * @exception HeadlessException If GraphicsEnvironment.isHeadless () is true, + */ + public TextArea (int rows, int columns) + { + this ("", rows, columns, SCROLLBARS_BOTH); + } + + /** + * Initialize a new instance of <code>TextArea</code> that can + * display the specified number of rows and columns of text, without + * the need to scroll. The TextArea initially contains the + * specified text. + * + * @param text The text to display in this text area. + * @param rows The number of rows in this text area. + * @param columns The number of columns in this text area. + * + * @exception HeadlessException If GraphicsEnvironment.isHeadless () is true, + */ + public TextArea (String text, int rows, int columns) + { + this (text, rows, columns, SCROLLBARS_BOTH); + } + + /** + * Initialize a new instance of <code>TextArea</code> 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. + * + * @param text The text to display in this text area. + * @param rows The number of rows in this text area. + * @param columns The number of columns in this text area. + * @param scrollbarVisibility The scroll bar display policy. One of + * SCROLLBARS_BOTH, SCROLLBARS_VERTICAL_ONLY, + * SCROLLBARS_HORIZONTAL_ONLY, SCROLLBARS_NONE. + * + * @exception HeadlessException If GraphicsEnvironment.isHeadless () is true, + */ + public TextArea (String text, int rows, int columns, int scrollbarVisibility) + { + super (text); + + if (GraphicsEnvironment.isHeadless ()) + throw new HeadlessException (); + + if (rows < 1 || columns < 0) + throw new IllegalArgumentException ("Bad row or column value"); + + if (scrollbarVisibility != SCROLLBARS_BOTH + && scrollbarVisibility != SCROLLBARS_VERTICAL_ONLY + && scrollbarVisibility != SCROLLBARS_HORIZONTAL_ONLY + && scrollbarVisibility != SCROLLBARS_NONE) + throw new IllegalArgumentException ("Bad scrollbar visibility value"); + + this.rows = rows; + this.columns = columns; + this.scrollbarVisibility = scrollbarVisibility; + } + + /* + * Instance Variables + */ + + /** + * 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. + * + * @return The preferred number of columns. + */ + public int getColumns () + { + return 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. + * + * @param columns The preferred number of columns. + * + * @exception IllegalArgumentException If columns is less than zero. + */ + public synchronized void setColumns (int columns) + { + if (columns < 0) + throw new IllegalArgumentException ("Value is less than zero: " + + columns); + + this.columns = columns; + } + + /** + * 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. + * + * @return The preferred number of rows. + */ + public int getRows () + { + return 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. + * + * @param rows The preferred number of rows. + * + * @exception IllegalArgumentException If rows is less than zero. + */ + public synchronized void setRows (int rows) + { + if (rows < 1) + throw new IllegalArgumentException ("Value is less than one: " + rows); + + this.rows = rows; + } + + /** + * Retrieve the minimum size for this text area, considering the + * text area's current row and column values. A text area's minimum + * size depends on the number of rows and columns of text it would + * prefer to display, and on the size of the font in which the text + * would be displayed. + * + * @return The minimum size for this text field. + */ + public Dimension getMinimumSize () + { + return getMinimumSize (getRows (), getColumns ()); + } + + /** + * Retrieve the minimum size that this text area would have if its + * row and column values were equal to those specified. A text + * area's minimum size depends on the number of rows and columns of + * text it would prefer to display, and on the size of the font in + * which the text would be displayed. + * + * @param rows The number of rows to use in the minimum size + * calculation. + * @param columns The number of columns to use in the minimum size + * calculation. + * + * @return The minimum size for this text area. + */ + public Dimension getMinimumSize (int rows, int columns) + { + TextAreaPeer peer = (TextAreaPeer) getPeer (); + + // Sun returns Dimension (0,0) in this case. + if (peer == null) + return new Dimension (0, 0); + + return peer.getMinimumSize (rows, columns); + } + + /** + * Retrieve the minimum size for this text area, considering the + * text area's current row and column values. A text area's minimum + * size depends on the number of rows and columns of text it would + * prefer to display, and on the size of the font in which the text + * would be displayed. + * + * @return The minimum size for this text area. + * + * @deprecated This method is deprecated in favor of + * <code>getMinimumSize ()</code>. + */ + public Dimension minimumSize () + { + return getMinimumSize (getRows (), getColumns ()); + } + + /** + * Retrieve the minimum size that this text area would have if its + * row and column values were equal to those specified. A text + * area's minimum size depends on the number of rows and columns of + * text it would prefer to display, and on the size of the font in + * which the text would be displayed. + * + * @param rows The number of rows to use in the minimum size + * calculation. + * @param columns The number of columns to use in the minimum size + * calculation. + * + * @return The minimum size for this text area. + * + * @deprecated This method is deprecated in favor of + * <code>getMinimumSize (int, int)</code>. + */ + public Dimension minimumSize (int rows, int columns) + { + return getMinimumSize (rows, columns); + } + + /** + * Retrieve the preferred size for this text area, considering the + * text area's current row and column values. A text area's preferred + * size depends on the number of rows and columns of text it would + * prefer to display, and on the size of the font in which the text + * would be displayed. + * + * @return The preferred size for this text field. + */ + public Dimension getPreferredSize () + { + return getPreferredSize (getRows (), getColumns ()); + } + + /** + * Retrieve the preferred size that this text area would have if its + * row and column values were equal to those specified. A text + * area's preferred size depends on the number of rows and columns + * of text it would prefer to display, and on the size of the font + * in which the text would be displayed. + * + * @param rows The number of rows to use in the preferred size + * calculation. + * @param columns The number of columns to use in the preferred size + * calculation. + * + * @return The preferred size for this text area. + */ + public Dimension getPreferredSize (int rows, int columns) + { + TextAreaPeer peer = (TextAreaPeer) getPeer (); + + // Sun returns Dimension (0,0) in this case. + if (peer == null) + return new Dimension (0, 0); + + return peer.getPreferredSize (rows, columns); + } + + /** + * Retrieve the preferred size for this text area, considering the + * text area's current row and column values. A text area's preferred + * size depends on the number of rows and columns of text it would + * prefer to display, and on the size of the font in which the text + * would be displayed. + * + * @return The preferred size for this text field. + * + * @deprecated This method is deprecated in favor of + * <code>getPreferredSize ()</code>. + */ + public Dimension preferredSize () + { + return getPreferredSize (getRows (), getColumns ()); + } + + /** + * Retrieve the preferred size that this text area would have if its + * row and column values were equal to those specified. A text + * area's preferred size depends on the number of rows and columns + * of text it would prefer to display, and on the size of the font + * in which the text would be displayed. + * + * @param rows The number of rows to use in the preferred size + * calculation. + * @param columns The number of columns to use in the preferred size + * calculation. + * + * @return The preferred size for this text area. + * + * @deprecated This method is deprecated in favor of + * <code>getPreferredSize (int, int)</code>. + */ + public Dimension preferredSize (int rows, int columns) + { + return getPreferredSize (rows, columns); + } + + /** + * Retrieve the scroll bar display policy -- one of SCROLLBARS_BOTH, + * SCROLLBARS_VERTICAL_ONLY, SCROLLBARS_HORIZONTAL_ONLY, + * SCROLLBARS_NONE. + * + * @return The current scroll bar display policy. + */ + public int getScrollbarVisibility () + { + return scrollbarVisibility; + } + + /** + * Notify this object that it should create its native peer. + */ + public void addNotify () + { + if (getPeer () != null) + return; + + setPeer ((ComponentPeer) getToolkit().createTextArea (this)); + } + + /** + * Append the specified text to the end of the current text. + * + * @param text The text to append. + */ + public void append (String str) + { + TextAreaPeer peer = (TextAreaPeer) getPeer (); + if (peer == null) + return; + + peer.insert (str, peer.getText().length ()); + } + + /** + * Append the specified text to the end of the current text. + * + * @param text The text to append. + * + * @deprecated This method is deprecated in favor of + * <code>append ()</code>. + */ + public void appendText (String text) + { + append (text); + } + + /** + * Insert the specified text at the specified position. The first + * character in the text area is at position zero. + * + * @param text The text to insert. + * @param pos The position at which to insert text. + */ + public void insert (String text, int pos) + { + TextAreaPeer peer = (TextAreaPeer) getPeer (); + if (peer == null) + return; + + peer.insert (text, pos); + } + + /** + * Insert the specified text at the specified position. The first + * character in the text area is at position zero. + * + * @param text The text to insert. + * @param pos The position at which to insert text. + * + * @deprecated This method is depcreated in favor of + * <code>insert ()</code>. + */ + public void insertText (String text, int pos) + { + insert (text, pos); + } + + /** + * 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. + * + * @param text The new text for the range. + * @param start The start position of the replacement range. + * @param end The end position of the replacement range. + */ + public void replaceRange (String text, int start, int end) + { + TextAreaPeer peer = (TextAreaPeer) getPeer (); + if (peer == null) + return; + + peer.replaceRange (text, start, 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. + * + * @param text The new text for the range. + * @param start The start position of the replacement range. + * @param end The end position of the replacement range. + * + * @deprecated This method is deprecated in favor of + * <code>replaceRange ()</code>. + */ + public void replaceText (String text, int start, int end) + { + replaceRange (text, start, end); + } + + /** + * Retrieve a debugging string for this text area. + * + * @return A debugging string for this text area. + */ + protected String paramString () + { + String sbVisibility = ""; + + switch (scrollbarVisibility) + { + case SCROLLBARS_BOTH: + sbVisibility = "both"; + break; + case SCROLLBARS_VERTICAL_ONLY: + sbVisibility = "vertical-only"; + break; + case SCROLLBARS_HORIZONTAL_ONLY: + sbVisibility = "horizontal-only"; + break; + case SCROLLBARS_NONE: + sbVisibility = "none"; + break; + } + + String editable = ""; + if (isEditable ()) + editable = "editable,"; + + return getName () + "," + getX () + "," + getY () + "," + getWidth () + + "x" + getHeight () + "," + "text=" + getText () + "," + editable + + "selection=" + getSelectionStart () + "-" + getSelectionEnd () + + ",rows=" + rows + ",columns=" + columns + ",scrollbarVisibility=" + + sbVisibility; + } + + /** + * Generate a unique name for this text area. + * + * @return A unique name for this text area. + */ + String generateName () + { + return "text" + getUniqueLong (); + } + + private static synchronized long getUniqueLong () + { + return next_text_number++; + } } - -} // class TextArea - |