Modifier and Type	Class and Description
private static class	TextArea.ParagraphList
private static class	TextArea.ParagraphListChange
private static class	TextArea.StyleableProperties
private static class	TextArea.TextAreaContent

Modifier and Type	Field and Description
private static final int	DEFAULT_PARAGRAPH_CAPACITY
public static final int	DEFAULT_PREF_COLUMN_COUNT The default value for `prefColumnCount`.
public static final 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.

Access	Constructor and Description
public	TextArea() Creates a `TextArea` with empty text content.
public	TextArea(String A string for text content. text) Creates a `TextArea` with initial text content.

Modifier and Type	Method and Description
protected Skin<?>	createDefaultSkin() Overrides javafx.scene.control.Control.createDefaultSkin. Create a new instance of the default skin for this control.
pack-priv String	filterInput(String text) Overrides javafx.scene.control.TextInputControl.filterInput.
public static List<CssMetaData<? extends Styleable, ?>>	Returns: the `CssMetaData` getClassCssMetaData() Hides javafx.scene.control.TextInputControl.getClassCssMetaData. Gets the `CssMetaData` associated with this class, which may include the `CssMetaData` of its superclasses.
public List<CssMetaData<? extends Styleable, ?>>	getControlCssMetaData() Overrides javafx.scene.control.TextInputControl.getControlCssMetaData. Gets the unmodifiable list of the control's CSS-styleable properties.
public ObservableList<CharSequence>	Returns: an unmodifiable list of the character sequences that back the text area's content getParagraphs() Returns an unmodifiable list of the character sequences that back the text area's content.
public final int	getPrefColumnCount()
public final int	getPrefRowCount()
public final double	getScrollLeft()
public final double	getScrollTop()
public final boolean	isWrapText()
public final IntegerProperty	prefColumnCountProperty()
public final IntegerProperty	prefRowCountProperty()
public final DoubleProperty	scrollLeftProperty()
public final DoubleProperty	scrollTopProperty()
public final void	setPrefColumnCount(int value)
public final void	setPrefRowCount(int value)
public final void	setScrollLeft(double value)
public final void	setScrollTop(double value)
public final void	setWrapText(boolean value)
pack-priv final void	textUpdated() Overrides javafx.scene.control.TextInputControl.textUpdated.
public final BooleanProperty	wrapTextProperty()

DEFAULT_PARAGRAPH_CAPACITY	back to summary
private static final int DEFAULT_PARAGRAPH_CAPACITY

DEFAULT_PREF_COLUMN_COUNT	back to summary
public static final int DEFAULT_PREF_COLUMN_COUNT The default value for `prefColumnCount`.

DEFAULT_PREF_ROW_COUNT	back to summary
public static final int DEFAULT_PREF_ROW_COUNT The default value for `prefRowCount`.

prefColumnCount	back to summary
private IntegerProperty prefColumnCount The preferred number of text columns. This is used for calculating the `TextArea`'s preferred width.

prefRowCount	back to summary
private IntegerProperty prefRowCount The preferred number of text rows. This is used for calculating the `TextArea`'s preferred height.

scrollLeft	back to summary
private DoubleProperty scrollLeft The number of pixels by which the content is horizontally scrolled.

scrollTop	back to summary
private DoubleProperty scrollTop The number of pixels by which the content is vertically scrolled.

wrapText	back to summary
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.

TextArea	back to summary
public TextArea() Creates a `TextArea` with empty text content.

TextArea	back to summary
public TextArea(String text) Creates a `TextArea` with initial text content. Parameters text:String A string for text content.

Method Detail

createDefaultSkin back to summary

createDefaultSkin	back to summary
protected Skin<?> createDefaultSkin() Overrides javafx.scene.control.Control.createDefaultSkin. Doc from javafx.scene.control.Control.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(...)`. Annotations @Override

protected Skin<?> createDefaultSkin()

Overrides javafx.scene.control.Control.createDefaultSkin.

Doc from javafx.scene.control.Control.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(...).

Annotations

@Override

filterInput	back to summary
pack-priv String filterInput(String text) Overrides javafx.scene.control.TextInputControl.filterInput. Annotations @Override

filterInput

back to summary

pack-priv String filterInput(String text)

Overrides javafx.scene.control.TextInputControl.filterInput.

Annotations

@Override

getClassCssMetaData back to summary

public static List<CssMetaData<? extends Styleable, ?>> getClassCssMetaData()

Hides javafx.scene.control.TextInputControl.getClassCssMetaData.

Gets the CssMetaData associated with this class, which may include the CssMetaData of its superclasses.

Returns:List<CssMetaData<? extends Styleable, ?>>: the CssMetaData
Since: JavaFX 8.0

getControlCssMetaData

back to summary

public List<CssMetaData<? extends Styleable, ?>> getControlCssMetaData()

Overrides javafx.scene.control.TextInputControl.getControlCssMetaData.

Doc from javafx.scene.control.TextInputControl.getControlCssMetaData.

Gets the unmodifiable list of the control's CSS-styleable properties.

Annotations

@Override

Since

JavaFX 8.0

getParagraphs	back to summary
public ObservableList<CharSequence> getParagraphs() Returns an unmodifiable list of the character sequences that back the text area's content. Returns:ObservableList<CharSequence> an unmodifiable list of the character sequences that back the text area's content

getParagraphs

back to summary

public ObservableList<CharSequence> getParagraphs()

Returns an unmodifiable list of the character sequences that back the text area's content.

Returns:ObservableList<CharSequence>: an unmodifiable list of the character sequences that back the text area's content

getPrefColumnCount	back to summary
public final int getPrefColumnCount()

getPrefRowCount	back to summary
public final int getPrefRowCount()

getScrollLeft	back to summary
public final double getScrollLeft()

getScrollTop	back to summary
public final double getScrollTop()

isWrapText	back to summary
public final boolean isWrapText()

prefColumnCountProperty	back to summary
public final IntegerProperty prefColumnCountProperty()

prefRowCountProperty	back to summary
public final IntegerProperty prefRowCountProperty()

scrollLeftProperty	back to summary
public final DoubleProperty scrollLeftProperty()

scrollTopProperty	back to summary
public final DoubleProperty scrollTopProperty()

setPrefColumnCount	back to summary
public final void setPrefColumnCount(int value)

setPrefRowCount	back to summary
public final void setPrefRowCount(int value)

setScrollLeft	back to summary
public final void setScrollLeft(double value)

setScrollTop	back to summary
public final void setScrollTop(double value)

setWrapText	back to summary
public final void setWrapText(boolean value)

textUpdated	back to summary
pack-priv final void textUpdated() Overrides javafx.scene.control.TextInputControl.textUpdated. Annotations @Override

textUpdated

back to summary

pack-priv final void textUpdated()

Overrides javafx.scene.control.TextInputControl.textUpdated.

Annotations

@Override

wrapTextProperty	back to summary
public final BooleanProperty wrapTextProperty()

javafx.scene.control back to summary

private final Class TextArea.ParagraphList

Class Inheritance

extends AbstractList<CharSequence>
implements ObservableList<CharSequence>

java.lang.Object
java.util.AbstractCollection
java.util.AbstractList
javafx.scene.control.TextArea.ParagraphList

All Implemented Interfaces

javafx.collections.ObservableList, javafx.beans.Observable, java.util.List, java.util.SequencedCollection, java.util.Collection, java.lang.Iterable

Field Summary

Modifier and Type	Field and Description
private TextArea.TextAreaContent	content
private ListListenerHelper<CharSequence>	listenerHelper

Inherited from java.util.AbstractList:: modCount

Constructor Summary

Access	Constructor and Description
private	ParagraphList()

Method Summary

Modifier and Type	Method and Description
public boolean	addAll(Collection<? extends CharSequence> paragraphs) Overrides java.util.AbstractCollection.addAll. Implements java.util.List.addAll, java.util.Collection.addAll. Appends all of the elements in the specified collection to the end of this list, in the order that they are returned by the specified collection's iterator (optional operation).
public boolean	addAll(CharSequence... paragraphs) Implements javafx.collections.ObservableList.addAll. A convenience method for var-arg addition of elements.
public void	addListener(ListChangeListener<? super CharSequence> listener) Implements javafx.collections.ObservableList.addListener. Add a listener to this observable list.
public void	addListener(InvalidationListener listener) Implements javafx.beans.Observable.addListener. Adds an `InvalidationListener` which will be notified whenever the `Observable` becomes invalid.
public CharSequence	get(int index) Implements abstract java.util.AbstractList.get. Implements java.util.List.get. Returns the element at the specified position in this list.
public void	remove(int from, int to) Implements javafx.collections.ObservableList.remove. A simplified way of calling `sublist(from, to).clear()`.
public boolean	removeAll(CharSequence... elements) Implements javafx.collections.ObservableList.removeAll. A convenience method for var-arg usage of the `removeAll` method.
public void	removeListener(ListChangeListener<? super CharSequence> listener) Implements javafx.collections.ObservableList.removeListener. Tries to remove a listener from this observable list.
public void	removeListener(InvalidationListener listener) Implements javafx.beans.Observable.removeListener. Removes the given listener from the list of listeners, that are notified whenever the value of the `Observable` becomes invalid.
public boolean	retainAll(CharSequence... elements) Implements javafx.collections.ObservableList.retainAll. A convenience method for var-arg usage of the `retainAll` method.
public boolean	setAll(Collection<? extends CharSequence> paragraphs) Implements javafx.collections.ObservableList.setAll. Clears the ObservableList and adds all elements from the collection.
public boolean	setAll(CharSequence... paragraphs) Implements javafx.collections.ObservableList.setAll. Clears the ObservableList and adds all the elements passed as var-args.
public int	size() Implements abstract java.util.AbstractCollection.size. Implements java.util.List.size, java.util.Collection.size. Returns the number of elements in this list.

Inherited from java.util.AbstractList:: add add addAll clear equals hashCode indexOf iterator lastIndexOf listIterator listIterator remove removeRange set subList

Field Detail

content	back to summary
private TextArea.TextAreaContent content

listenerHelper	back to summary
private ListListenerHelper<CharSequence> listenerHelper

Constructor Detail

ParagraphList	back to summary
private ParagraphList()

Method Detail

addAll	back to summary
public boolean addAll(Collection<? extends CharSequence> paragraphs) Overrides java.util.AbstractCollection.addAll. Implements java.util.List.addAll, java.util.Collection.addAll. Doc from java.util.List.addAll. Appends all of the elements in the specified collection to the end of this list, in the order that they are returned by the specified collection's iterator (optional operation). The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (Note that this will occur if the specified collection is this list, and it's nonempty.) Annotations @Override

addAll

back to summary

public boolean addAll(Collection<? extends CharSequence> paragraphs)

Overrides java.util.AbstractCollection.addAll.

Implements java.util.List.addAll, java.util.Collection.addAll.

Doc from java.util.List.addAll.

Appends all of the elements in the specified collection to the end of this list, in the order that they are returned by the specified collection's iterator (optional operation). The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (Note that this will occur if the specified collection is this list, and it's nonempty.)

Annotations

@Override

addAll	back to summary
public boolean addAll(CharSequence... paragraphs) Implements javafx.collections.ObservableList.addAll. Doc from javafx.collections.ObservableList.addAll. A convenience method for var-arg addition of elements. Annotations @Override

addAll

back to summary

public boolean addAll(CharSequence... paragraphs)

Implements javafx.collections.ObservableList.addAll.

Doc from javafx.collections.ObservableList.addAll.

A convenience method for var-arg addition of elements.

Annotations

@Override

addListener	back to summary
public void addListener(ListChangeListener<? super CharSequence> listener) Implements javafx.collections.ObservableList.addListener. Doc from javafx.collections.ObservableList.addListener. Add a listener to this observable list. Annotations @Override

addListener

back to summary

public void addListener(ListChangeListener<? super CharSequence> listener)

Implements javafx.collections.ObservableList.addListener.

Doc from javafx.collections.ObservableList.addListener.

Add a listener to this observable list.

Annotations

@Override

addListener back to summary

addListener	back to summary
public void addListener(InvalidationListener listener) Implements javafx.beans.Observable.addListener. Doc from javafx.beans.Observable.addListener. Adds an `InvalidationListener` which will be notified whenever the `Observable` becomes invalid. If the same listener is added more than once, then it will be notified more than once. That is, no check is made to ensure uniqueness. Note that the same actual `InvalidationListener` instance may be safely registered for different `Observables`. The `Observable` stores a strong reference to the listener which will prevent the listener from being garbage collected and may result in a memory leak. It is recommended to either unregister a listener by calling `removeListener` after use or to use an instance of `WeakInvalidationListener` avoid this situation. Annotations @Override

public void addListener(InvalidationListener listener)

Implements javafx.beans.Observable.addListener.

Doc from javafx.beans.Observable.addListener.

Adds an InvalidationListener which will be notified whenever the Observable becomes invalid. If the same listener is added more than once, then it will be notified more than once. That is, no check is made to ensure uniqueness.

Note that the same actual InvalidationListener instance may be safely registered for different Observables.

The Observable stores a strong reference to the listener which will prevent the listener from being garbage collected and may result in a memory leak. It is recommended to either unregister a listener by calling removeListener after use or to use an instance of WeakInvalidationListener avoid this situation.

Annotations

@Override

get	back to summary
public CharSequence get(int index) Implements abstract java.util.AbstractList.get. Implements java.util.List.get. Doc from java.util.List.get. Returns the element at the specified position in this list. Annotations @Override

get

back to summary

public CharSequence get(int index)

Implements abstract java.util.AbstractList.get.

Implements java.util.List.get.

Doc from java.util.List.get.

Returns the element at the specified position in this list.

Annotations

@Override

remove back to summary

remove	back to summary
public void remove(int from, int to) Implements javafx.collections.ObservableList.remove. Doc from javafx.collections.ObservableList.remove. A simplified way of calling `sublist(from, to).clear()`. As this is a common operation, ObservableList has this method for convenient usage. Annotations @Override

public void remove(int from, int to)

Implements javafx.collections.ObservableList.remove.

Doc from javafx.collections.ObservableList.remove.

A simplified way of calling sublist(from, to).clear(). As this is a common operation, ObservableList has this method for convenient usage.

Annotations

@Override

removeAll back to summary

removeAll	back to summary
public boolean removeAll(CharSequence... elements) Implements javafx.collections.ObservableList.removeAll. Doc from javafx.collections.ObservableList.removeAll. A convenience method for var-arg usage of the `removeAll` method. Annotations @Override

public boolean removeAll(CharSequence... elements)

Implements javafx.collections.ObservableList.removeAll.

Doc from javafx.collections.ObservableList.removeAll.

A convenience method for var-arg usage of the removeAll method.

Annotations

@Override

removeListener	back to summary
public void removeListener(ListChangeListener<? super CharSequence> listener) Implements javafx.collections.ObservableList.removeListener. Doc from javafx.collections.ObservableList.removeListener. Tries to remove a listener from this observable list. If the listener is not attached to this list, nothing happens. Annotations @Override

removeListener

back to summary

public void removeListener(ListChangeListener<? super CharSequence> listener)

Implements javafx.collections.ObservableList.removeListener.

Doc from javafx.collections.ObservableList.removeListener.

Tries to remove a listener from this observable list. If the listener is not attached to this list, nothing happens.

Annotations

@Override

removeListener back to summary

removeListener	back to summary
public void removeListener(InvalidationListener listener) Implements javafx.beans.Observable.removeListener. Doc from javafx.beans.Observable.removeListener. Removes the given listener from the list of listeners, that are notified whenever the value of the `Observable` becomes invalid. If the given listener has not been previously registered (i.e. it was never added) then this method call is a no-op. If it had been previously added then it will be removed. If it had been added more than once, then only the first occurrence will be removed. Annotations @Override

public void removeListener(InvalidationListener listener)

Implements javafx.beans.Observable.removeListener.

Doc from javafx.beans.Observable.removeListener.

Removes the given listener from the list of listeners, that are notified whenever the value of the Observable becomes invalid.

If the given listener has not been previously registered (i.e. it was never added) then this method call is a no-op. If it had been previously added then it will be removed. If it had been added more than once, then only the first occurrence will be removed.

Annotations

@Override

retainAll back to summary

public boolean retainAll(CharSequence... elements)

Implements javafx.collections.ObservableList.retainAll.

Doc from javafx.collections.ObservableList.retainAll.

A convenience method for var-arg usage of the retainAll method.

Annotations

@Override

setAll

back to summary

public boolean setAll(Collection<? extends CharSequence> paragraphs)

Implements javafx.collections.ObservableList.setAll.

Doc from javafx.collections.ObservableList.setAll.

Clears the ObservableList and adds all elements from the collection.

Annotations

@Override

setAll

back to summary

public boolean setAll(CharSequence... paragraphs)

Implements javafx.collections.ObservableList.setAll.

Doc from javafx.collections.ObservableList.setAll.

Clears the ObservableList and adds all the elements passed as var-args.

Annotations

@Override

size back to summary

public int size()

Implements abstract java.util.AbstractCollection.size.

Implements java.util.List.size, java.util.Collection.size.

Doc from java.util.List.size.

Returns the number of elements in this list. If this list contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Annotations

@Override

javafx.scene.control back to summary

private final Class TextArea.ParagraphListChange

Class Inheritance

extends NonIterableChange<CharSequence>

java.lang.Object
javafx.collections.ListChangeListener.Change
com.sun.javafx.collections.NonIterableChange
javafx.scene.control.TextArea.ParagraphListChange

Field Summary

Modifier and Type	Field and Description
private List<CharSequence>	removed

Constructor Summary

Access	Constructor and Description
protected	ParagraphListChange(ObservableList<CharSequence> list, int from, int to, List<CharSequence> removed)

Method Summary

Modifier and Type	Method and Description
protected int[]	getPermutation() Overrides com.sun.javafx.collections.NonIterableChange.getPermutation. If this change is a permutation, it returns an integer array that describes the permutation.
public List<CharSequence>	getRemoved() Implements abstract javafx.collections.ListChangeListener.Change.getRemoved. An immutable list of removed/replaced elements.

Inherited from com.sun.javafx.collections.NonIterableChange:: checkState getFrom getTo next reset toString

Field Detail

removed	back to summary
private List<CharSequence> removed

Constructor Detail

ParagraphListChange	back to summary
protected ParagraphListChange(ObservableList<CharSequence> list, int from, int to, List<CharSequence> removed)

Method Detail

getPermutation back to summary

protected int[] getPermutation()

Overrides com.sun.javafx.collections.NonIterableChange.getPermutation.

Doc from javafx.collections.ListChangeListener.Change.getPermutation.

If this change is a permutation, it returns an integer array that describes the permutation. This array maps directly from the previous indexes to the new ones. This method is not publicly accessible and therefore can return an array safely. The 0 index of the array corresponds to index getFrom() of the list. The same applies for the last index and getTo(). The method is used by wasPermutated() and getPermutation(int) methods.

Annotations

@Override

getRemoved

back to summary

public List<CharSequence> getRemoved()

Implements abstract javafx.collections.ListChangeListener.Change.getRemoved.

Doc from javafx.collections.ListChangeListener.Change.getRemoved.

An immutable list of removed/replaced elements. If no elements were removed from the list, an empty list is returned.

Annotations

@Override

javafx.scene.control back to summary

private Class TextArea.StyleableProperties

Class Inheritance

extends Object

java.lang.Object
javafx.scene.control.TextArea.StyleableProperties

Field Summary

Modifier and Type	Field and Description
private static final CssMetaData<TextArea, Number>	PREF_COLUMN_COUNT
private static final CssMetaData<TextArea, Number>	PREF_ROW_COUNT
private static final List<CssMetaData<? extends Styleable, ?>>	STYLEABLES
private static final CssMetaData<TextArea, Boolean>	WRAP_TEXT

Constructor Summary

Access	Constructor and Description
private	StyleableProperties()

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

PREF_COLUMN_COUNT	back to summary
private static final CssMetaData<TextArea, Number> PREF_COLUMN_COUNT

PREF_ROW_COUNT	back to summary
private static final CssMetaData<TextArea, Number> PREF_ROW_COUNT

STYLEABLES	back to summary
private static final List<CssMetaData<? extends Styleable, ?>> STYLEABLES

WRAP_TEXT	back to summary
private static final CssMetaData<TextArea, Boolean> WRAP_TEXT

Constructor Detail

StyleableProperties	back to summary
private StyleableProperties()

javafx.scene.control back to summary

private final Class TextArea.TextAreaContent

Class Inheritance

extends ContentBase

java.lang.Object
javafx.scene.control.TextInputControl.ContentBase
javafx.scene.control.TextArea.TextAreaContent

Field Summary

Modifier and Type	Field and Description
private int	contentLength
private final TextArea.ParagraphList	paragraphList
private final List<StringBuilder>	paragraphs

Constructor Summary

Access	Constructor and Description
private	TextAreaContent()

Method Summary

Modifier and Type	Method and Description
public void	delete(int start, int end, boolean notifyListeners) Implements javafx.scene.control.TextInputControl.Content.delete. Removes a sequence of characters from the content.
private void	fireParagraphListChangeEvent(int from, int to, List<CharSequence> removed)
public String	get(int start, int end) Implements javafx.scene.control.TextInputControl.Content.get. Retrieves a subset of the content.
public String	get() Implements javafx.beans.value.ObservableObjectValue.get. Returns the current value of this `ObservableObjectValue<T>`.
public String	getValue() Implements javafx.beans.value.ObservableValue.getValue. Returns the current value of this `ObservableValue`
public void	insert(int index, String text, boolean notifyListeners) Implements javafx.scene.control.TextInputControl.Content.insert. Inserts a sequence of characters into the content.
public int	length() Implements javafx.scene.control.TextInputControl.Content.length. Returns the number of characters represented by the content.