scalafx
API
Generated with
scalafx/scalafx/scalafx.beans/scalafx.beans.property/ReadOnlyMapWrapper

ReadOnlyMapWrapper

scalafx.beans.property.ReadOnlyMapWrapper
See theReadOnlyMapWrapper companion object
class ReadOnlyMapWrapper[K, V](val delegate: ReadOnlyMapWrapper[K, V]) extends MapProperty[K, V], SFXDelegate[ReadOnlyMapWrapper[K, V]]

Wraps javafx.beans.property.ReadOnlyMapWrapper.

Attributes

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

Members list

Value members

Constructors

def this(value: ObservableMap[K, V])

Creates a new ReadOnlyMapWrapper instance.

Creates a new ReadOnlyMapWrapper instance.

Value parameters

value

the initial value of the wrapped value

Attributes

def this(bean: Any, name: String)

Creates a new ReadOnlyMapWrapper.

Creates a new ReadOnlyMapWrapper.

Value parameters

bean

the bean of this MapProperty

name

the name of this MapProperty

Attributes

def this(bean: Any, name: String, value: ObservableMap[K, V])

Creates a new ReadOnlyMapWrapper.

Creates a new ReadOnlyMapWrapper.

Value parameters

bean

the bean of this MapProperty

name

the name of this MapProperty

value

the initial value

Attributes

Concrete methods

def readOnlyProperty: ReadOnlyMapProperty[K, V]

Returns the readonly property, that is synchronized with this ReadOnlyMapWrapper.

Returns the readonly property, that is synchronized with this ReadOnlyMapWrapper.

Attributes

Returns

the readonly property

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 ->(endVal: ObservableMap[K, V]): Tweenable[T, J]

Returns a new scalafx.animation.Tweenable from a End Value.

Returns a new scalafx.animation.Tweenable from a End Value.

Value parameters

endVal

End Value

Attributes

Returns

a new Tweenable with this Property and end value passed.

Inherited from:
Property
def <==(v: ObservableValue[_ <: ObservableMap[K, V], _ <: ObservableMap[K, V]]): Unit

Create a unidirectional binding for this Property.

Create a unidirectional binding for this Property.

Value parameters

v

ScalaFX ObservableValue this Property should be bound to.

Attributes

Inherited from:
Property
def <==(v: ObservableValue[_ <: ObservableMap[K, V]]): Unit

Create a unidirectional binding for this Property.

Create a unidirectional binding for this Property.

Value parameters

v

JavaFX ObservableValue this Property should be bound to.

Attributes

Inherited from:
Property
def <==>(v: Property[ObservableMap[K, V]]): Unit

Create a bidirectional binding between this Property and another JavaFX Property.

Create a bidirectional binding between this Property and another JavaFX Property.

Value parameters

v

the other JavaFX Property

Attributes

Inherited from:
Property
def <==>(v: Property[ObservableMap[K, V], ObservableMap[K, V]]): Unit

Create a bidirectional binding between this Property and another ScalaFX Property.

Create a bidirectional binding between this Property and another ScalaFX Property.

Value parameters

v

the other ScalaFX Property

Attributes

Inherited from:
Property
def apply(): T

Returns ObservableValue

Returns ObservableValue

Attributes

Returns

ObservableValue

Inherited from:
ObservableValue
def bean: AnyRef

Returns the Object that contains this property.

Returns the Object that contains this property.

Attributes

Inherited from:
ReadOnlyProperty
def bindContent(map: ObservableMap[K, V]): Unit

Creates a content binding between the ObservableMap, that is wrapped in this ReadOnlyMapProperty, and another ObservableMap.

Creates a content binding between the ObservableMap, that is wrapped in this ReadOnlyMapProperty, and another ObservableMap.

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

Value parameters

map

the ObservableMap this property should be bound to

Attributes

Inherited from:
ReadOnlyMapProperty
def bindContentBidirectional(map: ObservableMap[K, V]): Unit

Creates a bidirectional content binding of the ObservableMap, that is wrapped in this ReadOnlyMapProperty, and another ObservableMap.

Creates a bidirectional content binding of the ObservableMap, that is wrapped in this ReadOnlyMapProperty, and another ObservableMap.

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

Value parameters

map

the ObservableMap this property should be bound to

Attributes

Inherited from:
ReadOnlyMapProperty
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 name: String

Returns the name of this property.

Returns the name of this property.

Attributes

Inherited from:
ReadOnlyProperty
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 unbind(v: Property[ObservableMap[K, V]]): Unit

Remove a bidirectional binding between this Property and another JavaFX one. If no bidirectional binding between the properties exists, calling this method has no effect.

Remove a bidirectional binding between this Property and another JavaFX one. If no bidirectional binding between the properties exists, calling this method has no effect.

Value parameters

v
  • the other Property

Attributes

Inherited from:
Property
def unbind(v: Property[ObservableMap[K, V], ObservableMap[K, V]]): Unit

Remove a bidirectional binding between this Property and another ScalaFX one. If no bidirectional binding between the properties exists, calling this method has no effect.

Remove a bidirectional binding between this Property and another ScalaFX one. If no bidirectional binding between the properties exists, calling this method has no effect.

Value parameters

v
  • the other Property

Attributes

Inherited from:
Property
def unbind(): Unit

Remove the unidirectional binding for this Property. If the Property is not bound, calling this method has no effect.

Remove the unidirectional binding for this Property. If the Property is not bound, calling this method has no effect.

Attributes

Inherited from:
Property
def unbindContent[T <: Object](sfx: SFXDelegate[T]): Unit

Deletes a content binding between the ObservableMap, that is wrapped in this ReadOnlyMapProperty, and another Object.

Deletes a content binding between the ObservableMap, that is wrapped in this ReadOnlyMapProperty, and another Object.

This is a helper method that calls the JavaFX counterpart with a delegate rather than the original object.

Value parameters

sfx

the SFXDelegate object to which the binding should be removed

Attributes

Inherited from:
ReadOnlyMapProperty
def unbindContentBidirectional[T <: Object](sfx: SFXDelegate[T]): Unit

Deletes a bidirectional content binding between the ObservableMap, that is wrapped in this ReadOnlyMapProperty, and another Object.

Deletes a bidirectional content binding between the ObservableMap, that is wrapped in this ReadOnlyMapProperty, and another Object.

This is a helper method that calls the JavaFX counterpart with a delegate rather than the original object.

Value parameters

sfx

the SFXDelegate object to which the binding should be removed

Attributes

Inherited from:
ReadOnlyMapProperty
def update(v: ObservableMap[K, V]): Unit

Set the wrapped value.

Set the wrapped value.

Value parameters

v

The new value

Attributes

Inherited from:
Property
override def value: ObservableMap[K, V]

Returns ObservableValue

Returns ObservableValue

Attributes

Returns

ObservableValue

Definition Classes
Inherited from:
ReadOnlyMapProperty
override def value_=(v: ObservableMap[K, V]): Unit

Set the wrapped value.

Set the wrapped value.

Value parameters

v

The new value

Attributes

Definition Classes
Inherited from:
MapProperty
def values(): Iterable[V]

Attributes

Inherited from:
MapExpression
def when(condition: ObservableValue[Boolean, Boolean]): ObservableValue[J, J]

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: ReadOnlyMapWrapper[K, V]

JavaFX object to be wrapped.

JavaFX object to be wrapped.

Attributes

Generated with