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.
Efxclipse/Runtime/e4
General
Rendering Tags
Some of the model elements can be enhanced with special kind of values to influence the renderers to provide behavior very specific zu JavaFX
MWindow
| Title | Slot | Value | Since | Description |
|---|---|---|---|---|
| efx.window.scene.3d | persistedState | boolean | 0.9.0 | If you want to enable depthBuffering in your the windows scene you should pass true here |
| efx.window.decoration.fxml | persistedState | url | 0.9.0 | In case you want to show a custom window decoration you should pass an URL to a fxml-File to be used |
| efx.window.undecorated (DEPRECATED) | persistedState | boolean | 0.9.0 | DEPRECATED If you want the stage representing the window created with out any StageStyle.UNDECORATED you should pass true for it. Use 'efx.window.stagestyle' |
| efx.window.stagestyle | persistedState | String (one of the value in javafx.stage.StageStyle) | 1.0.0 | Allows you to define the stage-style to use Stage.initStyle. The allowed values are those defined in javafx.stage.StageStyle |
| efx.window.fullscreen | persistedState | boolean | 0.9.0 | If set puts the stage into a window into fullscreen mode |
| shellMaximized | tags | - | 1.0.0 | This tag is provided for SWT-Renderer compability |
MPartSashContainer
| Title | Slot | Value | Since | Description |
|---|---|---|---|---|
| fx_fixedLayout | tags | - | 0.9.0 | If you add this tag to a MPartSashContainer it will be rendered using a fixed layout (it isn't a Sash anymore but uses a LayoutPane) |
MPartSashContainerElement
| Title | Slot | Value | Since | Description |
|---|---|---|---|---|
| fx_layout_width | persistedState | double | 0.9.0 | The value is an absolute width this widget will use in the parent (MPartSashContainer tagged with "fx_fixedLayout") |
| fx_layout_height | persistedState | double | 0.9.0 | The value is an absolute height this widget will use in the parent (MPartSashContainer tagged with "fx_fixedLayout") |
| fx_layout_grab_horizontal | persistedState | boolean | 0.9.0 | If set to true the element grabs all free horizontal space (MPartSashContainer tagged with "fx_fixedLayout") |
| fx_layout_grab_vertical | persistedState | boolean | 0.9.0 | If set to true the element grabs all free vertical space (MPartSashContainer tagged with "fx_fixedLayout") |
MPart
By default the container injected in javafx.scene.layout.BorderPane instance
| Title | Slot | Value | Since | Description |
|---|---|---|---|---|
| Part-Toolbar-FullSpan | tags | - | 0.9.0 | If this tag is added to the MPart the toolbar is spanning the complete width of the part |
| Part-ToolBarMenu-Floating | tags | - | 0.9.0 | If this tag is added to the MPart the toolbar is floating above the parts content and can be collapsed |
| Part-ToolBarMenu-Bottom | tags | - | 0.9.0 | If this tag is added to the MPart the toolbar is rendered at the bottom instead of the top |
| Lifecycle URL | tags | EFX_LC:$URL$ | 0.9.0 | If you add a tag starting with EFX_LC: and an URL like e.g. bundleclass://my.bundle/my.lifecycle.Handler the methods @PreShow and @PreClose will be called at the appropriate time |
| Container:AnchorPane | tags | - | 0.9.0 | If this tag is set the container passed to the contribution is an AnchorPane |
| Container:FlowPane | tags | - | 0.9.0 | If this tag is set the container passed to the contribution is an FlowPane |
| Container:GridPane | tags | - | 0.9.0 | If this tag is set the container passed to the contribution is an GridPane |
| Container:HBox | tags | - | 0.9.0 | If this tag is set the container passed to the contribution is an HBox |
| Container:StackPane | tags | - | 0.9.0 | If this tag is set the container passed to the contribution is an StackPane |
| Container:VBox | tags | - | 0.9.0 | If this tag is set the container passed to the contribution is an VBox |
| Container:FillLayoutPane | tags | - | 0.9.0 | If this tag is set the container passed to the contribution is an org.eclipse.fx.ui.panes.FillLayoutPane |
| Container:GridLayoutPane | tags | - | 0.9.0 | If this tag is set the container passed to the contribution is an org.eclipse.fx.ui.panes.GridLayoutPane |
| Container:RowLayoutPane | tags | - | 0.9.0 | If this tag is set the container passed to the contribution is an org.eclipse.fx.ui.panes.RowLayoutPane |
| Container:SashLayoutPane | tags | - | 0.9.0 | If this tag is set the container passed to the contribution is an org.eclipse.fx.ui.panes.SashLayoutPane |
| Container:UrlPane:$URL$ | tags | - | 0.9.0 | If this tag is set the container passed to the contribution is an instance of the class provided through the URL e.g. bundleclass://my.container/my.layout.Pane the contributed class has to be a subclass of javafx.scene.layout.Pane |
MToolItem
| Title | Slot | Value | Since | Description |
|---|---|---|---|---|
| fx_checkbox | tags | - | 0.9.0 | If the ItemType is CHECKBOX and the tag is used a real checkbox is used (by default it is a toggle-button) |
MTrimElement
| Title | Slot | Value | Since | Description |
|---|---|---|---|---|
| fillspace | tags | - | 0.9.0 | If this tag is added to the MTrimElement it will fill the remaining space in the trim |
MPartStack
| Title | Slot | Value | Since | Description |
|---|---|---|---|---|
| fx_pagination | tags | - | 0.9.0 | If this tag is added to the MPartStack it will be rendered using a pagination control instead of a TabFolder |
| fx_tab_closing_policy_unavailable | tags | - | 1.1.0 | If this tag is added to the MPartStack the tab pane will not have a close button, therefore it will not be possible to close part ( see: http://docs.oracle.com/javafx/2/api/javafx/scene/control/TabPane.TabClosingPolicy.html ) |
| fx_tab_closing_policy_selectedTab | tags | - | 1.1.0 | If this tag is added to the MPartStack only the selected tab will have a close button ( see: http://docs.oracle.com/javafx/2/api/javafx/scene/control/TabPane.TabClosingPolicy.html ) |
| fx_tab_closing_policy_allTabs | tags | - | 1.1.0 | If this tag is added to the MPartStack all the tabs on the tab pan will have close buttons ( see: http://docs.oracle.com/javafx/2/api/javafx/scene/control/TabPane.TabClosingPolicy.html ) |
MPerspective
| Title | Slot | Value | Since | Description |
|---|---|---|---|---|
| Lifecycle URL | tags | EFX_LC:$URL$ | 0.9.0 | If you add a tag starting with EFX_LC: and an URL like e.g. bundleclass://my.bundle/my.lifecycle.Handler the methods @PreShow and @PreClose will be called at the appropriate time |
MMenu
| Title | Slot | Value | Since | Description |
|---|---|---|---|---|
| Lifecycle URL | tags | EFX_LC:$URL$ | 0.9.0 | If you add a tag starting with EFX_LC: and an URL like e.g. bundleclass://my.bundle/my.lifecycle.Handler the methods @PreShow and @PreClose will be called at the appropriate time |
MToolControl
By default the container injected in javafx.scene.Group instance
| Title | Slot | Value | Since | Description |
|---|---|---|---|---|
| Container:AnchorPane | tags | - | 0.9.0 | If this tag is set the container passed to the contribution is an AnchorPane |
| Container:FlowPane | tags | - | 0.9.0 | If this tag is set the container passed to the contribution is an FlowPane |
| Container:GridPane | tags | - | 0.9.0 | If this tag is set the container passed to the contribution is an GridPane |
| Container:HBox | tags | - | 0.9.0 | If this tag is set the container passed to the contribution is an HBox |
| Container:StackPane | tags | - | 0.9.0 | If this tag is set the container passed to the contribution is an StackPane |
| Container:VBox | tags | - | 0.9.0 | If this tag is set the container passed to the contribution is an VBox |
| Container:FillLayoutPane | tags | - | 0.9.0 | If this tag is set the container passed to the contribution is an org.eclipse.fx.ui.panes.FillLayoutPane |
| Container:GridLayoutPane | tags | - | 0.9.0 | If this tag is set the container passed to the contribution is an org.eclipse.fx.ui.panes.GridLayoutPane |
| Container:RowLayoutPane | tags | - | 0.9.0 | If this tag is set the container passed to the contribution is an org.eclipse.fx.ui.panes.RowLayoutPane |
| Container:SashLayoutPane | tags | - | 0.9.0 | If this tag is set the container passed to the contribution is an org.eclipse.fx.ui.panes.SashLayoutPane |
| Container:UrlPane:$URL$ | tags | - | 0.9.0 | If this tag is set the container passed to the contribution is an instance of the class provided through the URL e.g. bundleclass://my.container/my.layout.Pane the contributed class has to be a subclass of javafx.scene.layout.Pane |
Lifecycle
Certain renderers based on the efxclipse generic ones support the idea of a lifecycle (Show/Hide/...). We decided no to introduce a new mixin ourselves to support the lifecycle for now but abuse the tags for it because we expect to work with the upstream project on a general solution. Currently the following renderers support lifecycle:
- MMenu
- MPerspective
- MPart
There are 2 ways to register a lifecycle:
- declartive via e4xmi: by adding a tag to the element which starts with EFX_LC: followed by a URL to the lifecycle class
- programmaticall via ELifecycleService: Grab the service and register an lifecylce class using the same URL you'd have used for the tag
None standard Services
PopupMenuService (removed with 1.0.0)
The has the same feature as the EMenuService from e4 on SWT but because the service definition is found in a bundle which has a dependency on SWT we had to invent our own one.
Since 1.0.0 you should use the EMenuService from the Eclipse Application Platform
ELifecycleService
Allows to register/unregister lifecycle handlers on model elements
PerspectiveTransitionService / WindowTransitionService
Those 2 services allow you to control how perspective transitions and window open/close transition are done. The renderes will look up the service from the MApplications IEclipseContext and if one available use it.
DnDFeedbackService
The feedback service is responsible to show the drag and drop feedback. If your are not happy with the default implementation provided simply contribute your custom version to the OSGi-Service registry with a ranking > 0
Missing Features / Services
Some of the features implemented in e4 on SWT are not yet available in the JavaFX version. Due lack of time/funding and to some extend also due to features not yet available in JavaFX itself:
- MinMax support: There's feature request in bugzilla [1] but there've not been enough time yet to implement it.
- DnD support: Rearranging of the workbench Tab like in SWT is not yet support via DnD. You can move parts programmatically inside the model only. One of the major problems is that JavaFX does not yet support DnD on Tabs [2]
In case you miss a feature from SWT and/or you have an idea of a new feature file bug reports and link them in this section. We'll do our best to get features in but can promise unless you decide to fund the implementation