APIdia Launch Partner
Top Description Inners Fields Constructors Methods
javafx.beans.property

public abstract Class StringPropertyBase

extends StringProperty
Class Inheritance
Known Direct Subclasses
javafx.beans.property.SimpleStringProperty
Imports
javafx.beans.InvalidationListener, .Observable, .WeakListener, javafx.beans.value.ChangeListener, .ObservableValue, com.sun.javafx.binding.ExpressionHelper, java.lang.ref.WeakReference

The class StringPropertyBase is the base class for a property wrapping a String value. It provides all the functionality required for a property except for the getBean() and getName() methods, which must be implemented by extending classes.
Since
JavaFX 2.0
See Also
StringProperty

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class

Field Summary

Modifier and TypeField and Description
private ExpressionHelper<String>
private InvalidationListener
private ObservableValue<? extends String>
private boolean
private String

Constructor Summary

AccessConstructor and Description
public
StringPropertyBase()

The constructor of the StringPropertyBase.

public
StringPropertyBase(String
the initial value of the wrapped String
initialValue
)

The constructor of the StringPropertyBase.

Method Summary

Modifier and TypeMethod and Description
public void
addListener(InvalidationListener listener)

Implements javafx.beans.Observable.addListener.

Adds an InvalidationListener which will be notified whenever the Observable becomes invalid.

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

Implements javafx.beans.value.ObservableValue.addListener.

Adds a ChangeListener which will be notified whenever the value of the ObservableValue changes.

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

Implements javafx.beans.property.Property.bind.

Create a unidirection binding for this Property.

protected void
fireValueChangedEvent()

Sends notifications to all attached InvalidationListeners and ChangeListeners.

public String
protected void
invalidated()

The method invalidated() can be overridden to receive invalidation notifications.

public boolean
isBound()

Implements javafx.beans.property.Property.isBound.

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

private void
public void
removeListener(InvalidationListener 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
removeListener(ChangeListener<? super String> 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
set(String newValue)

Implements javafx.beans.value.WritableObjectValue.set.

Set the wrapped value.

public String

Returns:

a string representation of this StringPropertyBase object.
toString
()

Overrides javafx.beans.property.StringProperty.toString.

Returns a string representation of this StringPropertyBase object.

public void
unbind()

Implements javafx.beans.property.Property.unbind.

Remove the unidirectional binding for this Property.

Inherited from javafx.beans.property.StringProperty:
bindBidirectionalbindBidirectionalbindBidirectionalsetValueunbindBidirectionalunbindBidirectional

Field Detail

helperback to summary
private ExpressionHelper<String> helper
listenerback to summary
private InvalidationListener listener
observableback to summary
private ObservableValue<? extends String> observable
validback to summary
private boolean valid
valueback to summary
private String value

Constructor Detail

StringPropertyBaseback to summary
public StringPropertyBase()

The constructor of the StringPropertyBase.

StringPropertyBaseback to summary
public StringPropertyBase(String initialValue)

The constructor of the StringPropertyBase.

Parameters
initialValue:String

the initial value of the wrapped String

Method Detail

addListenerback 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.

Annotations
@Override
addListenerback 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.

Annotations
@Override
bindback to summary
public void bind(ObservableValue<? extends String> newObservable)

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.

Annotations
@Override
fireValueChangedEventback to summary
protected void fireValueChangedEvent()

Sends notifications to all attached InvalidationListeners and ChangeListeners. This method is called when the value is changed, either manually by calling set or in case of a bound property, if the binding becomes invalid.

getback 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

Annotations
@Override
invalidatedback to summary
protected void invalidated()

The method 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.

isBoundback 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.

Annotations
@Override
markInvalidback to summary
private void markInvalid()
removeListenerback 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.

Annotations
@Override
removeListenerback 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.

Annotations
@Override
setback to summary
public void set(String newValue)

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)

Annotations
@Override
toStringback to summary
public String toString()

Overrides javafx.beans.property.StringProperty.toString.

Returns a string representation of this StringPropertyBase object.

Returns:String

a string representation of this StringPropertyBase object.

Annotations
@Override
unbindback 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
javafx.beans.property back to summary

private Class StringPropertyBase.Listener

extends Object
implements InvalidationListener, WeakListener
Class Inheritance
All Implemented Interfaces
javafx.beans.WeakListener, javafx.beans.InvalidationListener

Field Summary

Modifier and TypeField and Description
private final WeakReference<StringPropertyBase>

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public void
invalidated(Observable observable)

Implements javafx.beans.InvalidationListener.invalidated.

This method needs to be provided by an implementation of InvalidationListener.

public boolean
wasGarbageCollected()

Implements javafx.beans.WeakListener.wasGarbageCollected.

Returns true if the linked listener was garbage-collected.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

wrefback to summary
private final WeakReference<StringPropertyBase> wref

Constructor Detail

Listenerback to summary
public Listener(StringPropertyBase ref)

Method Detail

invalidatedback to summary
public void invalidated(Observable observable)

Implements javafx.beans.InvalidationListener.invalidated.

Doc from javafx.beans.InvalidationListener.invalidated.

This method needs to be provided by an implementation of InvalidationListener. It is called if an Observable becomes invalid.

In general, it is considered bad practice to modify the observed value in this method.

Annotations
@Override
wasGarbageCollectedback to summary
public boolean wasGarbageCollected()

Implements javafx.beans.WeakListener.wasGarbageCollected.

Doc from javafx.beans.WeakListener.wasGarbageCollected.

Returns true if the linked listener was garbage-collected. In this case, the listener can be removed from the observable.

Annotations
@Override