-
Notifications
You must be signed in to change notification settings - Fork 68
/
KeyCombination.scala
204 lines (163 loc) · 7.32 KB
/
KeyCombination.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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
/*
* Copyright (c) 2011-2018, 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.scene.input
import javafx.scene.{input => jfxsi}
import scalafx.delegate.{SFXDelegate, SFXEnumDelegate, SFXEnumDelegateCompanion}
import scala.language.implicitConversions
object KeyCombination {
object ModifierValue
extends SFXEnumDelegateCompanion[jfxsi.KeyCombination.ModifierValue, ModifierValue] {
/**
* Constant which indicates that the modifier key can be either up or down.
*/
case object Any extends ModifierValue(jfxsi.KeyCombination.ModifierValue.ANY)
@deprecated ("Use Any; ANY will be removed in a future release", "8.0.60-R10")
val ANY = Any
/**
* Constant which indicates that the modifier key must be down.
*/
case object Down extends ModifierValue(jfxsi.KeyCombination.ModifierValue.DOWN)
@deprecated ("Use Down; DOWN will be removed in a future release", "8.0.60-R10")
val DOWN = Down
/**
* Constant which indicates that the modifier key must be up.
*/
case object Up extends ModifierValue(jfxsi.KeyCombination.ModifierValue.UP)
@deprecated ("Use Up; UP will be removed in a future release", "8.0.60-R10")
val UP = Up
protected override def unsortedValues: Array[ModifierValue] = Array(Any, Down, Up)
}
/**
* Wraps [[http://docs.oracle.com/javase/8/javafx/api/javafx/scene/input/KeyCombination.ModifierValue.html]]
*/
sealed abstract class ModifierValue(override val delegate: jfxsi.KeyCombination.ModifierValue)
extends SFXEnumDelegate[jfxsi.KeyCombination.ModifierValue]
object Modifier {
implicit def sfxModifier2jfx(m: Modifier): jfxsi.KeyCombination.Modifier = if (m != null) m.delegate else null
}
class Modifier(override val delegate: jfxsi.KeyCombination.Modifier) extends SFXDelegate[jfxsi.KeyCombination.Modifier] {
/**
* Gets the modifier key of this Modifier.
*/
def key: KeyCode = KeyCode(delegate.getKey)
/**
* Gets the modifier value of this Modifier.
*/
def value: ModifierValue = ModifierValue.jfxEnum2sfx(delegate.getValue)
}
implicit def sfxKeyCombination2jfx(kc: KeyCombination): jfxsi.KeyCombination = if (kc != null) kc.delegate else null
/**
* Modifier which specifies that the alt key can be either up or down.
*/
val AltAny: Modifier = new Modifier(jfxsi.KeyCombination.ALT_ANY)
/**
* Modifier which specifies that the alt key must be down.
*/
val AltDown: Modifier = new Modifier(jfxsi.KeyCombination.ALT_DOWN)
/**
* Modifier which specifies that the control key can be either up or down.
*/
val ControlAny: Modifier = new Modifier(jfxsi.KeyCombination.CONTROL_ANY)
/**
* Modifier which specifies that the control key must be down.
*/
val ControlDown: Modifier = new Modifier(jfxsi.KeyCombination.CONTROL_DOWN)
/**
* Modifier which specifies that the meta key can be either up or down.
*/
val MetaAny: Modifier = new Modifier(jfxsi.KeyCombination.META_ANY)
/**
* Modifier which specifies that the meta key must be down.
*/
val MetaDown: Modifier = new Modifier(jfxsi.KeyCombination.META_DOWN)
/**
* Modifier which specifies that the shift key can be either up or down.
*/
val ShiftAny: Modifier = new Modifier(jfxsi.KeyCombination.SHIFT_ANY)
/**
* Modifier which specifies that the shift key must be down.
*/
val ShiftDown: Modifier = new Modifier(jfxsi.KeyCombination.SHIFT_DOWN)
/**
* Modifier which specifies that the shortcut key can be either up or down.
*/
val ShortcutAny: Modifier = new Modifier(jfxsi.KeyCombination.SHORTCUT_ANY)
/**
* Modifier which specifies that the shortcut key must be down.
*/
val ShortcutDown: Modifier = new Modifier(jfxsi.KeyCombination.SHORTCUT_DOWN)
/**
* Constructs a new KeyCombination from the specified string.
*/
def keyCombination(name: String): KeyCombination = new KeyCombination(jfxsi.KeyCombination.keyCombination(name)) {}
/**
* Constructs a new KeyCombination from the specified string.
*/
@deprecated("Use apply instead", "1.0")
def valueOf(value: String) = jfxsi.KeyCombination.valueOf(value)
/**
* Constructs a new KeyCombination from the specified string.
*/
def apply(value: String): KeyCombination = new KeyCombination(jfxsi.KeyCombination.valueOf(value)) {}
}
abstract class KeyCombination protected(override val delegate: jfxsi.KeyCombination) extends SFXDelegate[jfxsi.KeyCombination] {
/**
* The state of the alt key in this key combination.
*/
def alt: KeyCombination.ModifierValue = KeyCombination.ModifierValue.jfxEnum2sfx(delegate.getAlt)
/**
* The state of the control key in this key combination.
*/
def control: KeyCombination.ModifierValue = KeyCombination.ModifierValue.jfxEnum2sfx(delegate.getControl)
/**
* Returns a string representation of this KeyCombination that is suitable for display in a user interface
* (for example, beside a menu item).
*
* @return A string representation of this KeyCombination, suitable for display in a user interface.
*/
def displayText: String = delegate.getDisplayText
/**
* The state of the meta key in this key combination.
*/
def meta: KeyCombination.ModifierValue = KeyCombination.ModifierValue.jfxEnum2sfx(delegate.getMeta)
/**
* Returns a string representation of this KeyCombination.
*/
def name = delegate.getName
/**
* The state of the shift key in this key combination.
*/
def shift: KeyCombination.ModifierValue = KeyCombination.ModifierValue.jfxEnum2sfx(delegate.getShift)
/**
* The state of the shortcut key in this key combination.
*/
def shortcut: KeyCombination.ModifierValue = KeyCombination.ModifierValue.jfxEnum2sfx(delegate.getShortcut)
/**
* Tests whether this key combination matches the combination in the given KeyEvent.
*/
def `match`(event: KeyEvent) = delegate.`match`(event)
}