scalafx
API
Generated with
scalafx/scalafx/scalafx.beans/scalafx.beans.binding/MapBinding

MapBinding

scalafx.beans.binding.MapBinding
See theMapBinding companion object
class MapBinding[K, V](val delegate: MapBinding[K, V]) extends MapExpression[K, V], ObservableValue[ObservableMap[K, V], ObservableMap[K, V]]

Wraps a JavaFX $URL0 MapBinding]].

Attributes

Companion
object
Graph
Supertypes
trait ObservableValue[ObservableMap[K, V], ObservableMap[K, V]]
trait Observable
trait SFXDelegate[ObservableValue[ObservableMap[K, V]]]
class MapExpression[K, V]
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

override def value: ObservableMap[K, V]

Returns ObservableValue

Returns ObservableValue

Attributes

Returns

ObservableValue

Definition Classes

Inherited methods

def ++=(m: Map[K, V]): Unit

Attributes

Inherited from:
MapExpression
def +=(kv: (K, V)): V

Attributes

Inherited from:
MapExpression
def -=(key: Any): V

Attributes

Inherited from:
MapExpression
def apply(): ObservableMap[K, V]

Returns ObservableValue

Returns ObservableValue

Attributes

Returns

ObservableValue

Inherited from:
ObservableValue
def empty: ReadOnlyBooleanProperty

A boolean property that is true, if the the map is empty.

A boolean property that is true, if the the map is empty.

Attributes

Inherited from:
MapExpression
override def equals(ref: Any): Boolean

Verifies if a object is equals to this delegate.

Verifies if a object is equals to this delegate.

Value parameters

ref

Object to be compared.

Attributes

Returns

if the other object is equals to this delegate or not.

Definition Classes
SFXDelegate -> Any
Inherited from:
SFXDelegate
def get(key: K): Option[V]

Optionally returns the value associated with a key.

Optionally returns the value associated with a key.

Value parameters

key

the key value

Attributes

Returns

an option value containing the value associated with key in this $MAP, or None if none exists.

Inherited from:
MapExpression
override def hashCode: Int

Attributes

Returns

The delegate hashcode

Definition Classes
SFXDelegate -> Any
Inherited from:
SFXDelegate
def isEqualTo(other: ObservableMap[_, _]): BooleanBinding

Creates a new BooleanBinding that holds true if this map is equal to another ObservableMap.

Creates a new BooleanBinding that holds true if this map is equal to another ObservableMap.

Value parameters

other

the other ObservableMap

Attributes

Returns

the new BooleanBinding

Inherited from:
MapExpression
def isNotEqualTo(other: ObservableMap[_, _]): BooleanBinding

Creates a new BooleanBinding that holds true if this map is not equal to another ObservableMap.

Creates a new BooleanBinding that holds true if this map is not equal to another ObservableMap.

Value parameters

other

the other ObservableMap

Attributes

Returns

the new BooleanBinding

Inherited from:
MapExpression
def onChange[J1 >: ObservableMap[K, V]](op: => Unit): Subscription

Adds a function as a `ChangeListener`. This function has no arguments because it will not handle values changed.

Adds a function as a `ChangeListener`. This function has no arguments because it will not handle values changed.

Value parameters

op

A Function with no arguments. It will be called when value changes.

Attributes

Returns

A new scalafx.event.subscriptions.Subscription to remove ObservableValue.

Inherited from:
ObservableValue
def onChange[J1 >: ObservableMap[K, V]](op: (ObservableValue[ObservableMap[K, V], ObservableMap[K, V]], J1, J1) => Unit): Subscription

Adds a function as a `ChangeListener`. This function has all arguments from T, T) `changed` method from ChangeListener.

Adds a function as a `ChangeListener`. This function has all arguments from T, T) `changed` method from ChangeListener.

Type parameters

J1

J superclass.

Value parameters

op

Function that receives a `ObservableValue`, the old value and the new value. It will be called when value changes.

Attributes

Returns

A new scalafx.event.subscriptions.Subscription to remove ObservableValue.

Inherited from:
ObservableValue
def onInvalidate(op: => Unit): Subscription

Adds a no argument function as a JavaFX `InvalidationListener`. This function has no arguments because it will not handle invalidated values.

Adds a no argument function as a JavaFX `InvalidationListener`. This function has no arguments because it will not handle invalidated values.

Value parameters

op

A Function with no arguments. It will be called when value was invalidated.

Attributes

Returns

A new scalafx.event.subscriptions.Subscription to remove JavaFX InvalidationListener.

Inherited from:
Observable
def onInvalidate(op: Observable => Unit): Subscription

Adds a function as a JavaFX `InvalidationListener`. This function has all arguments from `invalidated` method from InvalidationListener.

Adds a function as a JavaFX `InvalidationListener`. This function has all arguments from `invalidated` method from InvalidationListener.

Value parameters

op

Function that receives a ScalaFX Observable. It will be called when value was invalidated.

Attributes

Returns

A new scalafx.event.subscriptions.Subscription to remove JavaFX InvalidationListener.

Inherited from:
Observable
def size: ReadOnlyIntegerProperty

An integer property that represents the size of the map.

An integer property that represents the size of the map.

Attributes

Inherited from:
MapExpression
override def toString: String

Attributes

Returns

Returns the original delegate's toString() adding a [SFX] prefix.

Definition Classes
SFXDelegate -> Any
Inherited from:
SFXDelegate
def values(): Iterable[V]

Attributes

Inherited from:
MapExpression
def when(condition: ObservableValue[Boolean, Boolean]): ObservableValue[ObservableMap[K, V], ObservableMap[K, V]]

Returns an ObservableValue that holds this value and is updated only when condition holds true.

Returns an ObservableValue that holds this value and is updated only when condition holds true.

The returned ObservableValue only observes this value when condition holds true. This allows this ObservableValue and the conditional ObservableValue to be garbage collected if neither is otherwise strongly referenced when condition holds false. This is in contrast to the general behavior of bindings, where the binding is only eligible for garbage collection when not observed itself.

A condition holding null is treated as holding false.

For example:

  val condition         = BooleanProperty(true)
  val longLivedProperty = StringProperty("A")
  val whenProperty      = longLivedProperty.when(condition)

  // observe whenProperty, which will in turn observe longLivedProperty
  whenProperty.onChange((_, old, current) => println(s"whenProperty change : $old -> $current"));

  longLivedProperty.value = "B" // "B" is printed

  condition.value = false

  // After condition becomes false, whenProperty stops observing longLivedProperty; condition
  // and whenProperty may now be eligible for GC despite being observed by the ChangeListener
  longLivedProperty.value = "C" // nothing is printed
  longLivedProperty.value = "D" // nothing is printed

  condition.value = true // longLivedProperty is observed again, and "D" is printed

Value parameters

condition

a boolean ObservableValue, cannot be null

Attributes

Returns

an ObservableValue that holds this value whenever the given condition evaluates to true, otherwise holds the last seen value; never returns null

Since

20

Inherited from:
ObservableValue

Concrete fields

override val delegate: MapBinding[K, V]

JavaFX object to be wrapped.

JavaFX object to be wrapped.

Attributes

Generated with