TextArea

java.lang.Object
- Region
- - javafx.scene.control.Control
  - - javafx.scene.control.TextInputControl
    - - javafx.scene.control.TextArea

All Implemented Interfaces:

Skinnable
```
public class TextArea
extends TextInputControl
```
Text input component that allows a user to enter multiple lines of plain text. Unlike in previous releases of JavaFX, support for single line input is not available as part of the TextArea control, however this is the sole-purpose of the TextField control. Additionally, if you want a form of rich-text editing, there is also the HTMLEditor control.
TextArea supports the notion of showing prompt text to the user when there is no text already in the TextArea (either via the user, or set programmatically). This is a useful way of informing the user as to what is expected in the text area, without having to resort to tooltips or on-screen labels.

Since:

JavaFX 2.0

See Also:

TextField

Property Summary

All Methods Instance Methods Concrete Methods
Type	Property and Description
`IntegerProperty`	`prefColumnCount` The preferred number of text columns.
`IntegerProperty`	`prefRowCount` The preferred number of text rows.
`DoubleProperty`	`scrollLeft` The number of pixels by which the content is horizontally scrolled.
`DoubleProperty`	`scrollTop` The number of pixels by which the content is vertically scrolled.
`BooleanProperty`	`wrapText` If a run of text exceeds the width of the `TextArea`, then this variable indicates whether the text should wrap onto another line.

Properties inherited from class javafx.scene.control.TextInputControl
anchorProperty, caretPositionProperty, editableProperty, fontProperty, lengthProperty, promptTextProperty, redoableProperty, selectedTextProperty, selectionProperty, textFormatterProperty, textProperty, undoableProperty

Properties inherited from class javafx.scene.control.Control
contextMenuProperty, skinClassNameProperty, skinProperty, tooltipProperty

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private static class`	`TextArea.ParagraphList`
`private static class`	`TextArea.ParagraphListChange`
`private static class`	`TextArea.StyleableProperties` * Stylesheet Handling * *
`private static class`	`TextArea.TextAreaContent`

Nested classes/interfaces inherited from class javafx.scene.control.TextInputControl
TextInputControl.Content, TextInputControl.UndoRedoChange

Field Summary

Fields
Modifier and Type	Field and Description
`private static int`	`DEFAULT_PARAGRAPH_CAPACITY`
`static int`	`DEFAULT_PREF_COLUMN_COUNT` The default value for `prefColumnCount`.
`static int`	`DEFAULT_PREF_ROW_COUNT` The default value for `prefRowCount`.
`private IntegerProperty`	`prefColumnCount` The preferred number of text columns.
`private IntegerProperty`	`prefRowCount` The preferred number of text rows.
`private DoubleProperty`	`scrollLeft` The number of pixels by which the content is horizontally scrolled.
`private DoubleProperty`	`scrollTop` The number of pixels by which the content is vertically scrolled.
`private BooleanProperty`	`wrapText` If a run of text exceeds the width of the `TextArea`, then this variable indicates whether the text should wrap onto another line.

Constructor Summary

Constructors
Constructor and Description

TextArea()
Creates a TextArea with empty text content.

TextArea(java.lang.String text)
Creates a TextArea with initial text content.

Constructors
Constructor and Description
`TextArea()` Creates a `TextArea` with empty text content.
`TextArea(java.lang.String text)` Creates a `TextArea` with initial text content.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected Skin<?>`	`createDefaultSkin()` Create a new instance of the default skin for this control.
`static java.util.List<<any>>`	`getClassCssMetaData()`
`java.util.List<<any>>`	`getControlCssMetaData()`
`<any>`	`getParagraphs()` Returns an unmodifiable list of the character sequences that back the text area's content.
`int`	`getPrefColumnCount()` Gets the value of the property prefColumnCount.
`int`	`getPrefRowCount()` Gets the value of the property prefRowCount.
`double`	`getScrollLeft()` Gets the value of the property scrollLeft.
`double`	`getScrollTop()` Gets the value of the property scrollTop.
`boolean`	`isWrapText()` Gets the value of the property wrapText.
`IntegerProperty`	`prefColumnCountProperty()` The preferred number of text columns.
`IntegerProperty`	`prefRowCountProperty()` The preferred number of text rows.
`DoubleProperty`	`scrollLeftProperty()` The number of pixels by which the content is horizontally scrolled.
`DoubleProperty`	`scrollTopProperty()` The number of pixels by which the content is vertically scrolled.
`void`	`setPrefColumnCount(int value)` Sets the value of the property prefColumnCount.
`void`	`setPrefRowCount(int value)` Sets the value of the property prefRowCount.
`void`	`setScrollLeft(double value)` Sets the value of the property scrollLeft.
`void`	`setScrollTop(double value)` Sets the value of the property scrollTop.
`void`	`setWrapText(boolean value)` Sets the value of the property wrapText.
`(package private) void`	`textUpdated()`
`BooleanProperty`	`wrapTextProperty()` If a run of text exceeds the width of the `TextArea`, then this variable indicates whether the text should wrap onto another line.

Methods inherited from class javafx.scene.control.TextInputControl
anchorProperty, appendText, backward, cancelEdit, caretPositionProperty, clear, commitValue, containsInvalidCharacters, copy, cut, deleteNextChar, deletePreviousChar, deleteText, deleteText, deselect, editableProperty, end, endOfNextWord, executeAccessibleAction, extendSelection, filterInput, fontProperty, forward, getAnchor, getCaretPosition, getContent, getFont, getLength, getPromptText, getSelectedText, getSelection, getText, getText, getTextFormatter, home, insertText, isEditable, isRedoable, isUndoable, lengthProperty, nextWord, paste, positionCaret, previousWord, promptTextProperty, queryAccessibleAttribute, redo, redoableProperty, replaceSelection, replaceText, replaceText, selectAll, selectBackward, selectedTextProperty, selectEnd, selectEndOfNextWord, selectForward, selectHome, selectionProperty, selectNextWord, selectPositionCaret, selectPreviousWord, selectRange, setEditable, setFont, setPromptText, setText, setTextFormatter, textFormatterProperty, textProperty, undo, undoableProperty

Methods inherited from class javafx.scene.control.Control
computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, getBaselineOffset, getContextMenu, getControlChildren, getCssMetaData, getInitialFocusTraversable, getSkin, getTooltip, isResizable, layoutChildren, loadSkinClass, setContextMenu, setSkin, setTooltip, skinClassNameProperty, skinProperty, tooltipProperty

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Property Detail
  - wrapText
```
public final BooleanProperty wrapTextProperty
```
    If a run of text exceeds the width of the TextArea, then this variable indicates whether the text should wrap onto another line.
    
    See Also:
    
    isWrapText(), setWrapText(boolean)
  - prefColumnCount
```
public final IntegerProperty prefColumnCountProperty
```
    The preferred number of text columns. This is used for calculating the TextArea's preferred width.
    
    See Also:
    
    getPrefColumnCount(), setPrefColumnCount(int)
  - prefRowCount
```
public final IntegerProperty prefRowCountProperty
```
    The preferred number of text rows. This is used for calculating the TextArea's preferred height.
    
    See Also:
    
    getPrefRowCount(), setPrefRowCount(int)
  - scrollTop
```
public final DoubleProperty scrollTopProperty
```
    The number of pixels by which the content is vertically scrolled.
    
    See Also:
    
    getScrollTop(), setScrollTop(double)
  - scrollLeft
```
public final DoubleProperty scrollLeftProperty
```
    The number of pixels by which the content is horizontally scrolled.
    
    See Also:
    
    getScrollLeft(), setScrollLeft(double)
- Field Detail
  - DEFAULT_PREF_COLUMN_COUNT
```
public static final int DEFAULT_PREF_COLUMN_COUNT
```
    The default value for prefColumnCount.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_PREF_ROW_COUNT
```
public static final int DEFAULT_PREF_ROW_COUNT
```
    The default value for prefRowCount.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_PARAGRAPH_CAPACITY
```
private static final int DEFAULT_PARAGRAPH_CAPACITY
```
    See Also:
    
    Constant Field Values
  - wrapText
```
private BooleanProperty wrapText
```
    If a run of text exceeds the width of the TextArea, then this variable indicates whether the text should wrap onto another line.
  - prefColumnCount
```
private IntegerProperty prefColumnCount
```
    The preferred number of text columns. This is used for calculating the TextArea's preferred width.
  - prefRowCount
```
private IntegerProperty prefRowCount
```
    The preferred number of text rows. This is used for calculating the TextArea's preferred height.
  - scrollTop
```
private DoubleProperty scrollTop
```
    The number of pixels by which the content is vertically scrolled.
  - scrollLeft
```
private DoubleProperty scrollLeft
```
    The number of pixels by which the content is horizontally scrolled.
- Constructor Detail
  - TextArea
```
public TextArea()
```
    Creates a TextArea with empty text content.
  - TextArea
```
public TextArea(java.lang.String text)
```
    Creates a TextArea with initial text content.
    
    Parameters:
    
    text - A string for text content.
- Method Detail
  - textUpdated
```
final void textUpdated()
```
    Overrides:
    
    textUpdated in class TextInputControl
  - getParagraphs
```
public <any> getParagraphs()
```
    Returns an unmodifiable list of the character sequences that back the text area's content.
    
    Returns:
    
    an unmodifiable list of the character sequences that back the text area's content
  - wrapTextProperty
```
public final BooleanProperty wrapTextProperty()
```
    If a run of text exceeds the width of the TextArea, then this variable indicates whether the text should wrap onto another line.
    
    See Also:
    
    isWrapText(), setWrapText(boolean)
  - isWrapText
```
public final boolean isWrapText()
```
    Gets the value of the property wrapText.
  - setWrapText
```
public final void setWrapText(boolean value)
```
    Sets the value of the property wrapText.
  - prefColumnCountProperty
```
public final IntegerProperty prefColumnCountProperty()
```
    The preferred number of text columns. This is used for calculating the TextArea's preferred width.
    
    See Also:
    
    getPrefColumnCount(), setPrefColumnCount(int)
  - getPrefColumnCount
```
public final int getPrefColumnCount()
```
    Gets the value of the property prefColumnCount.
  - setPrefColumnCount
```
public final void setPrefColumnCount(int value)
```
    Sets the value of the property prefColumnCount.
  - prefRowCountProperty
```
public final IntegerProperty prefRowCountProperty()
```
    The preferred number of text rows. This is used for calculating the TextArea's preferred height.
    
    See Also:
    
    getPrefRowCount(), setPrefRowCount(int)
  - getPrefRowCount
```
public final int getPrefRowCount()
```
    Gets the value of the property prefRowCount.
  - setPrefRowCount
```
public final void setPrefRowCount(int value)
```
    Sets the value of the property prefRowCount.
  - scrollTopProperty
```
public final DoubleProperty scrollTopProperty()
```
    The number of pixels by which the content is vertically scrolled.
    
    See Also:
    
    getScrollTop(), setScrollTop(double)
  - getScrollTop
```
public final double getScrollTop()
```
    Gets the value of the property scrollTop.
  - setScrollTop
```
public final void setScrollTop(double value)
```
    Sets the value of the property scrollTop.
  - scrollLeftProperty
```
public final DoubleProperty scrollLeftProperty()
```
    The number of pixels by which the content is horizontally scrolled.
    
    See Also:
    
    getScrollLeft(), setScrollLeft(double)
  - getScrollLeft
```
public final double getScrollLeft()
```
    Gets the value of the property scrollLeft.
  - setScrollLeft
```
public final void setScrollLeft(double value)
```
    Sets the value of the property scrollLeft.
  - createDefaultSkin
```
protected Skin<?> createDefaultSkin()
```
    Create a new instance of the default skin for this control. This is called to create a skin for the control if no skin is provided via CSS -fx-skin or set explicitly in a sub-class with setSkin(...).
    
    Overrides:
    
    createDefaultSkin in class Control
    
    Returns:
    
    new instance of default skin for this control. If null then the control will have no skin unless one is provided by css.
  - getClassCssMetaData
```
public static java.util.List<<any>> getClassCssMetaData()
```
    Returns:
    
    The CssMetaData associated with this class, which may include the CssMetaData of its superclasses.
    
    Since:
    
    JavaFX 8.0
  - getControlCssMetaData
```
public java.util.List<<any>> getControlCssMetaData()
```
    Overrides:
    
    getControlCssMetaData in class TextInputControl
    
    Returns:
    
    unmodifiable list of the controls css styleable properties
    
    Since:
    
    JavaFX 8.0

Class TextArea

Property Summary

Properties inherited from class javafx.scene.control.TextInputControl

Properties inherited from class javafx.scene.control.Control

Nested Class Summary

Nested classes/interfaces inherited from class javafx.scene.control.TextInputControl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class javafx.scene.control.TextInputControl

Methods inherited from class javafx.scene.control.Control

Methods inherited from class java.lang.Object

Property Detail

wrapText

prefColumnCount

prefRowCount

scrollTop

scrollLeft

Field Detail

DEFAULT_PREF_COLUMN_COUNT

DEFAULT_PREF_ROW_COUNT

DEFAULT_PARAGRAPH_CAPACITY

wrapText

prefColumnCount

prefRowCount

scrollTop

scrollLeft

Constructor Detail

TextArea

TextArea

Method Detail

textUpdated

getParagraphs

wrapTextProperty

isWrapText

setWrapText

prefColumnCountProperty

getPrefColumnCount

setPrefColumnCount

prefRowCountProperty

getPrefRowCount

setPrefRowCount

scrollTopProperty

getScrollTop

setScrollTop

scrollLeftProperty

getScrollLeft

setScrollLeft

createDefaultSkin

getClassCssMetaData

getControlCssMetaData