Class ObjectPropertyBase<T>
- Type Parameters:
-
T- the type of the wrapped value
- All Implemented Interfaces:
-
Observable,Property<T>,ReadOnlyProperty<T>,ObservableObjectValue<T>,ObservableValue<T>,WritableObjectValue<T>,WritableValue<T>
- Direct Known Subclasses:
-
SimpleObjectProperty,StyleableObjectProperty
public abstract class ObjectPropertyBase<T> extends ObjectProperty<T>
ObjectPropertyBase is the base class for a property wrapping an arbitrary Object. It provides all the functionality required for a property except for the ReadOnlyProperty.getBean() and ReadOnlyProperty.getName() methods, which must be implemented by extending classes.- Since:
- JavaFX 2.0
- See Also:
Constructor Summary
| Constructor | Description |
|---|---|
ObjectPropertyBase() |
The constructor of the ObjectPropertyBase. |
ObjectPropertyBase |
The constructor of the ObjectPropertyBase. |
Method Summary
| Modifier and Type | Method | Description |
|---|---|---|
void |
addListener |
Adds an InvalidationListener which will be notified whenever the Observable becomes invalid. |
void |
addListener |
Adds a ChangeListener which will be notified whenever the value of the ObservableValue changes. |
void |
bind |
Create a unidirection binding for this Property. |
protected void |
fireValueChangedEvent() |
Sends notifications to all attached InvalidationListeners and ChangeListeners. |
T |
get() |
Returns the current value of this ObservableObjectValue<T>. |
protected void |
invalidated() |
The method invalidated() can be overridden to receive invalidation notifications. |
boolean |
isBound() |
Can be used to check, if a Property is bound. |
void |
removeListener |
Removes the given listener from the list of listeners, that are notified whenever the value of the Observable becomes invalid. |
void |
removeListener |
Removes the given listener from the list of listeners that are notified whenever the value of the ObservableValue changes. |
void |
set |
Set the wrapped value. |
String |
toString() |
Returns a string representation of this ObjectPropertyBase object. |
void |
unbind() |
Remove the unidirectional binding for this Property. |
Methods declared in class javafx.beans.property.ObjectProperty
bindBidirectional, setValue, unbindBidirectional
Methods declared in class javafx.beans.binding.ObjectExpression
asString, asString, asString, getValue, isEqualTo, isEqualTo, isNotEqualTo, isNotEqualTo, isNotNull, isNull, objectExpression
Methods declared in class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods declared in interface javafx.beans.Observable
subscribe
Methods declared in interface javafx.beans.value.ObservableValue
flatMap, getValue, map, orElse, subscribe, subscribe, when
Methods declared in interface javafx.beans.property.ReadOnlyProperty
getBean, getName
Methods declared in interface javafx.beans.value.WritableValue
getValue
Constructor Details
ObjectPropertyBase
public ObjectPropertyBase()
ObjectPropertyBase.ObjectPropertyBase
public ObjectPropertyBase(T initialValue)
ObjectPropertyBase.- Parameters:
-
initialValue- the initial value of the wrappedObject
Method Details
addListener
public void addListener(InvalidationListener listener)
ObservableInvalidationListener 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:
removeListener
public void removeListener(InvalidationListener listener)
ObservableObservable 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:
addListener
public void addListener(ChangeListener<? super T> listener)
ObservableValueChangeListener 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:
removeListener
public void removeListener(ChangeListener<? super T> listener)
ObservableValueObservableValue 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:
fireValueChangedEvent
protected void fireValueChangedEvent()
InvalidationListeners and ChangeListeners. This method is called when the value is changed, either manually by calling set(T) or in case of a bound property, if the binding becomes invalid.invalidated
protected void invalidated()
invalidated() can be overridden to receive invalidation notifications. This is the preferred option in Objects defining the property, because it requires less memory. The default implementation is empty.get
public T get()
ObservableObjectValue<T>.- Returns:
- The current value
set
public void set(T newValue)
WritableValue.setValue(java.lang.Object)
- Parameters:
-
newValue- The new value - See Also:
isBound
public boolean isBound()
Property is bound.- Returns:
-
trueif thePropertyis bound,falseotherwise - See Also:
bind
public void bind(ObservableValue<? extends T> newObservable)
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:
-
newObservable- The observable thisPropertyshould be bound to.
unbind
public void unbind()
Property. If the Property is not bound, calling this method has no effect.- See Also:
toString
public String toString()
ObjectPropertyBase object.- Overrides:
-
toStringin classObjectProperty<T> - Returns:
- a string representation of this
ObjectPropertyBaseobject.
© 2008, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from JavaFX API Documentation.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Java, JavaFX and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.