Skip to content

Latest commit

 

History

History
32 lines (23 loc) · 3.7 KB

How_To_Setup_UI_Tools.md

File metadata and controls

32 lines (23 loc) · 3.7 KB
Raw

How To Setup User Interface (UI) Tools for MapTool

You thought you were done? Sorry, there are two extra things you may wish to consider and both are related to managing UI elements within Maptool. The current edition of the tool uses Abeille to manage Swing elements within the design. Abeille is a WYSIWYG form designer for Swing objects and if you plan on modifying any of the UI elements you should definitely install the Abeille Designer.

As Swing is now deprecated within Java the plan is to move those elements over to JavaFX, although this work is further down the line at the moment. If you want to get to grips with JavaFX, you should probably install the Eclipse Plugin e(fx)clipse and the JavaFX Scene Builder. Scene Builder is also a WYSIWYG form designer, but this time for JavaFX Objects.

Install Abeille

  1. Go to the Abeille Downloads page and download the latest binaries. This is a closed project so they are quite old. The binaries are jar files so you can simply unzip the folder to anywhere on your PC, such as C:\Program Files (x86)\abeille-2.1.0_M3
    • As the Abeille downloads are now offline the last version has been attached here: abeille-2.1.0_M3.zip
  2. Launch the Designer by running the designer.jar file in the abeille-2.1.0_M3 directory. If you have installed Java as described elsewhere, you can just right click the file and select Open
  3. Once the Designer is running, you need to create a new project for the MapTool forms. Call this file maptool.jfpr and save it anywhere you like, BUT NOT in the Eclipse MapTool project directory, as you do not want this file to become part of the MapTool project and is only used by you locally.
  4. Add the MapTool resource directory as a Source path for your Abeille Project. On the Abeille Project Settings screen you should see a button in the Source Tab to Add Path. Click this and navigate to the resource directory. For example, if your Eclipse workspace directory was C:\Workspace and your top level MapTool project was called C:\Workspace\maptool you should add the path C:\Workspace\maptool\maptool\src\main\resources. This is very important, otherwise the Albeille Designer will save the local path names into the designer files rather than the relative paths that are needed for proper distribution.

Install e(fx)clipse Plugin

  1. From within Eclipse, select Help, and Install New Software...
  2. Click the Add button
  3. For name enter e(fx)clipse and for location enter http://download.eclipse.org/efxclipse/updates-released/1.2.0/site/ then click OK
  4. From the Working with: field select the e(fx)clipse address you have just added.
  5. Eclipse should now search the address for installable modules. Tick all options, the e(fx)clipse - install and the e(fx)clipse - single components option.
  6. Click Next and the components should start installing (this takes a while). Then click Next, accept the license and Finish and Eclipse will do the final install.

Install JavaFX Scene Builder

The JavaFX Scene Builder application has been handed over to the open source community and as a consequence it can be hard to find the Scene Builder install. The latest version as of this writing is SceneBuilder 10.0.0 and is available from GluonHQ.com

Download and install SceneBuilder. It can now be used to open .fxml files which are the JavaFX equivalent to Abeille files (above).