Class JTextArea
- All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible, Scrollable
JTextArea
is a multi-line area that displays plain text.
It is intended to be a lightweight component that provides source
compatibility with the java.awt.TextArea
class where it can
reasonably do so.
You can find information and examples of using all the text components in
Using Text Components,
a section in The Java Tutorial.
This component has capabilities not found in the
java.awt.TextArea
class. The superclass should be
consulted for additional capabilities.
Alternative multi-line text classes with
more capabilities are JTextPane
and JEditorPane
.
The java.awt.TextArea
internally handles scrolling.
JTextArea
is different in that it doesn't manage scrolling,
but implements the swing Scrollable
interface. This allows it
to be placed inside a JScrollPane
if scrolling
behavior is desired, and used directly if scrolling is not desired.
The java.awt.TextArea
has the ability to do line wrapping.
This was controlled by the horizontal scrolling policy. Since
scrolling is not done by JTextArea
directly, backward
compatibility must be provided another way. JTextArea
has
a bound property for line wrapping that controls whether or
not it will wrap lines. By default, the line wrapping property
is set to false (not wrapped).
java.awt.TextArea
has two properties rows
and columns
that are used to determine the preferred size.
JTextArea
uses these properties to indicate the
preferred size of the viewport when placed inside a JScrollPane
to match the functionality provided by java.awt.TextArea
.
JTextArea
has a preferred size of what is needed to
display all of the text, so that it functions properly inside of
a JScrollPane
. If the value for rows
or columns
is equal to zero,
the preferred size along that axis is used for
the viewport preferred size along the same axis.
The java.awt.TextArea
could be monitored for changes by adding
a TextListener
for TextEvent
s.
In the JTextComponent
based
components, changes are broadcasted from the model via a
DocumentEvent
to DocumentListeners
.
The DocumentEvent
gives
the location of the change and the kind of change if desired.
The code fragment might look something like:
DocumentListener myListener = ??; JTextArea myArea = ??; myArea.getDocument().addDocumentListener(myListener);
- Newlines
- For a discussion on how newlines are handled, see DefaultEditorKit.
Warning: Swing is not thread safe. For more information see Swing's Threading Policy.
Warning:
Serialized objects of this class will not be compatible with
future Swing releases. The current serialization support is
appropriate for short term storage or RMI between applications running
the same version of Swing. As of 1.4, support for long term storage
of all JavaBeans
has been added to the java.beans
package.
Please see XMLEncoder
.
- Since:
- 1.2
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected class
This class implements accessibility support for theJTextArea
class.Nested classes/interfaces declared in class JTextComponent
JTextComponent.AccessibleJTextComponent, JTextComponent.DropLocation, JTextComponent.KeyBinding
Modifier and TypeClassDescriptionclass
This class implements accessibility support for theJTextComponent
class.static final class
Represents a drop location forJTextComponent
s.static class
Binding record for creating key bindings.Nested classes/interfaces declared in class JComponent
JComponent.AccessibleJComponent
Modifier and TypeClassDescriptionclass
Inner class of JComponent used to provide default support for accessibility.Nested classes/interfaces declared in class Container
Container.AccessibleAWTContainer
Modifier and TypeClassDescriptionprotected class
Inner class of Container used to provide default support for accessibility.Nested classes/interfaces declared in class Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
Modifier and TypeClassDescriptionprotected class
Inner class of Component used to provide default support for accessibility.static enum
Enumeration of the common ways the baseline of a component can change as the size changes.protected class
Inner class for blitting offscreen surfaces to a component.protected class
Inner class for flipping buffers on a component. -
Field Summary
Fields declared in class JTextComponent
DEFAULT_KEYMAP, FOCUS_ACCELERATOR_KEY
Fields declared in class JComponent
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
Modifier and TypeFieldDescriptionprotected EventListenerList
A list of event listeners for this component.static final String
The comment to display when the cursor is over the component, also known as a "value tip", "flyover help", or "flyover label".protected ComponentUI
The look and feel delegate for this component.static final int
Constant used by some of the APIs to mean that no condition is defined.static final int
Constant used forregisterKeyboardAction
that means that the command should be invoked when the receiving component is an ancestor of the focused component or is itself the focused component.static final int
Constant used forregisterKeyboardAction
that means that the command should be invoked when the component has the focus.static final int
Constant used forregisterKeyboardAction
that means that the command should be invoked when the receiving component is in the window that has the focus or is itself the focused component.Fields declared in class Component
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
Modifier and TypeFieldDescriptionprotected AccessibleContext
TheAccessibleContext
associated with thisComponent
.static final float
Ease-of-use constant forgetAlignmentY
.static final float
Ease-of-use constant forgetAlignmentY
andgetAlignmentX
.static final float
Ease-of-use constant forgetAlignmentX
.static final float
Ease-of-use constant forgetAlignmentX
.static final float
Ease-of-use constant forgetAlignmentY()
.Fields declared in interface ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
Modifier and TypeFieldDescriptionstatic final int
This flag in the infoflags argument to imageUpdate indicates that an image which was being tracked asynchronously was aborted before production was complete.static final int
This flag in the infoflags argument to imageUpdate indicates that a static image which was previously drawn is now complete and can be drawn again in its final form.static final int
This flag in the infoflags argument to imageUpdate indicates that an image which was being tracked asynchronously has encountered an error.static final int
This flag in the infoflags argument to imageUpdate indicates that another complete frame of a multi-frame image which was previously drawn is now available to be drawn again.static final int
This flag in the infoflags argument to imageUpdate indicates that the height of the base image is now available and can be taken from the height argument to the imageUpdate callback method.static final int
This flag in the infoflags argument to imageUpdate indicates that the properties of the image are now available.static final int
This flag in the infoflags argument to imageUpdate indicates that more pixels needed for drawing a scaled variation of the image are available.static final int
This flag in the infoflags argument to imageUpdate indicates that the width of the base image is now available and can be taken from the width argument to the imageUpdate callback method. -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a new TextArea.JTextArea
(int rows, int columns) Constructs a new empty TextArea with the specified number of rows and columns.Constructs a new TextArea with the specified text displayed.Constructs a new TextArea with the specified text and number of rows and columns.Constructs a new JTextArea with the given document model, and defaults for all of the other arguments (null, 0, 0).Constructs a new JTextArea with the specified number of rows and columns, and the given model. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Appends the given text to the end of the document.protected Document
Creates the default implementation of the model to be used at construction if one isn't explicitly given.Gets the AccessibleContext associated with this JTextArea.int
Returns the number of columns in the TextArea.protected int
Gets column width.int
Determines the number of lines contained in the area.int
getLineEndOffset
(int line) Determines the offset of the end of the given line.int
getLineOfOffset
(int offset) Translates an offset into the components text to a line number.int
getLineStartOffset
(int line) Determines the offset of the start of the given line.boolean
Gets the line-wrapping policy of the text area.Returns the preferred size of the viewport if this component is embedded in a JScrollPane.Returns the preferred size of the TextArea.protected int
Defines the meaning of the height of a row.int
getRows()
Returns the number of rows in the TextArea.boolean
Returns true if a viewport should always force the width of this Scrollable to match the width of the viewport.int
getScrollableUnitIncrement
(Rectangle visibleRect, int orientation, int direction) Components that display logical rows or columns should compute the scroll increment that will completely expose one new row or column, depending on the value of orientation.int
Gets the number of characters used to expand tabs.Returns the class ID for the UI.boolean
Gets the style of wrapping used if the text area is wrapping lines.void
Inserts the specified text at the specified position.protected String
Returns a string representation of this JTextArea.void
replaceRange
(String str, int start, int end) Replaces text from the indicated start to end position with the new text specified.void
setColumns
(int columns) Sets the number of columns for this TextArea.void
Sets the current font.void
setLineWrap
(boolean wrap) Sets the line-wrapping policy of the text area.void
setRows
(int rows) Sets the number of rows for this TextArea.void
setTabSize
(int size) Sets the number of characters to expand tabs to.void
setWrapStyleWord
(boolean word) Sets the style of wrapping used if the text area is wrapping lines.Methods declared in class JTextComponent
addCaretListener, addKeymap, copy, cut, fireCaretUpdate, getActions, getCaret, getCaretColor, getCaretListeners, getCaretPosition, getDisabledTextColor, getDocument, getDragEnabled, getDropLocation, getDropMode, getFocusAccelerator, getHighlighter, getInputMethodRequests, getKeymap, getKeymap, getMargin, getNavigationFilter, getPrintable, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getSelectedText, getSelectedTextColor, getSelectionColor, getSelectionEnd, getSelectionStart, getText, getText, getToolTipText, getUI, isEditable, loadKeymap, modelToView, modelToView2D, moveCaretPosition, paste, print, print, print, read, removeCaretListener, removeKeymap, replaceSelection, restoreComposedText, saveComposedText, select, selectAll, setCaret, setCaretColor, setCaretPosition, setDisabledTextColor, setDocument, setDragEnabled, setDropMode, setEditable, setFocusAccelerator, setHighlighter, setKeymap, setMargin, setNavigationFilter, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, setText, setUI, updateUI, viewToModel, viewToModel2D, write
Modifier and TypeMethodDescriptionvoid
addCaretListener
(CaretListener listener) Adds a caret listener for notification of any changes to the caret.static Keymap
Adds a new keymap into the keymap hierarchy.void
copy()
Transfers the currently selected range in the associated text model to the system clipboard, leaving the contents in the text model.void
cut()
Transfers the currently selected range in the associated text model to the system clipboard, removing the contents from the model.protected void
Notifies all listeners that have registered interest for notification on this event type.Action[]
Fetches the command list for the editor.getCaret()
Fetches the caret that allows text-oriented navigation over the view.Fetches the current color used to render the caret.Returns an array of all the caret listeners registered on this text component.int
Returns the position of the text insertion caret for the text component.Fetches the current color used to render the disabled text.Fetches the model associated with the editor.boolean
Returns whether or not automatic drag handling is enabled.Returns the location that this component should visually indicate as the drop location during a DnD operation over the component, ornull
if no location is to currently be shown.final DropMode
Returns the drop mode for this component.char
Returns the key accelerator that will cause the receiving text component to get the focus.Fetches the object responsible for making highlights.Gets the input method request handler which supports requests from input methods for this component.Fetches the keymap currently active in this text component.static Keymap
Fetches a named keymap previously added to the document.Returns the margin between the text component's border and its text.Returns theNavigationFilter
.getPrintable
(MessageFormat headerFormat, MessageFormat footerFormat) Returns aPrintable
to use for printing the content of thisJTextComponent
.int
getScrollableBlockIncrement
(Rectangle visibleRect, int orientation, int direction) Components that display logical rows or columns should compute the scroll increment that will completely expose one block of rows or columns, depending on the value of orientation.boolean
Returns true if a viewport should always force the height of thisScrollable
to match the height of the viewport.Returns the selected text contained in thisTextComponent
.Fetches the current color used to render the selected text.Fetches the current color used to render the selection.int
Returns the selected text's end position.int
Returns the selected text's start position.getText()
Returns the text contained in thisTextComponent
.getText
(int offs, int len) Fetches a portion of the text represented by the component.getToolTipText
(MouseEvent event) Returns the string to be used as the tooltip forevent
.getUI()
Fetches the user-interface factory for this text-oriented editor.boolean
Returns the boolean indicating whether thisTextComponent
is editable or not.static void
loadKeymap
(Keymap map, JTextComponent.KeyBinding[] bindings, Action[] actions) Loads a keymap with a bunch of bindings.modelToView
(int pos) Deprecated.modelToView2D
(int pos) Converts the given location in the model to a place in the view coordinate system.void
moveCaretPosition
(int pos) Moves the caret to a new position, leaving behind a mark defined by the last timesetCaretPosition
was called.void
paste()
Transfers the contents of the system clipboard into the associated text model.boolean
print()
A convenience print method that displays a print dialog, and then prints thisJTextComponent
in interactive mode with no header or footer text.boolean
print
(MessageFormat headerFormat, MessageFormat footerFormat) A convenience print method that displays a print dialog, and then prints thisJTextComponent
in interactive mode with the specified header and footer text.boolean
print
(MessageFormat headerFormat, MessageFormat footerFormat, boolean showPrintDialog, PrintService service, PrintRequestAttributeSet attributes, boolean interactive) Prints the content of thisJTextComponent
.void
Initializes from a stream.void
removeCaretListener
(CaretListener listener) Removes a caret listener.static Keymap
removeKeymap
(String nm) Removes a named keymap previously added to the document.void
replaceSelection
(String content) Replaces the currently selected content with new content represented by the given string.protected void
Restores composed text previously saved bysaveComposedText
.protected boolean
saveComposedText
(int pos) Saves composed text around the specified position.void
select
(int selectionStart, int selectionEnd) Selects the text between the specified start and end positions.void
Selects all the text in theTextComponent
.void
Sets the caret to be used.void
Sets the current color used to render the caret.void
setCaretPosition
(int position) Sets the position of the text insertion caret for theTextComponent
.void
Sets the current color used to render the disabled text.void
setDocument
(Document doc) Associates the editor with a text document.void
setDragEnabled
(boolean b) Turns on or off automatic drag handling.final void
setDropMode
(DropMode dropMode) Sets the drop mode for this component.void
setEditable
(boolean b) Sets the specified boolean to indicate whether or not thisTextComponent
should be editable.void
setFocusAccelerator
(char aKey) Sets the key accelerator that will cause the receiving text component to get the focus.void
Sets the highlighter to be used.void
Sets the keymap to use for binding events to actions.void
Sets margin space between the text component's border and its text.void
setNavigationFilter
(NavigationFilter filter) Sets theNavigationFilter
.void
Sets the current color used to render the selected text.void
Sets the current color used to render the selection.void
setSelectionEnd
(int selectionEnd) Sets the selection end to the specified position.void
setSelectionStart
(int selectionStart) Sets the selection start to the specified position.void
Sets the text of thisTextComponent
to the specified text.void
Sets the user-interface factory for this text-oriented editor.void
updateUI()
Reloads the pluggable UI.int
viewToModel
(Point pt) Deprecated.replaced byJTextComponent.viewToModel2D(Point2D)
int
viewToModel2D
(Point2D pt) Converts the given place in the view coordinate system to the nearest representative location in the model.void
Stores the contents of the model into the given stream.Methods declared in class JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
Modifier and TypeMethodDescriptionvoid
addAncestorListener
(AncestorListener listener) Registerslistener
so that it will receiveAncestorEvents
when it or any of its ancestors move or are made visible or invisible.void
Notifies this component that it now has a parent component.void
Adds aVetoableChangeListener
to the listener list.void
computeVisibleRect
(Rectangle visibleRect) Returns theComponent
's "visible rect rectangle" - the intersection of the visible rectangles for this component and all of its ancestors.boolean
contains
(int x, int y) Gives the UI delegate an opportunity to define the precise shape of this component for the sake of mouse processing.Returns the instance ofJToolTip
that should be used to display the tooltip.void
disable()
Deprecated.As of JDK version 1.1, replaced byjava.awt.Component.setEnabled(boolean)
.void
enable()
Deprecated.As of JDK version 1.1, replaced byjava.awt.Component.setEnabled(boolean)
.void
firePropertyChange
(String propertyName, boolean oldValue, boolean newValue) Support for reporting bound property changes for boolean properties.void
firePropertyChange
(String propertyName, int oldValue, int newValue) Support for reporting bound property changes for integer properties.protected void
fireVetoableChange
(String propertyName, Object oldValue, Object newValue) Supports reporting constrained property changes.getActionForKeyStroke
(KeyStroke aKeyStroke) Returns the object that will perform the action registered for a given keystroke.final ActionMap
Returns theActionMap
used to determine whatAction
to fire for particularKeyStroke
binding.float
OverridesContainer.getAlignmentX
to return the horizontal alignment.float
OverridesContainer.getAlignmentY
to return the vertical alignment.Returns an array of all the ancestor listeners registered on this component.boolean
Gets theautoscrolls
property.int
getBaseline
(int width, int height) Returns the baseline.Returns an enum indicating how the baseline of the component changes as the size changes.Returns the border of this component ornull
if no border is currently set.Stores the bounds of this component into "return value"rv
and returnsrv
.final Object
getClientProperty
(Object key) Returns the value of the property with the specified key.protected Graphics
Returns the graphics object used to paint this component.ReturnsJPopupMenu
that assigned for this component.int
getConditionForKeyStroke
(KeyStroke aKeyStroke) Returns the condition that determines whether a registered action occurs in response to the specified keystroke.int
Returns the state of graphics debugging.static Locale
Returns the default locale used to initialize each JComponent's locale property upon creation.getFontMetrics
(Font font) Gets theFontMetrics
for the specifiedFont
.Returns this component's graphics context, which lets you draw on a component.int
Returns the current height of this component.boolean
Returns true if the JPopupMenu should be inherited from the parent.final InputMap
Returns theInputMap
that is used when the component has focus.final InputMap
getInputMap
(int condition) Returns theInputMap
that is used duringcondition
.Returns the input verifier for this component.If a border has been set on this component, returns the border's insets; otherwise callssuper.getInsets
.Returns anInsets
object containing this component's inset values.<T extends EventListener>
T[]getListeners
(Class<T> listenerType) Returns an array of all the objects currently registered asFooListener
s upon thisJComponent
.getLocation
(Point rv) Stores the x,y origin of this component into "return value"rv
and returnsrv
.If the maximum size has been set to a non-null
value just returns it.If the minimum size has been set to a non-null
value just returns it.Deprecated.As of 1.4, replaced byFocusTraversalPolicy
.getPopupLocation
(MouseEvent event) Returns the preferred location to display the popup menu in this component's coordinate system.Returns theKeyStrokes
that will initiate registered actions.Returns theJRootPane
ancestor for this component.Stores the width/height of this component into "return value"rv
and returnsrv
.getToolTipLocation
(MouseEvent event) Returns the tooltip location in this component's coordinate system.Returns the tooltip string that has been set withsetToolTipText
.Returns the top-level ancestor of this component (the containingWindow
) ornull
if this component has not been added to any container.Gets thetransferHandler
property.boolean
Returns the value that indicates whether the input verifier for the current focus owner will be called before this component requests focus.Returns an array of all the vetoable change listeners registered on this component.Returns theComponent
's "visible rectangle" - the intersection of this component's visible rectangle,new Rectangle(0, 0, getWidth(), getHeight())
, and all of its ancestors' visible rectangles.int
getWidth()
Returns the current width of this component.int
getX()
Returns the current x coordinate of the component's origin.int
getY()
Returns the current y coordinate of the component's origin.void
Requests that this Component get the input focus, and that this Component's top-level ancestor become the focused Window.void
hide()
Deprecated.boolean
Returns whether this component should use a buffer to paint.static boolean
Returns true if this component is lightweight, that is, if it doesn't have a native window system peer.boolean
Deprecated.As of 1.4, replaced byComponent.setFocusTraversalKeys(int, Set)
andContainer.setFocusCycleRoot(boolean)
.boolean
isOpaque()
Returns true if this component is completely opaque.boolean
Returns true if this component tiles its children -- that is, if it can guarantee that the children will not overlap.final boolean
Returnstrue
if the current painting operation on this component is part of aprint
operation.protected boolean
Returnstrue
if a paint triggered on a child component should cause painting to originate from this Component, or one of its ancestors.boolean
Returns true if the component is currently painting a tile.boolean
Returnstrue
if thisJComponent
should get focus; otherwise returnsfalse
.boolean
If this method returns true,revalidate
calls by descendants of this component will cause the entire tree beginning with this root to be validated.void
Invoked by Swing to draw components.protected void
Paints the component's border.protected void
Paints this component's children.protected void
Calls the UI delegate's paint method, if the UI delegate is non-null
.void
paintImmediately
(int x, int y, int w, int h) Paints the specified region in this component and all of its descendants that overlap the region, immediately.void
Paints the specified region now.void
Invoke this method to print the component to the specifiedGraphics
.void
Invoke this method to print the component.protected void
Prints the component's border.protected void
Prints this component's children.protected void
This is invoked during a printing operation.protected void
Processes any key events that the component itself recognizes.protected boolean
processKeyBinding
(KeyStroke ks, KeyEvent e, int condition, boolean pressed) Invoked to process the key bindings forks
as the result of theKeyEvent
e
.protected void
OverridesprocessKeyEvent
to process events.protected void
Processes mouse events occurring on this component by dispatching them to any registeredMouseListener
objects, refer toComponent.processMouseEvent(MouseEvent)
for a complete description of this method.protected void
Processes mouse motion events, such as MouseEvent.MOUSE_DRAGGED.final void
putClientProperty
(Object key, Object value) Adds an arbitrary key/value "client property" to this component.void
registerKeyboardAction
(ActionListener anAction, String aCommand, KeyStroke aKeyStroke, int aCondition) This method is now obsolete, please use a combination ofgetActionMap()
andgetInputMap()
for similar behavior.void
registerKeyboardAction
(ActionListener anAction, KeyStroke aKeyStroke, int aCondition) This method is now obsolete, please use a combination ofgetActionMap()
andgetInputMap()
for similar behavior.void
removeAncestorListener
(AncestorListener listener) Unregisterslistener
so that it will no longer receiveAncestorEvents
.void
Notifies this component that it no longer has a parent component.void
Removes aVetoableChangeListener
from the listener list.void
repaint
(long tm, int x, int y, int width, int height) Adds the specified region to the dirty region list if the component is showing.void
Adds the specified region to the dirty region list if the component is showing.boolean
Deprecated.As of 1.4, replaced byFocusTraversalPolicy.getDefaultComponent(Container).requestFocus()
void
Requests that thisComponent
gets the input focus.boolean
requestFocus
(boolean temporary) Requests that thisComponent
gets the input focus.boolean
Requests that thisComponent
gets the input focus.protected boolean
requestFocusInWindow
(boolean temporary) Requests that thisComponent
gets the input focus.void
Unregisters all the bindings in the first tierInputMaps
andActionMap
.void
reshape
(int x, int y, int w, int h) Deprecated.As of JDK 5, replaced byComponent.setBounds(int, int, int, int)
.void
Supports deferred automatic layout.void
scrollRectToVisible
(Rectangle aRect) Forwards thescrollRectToVisible()
message to theJComponent
's parent.final void
Sets theActionMap
toam
.void
setAlignmentX
(float alignmentX) Sets the horizontal alignment.void
setAlignmentY
(float alignmentY) Sets the vertical alignment.void
setAutoscrolls
(boolean autoscrolls) Sets theautoscrolls
property.void
setBackground
(Color bg) Sets the background color of this component.void
Sets the border of this component.void
setComponentPopupMenu
(JPopupMenu popup) Sets theJPopupMenu
for thisJComponent
.void
setDebugGraphicsOptions
(int debugOptions) Enables or disables diagnostic information about every graphics operation performed within the component or one of its children.static void
Sets the default locale used to initialize each JComponent's locale property upon creation.void
setDoubleBuffered
(boolean aFlag) Sets whether this component should use a buffer to paint.void
setEnabled
(boolean enabled) Sets whether or not this component is enabled.void
setFocusTraversalKeys
(int id, Set<? extends AWTKeyStroke> keystrokes) Sets the focus traversal keys for a given traversal operation for this Component.void
setForeground
(Color fg) Sets the foreground color of this component.void
setInheritsPopupMenu
(boolean value) Sets whether or notgetComponentPopupMenu
should delegate to the parent if this component does not have aJPopupMenu
assigned to it.final void
setInputMap
(int condition, InputMap map) Sets theInputMap
to use under the conditioncondition
tomap
.void
setInputVerifier
(InputVerifier inputVerifier) Sets the input verifier for this component.void
setMaximumSize
(Dimension maximumSize) Sets the maximum size of this component to a constant value.void
setMinimumSize
(Dimension minimumSize) Sets the minimum size of this component to a constant value.void
setNextFocusableComponent
(Component aComponent) Deprecated.As of 1.4, replaced byFocusTraversalPolicy
void
setOpaque
(boolean isOpaque) If true the component paints every pixel within its bounds.void
setPreferredSize
(Dimension preferredSize) Sets the preferred size of this component.void
setRequestFocusEnabled
(boolean requestFocusEnabled) Provides a hint as to whether or not thisJComponent
should get focus.void
setToolTipText
(String text) Registers the text to display in a tool tip.void
setTransferHandler
(TransferHandler newHandler) Sets theTransferHandler
, which provides support for transfer of data into and out of this component via cut/copy/paste and drag and drop.protected void
setUI
(ComponentUI newUI) Sets the look and feel delegate for this component.void
setVerifyInputWhenFocusTarget
(boolean verifyInputWhenFocusTarget) Sets the value to indicate whether input verifier for the current focus owner will be called before this component requests focus.void
setVisible
(boolean aFlag) Makes the component visible or invisible.void
unregisterKeyboardAction
(KeyStroke aKeyStroke) This method is now obsolete.void
Callspaint
.Methods declared in class Container
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree
Modifier and TypeMethodDescriptionAppends the specified component to the end of this container.Adds the specified component to this container at the given position.void
Adds the specified component to the end of this container.void
Adds the specified component to this container with the specified constraints at the specified index.Adds the specified component to this container.void
Adds the specified container listener to receive container events from this container.protected void
Adds the specified component to this container at the specified index.void
Adds a PropertyChangeListener to the listener list.void
addPropertyChangeListener
(String propertyName, PropertyChangeListener listener) Adds a PropertyChangeListener to the listener list for a specific property.void
Sets theComponentOrientation
property of this container and all components contained within it.boolean
areFocusTraversalKeysSet
(int id) Returns whether the Set of focus traversal keys for the given focus traversal operation has been explicitly defined for this Container.int
Deprecated.As of JDK version 1.1, replaced by getComponentCount().void
Deprecated.As of JDK version 1.1, replaced bydispatchEvent(AWTEvent e)
void
doLayout()
Causes this container to lay out its components.findComponentAt
(int x, int y) Locates the visible child component that contains the specified position.Locates the visible child component that contains the specified point.getComponent
(int n) Gets the nth component in this container.getComponentAt
(int x, int y) Locates the component that contains the x,y position.Gets the component that contains the specified point.int
Gets the number of components in this panel.Gets all the components in this container.int
getComponentZOrder
(Component comp) Returns the z-order index of the component inside the container.Returns an array of all the container listeners registered on this container.getFocusTraversalKeys
(int id) Returns the Set of focus traversal keys for a given traversal operation for this Container.Returns the focus traversal policy that will manage keyboard traversal of this Container's children, or null if this Container is not a focus cycle root.Gets the layout manager for this container.getMousePosition
(boolean allowChildren) Returns the position of the mouse pointer in thisContainer
's coordinate space if theContainer
is under the mouse pointer, otherwise returnsnull
.insets()
Deprecated.As of JDK version 1.1, replaced bygetInsets()
.void
Invalidates the container.boolean
Checks if the component is contained in the component hierarchy of this container.boolean
Returns whether this Container is the root of a focus traversal cycle.boolean
isFocusCycleRoot
(Container container) Returns whether the specified Container is the focus cycle root of this Container's focus traversal cycle.final boolean
Returns whether this container provides focus traversal policy.boolean
Returns whether the focus traversal policy has been explicitly set for this Container.void
layout()
Deprecated.As of JDK version 1.1, replaced bydoLayout()
.void
list
(PrintStream out, int indent) Prints a listing of this container to the specified output stream.void
list
(PrintWriter out, int indent) Prints out a list, starting at the specified indentation, to the specified print writer.locate
(int x, int y) Deprecated.As of JDK version 1.1, replaced bygetComponentAt(int, int)
.Deprecated.As of JDK version 1.1, replaced bygetMinimumSize()
.void
Paints each of the components in this container.Deprecated.As of JDK version 1.1, replaced bygetPreferredSize()
.void
Prints each of the components in this container.protected void
Processes container events occurring on this container by dispatching them to any registered ContainerListener objects.protected void
Processes events on this container.void
remove
(int index) Removes the component, specified byindex
, from this container.void
Removes the specified component from this container.void
Removes all the components from this container.void
Removes the specified container listener so it no longer receives container events from this container.void
setComponentZOrder
(Component comp, int index) Moves the specified component to the specified z-order index in the container.void
setFocusCycleRoot
(boolean focusCycleRoot) Sets whether this Container is the root of a focus traversal cycle.void
Sets the focus traversal policy that will manage keyboard traversal of this Container's children, if this Container is a focus cycle root.final void
setFocusTraversalPolicyProvider
(boolean provider) Sets whether this container will be used to provide focus traversal policy.void
setLayout
(LayoutManager mgr) Sets the layout manager for this container.void
Transfers the focus down one focus traversal cycle.void
validate()
Validates this container and all of its subcomponents.protected void
Recursively descends the container tree and recomputes the layout for any subtrees marked as needing it (those marked as invalid).Methods declared in class Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
Modifier and TypeMethodDescriptionboolean
Deprecated.As of JDK version 1.1, should register this component as ActionListener on component which fires action events.void
Adds the specified popup menu to the component.void
Adds the specified component listener to receive component events from this component.void
Adds the specified focus listener to receive focus events from this component when this component gains input focus.void
Adds the specified hierarchy bounds listener to receive hierarchy bounds events from this component when the hierarchy to which this container belongs changes.void
Adds the specified hierarchy listener to receive hierarchy changed events from this component when the hierarchy to which this container belongs changes.void
Adds the specified input method listener to receive input method events from this component.void
Adds the specified key listener to receive key events from this component.void
Adds the specified mouse listener to receive mouse events from this component.void
Adds the specified mouse motion listener to receive mouse motion events from this component.void
Adds the specified mouse wheel listener to receive mouse wheel events from this component.bounds()
Deprecated.As of JDK version 1.1, replaced bygetBounds()
.int
checkImage
(Image image, int width, int height, ImageObserver observer) Returns the status of the construction of a screen representation of the specified image.int
checkImage
(Image image, ImageObserver observer) Returns the status of the construction of a screen representation of the specified image.protected AWTEvent
coalesceEvents
(AWTEvent existingEvent, AWTEvent newEvent) Potentially coalesce an event being posted with an existing event.boolean
Checks whether this component "contains" the specified point, where the point's x and y coordinates are defined to be relative to the coordinate system of this component.createImage
(int width, int height) Creates an off-screen drawable image to be used for double buffering.createImage
(ImageProducer producer) Creates an image from the specified image producer.createVolatileImage
(int width, int height) Creates a volatile off-screen drawable image to be used for double buffering.createVolatileImage
(int width, int height, ImageCapabilities caps) Creates a volatile off-screen drawable image, with the given capabilities.protected final void
disableEvents
(long eventsToDisable) Disables the events defined by the specified event mask parameter from being delivered to this component.final void
Dispatches an event to this component or one of its sub components.void
enable
(boolean b) Deprecated.As of JDK version 1.1, replaced bysetEnabled(boolean)
.protected final void
enableEvents
(long eventsToEnable) Enables the events defined by the specified event mask parameter to be delivered to this component.void
enableInputMethods
(boolean enable) Enables or disables input method support for this component.void
firePropertyChange
(String propertyName, byte oldValue, byte newValue) Reports a bound property change.void
firePropertyChange
(String propertyName, char oldValue, char newValue) Reports a bound property change.void
firePropertyChange
(String propertyName, double oldValue, double newValue) Reports a bound property change.void
firePropertyChange
(String propertyName, float oldValue, float newValue) Reports a bound property change.void
firePropertyChange
(String propertyName, long oldValue, long newValue) Reports a bound property change.void
firePropertyChange
(String propertyName, short oldValue, short newValue) Reports a bound property change.protected void
firePropertyChange
(String propertyName, Object oldValue, Object newValue) Support for reporting bound property changes for Object properties.Gets the background color of this component.Gets the bounds of this component in the form of aRectangle
object.Gets the instance ofColorModel
used to display the component on the output device.Returns an array of all the component listeners registered on this component.Retrieves the language-sensitive orientation that is to be used to order the elements or text within this component.Gets the cursor set in the component.Gets theDropTarget
associated with thisComponent
.Returns the Container which is the focus cycle root of this Component's focus traversal cycle.Returns an array of all the focus listeners registered on this component.boolean
Returns whether focus traversal keys are enabled for this Component.getFont()
Gets the font of this component.Gets the foreground color of this component.Gets theGraphicsConfiguration
associated with thisComponent
.Returns an array of all the hierarchy bounds listeners registered on this component.Returns an array of all the hierarchy listeners registered on this component.boolean
Returns whether or not paint messages received from the operating system should be ignored.Gets the input context used by this component for handling the communication with input methods when text is entered in this component.Returns an array of all the input method listeners registered on this component.Returns an array of all the key listeners registered on this component.Gets the locale of this component.Gets the location of this component in the form of a point specifying the component's top-left corner.Gets the location of this component in the form of a point specifying the component's top-left corner in the screen's coordinate space.Returns an array of all the mouse listeners registered on this component.Returns an array of all the mouse motion listeners registered on this component.Returns the position of the mouse pointer in thisComponent
's coordinate space if theComponent
is directly under the mouse pointer, otherwise returnsnull
.Returns an array of all the mouse wheel listeners registered on this component.getName()
Gets the name of the component.Gets the parent of this component.Returns an array of all the property change listeners registered on this component.getPropertyChangeListeners
(String propertyName) Returns an array of all the listeners which have been associated with the named property.getSize()
Returns the size of this component in the form of aDimension
object.Gets the toolkit of this component.final Object
Gets this component's locking object (the object that owns the thread synchronization monitor) for AWT component-tree and layout operations.boolean
Deprecated.As of JDK version 1.1, replaced by processFocusEvent(FocusEvent).boolean
handleEvent
(Event evt) Deprecated.As of JDK version 1.1 replaced by processEvent(AWTEvent).boolean
hasFocus()
Returnstrue
if thisComponent
is the focus owner.boolean
imageUpdate
(Image img, int infoflags, int x, int y, int w, int h) Repaints the component when the image has changed.boolean
inside
(int x, int y) Deprecated.As of JDK version 1.1, replaced by contains(int, int).boolean
Returns whether the background color has been explicitly set for this Component.boolean
Returns whether the cursor has been explicitly set for this Component.boolean
Determines whether this component is displayable.boolean
Determines whether this component is enabled.boolean
Returns whether this Component can be focused.boolean
Returnstrue
if thisComponent
is the focus owner.boolean
Deprecated.As of 1.4, replaced byisFocusable()
.boolean
Returns whether the font has been explicitly set for this Component.boolean
Returns whether the foreground color has been explicitly set for this Component.boolean
A lightweight component doesn't have a native toolkit peer.boolean
Returns true if the maximum size has been set to a non-null
value otherwise returns false.boolean
Returns whether or notsetMinimumSize
has been invoked with a non-null value.boolean
Returns true if the preferred size has been set to a non-null
value otherwise returns false.boolean
Determines whether this component is showing on screen.boolean
isValid()
Determines whether this component is valid.boolean
Determines whether this component should be visible when its parent is visible.boolean
Deprecated.As of JDK version 1.1, replaced by processKeyEvent(KeyEvent).boolean
Deprecated.As of JDK version 1.1, replaced by processKeyEvent(KeyEvent).void
list()
Prints a listing of this component to the standard system output streamSystem.out
.void
list
(PrintStream out) Prints a listing of this component to the specified output stream.void
list
(PrintWriter out) Prints a listing to the specified print writer.location()
Deprecated.As of JDK version 1.1, replaced bygetLocation()
.boolean
Deprecated.As of JDK version 1.1, replaced by processFocusEvent(FocusEvent).boolean
Deprecated.As of JDK version 1.1, replaced by processMouseEvent(MouseEvent).boolean
Deprecated.As of JDK version 1.1, replaced by processMouseMotionEvent(MouseEvent).boolean
mouseEnter
(Event evt, int x, int y) Deprecated.As of JDK version 1.1, replaced by processMouseEvent(MouseEvent).boolean
Deprecated.As of JDK version 1.1, replaced by processMouseEvent(MouseEvent).boolean
Deprecated.As of JDK version 1.1, replaced by processMouseMotionEvent(MouseEvent).boolean
Deprecated.As of JDK version 1.1, replaced by processMouseEvent(MouseEvent).void
move
(int x, int y) Deprecated.As of JDK version 1.1, replaced bysetLocation(int, int)
.void
Deprecated.As of JDK version 1.1, replaced by transferFocus().void
Paints this component and all of its subcomponents.boolean
Deprecated.As of JDK version 1.1, replaced by dispatchEvent(AWTEvent).boolean
prepareImage
(Image image, int width, int height, ImageObserver observer) Prepares an image for rendering on this component at the specified width and height.boolean
prepareImage
(Image image, ImageObserver observer) Prepares an image for rendering on this component.protected void
Processes component events occurring on this component by dispatching them to any registeredComponentListener
objects.protected void
Processes focus events occurring on this component by dispatching them to any registeredFocusListener
objects.protected void
Processes hierarchy bounds events occurring on this component by dispatching them to any registeredHierarchyBoundsListener
objects.protected void
Processes hierarchy events occurring on this component by dispatching them to any registeredHierarchyListener
objects.protected void
Processes input method events occurring on this component by dispatching them to any registeredInputMethodListener
objects.protected void
Processes mouse wheel events occurring on this component by dispatching them to any registeredMouseWheelListener
objects.void
remove
(MenuComponent popup) Removes the specified popup menu from the component.void
Removes the specified component listener so that it no longer receives component events from this component.void
Removes the specified focus listener so that it no longer receives focus events from this component.void
Removes the specified hierarchy bounds listener so that it no longer receives hierarchy bounds events from this component.void
Removes the specified hierarchy listener so that it no longer receives hierarchy changed events from this component.void
Removes the specified input method listener so that it no longer receives input method events from this component.void
Removes the specified key listener so that it no longer receives key events from this component.void
Removes the specified mouse listener so that it no longer receives mouse events from this component.void
Removes the specified mouse motion listener so that it no longer receives mouse motion events from this component.void
Removes the specified mouse wheel listener so that it no longer receives mouse wheel events from this component.void
Removes a PropertyChangeListener from the listener list.void
removePropertyChangeListener
(String propertyName, PropertyChangeListener listener) Removes aPropertyChangeListener
from the listener list for a specific property.void
repaint()
Repaints this component.void
repaint
(int x, int y, int width, int height) Repaints the specified rectangle of this component.void
repaint
(long tm) Repaints the component.protected boolean
requestFocus
(boolean temporary, FocusEvent.Cause cause) Requests by the reason ofcause
that thisComponent
get the input focus, and that thisComponent
's top-level ancestor become the focusedWindow
.void
requestFocus
(FocusEvent.Cause cause) Requests by the reason ofcause
that this Component get the input focus, and that this Component's top-level ancestor become the focused Window.boolean
Requests by the reason ofcause
that this Component get the input focus, if this Component's top-level ancestor is already the focused Window.void
resize
(int width, int height) Deprecated.As of JDK version 1.1, replaced bysetSize(int, int)
.void
Deprecated.As of JDK version 1.1, replaced bysetSize(Dimension)
.void
setBounds
(int x, int y, int width, int height) Moves and resizes this component.void
Moves and resizes this component to conform to the new bounding rectangler
.void
Sets the language-sensitive orientation that is to be used to order the elements or text within this component.void
Sets the cursor image to the specified cursor.void
Associate aDropTarget
with this component.void
setFocusable
(boolean focusable) Sets the focusable state of this Component to the specified value.void
setFocusTraversalKeysEnabled
(boolean focusTraversalKeysEnabled) Sets whether focus traversal keys are enabled for this Component.void
setIgnoreRepaint
(boolean ignoreRepaint) Sets whether or not paint messages received from the operating system should be ignored.void
Sets the locale of this component.void
setLocation
(int x, int y) Moves this component to a new location.void
setLocation
(Point p) Moves this component to a new location.void
setMixingCutoutShape
(Shape shape) Sets a 'mixing-cutout' shape for this lightweight component.void
Sets the name of the component to the specified string.void
setSize
(int width, int height) Resizes this component so that it has widthwidth
and heightheight
.void
Resizes this component so that it has widthd.width
and heightd.height
.void
show()
Deprecated.As of JDK version 1.1, replaced bysetVisible(boolean)
.void
show
(boolean b) Deprecated.As of JDK version 1.1, replaced bysetVisible(boolean)
.size()
Deprecated.As of JDK version 1.1, replaced bygetSize()
.toString()
Returns a string representation of this component and its values.void
Transfers the focus to the next component, as though this Component were the focus owner.void
Transfers the focus to the previous component, as though this Component were the focus owner.void
Transfers the focus up one focus traversal cycle.Methods declared in class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Modifier and TypeMethodDescriptionprotected Object
clone()
Creates and returns a copy of this object.boolean
Indicates whether some other object is "equal to" this one.protected void
finalize()
Deprecated, for removal: This API element is subject to removal in a future version.Finalization is deprecated and subject to removal in a future release.final Class
<?> getClass()
Returns the runtime class of thisObject
.int
hashCode()
Returns a hash code value for this object.final void
notify()
Wakes up a single thread that is waiting on this object's monitor.final void
Wakes up all threads that are waiting on this object's monitor.final void
wait()
Causes the current thread to wait until it is awakened, typically by being notified or interrupted.final void
wait
(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.final void
wait
(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
-
Constructor Details
-
JTextArea
public JTextArea()Constructs a new TextArea. A default model is set, the initial string is null, and rows/columns are set to 0. -
JTextArea
Constructs a new TextArea with the specified text displayed. A default model is created and rows/columns are set to 0.- Parameters:
text
- the text to be displayed, or null
-
JTextArea
public JTextArea(int rows, int columns) Constructs a new empty TextArea with the specified number of rows and columns. A default model is created, and the initial string is null.- Parameters:
rows
- the number of rows >= 0columns
- the number of columns >= 0- Throws:
IllegalArgumentException
- if the rows or columns arguments are negative.
-
JTextArea
Constructs a new TextArea with the specified text and number of rows and columns. A default model is created.- Parameters:
text
- the text to be displayed, or nullrows
- the number of rows >= 0columns
- the number of columns >= 0- Throws:
IllegalArgumentException
- if the rows or columns arguments are negative.
-
JTextArea
Constructs a new JTextArea with the given document model, and defaults for all of the other arguments (null, 0, 0).- Parameters:
doc
- the model to use
-
JTextArea
Constructs a new JTextArea with the specified number of rows and columns, and the given model. All of the constructors feed through this constructor.- Parameters:
doc
- the model to use, or create a default one if nulltext
- the text to be displayed, null if nonerows
- the number of rows >= 0columns
- the number of columns >= 0- Throws:
IllegalArgumentException
- if the rows or columns arguments are negative.
-
-
Method Details
-
getUIClassID
Returns the class ID for the UI.- Overrides:
getUIClassID
in classJComponent
- Returns:
- the string "TextAreaUI"
- See Also:
-
createDefaultModel
Creates the default implementation of the model to be used at construction if one isn't explicitly given. A new instance of PlainDocument is returned.- Returns:
- the default document model
-
setTabSize
@BeanProperty(preferred=true, description="the number of characters to expand tabs to") public void setTabSize(int size) Sets the number of characters to expand tabs to. This will be multiplied by the maximum advance for variable width fonts. A PropertyChange event ("tabSize") is fired when the tab size changes.- Parameters:
size
- number of characters to expand to- See Also:
-
getTabSize
public int getTabSize()Gets the number of characters used to expand tabs. If the document is null or doesn't have a tab setting, return a default of 8.- Returns:
- the number of characters
-
setLineWrap
@BeanProperty(preferred=true, description="should lines be wrapped") public void setLineWrap(boolean wrap) Sets the line-wrapping policy of the text area. If set to true the lines will be wrapped if they are too long to fit within the allocated width. If set to false, the lines will always be unwrapped. APropertyChange
event ("lineWrap") is fired when the policy is changed. By default this property is false.- Parameters:
wrap
- indicates if lines should be wrapped- See Also:
-
getLineWrap
public boolean getLineWrap()Gets the line-wrapping policy of the text area. If set totrue
the lines will be wrapped if they are too long to fit within the allocated width. If set tofalse
, the lines will always be unwrapped.- Returns:
true
if lines will be wrapped, otherwisefalse
-
setWrapStyleWord
@BeanProperty(description="should wrapping occur at word boundaries") public void setWrapStyleWord(boolean word) Sets the style of wrapping used if the text area is wrapping lines. If set to true the lines will be wrapped at word boundaries (whitespace) if they are too long to fit within the allocated width. If set to false, the lines will be wrapped at character boundaries. By default this property is false.- Parameters:
word
- indicates if word boundaries should be used for line wrapping- See Also:
-
getWrapStyleWord
public boolean getWrapStyleWord()Gets the style of wrapping used if the text area is wrapping lines. If set totrue
the lines will be wrapped at word boundaries (ie whitespace) if they are too long to fit within the allocated width. If set tofalse
, the lines will be wrapped at character boundaries.- Returns:
true
if the wrap style should be word boundaries instead of character boundaries, otherwisefalse
- See Also:
-
getLineOfOffset
Translates an offset into the components text to a line number.- Parameters:
offset
- the offset >= 0- Returns:
- the line number >= 0
- Throws:
BadLocationException
- thrown if the offset is less than zero or greater than the document length.
-
getLineCount
Determines the number of lines contained in the area.- Returns:
- the number of lines > 0
-
getLineStartOffset
Determines the offset of the start of the given line.- Parameters:
line
- the line number to translate >= 0- Returns:
- the offset >= 0
- Throws:
BadLocationException
- thrown if the line is less than zero or greater or equal to the number of lines contained in the document (as reported by getLineCount).
-
getLineEndOffset
Determines the offset of the end of the given line.- Parameters:
line
- the line >= 0- Returns:
- the offset >= 0
- Throws:
BadLocationException
- Thrown if the line is less than zero or greater or equal to the number of lines contained in the document (as reported by getLineCount).
-
insert
Inserts the specified text at the specified position. Does nothing if the model is null or if the text is null or empty.- Parameters:
str
- the text to insertpos
- the position at which to insert >= 0- Throws:
IllegalArgumentException
- if pos is an invalid position in the model- See Also:
-
append
Appends the given text to the end of the document. Does nothing if the model is null or the string is null or empty.- Parameters:
str
- the text to insert- See Also:
-
replaceRange
Replaces text from the indicated start to end position with the new text specified. Does nothing if the model is null. Simply does a delete if the new string is null or empty.- Parameters:
str
- the text to use as the replacementstart
- the start position >= 0end
- the end position >= start- Throws:
IllegalArgumentException
- if part of the range is an invalid position in the model- See Also:
-
getRows
public int getRows()Returns the number of rows in the TextArea.- Returns:
- the number of rows >= 0
-
setRows
@BeanProperty(bound=false, description="the number of rows preferred for display") public void setRows(int rows) Sets the number of rows for this TextArea. Calls invalidate() after setting the new value.- Parameters:
rows
- the number of rows >= 0- Throws:
IllegalArgumentException
- if rows is less than 0- See Also:
-
getRowHeight
protected int getRowHeight()Defines the meaning of the height of a row. This defaults to the height of the font.- Returns:
- the height >= 1
-
getColumns
public int getColumns()Returns the number of columns in the TextArea.- Returns:
- number of columns >= 0
-
setColumns
@BeanProperty(bound=false, description="the number of columns preferred for display") public void setColumns(int columns) Sets the number of columns for this TextArea. Does an invalidate() after setting the new value.- Parameters:
columns
- the number of columns >= 0- Throws:
IllegalArgumentException
- if columns is less than 0- See Also:
-
getColumnWidth
protected int getColumnWidth()Gets column width. The meaning of what a column is can be considered a fairly weak notion for some fonts. This method is used to define the width of a column. By default this is defined to be the width of the character m for the font used. This method can be redefined to be some alternative amount.- Returns:
- the column width >= 1
-
getPreferredSize
Returns the preferred size of the TextArea. This is the maximum of the size needed to display the text and the size requested for the viewport.- Overrides:
getPreferredSize
in classJComponent
- Returns:
- the size
- See Also:
-
setFont
Sets the current font. This removes cached row height and column width so the new font will be reflected, and calls revalidate().- Overrides:
setFont
in classJComponent
- Parameters:
f
- the font to use as the current font- See Also:
-
paramString
Returns a string representation of this JTextArea. 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 classJTextComponent
- Returns:
- a string representation of this JTextArea.
-
getScrollableTracksViewportWidth
Returns true if a viewport should always force the width of this Scrollable to match the width of the viewport. This is implemented to return true if the line wrapping policy is true, and false if lines are not being wrapped.- Specified by:
getScrollableTracksViewportWidth
in interfaceScrollable
- Overrides:
getScrollableTracksViewportWidth
in classJTextComponent
- Returns:
- true if a viewport should force the Scrollables width to match its own.
-
getPreferredScrollableViewportSize
Returns the preferred size of the viewport if this component is embedded in a JScrollPane. This uses the desired column and row settings if they have been set, otherwise the superclass behavior is used.- Specified by:
getPreferredScrollableViewportSize
in interfaceScrollable
- Overrides:
getPreferredScrollableViewportSize
in classJTextComponent
- Returns:
- The preferredSize of a JViewport whose view is this Scrollable.
- See Also:
-
getScrollableUnitIncrement
Components that display logical rows or columns should compute the scroll increment that will completely expose one new row or column, depending on the value of orientation. This is implemented to use the values returned by thegetRowHeight
andgetColumnWidth
methods.Scrolling containers, like JScrollPane, will use this method each time the user requests a unit scroll.
- Specified by:
getScrollableUnitIncrement
in interfaceScrollable
- Overrides:
getScrollableUnitIncrement
in classJTextComponent
- Parameters:
visibleRect
- the view area visible within the viewportorientation
- Either SwingConstants.VERTICAL or SwingConstants.HORIZONTAL.direction
- Less than zero to scroll up/left, greater than zero for down/right.- Returns:
- The "unit" increment for scrolling in the specified direction
- Throws:
IllegalArgumentException
- for an invalid orientation- See Also:
-
getAccessibleContext
Gets the AccessibleContext associated with this JTextArea. For JTextAreas, the AccessibleContext takes the form of an AccessibleJTextArea. A new AccessibleJTextArea instance is created if necessary.- Specified by:
getAccessibleContext
in interfaceAccessible
- Overrides:
getAccessibleContext
in classJTextComponent
- Returns:
- an AccessibleJTextArea that serves as the AccessibleContext of this JTextArea
-
JTextComponent.modelToView2D(int)