Module javafx.base

Class StringProperty

All Implemented Interfaces:
Observable, Property<String>, ReadOnlyProperty<String>, ObservableObjectValue<String>, ObservableStringValue, ObservableValue<String>, WritableObjectValue<String>, WritableStringValue, WritableValue<String>
Direct Known Subclasses:
JavaBeanStringProperty, StringPropertyBase

public abstract class StringProperty
extends ReadOnlyStringProperty
implements Property<String>, WritableStringValue
This class provides a full implementation of a Property wrapping a String value. The value of a StringProperty can be get and set with ObservableObjectValue.get(), ObservableValue.getValue(), WritableObjectValue.set(Object), and WritableValue.setValue(String). A property can be bound and unbound unidirectional with Property.bind(ObservableValue) and Property.unbind(). Bidirectional bindings can be created and removed with Property.bindBidirectional(Property) and unbindBidirectional(Property). The context of a StringProperty can be read with ReadOnlyProperty.getBean() and ReadOnlyProperty.getName().
Since:
JavaFX 2.0
See Also:
ObservableStringValue, WritableStringValue, ReadOnlyStringProperty, Property
  • Constructor Details

    • StringProperty

      public StringProperty()
      Creates a default StringProperty.
  • Method Details

    • bindBidirectional

      public void bindBidirectional​(Property<?> other, Format format)
      Create a bidirectional binding between this StringProperty and another arbitrary property. Relies on an implementation of Format for conversion.
      Parameters:
      other - the other Property
      format - the Format used to convert between this StringProperty and the other Property
      Throws:
      NullPointerException - if other or format is null
      IllegalArgumentException - if other is this
      Since:
      JavaFX 2.1
    • bindBidirectional

      public <T> void bindBidirectional​(Property<T> other, StringConverter<T> converter)
      Create a bidirectional binding between this StringProperty and another arbitrary property. Relies on an implementation of StringConverter for conversion.
      Type Parameters:
      T - the type of the wrapped Object
      Parameters:
      other - the other Property
      converter - the StringConverter used to convert between this StringProperty and the other Property
      Throws:
      NullPointerException - if other or converter is null
      IllegalArgumentException - if other is this
      Since:
      JavaFX 2.1
    • unbindBidirectional

      public void unbindBidirectional​(Object other)
      Remove a bidirectional binding between this Property and another one. If no bidirectional binding between the properties exists, calling this method has no effect.
      Parameters:
      other - the other Property
      Throws:
      NullPointerException - if other is null
      IllegalArgumentException - if other is this
      Since:
      JavaFX 2.1
    • toString

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