You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Gluon [Scene Builder](http://gluonhq.com/products/scene-builder/) is a drag and drop UI designer tool allowing rapid desktop and mobile app development.
4
14
Scene Builder separates design from logic, allowing team members to quickly and easily focus on their specific aspect of application development.
5
15
@@ -44,7 +54,7 @@ These are the requisites:
44
54
45
55
### How to build Scene Builder ###
46
56
47
-
Scene Builder makes use of the Maven Wrapper to build and run the project. So there is no need to install Maven on the developers machine. To utilize Maven Wrapper, instead of calling `mvn`, one can run `./mvnw` on Linux or macOS or`mvnw` on Windows instead.
57
+
Scene Builder uses Maven Wrapper to build and run the project. Run `./mvnw` on Linux or macOS and`mvnw` on Windows.
48
58
49
59
To build the Scene Builder services, on the project's root, run:
50
60
@@ -61,11 +71,11 @@ It will create a partial shadow cross-platform jar under `app/target/lib/scenebu
61
71
Before starting the app, all dependencies must be installed locally.
62
72
This is achieved by:
63
73
64
-
`mvn install`
74
+
`./mvnw install`
65
75
66
76
Then Scene Builder can be started with Maven:
67
77
68
-
`mvn javafx:run -f app`
78
+
`./mvnw javafx:run -f app`
69
79
70
80
Alternatively, you can run the partial shadow jar in the classpath, providing you have downloaded the JavaFX SDK from [here](https://gluonhq.com/products/javafx/):
The Scene Builder project has three main components defined by three modules (that is, three Java modules defined in three Maven modules subprojects):
94
+
95
+
- Scene Builder App
96
+
- Scene Builder Kit
97
+
- Gluon plugin
98
+
99
+
### Scene Builder App ###
100
+
101
+
Contains the JavaFX main application that embeds the Scene Builder Kit, and includes menus, preferences and dialogs to interact with it.
82
102
83
-
To build and install the Scene Builder Kit in your local repository, run:
103
+
### Scene Builder Kit###
84
104
85
-
`mvn clean install -f kit`
105
+
Scene Builder Kit is the core of the project and defines three main areas:
86
106
87
-
The custom controls of the Scene Builder kit can be used in your project.
88
-
You can add it as a regular dependency to the build of your app:
107
+
- Left: Library of custom and built-in controls, Hierarchy and Controller of the FXML layout being edited
108
+
- Center: Workspace area for displaying the content of the FXML layout that is being designed
109
+
- Right: Inspector with properties, layout and event handlers of the components of the FXML layout.
110
+
111
+
Scene Builder Kit contains an API that allows these components and their functionality to be integrated in other applications or IDEs. Scene Builder App is the best example of such integration. Another basic example can be found here: [EmbeddedSceneBuilderDemo](https://github.com/gluonhq/EmbeddedSceneBuilderDemo). You can also use the controls available in Scene Builder Kit in your project.
112
+
113
+
Scene Builder Kit is published to Maven Central, and you can add it as a regular dependency to the build of your app:
89
114
90
115
```
91
116
<dependency>
@@ -95,6 +120,16 @@ You can add it as a regular dependency to the build of your app:
95
120
</dependency>
96
121
```
97
122
123
+
If you want to build and install the Scene Builder Kit in your local repository, run:
124
+
125
+
`./mvnw clean install -f kit`
126
+
127
+
### Gluon plugin ###
128
+
129
+
The Gluon section in the Library allows adding [Gluon Mobile](http://gluonhq.com/products/mobile) controls to the FXML layout, and setting the stylesheets from the Gluon themes and swatch colors.
130
+
131
+
An easy way to get started is by selecting the Mobile Basic Screen from the available templates in the welcome dialog.
132
+
98
133
## Code Style
99
134
100
135
To ensure that new code formatting matches the requirements for Pull Requests,
@@ -106,10 +141,10 @@ Contributors can check for code-style violations in their code by running the Ch
106
141
To run the plugin:
107
142
108
143
```
109
-
mvn checkstyle:checkstyle
144
+
./mvnw checkstyle:checkstyle
110
145
```
111
146
112
-
There will be a report for each sub-project, one for `app` and one for `kit`.
0 commit comments