Class StringPropertyBase
- All Implemented Interfaces:
Observable
,Property<String>
,ReadOnlyProperty<String>
,ObservableObjectValue<String>
,ObservableStringValue
,ObservableValue<String>
,WritableObjectValue<String>
,WritableStringValue
,WritableValue<String>
- Direct Known Subclasses:
SimpleStringProperty
StringPropertyBase
is the base class for a property
wrapping a String
value.
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
ConstructorsConstructorDescriptionThe constructor of theStringPropertyBase
.StringPropertyBase
(String initialValue) The constructor of theStringPropertyBase
. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addListener
(InvalidationListener listener) Adds anInvalidationListener
which will be notified whenever theObservable
becomes invalid.void
addListener
(ChangeListener<? super String> listener) Adds aChangeListener
which will be notified whenever the value of theObservableValue
changes.void
bind
(ObservableValue<? extends String> newObservable) Create a unidirection binding for thisProperty
.protected void
Sends notifications to all attachedInvalidationListeners
andChangeListeners
.get()
Get the wrapped value.protected void
The methodinvalidated()
can be overridden to receive invalidation notifications.boolean
isBound()
Can be used to check, if aProperty
is bound.void
removeListener
(InvalidationListener listener) Removes the given listener from the list of listeners, that are notified whenever the value of theObservable
becomes invalid.void
removeListener
(ChangeListener<? super String> listener) Removes the given listener from the list of listeners, that are notified whenever the value of theObservableValue
changes.void
Set the wrapped value.toString()
Returns a string representation of thisStringPropertyBase
object.void
unbind()
Remove the unidirectional binding for thisProperty
.Methods inherited from class javafx.beans.property.StringProperty
bindBidirectional, bindBidirectional, setValue, unbindBidirectional, unbindBidirectional
Methods inherited from class javafx.beans.binding.StringExpression
getValue, getValueSafe
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface javafx.beans.value.ObservableValue
getValue
Methods inherited from interface javafx.beans.property.ReadOnlyProperty
getBean, getName
Methods inherited from interface javafx.beans.value.WritableValue
getValue
-
Constructor Details
-
StringPropertyBase
public StringPropertyBase()The constructor of theStringPropertyBase
. -
StringPropertyBase
The constructor of theStringPropertyBase
.- Parameters:
initialValue
- the initial value of the wrappedString
-
-
Method Details
-
addListener
Description copied from interface:Observable
Adds anInvalidationListener
which will be notified whenever theObservable
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 differentObservables
.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 callingremoveListener
after use or to use an instance ofWeakInvalidationListener
avoid this situation.- Parameters:
listener
- The listener to register- See Also:
-
removeListener
Description copied from interface:Observable
Removes the given listener from the list of listeners, that are notified whenever the value of theObservable
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
Description copied from interface:ObservableValue
Adds aChangeListener
which will be notified whenever the value of theObservableValue
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 differentObservableValues
.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 callingremoveListener
after use or to use an instance ofWeakChangeListener
avoid this situation.- Parameters:
listener
- The listener to register- See Also:
-
removeListener
Description copied from interface:ObservableValue
Removes the given listener from the list of listeners, that are notified whenever the value of theObservableValue
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()Sends notifications to all attachedInvalidationListeners
andChangeListeners
. This method is called when the value is changed, either manually by callingset(java.lang.String)
or in case of a bound property, if the binding becomes invalid. -
invalidated
protected void invalidated()The methodinvalidated()
can be overridden to receive invalidation notifications. This is the preferred option inObjects
defining the property, because it requires less memory. The default implementation is empty. -
get
Get the wrapped value. This must be identical to the value returned fromWritableValue.getValue()
.This method exists only to align WritableObjectValue API with
WritableBooleanValue
and subclasses ofWritableNumberValue
- Returns:
- The current value
-
set
Set the wrapped value. Should be equivalent toWritableValue.setValue(java.lang.Object)
- Parameters:
newValue
- The new value- See Also:
-
isBound
public boolean isBound()Can be used to check, if aProperty
is bound.- Returns:
true
if theProperty
is bound,false
otherwise- See Also:
-
bind
Create a unidirection binding for thisProperty
.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 thisProperty
should be bound to.
-
unbind
public void unbind()Remove the unidirectional binding for thisProperty
. If theProperty
is not bound, calling this method has no effect. -
toString
Returns a string representation of thisStringPropertyBase
object.- Overrides:
toString
in classStringProperty
- Returns:
- a string representation of this
StringPropertyBase
object.
-