SetBinding

java.lang.Object
- javafx.beans.binding.SetExpression<E>
- - javafx.beans.binding.SetBinding<E>

Type Parameters:

E - the type of the Set elements

All Implemented Interfaces:

Binding<<any>>
```
public abstract class SetBinding<E>
extends SetExpression<E>
implements Binding<<any>>
```
Base class that provides most of the functionality needed to implement a Binding of an javafx.collections.ObservableSet.
SetBinding provides a simple invalidation-scheme. An extending class can register dependencies by calling bind(Observable...). If one of the registered dependencies becomes invalid, this SetBinding is marked as invalid. With unbind(Observable...) listening to dependencies can be stopped.
To provide a concrete implementation of this class, the method computeValue() has to be implemented to calculate the value of this binding based on the current state of the dependencies. It is called when get() is called for an invalid binding.
See DoubleBinding for an example how this base class can be extended.

Since:

JavaFX 2.1

See Also:

Binding, SetExpression

Property Summary

All Methods Instance Methods Concrete Methods
Type	Property and Description
`ReadOnlyBooleanProperty`	`empty` A boolean property that is `true`, if the set is empty.
`ReadOnlyIntegerProperty`	`size` An integer property that represents the size of the set.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

private class SetBinding.EmptyProperty

private class SetBinding.SizeProperty

Nested Classes
Modifier and Type	Class and Description
`private class`	`SetBinding.EmptyProperty`
`private class`	`SetBinding.SizeProperty`

Field Summary

Fields
Modifier and Type	Field and Description
`private SetBinding.EmptyProperty`	`empty0`
`private <any>`	`helper`
`private BindingHelperObserver`	`observer`
`private <any>`	`setChangeListener`
`private SetBinding.SizeProperty`	`size0`
`private boolean`	`valid`
`private <any>`	`value`

Constructor Summary

Constructors
Constructor and Description

SetBinding()

Constructors
Constructor and Description
`SetBinding()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addListener(<any> listener)`
`void`	`addListener(<any> listener)`
`void`	`addListener(InvalidationListener listener)`
`protected void`	`bind(Observable... dependencies)` Start observing the dependencies for changes.
`protected abstract <any>`	`computeValue()` Calculates the current value of this binding.
`void`	`dispose()` A default implementation of `dispose()` that is empty.
`ReadOnlyBooleanProperty`	`emptyProperty()` A boolean property that is `true`, if the set is empty.
`<any>`	`get()` Returns the result of `computeValue()`.
`<any>`	`getDependencies()` A default implementation of `getDependencies()` that returns an empty `javafx.collections.ObservableList`.
`void`	`invalidate()` Mark a binding as invalid.
`private void`	`invalidateProperties()`
`boolean`	`isValid()` Checks if a binding is valid.
`protected void`	`onInvalidating()` The method onInvalidating() can be overridden by extending classes to react, if this binding becomes invalid.
`void`	`removeListener(<any> listener)`
`void`	`removeListener(<any> listener)`
`void`	`removeListener(InvalidationListener listener)`
`ReadOnlyIntegerProperty`	`sizeProperty()` An integer property that represents the size of the set.
`java.lang.String`	`toString()` Returns a string representation of this `SetBinding` object.
`protected void`	`unbind(Observable... dependencies)` Stop observing the dependencies for changes.

Methods inherited from class javafx.beans.binding.SetExpression
add, addAll, asString, clear, contains, containsAll, getSize, getValue, isEmpty, isEqualTo, isNotEqualTo, isNotNull, isNull, iterator, remove, removeAll, retainAll, setExpression, size, toArray, toArray

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Property Detail
  - size
```
public ReadOnlyIntegerProperty sizeProperty
```
    Specified by:
    
    sizeProperty in class SetExpression<E>
    
    Returns:
    
    the property
  - empty
```
public ReadOnlyBooleanProperty emptyProperty
```
    Specified by:
    
    emptyProperty in class SetExpression<E>
    
    Returns:
    
    the ReadOnlyBooleanProperty
- Field Detail
  - setChangeListener
```
private final <any> setChangeListener
```
  - value
```
private <any> value
```
  - valid
```
private boolean valid
```
  - observer
```
private BindingHelperObserver observer
```
  - helper
```
private <any> helper
```
  - size0
```
private SetBinding.SizeProperty size0
```
  - empty0
```
private SetBinding.EmptyProperty empty0
```
- Constructor Detail
  - SetBinding
```
public SetBinding()
```
- Method Detail
  - sizeProperty
```
public ReadOnlyIntegerProperty sizeProperty()
```
    Description copied from class: SetExpression
    
    An integer property that represents the size of the set.
    
    Specified by:
    
    sizeProperty in class SetExpression<E>
    
    Returns:
    
    the property
  - emptyProperty
```
public ReadOnlyBooleanProperty emptyProperty()
```
    Description copied from class: SetExpression
    
    A boolean property that is true, if the set is empty.
    
    Specified by:
    
    emptyProperty in class SetExpression<E>
    
    Returns:
    
    the ReadOnlyBooleanProperty
  - addListener
```
public void addListener(InvalidationListener listener)
```
  - removeListener
```
public void removeListener(InvalidationListener listener)
```
  - addListener
```
public void addListener(<any> listener)
```
  - removeListener
```
public void removeListener(<any> listener)
```
  - addListener
```
public void addListener(<any> listener)
```
  - removeListener
```
public void removeListener(<any> listener)
```
  - bind
```
protected final void bind(Observable... dependencies)
```
    Start observing the dependencies for changes. If the value of one of the dependencies changes, the binding is marked as invalid.
    
    Parameters:
    
    dependencies - the dependencies to observe
  - unbind
```
protected final void unbind(Observable... dependencies)
```
    Stop observing the dependencies for changes.
    
    Parameters:
    
    dependencies - the dependencies to stop observing
  - dispose
```
public void dispose()
```
    A default implementation of dispose() that is empty.
    
    Specified by:
    
    dispose in interface Binding<<any>>
  - getDependencies
```
public <any> getDependencies()
```
    A default implementation of getDependencies() that returns an empty javafx.collections.ObservableList.
    
    Specified by:
    
    getDependencies in interface Binding<<any>>
    
    Returns:
    
    an empty ObservableList
  - get
```
public final <any> get()
```
    Returns the result of computeValue(). The method computeValue() is only called if the binding is invalid. The result is cached and returned if the binding did not become invalid since the last call of get().
    
    Returns:
    
    the current value
  - onInvalidating
```
protected void onInvalidating()
```
    The method onInvalidating() can be overridden by extending classes to react, if this binding becomes invalid. The default implementation is empty.
  - invalidateProperties
```
private void invalidateProperties()
```
  - invalidate
```
public final void invalidate()
```
    Description copied from interface: Binding
    
    Mark a binding as invalid. This forces the recalculation of the value of the Binding next time it is request.
    
    Specified by:
    
    invalidate in interface Binding<<any>>
  - isValid
```
public final boolean isValid()
```
    Description copied from interface: Binding
    
    Checks if a binding is valid.
    
    Specified by:
    
    isValid in interface Binding<<any>>
    
    Returns:
    
    true if the Binding is valid, false otherwise
  - computeValue
```
protected abstract <any> computeValue()
```
    Calculates the current value of this binding.
    Classes extending SetBinding have to provide an implementation of computeValue.
    
    Returns:
    
    the current value
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this SetBinding object.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a string representation of this SetBinding object.

Class SetBinding<E>

Property Summary

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class javafx.beans.binding.SetExpression

Methods inherited from class java.lang.Object

Property Detail

size

empty

Field Detail

setChangeListener

value

valid

observer

helper

size0

empty0

Constructor Detail

SetBinding

Method Detail

sizeProperty

emptyProperty

addListener

removeListener

addListener

removeListener

addListener

removeListener

bind

unbind

dispose

getDependencies

get

onInvalidating

invalidateProperties

invalidate

isValid

computeValue

toString