Class TextArea
java.lang.Object
java.awt.Component
java.awt.TextComponent
java.awt.TextArea
- All Implemented Interfaces:
ImageObserver
,MenuContainer
,Serializable
,Accessible
A
TextArea
object is a multi-line region
that displays text. It can be set to allow editing or
to be read-only.
The following image shows the appearance of a text area:
This text area could be created by the following line of code:
new TextArea("Hello", 5, 40);
- Since:
- 1.0
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionprotected class
This class implements accessibility support for theTextArea
class.Nested classes/interfaces inherited from class java.awt.TextComponent
TextComponent.AccessibleAWTTextComponent
Nested classes/interfaces inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
Create and display both vertical and horizontal scrollbars.static final int
Create and display horizontal scrollbar only.static final int
Do not create or display any scrollbars for the text area.static final int
Create and display vertical scrollbar only.Fields inherited from class java.awt.TextComponent
textListener
Fields inherited from class java.awt.Component
accessibleContext, 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
-
Constructor Summary
ConstructorDescriptionTextArea()
Constructs a new text area with the empty string as text.TextArea
(int rows, int columns) Constructs a new text area with the specified number of rows and columns and the empty string as text.Constructs a new text area with the specified text.Constructs a new text area with the specified text, and with the specified number of rows and columns.Constructs a new text area with the specified text, and with the rows, columns, and scroll bar visibility as specified. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Creates theTextArea
's peer.void
Appends the given text to the text area's current text.void
appendText
(String str) Deprecated.Returns theAccessibleContext
associated with thisTextArea
.int
Returns the number of columns in this text area.Determines the minimum size of this text area.getMinimumSize
(int rows, int columns) Determines the minimum size of a text area with the specified number of rows and columns.Determines the preferred size of this text area.getPreferredSize
(int rows, int columns) Determines the preferred size of a text area with the specified number of rows and columns.int
getRows()
Returns the number of rows in the text area.int
Returns an enumerated value that indicates which scroll bars the text area uses.void
Inserts the specified text at the specified position in this text area.void
insertText
(String str, int pos) Deprecated.As of JDK version 1.1, replaced byinsert(String, int)
.Deprecated.As of JDK version 1.1, replaced bygetMinimumSize()
.minimumSize
(int rows, int columns) Deprecated.As of JDK version 1.1, replaced bygetMinimumSize(int, int)
.protected String
Returns a string representing the state of thisTextArea
.Deprecated.As of JDK version 1.1, replaced bygetPreferredSize()
.preferredSize
(int rows, int columns) Deprecated.As of JDK version 1.1, replaced bygetPreferredSize(int, int)
.void
replaceRange
(String str, int start, int end) Replaces text between the indicated start and end positions with the specified replacement text.void
replaceText
(String str, int start, int end) Deprecated.As of JDK version 1.1, replaced byreplaceRange(String, int, int)
.void
setColumns
(int columns) Sets the number of columns for this text area.void
setRows
(int rows) Sets the number of rows for this text area.Methods inherited from class java.awt.TextComponent
addTextListener, enableInputMethods, getBackground, getCaretPosition, getInputMethodRequests, getListeners, getSelectedText, getSelectionEnd, getSelectionStart, getText, getTextListeners, isEditable, processEvent, processTextEvent, removeNotify, removeTextListener, select, selectAll, setBackground, setCaretPosition, setEditable, setSelectionEnd, setSelectionStart, setText
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAlignmentX, getAlignmentY, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getKeyListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusCycleRoot, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paint, paintAll, postEvent, prepareImage, prepareImage, print, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, revalidate, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setMixingCutoutShape, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle, update, validate
-
Field Details
-
SCROLLBARS_BOTH
public static final int SCROLLBARS_BOTHCreate and display both vertical and horizontal scrollbars.- Since:
- 1.1
- See Also:
-
SCROLLBARS_VERTICAL_ONLY
public static final int SCROLLBARS_VERTICAL_ONLYCreate and display vertical scrollbar only.- Since:
- 1.1
- See Also:
-
SCROLLBARS_HORIZONTAL_ONLY
public static final int SCROLLBARS_HORIZONTAL_ONLYCreate and display horizontal scrollbar only.- Since:
- 1.1
- See Also:
-
SCROLLBARS_NONE
public static final int SCROLLBARS_NONEDo not create or display any scrollbars for the text area.- Since:
- 1.1
- See Also:
-
-
Constructor Details
-
TextArea
Constructs a new text area with the empty string as text. This text area is created with scrollbar visibility equal toSCROLLBARS_BOTH
, so both vertical and horizontal scrollbars will be visible for this text area.- Throws:
HeadlessException
- ifGraphicsEnvironment.isHeadless
returns true- See Also:
-
TextArea
Constructs a new text area with the specified text. This text area is created with scrollbar visibility equal toSCROLLBARS_BOTH
, so both vertical and horizontal scrollbars will be visible for this text area.- Parameters:
text
- the text to be displayed; iftext
isnull
, the empty string""
will be displayed- Throws:
HeadlessException
- ifGraphicsEnvironment.isHeadless
returns true- See Also:
-
TextArea
Constructs a new text area with the specified number of rows and columns and the empty string as text. A column is an approximate average character width that is platform-dependent. The text area is created with scrollbar visibility equal toSCROLLBARS_BOTH
, so both vertical and horizontal scrollbars will be visible for this text area.- Parameters:
rows
- the number of rowscolumns
- the number of columns- Throws:
HeadlessException
- ifGraphicsEnvironment.isHeadless
returns true- See Also:
-
TextArea
Constructs a new text area with the specified text, and with the specified number of rows and columns. A column is an approximate average character width that is platform-dependent. The text area is created with scrollbar visibility equal toSCROLLBARS_BOTH
, so both vertical and horizontal scrollbars will be visible for this text area.- Parameters:
text
- the text to be displayed; iftext
isnull
, the empty string""
will be displayedrows
- the number of rowscolumns
- the number of columns- Throws:
HeadlessException
- ifGraphicsEnvironment.isHeadless
returns true- See Also:
-
TextArea
Constructs a new text area with the specified text, and with the rows, columns, and scroll bar visibility as specified. AllTextArea
constructors defer to this one.The
TextArea
class defines several constants that can be supplied as values for thescrollbars
argument:SCROLLBARS_BOTH
,SCROLLBARS_VERTICAL_ONLY
,SCROLLBARS_HORIZONTAL_ONLY
,SCROLLBARS_NONE
.
scrollbars
argument is invalid and will result in this text area being created with scrollbar visibility equal to the default value ofSCROLLBARS_BOTH
.- Parameters:
text
- the text to be displayed; iftext
isnull
, the empty string""
will be displayedrows
- the number of rows; ifrows
is less than0
,rows
is set to0
columns
- the number of columns; ifcolumns
is less than0
,columns
is set to0
scrollbars
- a constant that determines what scrollbars are created to view the text area- Throws:
HeadlessException
- ifGraphicsEnvironment.isHeadless
returns true- Since:
- 1.1
- See Also:
-
-
Method Details
-
addNotify
public void addNotify()Creates theTextArea
's peer. The peer allows us to modify the appearance of theTextArea
without changing any of its functionality.- Overrides:
addNotify
in classTextComponent
- See Also:
-
insert
Inserts the specified text at the specified position in this text area.Note that passing
null
or inconsistent parameters is invalid and will result in unspecified behavior.- Parameters:
str
- the non-null
text to insertpos
- the position at which to insert- Since:
- 1.1
- See Also:
-
insertText
Deprecated.As of JDK version 1.1, replaced byinsert(String, int)
.Inserts the specified text at the specified position in this text area.- Parameters:
str
- the non-null
text to insertpos
- the position at which to insert
-
append
Appends the given text to the text area's current text.Note that passing
null
or inconsistent parameters is invalid and will result in unspecified behavior.- Parameters:
str
- the non-null
text to append- Since:
- 1.1
- See Also:
-
appendText
Deprecated.As of JDK version 1.1, replaced byappend(String)
.Appends the given text to the text area's current text.- Parameters:
str
- the text to append
-
replaceRange
Replaces text between the indicated start and end positions with the specified replacement text. The text at the end position will not be replaced. The text at the start position will be replaced (unless the start position is the same as the end position). The text position is zero-based. The inserted substring may be of a different length than the text it replaces.Note that passing
null
or inconsistent parameters is invalid and will result in unspecified behavior.- Parameters:
str
- the non-null
text to use as the replacementstart
- the start positionend
- the end position- Since:
- 1.1
- See Also:
-
replaceText
Deprecated.As of JDK version 1.1, replaced byreplaceRange(String, int, int)
.Replaces a range of characters between the indicated start and end positions with the specified replacement text (the text at the end position will not be replaced).- Parameters:
str
- the non-null
text to use as the replacementstart
- the start positionend
- the end position
-
getRows
public int getRows()Returns the number of rows in the text area.- Returns:
- the number of rows in the text area
- Since:
- 1.0
- See Also:
-
setRows
public void setRows(int rows) Sets the number of rows for this text area.- Parameters:
rows
- the number of rows- Throws:
IllegalArgumentException
- if the value supplied forrows
is less than0
- Since:
- 1.1
- See Also:
-
getColumns
public int getColumns()Returns the number of columns in this text area.- Returns:
- the number of columns in the text area
- See Also:
-
setColumns
public void setColumns(int columns) Sets the number of columns for this text area.- Parameters:
columns
- the number of columns- Throws:
IllegalArgumentException
- if the value supplied forcolumns
is less than0
- Since:
- 1.1
- See Also:
-
getScrollbarVisibility
public int getScrollbarVisibility()Returns an enumerated value that indicates which scroll bars the text area uses.The
TextArea
class defines four integer constants that are used to specify which scroll bars are available.TextArea
has one constructor that gives the application discretion over scroll bars.- Returns:
- an integer that indicates which scroll bars are used
- Since:
- 1.1
- See Also:
-
getPreferredSize
Determines the preferred size of a text area with the specified number of rows and columns.- Parameters:
rows
- the number of rowscolumns
- the number of columns- Returns:
- the preferred dimensions required to display the text area with the specified number of rows and columns
- Since:
- 1.1
- See Also:
-
preferredSize
Deprecated.As of JDK version 1.1, replaced bygetPreferredSize(int, int)
.Determines the preferred size of the text area with the specified number of rows and columns.- Parameters:
rows
- the number of rowscolumns
- the number of columns- Returns:
- the preferred dimensions needed for the text area
-
getPreferredSize
Determines the preferred size of this text area.- Overrides:
getPreferredSize
in classComponent
- Returns:
- the preferred dimensions needed for this text area
- Since:
- 1.1
- See Also:
-
preferredSize
Deprecated.As of JDK version 1.1, replaced bygetPreferredSize()
.Description copied from class:Component
Returns the component's preferred size.- Overrides:
preferredSize
in classComponent
- Returns:
- the component's preferred size
-
getMinimumSize
Determines the minimum size of a text area with the specified number of rows and columns.- Parameters:
rows
- the number of rowscolumns
- the number of columns- Returns:
- the minimum dimensions required to display the text area with the specified number of rows and columns
- Since:
- 1.1
- See Also:
-
minimumSize
Deprecated.As of JDK version 1.1, replaced bygetMinimumSize(int, int)
.Determines the minimum size of the text area with the specified number of rows and columns.- Parameters:
rows
- the number of rowscolumns
- the number of columns- Returns:
- the minimum size for the text area
-
getMinimumSize
Determines the minimum size of this text area.- Overrides:
getMinimumSize
in classComponent
- Returns:
- the preferred dimensions needed for this text area
- Since:
- 1.1
- See Also:
-
minimumSize
Deprecated.As of JDK version 1.1, replaced bygetMinimumSize()
.Description copied from class:Component
Returns the minimum size of this component.- Overrides:
minimumSize
in classComponent
- Returns:
- the minimum size of this component
-
paramString
Returns a string representing the state of thisTextArea
. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not benull
.- Overrides:
paramString
in classTextComponent
- Returns:
- the parameter string of this text area
-
getAccessibleContext
Returns theAccessibleContext
associated with thisTextArea
. For text areas, theAccessibleContext
takes the form of anAccessibleAWTTextArea
. A newAccessibleAWTTextArea
instance is created if necessary.- Specified by:
getAccessibleContext
in interfaceAccessible
- Overrides:
getAccessibleContext
in classTextComponent
- Returns:
- an
AccessibleAWTTextArea
that serves as theAccessibleContext
of thisTextArea
- Since:
- 1.3
-
append(String)
.