public abstract Class WorkbenchModule

Implementation Note

if a module is being opened from the overview for the first time, it will get initialized first by calling init(), afterwards activate() will be called.

Implementation Note

Warning! This will definitely close this module! It will not call destroy() before closing it. If you need to clean up before closing the module, call destroy() before calling close().

Implementation Note

Assuming Module 1 and Module 2, with both being already initialized and Module 1 being the currently displayed content. When switching the content to Module 2, deactivate() gets called on Module 1, followed by a call of activate() on Module 2.

Implementation Note

Lifecycle: When Workbench#closeModule(WorkbenchModule) is being called on an active module, deactivate() will be called before destroy() is called. In case of an inactive module, only destroy() will be called.
Return behavior: Assuming Module 1 and Module 2, with both being already initialized and Module 2 being the currently active and displayed module. When calling destroy() on Module 1: If true is returned, Module 2 will be removed and Module 1 will be set as the active module. If false is returned, Module 2 will not be removed and Module 1 will be set as the new active module, to enable the user to react to the interrupted closing of the module.

Implementation Specification

To implement an asynchronous, controlled closing of a module, execute the immediate action (e.g. open a dialog) and define the asynchronous behavior in advance to call close() (e.g. define pressing "Yes" on the dialog to call close()). Then return false, which prevents this module from immediately getting closed and causes this WorkbenchModule to get opened, so the user can react.
Example:

          getWorkbench().showDialog(WorkbenchDialog.builder("Confirmation", "Close Module?",
                                    WorkbenchDialog.Type.CONFIRMATION)
                        .blocking(true)
                        .onResult(buttonType -< {
                          if (ButtonType.YES.equals(buttonType)) {
                            // yes was pressed
                            close();
                          }
                        }).build()
          );
          return false;
          

Implementation Note

Clicking on the Tile of a module in the add module view will cause the corresponding module to get opened. When this module is being opened, with no Tabs of this module existing yet, the Workbench will first call this method. Then, it will create a new Tab for this module in the tab bar and open it, which causes activate() to get called.
When there is an open Tab of a module, opening the module will not cause init(Workbench) to be called again. It will only be called if the module's Tab was closed and the module is opened again.

Implementation Specification

the implementor of this method must call super(Workbench) to ensure correct working order.