-
Notifications
You must be signed in to change notification settings - Fork 67
/
ObservableValue.scala
150 lines (126 loc) · 6.67 KB
/
ObservableValue.scala
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
/*
* Copyright (c) 2011-2017, ScalaFX Project
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of the ScalaFX Project nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE SCALAFX PROJECT OR ITS CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package scalafx.beans.value
import javafx.beans.{value => jfxbv}
import javafx.{collections => jfxc}
import scala.language.implicitConversions
import scalafx.beans.Observable
import scalafx.collections.{ObservableBuffer, ObservableMap, ObservableSet}
import scalafx.delegate.SFXDelegate
import scalafx.event.subscriptions.Subscription
object ObservableValue {
implicit def sfxObservableValue2jfx[T, J](ov: ObservableValue[T, J]): jfxbv.ObservableValue[J] = if (ov != null) ov.delegate else null
// Conversions to JavaFX Marker classes (no need for these in scala, due to specialized classes)
implicit def sfxObservableValue2jfxIntegerValue(ov: ObservableValue[Int, Number]): jfxbv.ObservableIntegerValue = ov.delegate.asInstanceOf[jfxbv.ObservableIntegerValue]
implicit def sfxObservableValue2jfxLongValue(ov: ObservableValue[Long, Number]): jfxbv.ObservableLongValue = ov.delegate.asInstanceOf[jfxbv.ObservableLongValue]
implicit def sfxObservableValue2jfxFloatValue(ov: ObservableValue[Float, Number]): jfxbv.ObservableFloatValue = ov.delegate.asInstanceOf[jfxbv.ObservableFloatValue]
implicit def sfxObservableValue2jfxDoubleValue(ov: ObservableValue[Double, Number]): jfxbv.ObservableDoubleValue = ov.delegate.asInstanceOf[jfxbv.ObservableDoubleValue]
implicit def sfxObservableValue2jfxBooleanValue(ov: ObservableValue[Boolean, java.lang.Boolean]): jfxbv.ObservableBooleanValue = ov.delegate.asInstanceOf[jfxbv.ObservableBooleanValue]
implicit def sfxObservableValue2jfxStringValue(ov: ObservableValue[String, String]): jfxbv.ObservableStringValue = ov.delegate.asInstanceOf[jfxbv.ObservableStringValue]
implicit def sfxObservableValue2jfxObjectValue[T](ov: ObservableValue[T, T]): jfxbv.ObservableObjectValue[T] = ov.delegate.asInstanceOf[jfxbv.ObservableObjectValue[T]]
implicit def sfxObservableValue2jfxNumberValue(ov: ObservableValue[Number, Number]): jfxbv.ObservableNumberValue = ov.delegate.asInstanceOf[jfxbv.ObservableNumberValue]
implicit def sfxObservableValue2jfxListValue[E](ov: ObservableValue[ObservableBuffer[E], jfxc.ObservableList[E]]
): jfxbv.ObservableListValue[E] =
ov.delegate.asInstanceOf[jfxbv.ObservableListValue[E]]
implicit def sfxObservableValue2jfxSetValue[E](ov: ObservableValue[ObservableSet[E], jfxc.ObservableSet[E]]
): jfxbv.ObservableListValue[E] =
ov.delegate.asInstanceOf[jfxbv.ObservableListValue[E]]
implicit def sfxObservableValue2jfxMapValue[K, V](ov: ObservableValue[ObservableMap[K, V], jfxc.ObservableMap[K, V]]
): jfxbv.ObservableMapValue[K, V] =
ov.delegate.asInstanceOf[jfxbv.ObservableMapValue[K, V]]
}
/**
* An ObservableValue is an entity that wraps a value and allows to observe the value for changes.
*
* @tparam T Indicates Scala type that will be returned for this Observable.
* @tparam J Indicates Java type to be wrapped by T. Eventually T and J could be the same.
*
* @define OV `ObservableValue`
* @define VALUE the current value of this $OV.
* @define CV `ChangeListener`
* @define URLCV [[http://docs.oracle.com/javase/8/javafx/api/javafx/beans/value/ChangeListener.html `ChangeListener`]]
* @define SUBRET A new [[scalafx.event.subscriptions.Subscription]] to remove $OV.
*/
trait ObservableValue[@specialized(Int, Long, Float, Double, Boolean) T, J]
extends Observable
with SFXDelegate[jfxbv.ObservableValue[J]] {
/**
* Returns $OV
*
* @return $OV
*/
def value: T
/**
* Returns $OV
*
* @return $OV
*/
def apply() = value
/**
* Adds a function as a $URLCV. This function has all arguments from
* [[http://docs.oracle.com/javase/8/javafx/api/javafx/beans/value/ChangeListener.html#changed(javafx.beans.value.ObservableValue, T, T) `changed`]]
* method from $CV.
*
* @tparam J1 J superclass.
* @param op Function that receives a
* [[http://docs.oracle.com/javase/8/javafx/api/javafx/beans/value/ObservableValue.html $OV]],
* the old value and the new value. It will be called when value changes.
* @return $SUBRET
*/
def onChange[J1 >: J](op: (ObservableValue[T, J], J1, J1) => Unit): Subscription = {
val listener = new jfxbv.ChangeListener[J1] {
def changed(observable: jfxbv.ObservableValue[_ <: J1], oldValue: J1, newValue: J1) {
op(ObservableValue.this, oldValue, newValue)
}
}
delegate.addListener(listener)
new Subscription {
def cancel() {
delegate.removeListener(listener)
}
}
}
/**
* Adds a function as a $URLCV. This function has no arguments because it will not handle values changed.
*
* @param op A Function with no arguments. It will be called when value changes.
* @return $SUBRET
*/
def onChange[J1 >: J](op: => Unit): Subscription = {
val listener = new jfxbv.ChangeListener[J1] {
def changed(observable: jfxbv.ObservableValue[_ <: J1], oldValue: J1, newValue: J1) {
op
}
}
delegate.addListener(listener)
new Subscription {
def cancel() {
delegate.removeListener(listener)
}
}
}
}