Module javafx.base

Class ReadOnlyListProperty<E>

java.lang.Object
javafx.beans.binding.ListExpression<E>
javafx.beans.property.ReadOnlyListProperty<E>
Type Parameters:
E - the type of the List elements
All Implemented Interfaces:
Iterable<E>, Collection<E>, List<E>, Observable, ReadOnlyProperty<ObservableList<E>>, ObservableListValue<E>, ObservableObjectValue<ObservableList<E>>, ObservableValue<ObservableList<E>>, ObservableList<E>
Direct Known Subclasses:
ListProperty, ReadOnlyListPropertyBase

public abstract class ReadOnlyListProperty<E> extends ListExpression<E> implements ReadOnlyProperty<ObservableList<E>>
Superclass for all readonly properties wrapping an ObservableList.
Since:
JavaFX 2.1
See Also:
  • Constructor Details

    • ReadOnlyListProperty

      public ReadOnlyListProperty()
      The constructor of ReadOnlyListProperty.
  • Method Details

    • bindContentBidirectional

      public void bindContentBidirectional(ObservableList<E> list)
      Creates a bidirectional content binding of the ObservableList, that is wrapped in this ReadOnlyListProperty, and another ObservableList.

      A bidirectional content binding ensures that the content of two ObservableLists is the same. If the content of one of the lists changes, the other one will be updated automatically.

      Parameters:
      list - the ObservableList this property should be bound to
      Throws:
      NullPointerException - if list is null
      IllegalArgumentException - if list is the same list that this ReadOnlyListProperty points to
    • unbindContentBidirectional

      public void unbindContentBidirectional(Object object)
      Deletes a bidirectional content binding between the ObservableList, that is wrapped in this ReadOnlyListProperty, and another Object.
      Parameters:
      object - the Object to which the bidirectional binding should be removed
      Throws:
      NullPointerException - if object is null
      IllegalArgumentException - if object is the same list that this ReadOnlyListProperty points to
    • bindContent

      public void bindContent(ObservableList<E> list)
      Creates a content binding between the ObservableList, that is wrapped in this ReadOnlyListProperty, and another ObservableList.

      A content binding ensures that the content of the wrapped ObservableLists is the same as that of the other list. If the content of the other list changes, the wrapped list will be updated automatically. Once the wrapped list is bound to another list, you must not change it directly.

      Parameters:
      list - the ObservableList this property should be bound to
      Throws:
      NullPointerException - if list is null
      IllegalArgumentException - if list is the same list that this ReadOnlyListProperty points to
    • unbindContent

      public void unbindContent(Object object)
      Deletes a content binding between the ObservableList, that is wrapped in this ReadOnlyListProperty, and another Object.
      Parameters:
      object - the Object to which the binding should be removed
      Throws:
      NullPointerException - if object is null
      IllegalArgumentException - if object is the same list that this ReadOnlyListProperty points to
    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface Collection<E>
      Specified by:
      equals in interface List<E>
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface Collection<E>
      Specified by:
      hashCode in interface List<E>
      Overrides:
      hashCode in class Object
    • toString

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