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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
|
/*******************************************************************************
* Copyright (c) 2012 BestSolution.at and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Tom Schindl<tom.schindl@bestsolution.at> - initial API and implementation
*******************************************************************************/
package org.eclipse.fx.osgi.util;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import java.util.ResourceBundle;
import javafx.fxml.FXMLLoader;
import javafx.fxml.JavaFXBuilderFactory;
import javafx.util.Builder;
import javafx.util.BuilderFactory;
import javafx.util.Callback;
import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.jdt.annotation.Nullable;
import org.osgi.framework.Bundle;
import org.osgi.framework.wiring.BundleWiring;
/**
* Helper class which is able to load FXML-Files in OSGi is an easy way
*/
public class OSGiFXMLLoader {
/**
* Load a FXML file relative to the requested
*
* @param requester
* the requester
* @param relativeFxmlPath
* the relative FXML-File Path
* @param resourceBundle
* the translation to be used
* @param builderFactory
* the builder factory to use
* @return the created scene graph
* @throws IOException
*/
public static <O> O load(@NonNull Class<?> requester, @NonNull String relativeFxmlPath, @Nullable ResourceBundle resourceBundle, @Nullable BuilderFactory builderFactory) throws IOException {
URL url = requester.getResource(relativeFxmlPath);
ClassLoader loader = requester.getClassLoader();
return load(loader, url, resourceBundle, builderFactory);
}
/**
* Load a FXML file relative to the requested and provide the constructed scene-node and the controller
*
* @param requester
* the requester
* @param relativeFxmlPath
* the relative FXML-File Path
* @param resourceBundle
* the translation to be used
* @param builderFactory
* the builder factory to use
* @return the created scene graph
* @throws IOException
*/
public static <O,C> FXMLData<O,C> loadWithController(@NonNull Class<?> requester, @NonNull String relativeFxmlPath, @Nullable ResourceBundle resourceBundle, @Nullable BuilderFactory builderFactory) throws IOException {
URL url = requester.getResource(relativeFxmlPath);
ClassLoader loader = requester.getClassLoader();
return loadWithController(loader, url, resourceBundle, builderFactory);
}
/**
* Load a FXML file relative to the bundle
*
* @param bundle
* the bundle
* @param bundleRelativeFxmlPath
* the bundle relative path
* @param resourceBundle
* the translation to be used
* @param builderFactory
* the builder factory to use
* @return the created scene graph
* @throws IOException
*/
public static <O> O load(@NonNull Bundle bundle, @NonNull String bundleRelativeFxmlPath, @Nullable ResourceBundle resourceBundle, @Nullable BuilderFactory builderFactory) throws IOException {
URL url = bundle.getResource(bundleRelativeFxmlPath);
ClassLoader loader = bundle.adapt(BundleWiring.class).getClassLoader();
return load(loader, url, resourceBundle, builderFactory);
}
/**
* Load a FXML file relative to the bundle and provide the constructed scene-node and the controller
*
* @param bundle
* the bundle
* @param bundleRelativeFxmlPath
* the bundle relative path
* @param resourceBundle
* the translation to be used
* @param builderFactory
* the builder factory to use
* @return the created scene graph
* @throws IOException
*/
public static <O,C> FXMLData<O,C> loadWithController(@NonNull Bundle bundle, @NonNull String bundleRelativeFxmlPath, @Nullable ResourceBundle resourceBundle, @Nullable BuilderFactory builderFactory) throws IOException {
URL url = bundle.getResource(bundleRelativeFxmlPath);
ClassLoader loader = bundle.adapt(BundleWiring.class).getClassLoader();
return loadWithController(loader, url, resourceBundle, builderFactory);
}
/**
* Load using the given classloader
*
* @param classloader
* the classloader
* @param url
* the url of the fxml file
* @param resourceBundle
* the translations
* @param builderFactory
* the builder factory
* @return the created scene graph
* @throws IOException
*/
public static <O> O load(@NonNull ClassLoader classloader, @NonNull URL url, @Nullable ResourceBundle resourceBundle, @Nullable BuilderFactory builderFactory) throws IOException {
return load(classloader, url, resourceBundle, builderFactory, null);
}
/**
* Load using the given classloader and provide the constructed scene-node and the controller
*
* @param classloader
* the classloader
* @param url
* the url of the fxml file
* @param resourceBundle
* the translations
* @param builderFactory
* the builder factory
* @return the created scene graph
* @throws IOException
*/
public static <O,C> FXMLData<O,C> loadWithController(@NonNull ClassLoader classloader, @NonNull URL url, @Nullable ResourceBundle resourceBundle, @Nullable BuilderFactory builderFactory) throws IOException {
return loadWithController(classloader, url, resourceBundle, builderFactory, null);
}
/**
* Load a FXML file relative to the requested
*
* @param requester
* the requester
* @param relativeFxmlPath
* the relative FXML-File Path
* @param resourceBundle
* the translation to be used
* @param builderFactory
* the builder factory to use
* @param controllerFactory
* the controller factory
* @return the created scene graph
* @throws IOException
*/
public static <O> O load(@NonNull Class<?> requester, @NonNull String relativeFxmlPath, @Nullable ResourceBundle resourceBundle, @Nullable BuilderFactory builderFactory,
@Nullable Callback<Class<?>, Object> controllerFactory) throws IOException {
URL url = requester.getResource(relativeFxmlPath);
ClassLoader loader = requester.getClassLoader();
return load(loader, url, resourceBundle, builderFactory, controllerFactory);
}
/**
* Load a FXML file relative to the requested and provide the constructed scene-node and the controller
*
* @param requester
* the requester
* @param relativeFxmlPath
* the relative FXML-File Path
* @param resourceBundle
* the translation to be used
* @param builderFactory
* the builder factory to use
* @param controllerFactory
* the controller factory
* @return the created scene graph
* @throws IOException
*/
public static <O,C> FXMLData<O,C> loadWithController(@NonNull Class<?> requester, @NonNull String relativeFxmlPath, @Nullable ResourceBundle resourceBundle, @Nullable BuilderFactory builderFactory,
@Nullable Callback<Class<?>, Object> controllerFactory) throws IOException {
URL url = requester.getResource(relativeFxmlPath);
ClassLoader loader = requester.getClassLoader();
return loadWithController(loader, url, resourceBundle, builderFactory, controllerFactory);
}
/**
* Load a FXML file relative to the bundle
*
* @param bundle
* the bundle
* @param bundleRelativeFxmlPath
* the bundle relative path
* @param resourceBundle
* the translation to be used
* @param builderFactory
* the builder factory to use
* @param controllerFactory
* the controller factory
* @return the created scene graph
* @throws IOException
*/
public static <O> O load(@NonNull Bundle bundle, @NonNull String bundleRelativeFxmlPath, @Nullable ResourceBundle resourceBundle, @Nullable BuilderFactory builderFactory,
@Nullable Callback<Class<?>, Object> controllerFactory) throws IOException {
URL url = bundle.getResource(bundleRelativeFxmlPath);
ClassLoader loader = bundle.adapt(BundleWiring.class).getClassLoader();
return load(loader, url, resourceBundle, builderFactory, controllerFactory);
}
/**
* Load a FXML file relative to the bundle and provide the constructed scene-node and the controller
*
* @param bundle
* the bundle
* @param bundleRelativeFxmlPath
* the bundle relative path
* @param resourceBundle
* the translation to be used
* @param builderFactory
* the builder factory to use
* @param controllerFactory
* the controller factory
* @return the created scene graph
* @throws IOException
*/
public static <O,C> FXMLData<O,C> loadWithController(@NonNull Bundle bundle, @NonNull String bundleRelativeFxmlPath, @Nullable ResourceBundle resourceBundle, @Nullable BuilderFactory builderFactory,
@Nullable Callback<Class<?>, Object> controllerFactory) throws IOException {
URL url = bundle.getResource(bundleRelativeFxmlPath);
ClassLoader loader = bundle.adapt(BundleWiring.class).getClassLoader();
return loadWithController(loader, url, resourceBundle, builderFactory, controllerFactory);
}
/**
* Load using the given classloader
*
* @param classloader
* the classloader
* @param url
* the url of the fxml file
* @param resourceBundle
* the translations
* @param builderFactory
* the builder factory
* @param controllerFactory
* the controller factory
* @return the created scene graph
* @throws IOException
*/
public static <O> O load(@NonNull final ClassLoader classloader, @NonNull URL url, @Nullable ResourceBundle resourceBundle, @Nullable final BuilderFactory builderFactory,
@Nullable Callback<Class<?>, Object> controllerFactory) throws IOException {
return OSGiFXMLLoader.<O, Object> loadWithController(classloader, url, resourceBundle, builderFactory, controllerFactory).node;
}
/**
* Load using the given classloader and provide the constructed scene-node and the controller
*
* @param classloader
* the classloader
* @param url
* the url of the fxml file
* @param resourceBundle
* the translations
* @param builderFactory
* the builder factory
* @param controllerFactory
* the controller factory
* @return the created scene graph
* @throws IOException
*/
@SuppressWarnings("unchecked")
public static <O, C> FXMLData<O, C> loadWithController(@NonNull final ClassLoader classloader, @NonNull URL url, @Nullable ResourceBundle resourceBundle,
@Nullable final BuilderFactory builderFactory, @Nullable Callback<Class<?>, Object> controllerFactory) throws IOException {
FXMLLoader loader = new FXMLLoader();
loader.setLocation(url);
loader.setClassLoader(classloader);
loader.setResources(resourceBundle);
if (builderFactory == null) {
loader.setBuilderFactory(new JavaFXBuilderFactory(classloader));
} else {
loader.setBuilderFactory(new BuilderFactory() {
private JavaFXBuilderFactory orgBuilder = new JavaFXBuilderFactory(classloader);
@Override
public Builder<?> getBuilder(Class<?> type) {
Builder<?> b = builderFactory.getBuilder(type);
if (b == null) {
b = this.orgBuilder.getBuilder(type);
}
return b;
}
});
}
if (controllerFactory != null) {
loader.setControllerFactory(controllerFactory);
}
try (InputStream in = url.openStream()) {
O value = loader.load(in);
in.close();
return new FXMLData<O, C>(value, (C) loader.getController());
}
}
/**
* Data structured holding data constructed while loading the FXML-Document
*
* @param <N> the node
* @param <C> the controller
*/
public static class FXMLData<N, C> {
/**
* The node
*/
@NonNull
public final N node;
/**
* The controller, might be <code>null</code>
*/
@Nullable
public final C controller;
FXMLData(N node, C controller) {
this.node = node;
this.controller = controller;
}
}
}
|
