- All Implemented Interfaces:
Observable
,ReadOnlyJavaBeanProperty<String>
,ReadOnlyProperty<String>
,ObservableObjectValue<String>
,ObservableStringValue
,ObservableValue<String>
public final class ReadOnlyJavaBeanStringProperty extends ReadOnlyStringPropertyBase implements ReadOnlyJavaBeanProperty<String>
ReadOnlyJavaBeanStringProperty
provides an adapter between a regular
read only Java Bean property of type String
and a JavaFX
ReadOnlyStringProperty
. It cannot be created directly, but a
ReadOnlyJavaBeanStringPropertyBuilder
has to be used.
As a minimum, the Java Bean class must implement a getter for the
property.
The class, as well as the getter method, 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 Java Bean property is bound (i.e. it supports
PropertyChangeListeners), this ReadOnlyJavaBeanStringProperty
will be
aware of changes in the Java Bean. Otherwise it can be notified about
changes by calling fireValueChangedEvent()
.
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:
ReadOnlyStringProperty
,ReadOnlyJavaBeanStringPropertyBuilder
-
Method Summary
Modifier and Type Method Description void
dispose()
Signals to the JavaFX property that it will not be used anymore and any references can be removed.void
fireValueChangedEvent()
Sends notifications to all attachedInvalidationListeners
andChangeListeners
.String
get()
Returns the current value of thisObservableObjectValue<T>
.Object
getBean()
Returns theObject
that contains this property.String
getName()
Returns the name of this property.Methods inherited from class javafx.beans.property.ReadOnlyStringPropertyBase
addListener, addListener, removeListener, removeListener
Methods inherited from class javafx.beans.property.ReadOnlyStringProperty
toString
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.Observable
addListener, removeListener
Methods inherited from interface javafx.beans.value.ObservableValue
addListener, getValue, removeListener
-
Method Details
-
get
Returns the current value of thisObservableObjectValue<T>
.- Specified by:
get
in interfaceObservableObjectValue<String>
- Returns:
- The current value
- Throws:
UndeclaredThrowableException
- if calling the getter of the Java Bean property throws anIllegalAccessException
or anInvocationTargetException
.
-
getBean
Returns theObject
that contains this property. If this property is not contained in anObject
,null
is returned.- Specified by:
getBean
in interfaceReadOnlyProperty<String>
- Returns:
- the containing
Object
ornull
-
getName
Returns the name of this property. If the property does not have a name, this method returns an emptyString
.- Specified by:
getName
in interfaceReadOnlyProperty<String>
- Returns:
- the name or an empty
String
-
fireValueChangedEvent
public void fireValueChangedEvent()Sends notifications to all attachedInvalidationListeners
andChangeListeners
. This method needs to be called, if the value of this property changes.- Specified by:
fireValueChangedEvent
in interfaceReadOnlyJavaBeanProperty<String>
- Overrides:
fireValueChangedEvent
in classReadOnlyStringPropertyBase
-
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 interfaceReadOnlyJavaBeanProperty<String>
-