javafx.scene.control

Class TextInputControl.TextProperty

java.lang.Object

javafx.beans.binding.StringExpression

javafx.beans.property.ReadOnlyStringProperty

javafx.beans.property.StringProperty

javafx.scene.control.TextInputControl.TextProperty

All Implemented Interfaces:

Observable, Property<java.lang.String>, ReadOnlyProperty<java.lang.String>, ObservableObjectValue<java.lang.String>, ObservableStringValue, ObservableValue<java.lang.String>, WritableObjectValue<java.lang.String>, WritableStringValue, WritableValue<java.lang.String>

Enclosing class:

TextInputControl

private class TextInputControl.TextProperty
extends StringProperty

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	TextInputControl.TextProperty.Listener

Field Summary

Fields

Modifier and Type	Field and Description
private ExpressionHelper<java.lang.String>	helper
private InvalidationListener	listener
private ObservableValue<? extends java.lang.String>	observable
private boolean	textIsNull

Constructor Summary

Constructors

Modifier	Constructor and Description
private	TextProperty()

Method Summary

Modifier and Type	Method and Description
void	addListener(ChangeListener<? super java.lang.String> listener) Adds a ChangeListener which will be notified whenever the value of the ObservableValue changes.
void	addListener(InvalidationListener listener) Adds an InvalidationListener which will be notified whenever the Observable becomes invalid.
void	bind(ObservableValue<? extends java.lang.String> observable) Create a unidirection binding for this Property.
private void	controlContentHasChanged() Called whenever the content on the control has changed (as determined by a listener on the content).
private void	doSet(java.lang.String value) doSet is called whenever the setText() method was called directly on the TextInputControl, or when the text property was bound, unbound, or reacted to a binding invalidation.
private void	fireValueChangedEvent()
java.lang.String	get() Get the wrapped value.
java.lang.Object	getBean() Returns the Object that contains this property.
java.lang.String	getName() Returns the name of this property.
boolean	isBound() Can be used to check, if a Property is bound.
private void	markInvalid()
void	removeListener(ChangeListener<? super java.lang.String> listener) Removes the given listener from the list of listeners, that are notified whenever the value of the ObservableValue changes.
void	removeListener(InvalidationListener listener) Removes the given listener from the list of listeners, that are notified whenever the value of the Observable becomes invalid.
void	set(java.lang.String value) Set the wrapped value.
void	unbind() Remove the unidirectional binding for this Property.

Methods inherited from class javafx.beans.property.StringProperty

bindBidirectional, bindBidirectional, bindBidirectional, setValue, toString, unbindBidirectional, unbindBidirectional

Methods inherited from class javafx.beans.binding.StringExpression

concat, getValue, getValueSafe, greaterThan, greaterThan, greaterThanOrEqualTo, greaterThanOrEqualTo, isEmpty, isEqualTo, isEqualTo, isEqualToIgnoreCase, isEqualToIgnoreCase, isNotEmpty, isNotEqualTo, isNotEqualTo, isNotEqualToIgnoreCase, isNotEqualToIgnoreCase, isNotNull, isNull, length, lessThan, lessThan, lessThanOrEqualTo, lessThanOrEqualTo, stringExpression

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface javafx.beans.value.ObservableValue

getValue

Methods inherited from interface javafx.beans.value.WritableValue

getValue

Field Detail

observable

private ObservableValue<? extends java.lang.String> observable

listener

private InvalidationListener listener

helper

private ExpressionHelper<java.lang.String> helper

textIsNull

private boolean textIsNull

Constructor Detail

TextProperty

private TextProperty()

Method Detail

get

public java.lang.String get()

Description copied from interface: WritableObjectValue

Get the wrapped value. This must be identical to the value returned from WritableValue.getValue().

This method exists only to align WritableObjectValue API with WritableBooleanValue and subclasses of WritableNumberValue

Returns:

The current value

set

public void set(java.lang.String value)

Description copied from interface: WritableObjectValue

Set the wrapped value. Should be equivalent to WritableValue.setValue(java.lang.Object)

Parameters:

value - The new value

See Also:

WritableObjectValue.get()

controlContentHasChanged

private void controlContentHasChanged()

Called whenever the content on the control has changed (as determined by a listener on the content).

bind

public void bind(ObservableValue<? extends java.lang.String> observable)

Description copied from interface: Property

Create a unidirection binding for this Property.

Note that JavaFX has all the bind calls implemented through weak listeners. This means the bound property can be garbage collected and stopped from being updated.

Parameters:

observable - The observable this Property should be bound to.

unbind

public void unbind()

Description copied from interface: Property

Remove the unidirectional binding for this Property. If the Property is not bound, calling this method has no effect.

See Also:

Property.bind(javafx.beans.value.ObservableValue)

isBound

public boolean isBound()

Description copied from interface: Property

Can be used to check, if a Property is bound.

Returns:

true if the Property is bound, false otherwise

See Also:

Property.bind(javafx.beans.value.ObservableValue)

addListener

public void addListener(InvalidationListener listener)

Description copied from interface: Observable

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.

Parameters:

listener - The listener to register

See Also:

Observable.removeListener(InvalidationListener)

removeListener

public void removeListener(InvalidationListener listener)

Description copied from interface: Observable

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.

Parameters:

listener - The listener to remove

See Also:

Observable.addListener(InvalidationListener)

addListener

public void addListener(ChangeListener<? super java.lang.String> listener)

Description copied from interface: ObservableValue

Adds a ChangeListener which will be notified whenever the value of the ObservableValue changes. 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 ChangeListener instance may be safely registered for different ObservableValues.

The ObservableValue 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 WeakChangeListener avoid this situation.

Parameters:

listener - The listener to register

See Also:

ObservableValue.removeListener(ChangeListener)

removeListener

public void removeListener(ChangeListener<? super java.lang.String> listener)

Description copied from interface: ObservableValue

Removes the given listener from the list of listeners, that are notified whenever the value of the ObservableValue changes.

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.

Parameters:

listener - The listener to remove

See Also:

ObservableValue.addListener(ChangeListener)

getBean

public java.lang.Object getBean()

Description copied from interface: ReadOnlyProperty

Returns the Object that contains this property. If this property is not contained in an Object, null is returned.

Returns:

the containing Object or null

getName

public java.lang.String getName()

Description copied from interface: ReadOnlyProperty

Returns the name of this property. If the property does not have a name, this method returns an empty String.

Returns:

the name or an empty String

fireValueChangedEvent

private void fireValueChangedEvent()

markInvalid

private void markInvalid()

doSet

private void doSet(java.lang.String value)

doSet is called whenever the setText() method was called directly on the TextInputControl, or when the text property was bound, unbound, or reacted to a binding invalidation. It is *not* called when modifications to the content happened indirectly, such as through the replaceText / replaceSelection methods.

Parameters:

value - The new value