Docking

• VLDocking 2.1
• Features
• Screenshots
• Customers
• Demonstration
• Licences
• Workspace Editor
• Documentation

VLDocking 2.1 - Workspace Editor

This application is a visual designer for docking workspaces.

Context

There a two ways to create a docking layout (known as workspace) with VLDocking :

• Use the DockingDesktop API to define the layout of the dockables :
  - addDockable(),
  - split(),
  - createTab()...
• or read a workspace XML file with the readXML(InputStream) from DockingDesktop

The first case is the most often used as it is extensively described in the online VLDocking tutorial.

The second approach is less used, but should become more thanks to the Workspace Editor. Until now, creating an xml workspace file was problematic as you had to use the desk.writeXML() method, starting from an already existing layout.

With Workspace Editor, it is now possible to create this (these) xml file(s) with a GUI, even before the application is developed.

User Guide

This application is very easy to use :

There are two windows :

• The workspace simulator (editor) : a window presenting the shape of your current workspace. The target application will share the same dockables layout.
• The dockable factory window : Each drag and drop gesture starting from this window and ending into the simulator will add a new dockable.

The Workspace windows : Factory and Editor

Define a workspace

• Use the mouse to drop new dockables (from the Factory) into the workspace.
• Use the available standard docking gestures to define the final layout : you can create tabs, detach some dockables, iconify (auto-hide) others.
• If you created too many dockables, just remove them with the close button

Update the key attributes

Each dockable is presented as a UI component with two input fields matching its key (DockKey) :

• Id : the unique identifier associated to the dockable.
• Label : a label (not unique) displayed in the title bars and tabs.

Your goal is to update the unique Ids to match the ones of the target application. Then, they will be recognized when the workpace is loaded.

Note : The labels are not used in the target application : they are just used by the Workspace Editor to help you define your GUI.

Once the workspace is finished

You just have to save it (use the File/Save menu) and integrate it into your target application. To help you in that task, you can read the section 4 from the tutorial : Loading and Saving Desktop Configurations.

To simplify : you just have to declare the dockables used by the workspace (desk.registerDockable(Dockable)), and then read it with desk.readXML(InputStream).

Note : Don't forget the Workspace Editor only manages the layout and state of the dockables. Defining attributes (closingEnabled, floatingEnabled...) and presentation (label, icons...) is left to the DockKey API.

Comments

Don't hesitate to share your remarks concerning this application through our forum or via email : we'll listen to them.

---

Return to VLDocking 2.1 home page .