1 JAVAFX SCENE BUILDER SAMPLES README 2 3 Contents 4 5 What's in the samples zip file? 6 What do I need to set up my environment? 7 How do I build and run the samples? 8 How do I build and run the sample projects in NetBeans IDE? 9 How do I edit the sample projects in JavaFX Scene Builder? 10 Sample Descriptions 11 12 13 =============================== 14 What's in the samples zip file? 15 =============================== 16 17 The samples zip file contain samples that you can build and run, 18 either from the command line or in NetBeans IDE. 19 All of the samples contain one or more FXML files. FXML is the underlying format of JavaFX Scene Builder. 20 21 Extracting the samples zip file produces the following directory structure: 22 23 --<Sample1> 24 --nbproject 25 --src 26 --build.xml 27 --manifest.mf 28 --<Sample2> 29 ... 30 31 32 ======================================== 33 What do I need to set up my environment? 34 ======================================== 35 36 To build and run the samples from the command line, you need the following environment: 37 38 - Ant 1.8 or higher. 39 - A supported version** of the JavaFX SDK that matches the samples zip 40 file version. The JavaFX SDK includes the JavaFX Runtime. 41 - A supported version** of the Java Development Kit (JDK). 42 The JDK includes the JRE. 43 44 45 To build and run the samples in NetBeans IDE, you need the following 46 environment: 47 48 - A supported version** of the JavaFX SDK that matches the samples zip file version. 49 - A supported version** of the JDK. 50 - A supported version** of NetBeans IDE. 51 52 53 To open the samples projects in JavaFX Scene Builder, you need the following 54 environment: 55 56 - A version of JavaFX Scene Builder that matches the samples zip file version. 57 - A supported version** of the JRE. 58 59 60 **To find the supported versions of operating system, Java platform, JavaFX Platform 61 and NetBeans IDE for a particular JavaFX Scene Builder release, see the release 62 documentation page at 63 https://docs.oracle.com/javafx/release-documentation.html 64 65 To get the latest release of JavaFX Scene Builder, go to 66 http://www.oracle.com/technetwork/java/javafx/downloads/index.html 67 68 69 ========================================================= 70 How do I build and run the samples from the command line? 71 ========================================================= 72 73 Use the following command to build and run the application: 74 75 ant -Dplatforms.Default_JavaFX_Platform.home=<JAVA_HOME> 76 -f <SAMPLE_NAME>/build.xml 77 <TARGET> 78 79 The main values for <TARGET> are clean, jar, run. 80 Replace <TARGET> with -projecthelp to get a list of available targets. 81 82 The following example shows how to build and run the HelloWorld sample on Windows: 83 ant -Dplatforms.JDK_1.8.home="C:\Program Files\Java\jdk1.8.0" -f HelloI18N\build.xml run 84 85 The following example shows how to build and run HelloI18N on Mac (where Java 8 from Oracle is installed at its default location): 86 ant -Dplatforms.JDK_1.8.home=/usr -f HelloI18N/build.xml run 87 88 89 =========================================================== 90 How do I build and run the sample projects in NetBeans IDE? 91 =========================================================== 92 93 To build and run a sample project in NetBeans IDE: 94 95 1. Click Open Project in the toolbar, or on the File menu 96 choose Open Project. 97 98 2. Navigate to the location in which you unzipped the samples, select 99 one of the sample directories, then click Open. 100 101 3. To run the application in NetBeans IDE, in the Project pane, right-click 102 the project and choose Run. 103 104 You can change the mode in which the application runs in the IDE by selecting the Run 105 category in Project Properties and choosing Standalone, as Web Start, or in the Browser as the Run setting. 106 107 108 ========================================================== 109 How do I edit the sample projects in JavaFX Scene Builder? 110 ========================================================== 111 112 1. In JavaFX Scene Builder, on the File menu choose Open. 113 114 2. Navigate to the location in which you unzipped the samples, then in the src 115 directory look for one or more file names with the extension .fxml. 116 117 3. Select an fxml file, then click Open. 118 119 120 =================== 121 Sample Descriptions 122 =================== 123 124 The following samples are included in the zip file. 125 126 --------- 127 HelloI18N 128 129 This sample behaves as HelloWorld one. 130 In addition it is internationalized and localized in English and French. 131 From within Scene Builder you can preview the application in English, in French or view the raw key value used for the button's text. 132 133 134 ----- 135 Login 136 137 A slightly more complex sample that includes some assets, such as Button, TextField, 138 and CheckBox, that have some logic associated with them. 139 It demonstrates a simple login system and user session, where users can log in 140 and edit their profile information. 141 The default login/password credentials are demo/demo. 142 143 144 ----------------- 145 IssueTrackingLite 146 147 This sample contains the starting point for the IssueTrackingLite sample application, which is 148 created using the Getting Started with JavaFX Scene Builder document. It is a complete NetBeans 149 project and includes a completed UI layout that the tutorial will instruct you to rename so you 150 can replace it with your own. You need to follow the tutorial, which will lead you through creating 151 the UI layout from the start and connecting it to the controller class. The renamed UI layout provided with 152 this sample can be used for your reference as you create your own IssueTrackingLite.fxml layout file. 153 154 155 ----------------- 156 IssueTrackingBiDi 157 158 The IssueTrackingBiDi sample demonstrates the use of the bi-directional rendering feature. 159 The sample is a localized version of the IssueTrackingLite sample and uses two left-to-right languages, English and French, 160 and two right-to-left languages, Arabic and Hebrew. The whole application's flow follows the flow of the language used. 161 An example of how to use the DatePicker control is also included in the sample. 162 163 164 ------------ 165 UnlockCustom 166 167 A sample where after an initial click to unveil a key pad you need to enter a valid PIN, 1234, to remove the lock. 168 This application uses GridPane component as well as an animation. 169 UnlockCustom uses a key pad defined as a custom type. 170 The key pad is defined as a custom type named Keypad. 171 From within Unlock.fxml we refer to the key pad by its Java class name, Keypad, thanks a statement of the form <Keypad .../>. 172 173 174 -------------- 175 HelloSwingNode 176 177 A sample that demonstrates a Swing asset in action, a JButton, within the JavaFX application. 178 Two buttons are live in this application, a JavaFX Button and a Swing JButton. 179 The user can click on either the JavaFX one or the Swing one to respectively disable or enable the other button. 180 181 182 ---------- 183 AirportApp 184 185 A sample application with an aeronautical theme. The user can select an airport from the ListView 186 which is then located on a map (utilising a ScrollPane to animate to the correct location). 187 There is a detailed video showing how this app is constructed, including applying CSS and connecting code. 188 You can find the video on the Java YouTube channel at: http://youtu.be/ij0HwRAlCmo 189 190 191 -------------------------------------------------------------------- 192 Copyright (c) 2012, 2014, Oracle and/or its affiliates. All rights reserved. 193