Class JavaBeanStringProperty

java.lang.Object

javafx.beans.binding.StringExpression

javafx.beans.property.ReadOnlyStringProperty

javafx.beans.property.StringProperty

javafx.beans.property.adapter.JavaBeanStringProperty

All Implemented Interfaces:

Observable, JavaBeanProperty<String>, ReadOnlyJavaBeanProperty<String>, Property<String>, ReadOnlyProperty<String>, ObservableObjectValue<String>, ObservableStringValue, ObservableValue<String>, WritableObjectValue<String>, WritableStringValue, WritableValue<String>

public final class JavaBeanStringProperty
extends StringProperty
implements JavaBeanProperty<String>

A JavaBeanStringProperty provides an adapter between a regular Java Bean property of type String and a JavaFX StringProperty. It cannot be created directly, but a JavaBeanStringPropertyBuilder has to be used.

As a minimum, the Java Bean class must implement a getter and a setter for the property. The class, as well as the getter and a setter methods, must be declared public. If the getter of an instance of this class is called, the property of the Java Bean is returned. If the setter is called, the value will be passed to the Java Bean property. If the Java Bean property is bound (i.e. it supports PropertyChangeListeners), this JavaBeanStringProperty will be aware of changes in the Java Bean. Otherwise it can be notified about changes by calling fireValueChangedEvent(). If the Java Bean property is also constrained (i.e. it supports VetoableChangeListeners), this JavaBeanStringProperty will reject changes, if it is bound to an ObservableValue<String>.

Deploying an Application as a Module

If the Java Bean class is in a named module, then it must be reflectively accessible to the javafx.base module. A class is reflectively accessible if the module opens the containing package to at least the javafx.base module.

For example, if com.foo.MyBeanClass is in the foo.app module, the module-info.java might look like this:

module foo.app {
    opens com.foo to javafx.base;
}

Alternatively, a class is reflectively accessible if the module exports the containing package unconditionally.

Since:

JavaFX 2.1

See Also:

• StringProperty
• JavaBeanStringPropertyBuilder

Method Summary

Modifier and Type	Method	Description
void	addListener(InvalidationListener listener)	Adds an InvalidationListener which will be notified whenever the Observable becomes invalid.
void	addListener(ChangeListener<? super String> listener)	Adds a ChangeListener which will be notified whenever the value of the ObservableValue changes.
void	bind(ObservableValue<? extends String> observable)	Create a unidirection binding for this Property.
void	dispose()	Signals to the JavaFX property that it will not be used anymore and any references can be removed.
void	fireValueChangedEvent()	This method can be called to notify the adapter of a change of the Java Bean value, if the Java Bean property is not bound (i.e.
String	get()	Returns the current value of this ObservableObjectValue<T>.
Object	getBean()	Returns the Object that contains this property.
String	getName()	Returns the name of this property.
boolean	isBound()	Can be used to check, if a Property is bound.
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	removeListener(ChangeListener<? super String> listener)	Removes the given listener from the list of listeners that are notified whenever the value of the ObservableValue changes.
void	set(String value)	Set the wrapped value.
void	unbind()	Remove the unidirectional binding for this Property.

Methods declared in class StringProperty

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

Modifier and Type	Method	Description
void	bindBidirectional(Property<?> other, Format format)	Create a bidirectional binding between this StringProperty and another arbitrary property.
void	bindBidirectional(Property<String> other)	Create a bidirectional binding between this Property and another one.
<T> void	bindBidirectional(Property<T> other, StringConverter<T> converter)	Create a bidirectional binding between this StringProperty and another arbitrary property.
void	setValue(String v)	Set the wrapped value.
String	toString()	Returns a string representation of this StringProperty object.
void	unbindBidirectional(Object other)	Remove a bidirectional binding between this Property and another one.
void	unbindBidirectional(Property<String> other)	Removes a bidirectional binding between this Property and another one.

Methods declared in class 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

Modifier and Type	Method	Description
StringExpression	concat(Object other)	Returns a StringExpression that holds the value of this StringExpression concatenated with another Object.
String	getValue()	Returns the current value of this ObservableValue
final String	getValueSafe()	Returns usually the value of this StringExpression.
BooleanBinding	greaterThan(String other)	Creates a new BooleanBinding that holds true if this StringExpression is greater than a constant value.
BooleanBinding	greaterThan(ObservableStringValue other)	Creates a new BooleanBinding that holds true if this StringExpression is greater than another ObservableStringValue.
BooleanBinding	greaterThanOrEqualTo(String other)	Creates a new BooleanBinding that holds true if this StringExpression is greater than or equal to a constant value.
BooleanBinding	greaterThanOrEqualTo(ObservableStringValue other)	Creates a new BooleanBinding that holds true if this StringExpression is greater than or equal to another ObservableStringValue.
BooleanBinding	isEmpty()	Creates a new BooleanBinding that holds true if this StringExpression is empty.
BooleanBinding	isEqualTo(String other)	Creates a new BooleanBinding that holds true if this StringExpression is equal to a constant value.
BooleanBinding	isEqualTo(ObservableStringValue other)	Creates a new BooleanBinding that holds true if this and another ObservableStringValue are equal.
BooleanBinding	isEqualToIgnoreCase(String other)	Creates a new BooleanBinding that holds true if this StringExpression is equal to a constant value ignoring case.
BooleanBinding	isEqualToIgnoreCase(ObservableStringValue other)	Creates a new BooleanBinding that holds true if this and another ObservableStringValue are equal ignoring case.
BooleanBinding	isNotEmpty()	Creates a new BooleanBinding that holds true if this StringExpression is not empty.
BooleanBinding	isNotEqualTo(String other)	Creates a new BooleanBinding that holds true if this StringExpression is not equal to a constant value.
BooleanBinding	isNotEqualTo(ObservableStringValue other)	Creates a new BooleanBinding that holds true if this and another ObservableStringValue are not equal.
BooleanBinding	isNotEqualToIgnoreCase(String other)	Creates a new BooleanBinding that holds true if this StringExpression is not equal to a constant value ignoring case.
BooleanBinding	isNotEqualToIgnoreCase(ObservableStringValue other)	Creates a new BooleanBinding that holds true if this and another ObservableStringValue are not equal ignoring case.
BooleanBinding	isNotNull()	Creates a new BooleanBinding that holds true if this StringExpression is not null.
BooleanBinding	isNull()	Creates a new BooleanBinding that holds true if this StringExpression is null.
IntegerBinding	length()	Creates a new IntegerBinding that holds the length of this StringExpression.
BooleanBinding	lessThan(String other)	Creates a new BooleanBinding that holds true if this StringExpression is less than a constant value.
BooleanBinding	lessThan(ObservableStringValue other)	Creates a new BooleanBinding that holds true if this StringExpression is less than another ObservableStringValue.
BooleanBinding	lessThanOrEqualTo(String other)	Creates a new BooleanBinding that holds true if this StringExpression is less than or equal to a constant value.
BooleanBinding	lessThanOrEqualTo(ObservableStringValue other)	Creates a new BooleanBinding that holds true if this StringExpression is less than or equal to another ObservableStringValue.
static StringExpression	stringExpression(ObservableValue<?> value)	Returns a StringExpression that wraps a ObservableValue.

Methods declared in class Object

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

Methods declared in interface Observable

subscribe

Modifier and Type	Method	Description
default Subscription	subscribe(Runnable invalidationSubscriber)	Creates a Subscription on this Observable which calls invalidationSubscriber whenever it becomes invalid.

Methods declared in interface ObservableValue

flatMap, map, orElse, subscribe, subscribe, when

Modifier and Type	Method	Description
default <U> ObservableValue<U>	flatMap(Function<? super String, ? extends ObservableValue<? extends U>> mapper)	Returns an ObservableValue that holds the value of an ObservableValue produced by applying the given mapping function on this value.
default <U> ObservableValue<U>	map(Function<? super String, ? extends U> mapper)	Returns an ObservableValue that holds the result of applying the given mapping function on this value.
default ObservableValue<String>	orElse(String constant)	Returns an ObservableValue that holds this value, or the given constant if it is null.
default Subscription	subscribe(BiConsumer<? super String, ? super String> changeSubscriber)	Creates a Subscription on this ObservableValue which calls the given changeSubscriber with the old and new value whenever its value changes.
default Subscription	subscribe(Consumer<? super String> valueSubscriber)	Creates a Subscription on this ObservableValue which immediately provides the current value to the given valueSubscriber, followed by any subsequent values whenever its value changes.
default ObservableValue<String>	when(ObservableValue<Boolean> condition)	Returns an ObservableValue that holds this value and is updated only when condition holds true.

Methods declared in interface WritableValue

getValue

Modifier and Type	Method	Description
String	getValue()	Get the wrapped value.

Method Details

get

public String get()

Returns the current value of this ObservableObjectValue<T>.

Specified by:

get in interface ObservableObjectValue<String>

Specified by:

get in interface WritableObjectValue<String>

Returns:

The current value

Throws:

UndeclaredThrowableException - if calling the getter of the Java Bean property throws an IllegalAccessException or an InvocationTargetException.

set

public void set(String value)

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

Specified by:

set in interface WritableObjectValue<String>

Parameters:

value - The new value

Throws:

UndeclaredThrowableException - if calling the getter of the Java Bean property throws an IllegalAccessException or an InvocationTargetException.

See Also:

• WritableObjectValue.get()

bind

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

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.

Specified by:

bind in interface Property<String>

Parameters:

observable - The observable this Property should be bound to.

unbind

public void unbind()

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

Specified by:

unbind in interface Property<String>

See Also:

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

isBound

public boolean isBound()

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

Specified by:

isBound in interface Property<String>

Returns:

true if the Property is bound, false otherwise

See Also:

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

getBean

public Object getBean()

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

Specified by:

getBean in interface ReadOnlyProperty<String>

Returns:

the containing Object or null

getName

public String getName()

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

Specified by:

getName in interface ReadOnlyProperty<String>

Returns:

the name or an empty String

addListener

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

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.

Specified by:

addListener in interface ObservableValue<String>

Parameters:

listener - The listener to register

See Also:

• ObservableValue.removeListener(ChangeListener)

removeListener

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

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.

Specified by:

removeListener in interface ObservableValue<String>

Parameters:

listener - The listener to remove

See Also:

• ObservableValue.addListener(ChangeListener)

addListener

public void addListener(InvalidationListener listener)

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.

Specified by:

addListener in interface Observable

Parameters:

listener - The listener to register

See Also:

• Observable.removeListener(InvalidationListener)

removeListener

public void removeListener(InvalidationListener listener)

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.

Specified by:

removeListener in interface Observable

Parameters:

listener - The listener to remove

See Also:

• Observable.addListener(InvalidationListener)

fireValueChangedEvent

public void fireValueChangedEvent()

This method can be called to notify the adapter of a change of the Java Bean value, if the Java Bean property is not bound (i.e. it does not support PropertyChangeListeners).

Specified by:

fireValueChangedEvent in interface ReadOnlyJavaBeanProperty<String>

dispose

public void dispose()

Signals to the JavaFX property that it will not be used anymore and any references can be removed. A call of this method usually results in the property stopping to observe the Java Bean property by unregistering its listener(s).

Specified by:

dispose in interface ReadOnlyJavaBeanProperty<String>