Module javafx.base

Class StringPropertyBase

    • Constructor Detail

      • StringPropertyBase

        public StringPropertyBase()
        The constructor of the StringPropertyBase.
      • StringPropertyBase

        public StringPropertyBase​(String initialValue)
        The constructor of the StringPropertyBase.
        Parameters:
        initialValue - the initial value of the wrapped String
    • Method Detail

      • addListener

        public void addListener​(InvalidationListener listener)
        Description copied from interface: Observable
        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.

        Parameters:
        listener - The listener to register
        See Also:
        Observable.removeListener(InvalidationListener)
      • removeListener

        public void removeListener​(InvalidationListener listener)
        Description copied from interface: Observable
        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.

        Parameters:
        listener - The listener to remove
        See Also:
        Observable.addListener(InvalidationListener)
      • addListener

        public void addListener​(ChangeListener<? super String> listener)
        Description copied from interface: ObservableValue
        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.

        Parameters:
        listener - The listener to register
        See Also:
        ObservableValue.removeListener(ChangeListener)
      • removeListener

        public void removeListener​(ChangeListener<? super String> listener)
        Description copied from interface: ObservableValue
        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.

        Parameters:
        listener - The listener to remove
        See Also:
        ObservableValue.addListener(ChangeListener)
      • fireValueChangedEvent

        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(java.lang.String) or in case of a bound property, if the binding becomes invalid.
      • invalidated

        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.
      • bind

        public void bind​(ObservableValue<? extends String> newObservable)
        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.

        Parameters:
        newObservable - The observable this Property should be bound to.
      • toString

        public String toString()
        Returns a string representation of this StringPropertyBase object.
        Overrides:
        toString in class StringProperty
        Returns:
        a string representation of this StringPropertyBase object.