Spec-Zone.ru › OpenJavaFX 8
javafx.beans.property

Class StringPropertyBase

java.lang.Object
  • javafx.beans.binding.StringExpression
    • javafx.beans.property.ReadOnlyStringProperty
      • javafx.beans.property.StringProperty
        • javafx.beans.property.StringPropertyBase

All Implemented Interfaces:

Observable, Property<String>, ReadOnlyProperty<String>, ObservableObjectValue<String>, ObservableStringValue, ObservableValue<String>, WritableObjectValue<String>, WritableStringValue, WritableValue<String>

Direct Known Subclasses:

SimpleStringProperty, StyleableStringProperty



public abstract class StringPropertyBase
extends StringProperty
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 ReadOnlyProperty.getBean() and ReadOnlyProperty.getName() methods, which must be implemented by extending classes.

Since:

JavaFX 2.0

See Also:

StringProperty

  • Constructor Summary

    Constructors
    Constructor and Description
    StringPropertyBase()
    The constructor of the StringPropertyBase.
    StringPropertyBase(String initialValue)
    The constructor of the StringPropertyBase.
  • Method Summary

    All MethodsInstance MethodsConcrete Methods
    Modifier and Type Method and Description
    void addListener(ChangeListener<? super String> listener)
    Adds a ChangeListener which will be notified whenever the value of the ObservableValue changes.
    void addListener(InvalidationListener listener)
    Adds an InvalidationListener which will be notified whenever the Observable becomes invalid.
    void bind(ObservableValue<? extends String> newObservable)
    Create a unidirection binding for this Property.
    protected void fireValueChangedEvent()
    Sends notifications to all attached InvalidationListeners and ChangeListeners.
    String get()
    Get the wrapped value.
    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(ChangeListener<? super String> listener)
    Removes the given listener from the list of listeners, that are notified whenever the value of the ObservableValue changes.
    void removeListener(InvalidationListener listener)
    Removes the given listener from the list of listeners, that are notified whenever the value of the Observable becomes invalid.
    void set(String newValue)
    Set the wrapped value.
    String toString()
    Returns a string representation of this StringPropertyBase object.
    void unbind()
    Remove the unidirectional binding for this Property.
    • Methods inherited from class javafx.beans.property.StringProperty

      bindBidirectional, bindBidirectional, bindBidirectional, setValue, unbindBidirectional, unbindBidirectional
    • 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.property.ReadOnlyProperty

      getBean, getName
    • Methods inherited from interface javafx.beans.value.ObservableValue

      getValue
    • Methods inherited from interface javafx.beans.value.WritableValue

      getValue
  • 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.
    • get

      public String get()
      Get the wrapped value. This must be identical to the value returned from WritableValue.getValue().

      This method exists only to align WritableObjectValue API with WritableBooleanValue and subclasses of WritableNumberValue

      Returns:

      The current value

    • set

      public void set(String newValue)
      Set the wrapped value. Should be equivalent to WritableValue.setValue(java.lang.Object)

      Parameters:

      newValue - The new value

      See Also:

      WritableObjectValue.get()

    • isBound

      public boolean isBound()
      Can be used to check, if a Property is bound.

      Returns:

      true if the Property is bound, false otherwise

      See Also:

      Property.bind(javafx.beans.value.ObservableValue)

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

    • unbind

      public void unbind()
      Remove the unidirectional binding for this Property. If the Property is not bound, calling this method has no effect.

      See Also:

      Property.bind(javafx.beans.value.ObservableValue)

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

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API