/
ComboBoxTreeCell.scala
183 lines (164 loc) · 7.03 KB
/
ComboBoxTreeCell.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
/*
* Copyright (c) 2011-2014, 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.control.cell
import javafx.scene.control.{cell => jfxscc}
import javafx.{collections => jfxc, util => jfxu}
import scala.language.implicitConversions
import scalafx.Includes._
import scalafx.collections.ObservableBuffer
import scalafx.delegate.SFXDelegate
import scalafx.scene.control.{TreeCell, TreeView}
import scalafx.util.StringConverter
/**
* Companion Object for [[scalafx.scene.control.cell.ComboBoxTreeCell]].
*
* @define CBTC `ComboBoxTreeCell`
* @define TTYPE The type of the elements contained within the `TreeView`.
* @define FTCINIT Creates a ComboBox cell factory for use in [[scalafx.scene.control.TreeView]] controls.
* @define FTCINITDEPREC Added to satisfy Spec tests.
* @define ITEMSPARAM Zero or more items that will be shown to the user when the `ComboBox` menu is showing.
* @define CONVPARAM A [[scalafx.util.StringConverter]] to convert the given item (of type T) to a String for displaying to the user.
* @define RET A function that will return a TableCell that is able to work on the type of element contained within the TableColumn.
*/
object ComboBoxTreeCell {
/**
* Converts a ScalaFX $CBTC to its JavaFX counterpart.
*
* @tparam T $TTYPE
* @param cell ScalaFX $CBTC
* @return JavaFX $CBTC
*/
implicit def sfxComboBoxTreeCell2jfx[T](cell: ComboBoxTreeCell[T]): jfxscc.ComboBoxTreeCell[T] = if (cell != null) cell.delegate else null
/**
* $FTCINIT
*
* @tparam $TTYPE
* @param items $ITEMSPARAM
* @return $RET
*/
def forTreeView[T](items: ObservableBuffer[T]): (TreeView[T] => TreeCell[T]) =
(view: TreeView[T]) => jfxscc.ComboBoxTreeCell.forTreeView[T](items).call(view)
/**
* $FTCINITDEPREC
*/
@deprecated(message = "Use forTreeView[T](ObservableBuffer[T])", since = "1.0")
def forTreeView[T](items: jfxc.ObservableList[T]) = jfxscc.ComboBoxTreeCell.forTreeView[T](items)
/**
* $FTCINIT
*
* @tparam $TTYPE
* @param converter $CONVPARAM
* @param items $ITEMSPARAM
* @return $RET
*/
def forTreeView[T](converter: StringConverter[T], items: ObservableBuffer[T]): (TreeView[T] => TreeCell[T]) =
(view: TreeView[T]) => jfxscc.ComboBoxTreeCell.forTreeView[T](converter, items).call(view)
/**
* $FTCINITDEPREC
*/
@deprecated(message = "Use forTreeView[T](StringConverter[T], ObservableBuffer[T])", since = "1.0")
def forTreeView[T](converter: jfxu.StringConverter[T], items: jfxc.ObservableList[T]) =
jfxscc.ComboBoxTreeCell.forTreeView[T](converter, items)
/**
* $FTCINIT
*
* @tparam $TTYPE
* @param converter $CONVPARAM
* @param items $ITEMSPARAM
* @return $RET
*/
def forTreeView[T](converter: StringConverter[T], items: T*): (TreeView[T] => TreeCell[T]) =
(view: TreeView[T]) => jfxscc.ComboBoxTreeCell.forTreeView[T](converter, items: _*).call(view)
/**
* $FTCINITDEPREC
*/
@deprecated(message = "Use forTreeView[T](StringConverter[T], T*)", since = "1.0")
def forTreeView[T](converter: jfxu.StringConverter[T], items: T*) = jfxscc.ComboBoxTreeCell.forTreeView[T](converter, items: _*)
/**
* $FTCINIT
*
* @tparam $TTYPE
* @param items $ITEMSPARAM
* @return $RET
*/
def forTreeView[T](items: T*): (TreeView[T] => TreeCell[T]) =
(view: TreeView[T]) => jfxscc.ComboBoxTreeCell.forTreeView[T](items: _*).call(view)
/**
* $FTCINITDEPREC
*/
@deprecated(message = "Use forTreeView[T](T*)", since = "1.0")
def forTreeView[T](items: Array[T]) = jfxscc.ComboBoxTreeCell.forTreeView[T](items: _*)
}
/**
* Wraps [[http://docs.oracle.com/javase/8/javafx/api/javafx/scene/control/cell/ComboBoxTreeCell.html $CBTC]]
*
* @tparam T Type used in this cell
* @constructor Creates a new $CBTC from a JavaFX $CBTC
* @param delegate JavaFX $CBTC
*
* @define CBTC `ComboBoxTreeCell`
* @define CMBX `ComboBox`
* @define STCV `StringConverter`
* @define CONSTRCONVERTER Creates a $CBTC instance with the given items being used to populate the $CMBX when it is shown, and the $STCV being used to convert the item in to a user-readable form.
* @define CONSTITEMS Creates a default $CBTC instance with the given items being used to populate the $CMBX when it is shown.
* @define CONVPARAM A $STCV that can convert an item of type T into a user-readable string so that it may then be shown in the $CMBX popup menu.
* @define ITEMSPARAM The items to show in the $CMBX popup menu when selected by the user.
*/
class ComboBoxTreeCell[T](override val delegate: jfxscc.ComboBoxTreeCell[T] = new jfxscc.ComboBoxTreeCell[T])
extends TreeCell[T](delegate)
with ConvertableCell[jfxscc.ComboBoxTreeCell[T], T, T]
with ComboBoxEditableCell[jfxscc.ComboBoxTreeCell[T], T]
with UpdatableCell[jfxscc.ComboBoxTreeCell[T], T]
with ItemableCell[jfxscc.ComboBoxTreeCell[T], T]
with SFXDelegate[jfxscc.ComboBoxTreeCell[T]] {
/**
* $CONSTITEMS
*
* @param items $ITEMSPARAM
*/
def this(items: ObservableBuffer[T]) = this(new jfxscc.ComboBoxTreeCell[T](items))
/**
* $CONSTRCONVERTER
*
* @param converter $CONVPARAM
* @param items $ITEMSPARAM
*/
def this(converter: StringConverter[T], items: ObservableBuffer[T]) = this(new jfxscc.ComboBoxTreeCell[T](converter, items))
/**
* $CONSTRCONVERTER
*
* @param converter $CONVPARAM
* @param items $ITEMSPARAM
*/
def this(converter: StringConverter[T], items: T*) = this(new jfxscc.ComboBoxTreeCell[T](converter, items: _*))
/**
* $CONSTITEMS
*
* @param items $ITEMSPARAM
*/
def this(items: T*) = this(new jfxscc.ComboBoxTreeCell[T](items: _*))
}