Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Platform UI Design Discussion
A discussion about generalizing and simplifying core Workbench concepts.
Discussion Areas
- grouping
- appearance
- connections
- nesting
- MarkersViews Platform_UI_MarkersView
Use Cases
- Debugging client and server at the same time (each with its own Debug view, Variables view, etc)
- Define an eclipse presentation suitable for a Cell Phone (ensures presentation generality)
Separation of Concerns
Overall it seems that there are two concerns that we would like to separate:
- How are the pieces that make up the workbench (window, views, editors, trim, ...) composed, and how are they connected?
For this, we focus on questions like:- Which services (selection, key binding, etc.) does a piece need, and where does it get it from?
- Menus - programmatically through the site and IActionBars
- Context menus - programmatically through the site and IActionBars
- Toolbar items - programmitcally through the site and IActionBars
- Command handlers - programmatically through the site and IHandlerService
- Selection service - programmatically through the site and/or workbench page/window
- Part service - programmatically through the workbench page/window
- Keybindings (sorta) - programmatically through the site and IBindingService (or the old IKeybindingService)
- What does a piece (mostly: view, editor) contribute in terms of menus, toolbar items, context menu, trim items?
- etc.
- Which services (selection, key binding, etc.) does a piece need, and where does it get it from?
- How are the pieces presented, using a common layout, based on policy decisions for their placement?
Here we answer questions like:- Where in the UI do the pieces show up? Where do contributed items show up?
- Which pieces can be rearranged and moved by the user, and in which way?
- CoolBar:
- Rearrange groups by dragging (within the CoolBar only)
- Perspective Switcher:
- Location can be changed using the "Dock On" entry in its context menu
- Drag the perspective entries to rearrange them
- Drag an entry outside the workbench window to create a new window showing that perspective (not true in version 3.6 or possibly earlier)
- Trim:
- Drag the trim element to any trim area
- View Stacks:
- Drag a view/stack to another stack to merge the two
- Drag a view to a 'new' site to create a new stack containing the view (dragging a view stack this way is a rearrangement since the old stack will disappear once all the views have been moved to the new one).
- Drag a view/stack outside the workbench to create a Detached Window (only on platforms that support reparenting)
- Drag a view/stack to the Fast View Bar (FVB) to make all the views in the stack fast views The entries are added at the drop insertion point (i.e. you can drop between two existing icons in the FVB)
- Drag a single view icon within the FVB to rearrange. Dragging outside the FVB acts like any other view drag
- CoolBar:
Things like menus, context menus, and toolbar items are also contributed declaratively through:
- org.eclipse.ui.actionSets
- org.eclipse.ui.editorActions
- org.eclipse.ui.viewActions
- org.eclipse.ui.popupMenus
- org.eclipse.ui.menus (this is destined to replace all four of the above)
Thoughts
Why does trim not show up in the class hierarchy for views and editors, e.g. as in:
Piece Trim Part View Editor
We should look at the persistence life-cycle. Currently we're in a state where the trim order gets read and applied after we've already loaded and arranged the trim in its default location. This is clearly non-optimal and leaves us open to flashing etc. Ensuring that all cached info is read and used during the workbench's initial construction might be better.