JavaFX 24 · javafx.beans.property.adapter.JavaBeanStringProperty

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.

Modifier and Type	Field and Description
private final PropertyDescriptor<String>	descriptor
private ExpressionHelper<String>	helper
private final PropertyDescriptor<String>.Listener	listener
private ObservableValue<? extends String>	observable

Access	Constructor and Description
pack-priv	JavaBeanStringProperty(PropertyDescriptor<String> descriptor, Object bean)

Method Summary

Modifier and Type	Method and Description
public void	addListener(ChangeListener<? super String> The listener to register listener) Implements javafx.beans.value.ObservableValue.addListener. Adds a `ChangeListener` which will be notified whenever the value of the `ObservableValue` changes.
public void	addListener(InvalidationListener The listener to register listener) Implements javafx.beans.Observable.addListener. Adds an `InvalidationListener` which will be notified whenever the `Observable` becomes invalid.
public void	bind(ObservableValue<? extends String> The observable this `Property` should be bound to. observable) Implements javafx.beans.property.Property.bind. Create a unidirection binding for this `Property`.
public void	dispose() Implements javafx.beans.property.adapter.ReadOnlyJavaBeanProperty.dispose. Signals to the JavaFX property that it will not be used anymore and any references can be removed.
public void	fireValueChangedEvent() Implements javafx.beans.property.adapter.ReadOnlyJavaBeanProperty.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).
public String	get() Implements javafx.beans.value.WritableObjectValue.get, javafx.beans.value.ObservableObjectValue.get. Get the wrapped value.
public Object	getBean() Implements javafx.beans.property.ReadOnlyProperty.getBean. Returns the `Object` that contains this property.
public String	getName() Implements javafx.beans.property.ReadOnlyProperty.getName. Returns the name of this property.
public boolean	isBound() Implements javafx.beans.property.Property.isBound. Can be used to check, if a `Property` is bound.
public void	removeListener(ChangeListener<? super String> The listener to remove listener) Implements javafx.beans.value.ObservableValue.removeListener. Removes the given listener from the list of listeners that are notified whenever the value of the `ObservableValue` changes.
public void	removeListener(InvalidationListener The listener to remove 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 void	set(final String The new value value) Implements javafx.beans.value.WritableObjectValue.set. Set the wrapped value.
public void	unbind() Implements javafx.beans.property.Property.unbind. Remove the unidirectional binding for this `Property`.

Inherited from javafx.beans.property.StringProperty:: bindBidirectional bindBidirectional bindBidirectional setValue toString unbindBidirectional unbindBidirectional

Field Detail

descriptor	back to summary
private final PropertyDescriptor<String> descriptor

helper	back to summary
private ExpressionHelper<String> helper

listener	back to summary
private final PropertyDescriptor<String>.Listener listener

observable	back to summary
private ObservableValue<? extends String> observable

Constructor Detail

JavaBeanStringProperty	back to summary
pack-priv JavaBeanStringProperty(PropertyDescriptor<String> descriptor, Object bean)

Method Detail

addListener back to summary

addListener	back to summary
public void addListener(ChangeListener<? super String> listener) Implements javafx.beans.value.ObservableValue.addListener. Doc from javafx.beans.value.ObservableValue.addListener. 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:ChangeListener<? super String> The listener to register Annotations @Override

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

Implements javafx.beans.value.ObservableValue.addListener.

Doc from javafx.beans.value.ObservableValue.addListener.

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:ChangeListener<? super String>: The listener to register

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. Parameters listener:InvalidationListener The listener to register 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.

Parameters

listener:InvalidationListener: The listener to register

Annotations

@Override

bind back to summary

bind	back to summary
public void bind(ObservableValue<? extends String> observable) Implements javafx.beans.property.Property.bind. Doc from javafx.beans.property.Property.bind. 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:ObservableValue<? extends String> The observable this `Property` should be bound to. Annotations @Override

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

Implements javafx.beans.property.Property.bind.

Doc from javafx.beans.property.Property.bind.

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:ObservableValue<? extends String>: The observable this Property should be bound to.

Annotations

@Override

dispose	back to summary
public void dispose() Implements javafx.beans.property.adapter.ReadOnlyJavaBeanProperty.dispose. Doc from javafx.beans.property.adapter.ReadOnlyJavaBeanProperty.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). Annotations @Override

dispose

back to summary

public void dispose()

Implements javafx.beans.property.adapter.ReadOnlyJavaBeanProperty.dispose.

Doc from javafx.beans.property.adapter.ReadOnlyJavaBeanProperty.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).

Annotations

@Override

fireValueChangedEvent	back to summary
public void fireValueChangedEvent() Implements javafx.beans.property.adapter.ReadOnlyJavaBeanProperty.fireValueChangedEvent. Doc from javafx.beans.property.adapter.ReadOnlyJavaBeanProperty.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). Annotations @Override

fireValueChangedEvent

back to summary

public void fireValueChangedEvent()

Implements javafx.beans.property.adapter.ReadOnlyJavaBeanProperty.fireValueChangedEvent.

Doc from javafx.beans.property.adapter.ReadOnlyJavaBeanProperty.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).

Annotations

@Override

get back to summary

get	back to summary
public String get() Implements javafx.beans.value.WritableObjectValue.get, javafx.beans.value.ObservableObjectValue.get. Doc from javafx.beans.value.WritableObjectValue.get. Get the wrapped value. This must be identical to the value returned from `getValue()`. This method exists only to align WritableObjectValue API with `WritableBooleanValue` and subclasses of `WritableNumberValue` Returns:String The current value Annotations @Override Exceptions UndeclaredThrowableException: if calling the getter of the Java Bean property throws an `IllegalAccessException` or an `InvocationTargetException`.

public String get()

Implements javafx.beans.value.WritableObjectValue.get, javafx.beans.value.ObservableObjectValue.get.

Doc from javafx.beans.value.WritableObjectValue.get.

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

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

Returns:String

The current value

Annotations

@Override

Exceptions

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

getBean back to summary

getBean	back to summary
public Object getBean() Implements javafx.beans.property.ReadOnlyProperty.getBean. Doc from javafx.beans.property.ReadOnlyProperty.getBean. Returns the `Object` that contains this property. If this property is not contained in an `Object`, `null` is returned. Returns:Object the containing `Object` or `null` Annotations @Override

public Object getBean()

Implements javafx.beans.property.ReadOnlyProperty.getBean.

Doc from javafx.beans.property.ReadOnlyProperty.getBean.

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

Returns:Object

the containing Object or null

Annotations

@Override

getName back to summary

getName	back to summary
public String getName() Implements javafx.beans.property.ReadOnlyProperty.getName. Doc from javafx.beans.property.ReadOnlyProperty.getName. Returns the name of this property. If the property does not have a name, this method returns an empty `String`. Returns:String the name or an empty `String` Annotations @Override

public String getName()

Implements javafx.beans.property.ReadOnlyProperty.getName.

Doc from javafx.beans.property.ReadOnlyProperty.getName.

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

Returns:String

the name or an empty String

Annotations

@Override

isBound back to summary

isBound	back to summary
public boolean isBound() Implements javafx.beans.property.Property.isBound. Doc from javafx.beans.property.Property.isBound. Can be used to check, if a `Property` is bound. Returns:boolean `true` if the `Property` is bound, `false` otherwise Annotations @Override

public boolean isBound()

Implements javafx.beans.property.Property.isBound.

Doc from javafx.beans.property.Property.isBound.

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

Returns:boolean

true if the Property is bound, false otherwise

Annotations

@Override

removeListener back to summary

removeListener	back to summary
public void removeListener(ChangeListener<? super String> listener) Implements javafx.beans.value.ObservableValue.removeListener. Doc from javafx.beans.value.ObservableValue.removeListener. 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:ChangeListener<? super String> The listener to remove Annotations @Override

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

Implements javafx.beans.value.ObservableValue.removeListener.

Doc from javafx.beans.value.ObservableValue.removeListener.

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:ChangeListener<? super String>: The listener to remove

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. Parameters listener:InvalidationListener The listener to remove 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.

Parameters

listener:InvalidationListener: The listener to remove

Annotations

@Override

set back to summary

set	back to summary
public void set(final String value) Implements javafx.beans.value.WritableObjectValue.set. Doc from javafx.beans.value.WritableObjectValue.set. Set the wrapped value. Should be equivalent to `setValue(java.lang.Object)` Parameters value:String The new value Annotations @Override Exceptions UndeclaredThrowableException: if calling the getter of the Java Bean property throws an `IllegalAccessException` or an `InvocationTargetException`.

public void set(final String value)

Implements javafx.beans.value.WritableObjectValue.set.

Doc from javafx.beans.value.WritableObjectValue.set.

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

Parameters

value:String: The new value

Annotations

@Override

Exceptions

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

unbind back to summary

unbind	back to summary
public void unbind() Implements javafx.beans.property.Property.unbind. Doc from javafx.beans.property.Property.unbind. Remove the unidirectional binding for this `Property`. If the `Property` is not bound, calling this method has no effect. Annotations @Override

public void unbind()

Implements javafx.beans.property.Property.unbind.

Doc from javafx.beans.property.Property.unbind.

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

Annotations

@Override

public final Class JavaBeanStringProperty

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail