javafx.beans.property.adapter

Class JavaBeanStringProperty

java.lang.Object

StringProperty

javafx.beans.property.adapter.JavaBeanStringProperty

All Implemented Interfaces:

JavaBeanProperty<java.lang.String>, ReadOnlyJavaBeanProperty<java.lang.String>

public final class JavaBeanStringProperty
extends StringProperty
implements JavaBeanProperty<java.lang.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:

javafx.beans.property.StringProperty, JavaBeanStringPropertyBuilder

Field Summary

Fields

Modifier and Type	Field and Description
private java.security.AccessControlContext	acc
private PropertyDescriptor	descriptor
private <any>	helper
private <any>	listener
private <any>	observable

Constructor Summary

Constructors

Constructor and Description
JavaBeanStringProperty(PropertyDescriptor descriptor, java.lang.Object bean)

Method Summary

Modifier and Type	Method and Description
void	addListener(<any> listener)
void	addListener(InvalidationListener listener)
void	bind(<any> observable)
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.
java.lang.String	get()
java.lang.Object	getBean()
java.lang.String	getName()
boolean	isBound()
void	removeListener(<any> listener)
void	removeListener(InvalidationListener listener)
void	set(java.lang.String value)
void	unbind()

Methods inherited from class java.lang.Object

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

Field Detail

descriptor

private final PropertyDescriptor descriptor

listener

private final <any> listener

observable

private <any> observable

helper

private <any> helper

acc

private final java.security.AccessControlContext acc

Constructor Detail

JavaBeanStringProperty

JavaBeanStringProperty(PropertyDescriptor descriptor,
                       java.lang.Object bean)

Method Detail

get

public java.lang.String get()

Throws:

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

set

public void set(java.lang.String value)

Throws:

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

bind

public void bind(<any> observable)

unbind

public void unbind()

isBound

public boolean isBound()

getBean

public java.lang.Object getBean()

getName

public java.lang.String getName()

addListener

public void addListener(<any> listener)

removeListener

public void removeListener(<any> listener)

addListener

public void addListener(InvalidationListener listener)

removeListener

public void removeListener(InvalidationListener listener)

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<java.lang.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<java.lang.String>