WorkbenchFX 11.3.1 · com.dlsc.workbenchfx.Workbench · APIdia, the JavaDoc alternative

Modifier and Type	Class and Description
public static class	Workbench.WorkbenchBuilder

Modifier and Type	Field and Description
private final ObjectProperty<WorkbenchModule>	activeModule Currently active module.
private final ObjectProperty<Node>	activeModuleView
private final IntegerProperty	amountOfPages
private static final int	ANIMATION_DURATION_DRAWER_CLOSE
private static final int	ANIMATION_DURATION_DRAWER_OPEN Duration of animations according to material design guidelines.
private final ObservableList<Region>	blockingOverlaysShown
private static final int	DEFAULT_MODULES_PER_PAGE
private static final NavigationDrawer	DEFAULT_NAVIGATION_DRAWER
private static final Callback<Workbench, Page>	DEFAULT_PAGE_FACTORY
private static final Callback<Workbench, Tab>	DEFAULT_TAB_FACTORY
private static final Callback<Workbench, Tile>	DEFAULT_TILE_FACTORY
private final ObjectProperty<Region>	drawerShown
private final ObjectProperty<Side>	drawerSideShown
private static final Logger	LOGGER
private static final int	MAX_PERCENT
private final Map<WorkbenchModule, CompletableFuture<Boolean>>	moduleCloseableMap Will close the module without calling `WorkbenchModule#destroy()` if the corresponding `CompletableFuture` is completed.
private final ListProperty<WorkbenchModule>	modules List of all modules.
private final IntegerProperty	modulesPerPage
private final ObjectProperty<NavigationDrawer>	navigationDrawer
private final ObservableList<MenuItem>	navigationDrawerItems
private final ObservableList<Region>	nonBlockingOverlaysShown
private final ListProperty<WorkbenchModule>	openModules List of all currently open modules.
private final ObservableMap<Region, WorkbenchOverlay>	overlays Map containing all overlays which have been loaded into the scene graph, with their corresponding model object `WorkbenchOverlay`.
private final ObjectProperty<Callback<Workbench, Page>>	pageFactory
private final ObjectProperty<Callback<Workbench, Tab>>	tabFactory The factories which are called when creating Tabs, Tiles and Pages of Tiles for the Views.
private final ObjectProperty<Callback<Workbench, Tile>>	tileFactory
private final ObservableList<ToolbarItem>	toolbarControlsLeft
private final ObservableList<ToolbarItem>	toolbarControlsRight

Access	Constructor and Description
public	Workbench() Default constructor for use with Scene Builder.
private	Workbench(Workbench.WorkbenchBuilder to use for the setup builder) Constructor for WorkbenchFX by using the `WorkbenchBuilder`.

Method Summary

Modifier and Type	Method and Description
public final ReadOnlyObjectProperty<WorkbenchModule>	activeModuleProperty()
public final ReadOnlyObjectProperty<Node>	activeModuleViewProperty()
private void	addInitialAnimationHandler(WorkbenchOverlay for which to prepare the initial animation handler for workbenchOverlay, Side from which the sliding animation should originate side) Handles the initial animation of an overlay.
public final ReadOnlyIntegerProperty	amountOfPagesProperty()
private void	bindDrawerHeight(Region drawer)
private void	bindDrawerWidth(Region drawer)
public static Workbench.WorkbenchBuilder	Returns: builder object builder(WorkbenchModule... which should be loaded for the application modules) Creates a builder for `Workbench`.
private int	Returns: amount of pages calculateAmountOfPages() Calculates the amount of pages of modules (rendered as tiles).
public final void	clearOverlays() Removes all previously loaded overlays from the scene graph including all references to them, in order to free up memory.
public final boolean	Returns: true if closing was successful closeModule(WorkbenchModule to be closed module) Closes the `module`.
public final void	completeModuleCloseable(WorkbenchModule whose `moduleCloseable` should be completed module) Completes the `moduleCloseable` of the `module`.
protected final Skin<?>	createDefaultSkin() Overrides javafx.scene.control.Control.createDefaultSkin. Create a new instance of the default skin for this control.
public final ReadOnlyObjectProperty<Region>	drawerShownProperty()
public final ReadOnlyObjectProperty<Side>	drawerSideShownProperty()
public final WorkbenchModule	getActiveModule()
public final Node	getActiveModuleView()
public final int	getAmountOfPages()
public final ObservableList<Region>	getBlockingOverlaysShown()
public final Region	getDrawerShown()
public final Side	getDrawerSideShown()
private CompletableFuture<Boolean>	getModuleCloseable(WorkbenchModule module) Returns a `CompletableFuture`, which upon completion will cause the module to be closed and if there was an ongoing stage closing process, it will re-initiate that process.
public final ObservableList<WorkbenchModule>	Returns: the list of all loaded modules getModules() Returns a list of the currently loaded modules.
public final int	getModulesPerPage()
public final NavigationDrawer	getNavigationDrawer()
public final ObservableList<MenuItem>	getNavigationDrawerItems()
public final ObservableList<Region>	getNonBlockingOverlaysShown()
public final ObservableList<WorkbenchModule>	Returns: an unmodifiableObservableList of the currently open modules. getOpenModules() Returns an unmodifiableObservableList of the currently open modules.
public final ObservableMap<Region, WorkbenchOverlay>	Returns: a map of all overlays, which have previously been opened, with their corresponding model object `WorkbenchOverlay`. getOverlays() Returns a map of all overlays, which have previously been opened, with their corresponding model object `WorkbenchOverlay`.
public final Callback<Workbench, Page>	getPageFactory()
public final Callback<Workbench, Tab>	getTabFactory()
public final Callback<Workbench, Tile>	getTileFactory()
public final ObservableList<ToolbarItem>	Returns: a list of the currently loaded toolbar controls on the left. getToolbarControlsLeft() Returns a list of the currently loaded toolbar controls on the left.
public final ObservableList<ToolbarItem>	Returns: a list of the currently loaded toolbar controls on the right. getToolbarControlsRight() Returns a list of the currently loaded toolbar controls on the right.
public final String	getUserAgentStylesheet() Overrides javafx.scene.layout.Region.getUserAgentStylesheet. An implementation may specify its own user-agent styles for this Region, and its children, by overriding this method.
public final void	hideDialog(WorkbenchDialog to be hidden dialog) Hides the `dialog` which was previously shown in the view using `showDialog(WorkbenchDialog)`.
public final void	hideDrawer() Hides the currently displayed drawer that was previously shown using `showDrawer(Region, Side)` or `showDrawer(Region, Side, int)`.
public final void	hideNavigationDrawer()
public final boolean	Returns: true if the overlay was showing and is now hidden hideOverlay(Region to be hidden overlay) Hides the `overlay` together with its `GlassPane`, which has previously been shown using `Workbench#showOverlay(Region, boolean)`.
private void	initBindings()
private void	initFactories(Workbench.WorkbenchBuilder builder)
private void	initListeners()
private void	initModules(Workbench.WorkbenchBuilder builder)
private void	initNavigationDrawer(Workbench.WorkbenchBuilder builder)
private void	initNavigationDrawer(NavigationDrawer navigationDrawer)
private void	initToolbarControls(Workbench.WorkbenchBuilder builder)
public final boolean	isSingleModuleLayout()
public final IntegerProperty	modulesPerPageProperty()
private ListProperty<WorkbenchModule>	modulesProperty()
public final ObjectProperty<NavigationDrawer>	navigationDrawerProperty()
public final void	openAddModulePage() Goes back to the AddModulePage screen where the user can choose between modules.
public final void	openModule(WorkbenchModule the module to be opened or null to go to the home view module) Opens the `module` in a new tab, if it isn't initialized yet or else opens the tab of it.
private ListProperty<WorkbenchModule>	openModulesProperty()
public final ObjectProperty<Callback<Workbench, Page>>	pageFactoryProperty()
private void	resetModuleCloseable(WorkbenchModule module)
private void	setDrawerShown(Region drawerShown)
private void	setDrawerSideShown(Side drawerSideShown)
public final void	setModulesPerPage(int modulesPerPage)
public final void	setNavigationDrawer(NavigationDrawer navigationDrawer)
public final void	setPageFactory(Callback<Workbench, Page> pageFactory)
public final void	setTabFactory(Callback<Workbench, Tab> tabFactory)
public final void	setTileFactory(Callback<Workbench, Tile> tileFactory)
pack-priv void	setupCleanup()
public final WorkbenchDialog	Returns: the `WorkbenchDialog`, which will be shown showConfirmationDialog(String of the dialog title, String of the dialog message, Consumer<ButtonType> the action to perform when a button of the dialog was pressed, providing the `ButtonType` that was pressed onResult) Shows a confirmation dialog in the view.
public final WorkbenchDialog	Returns: the `WorkbenchDialog`, which will be shown showDialog(WorkbenchDialog to be shown dialog) Shows a `WorkbenchDialog` in the view.
public final void	showDrawer(Region to be shown drawer, Side of the workbench, on which the `drawer` should be positioned side) Shows the `drawer` on the defined `side` in the `Workbench`.
public final void	showDrawer(Region to be shown drawer, Side of the workbench, on which the `drawer` should be positioned side, int value between 0 and 100, defining how much maximum coverage the drawer should have or -1, to have the drawer size according to its computed size percentage) Shows the `drawer` on the defined `side` in the `Workbench`, ensuring the `drawer` doesn't cover more than the specified `percentage`.
public final WorkbenchDialog	Returns: the `WorkbenchDialog`, which will be shown showErrorDialog(String of the dialog title, String of the dialog message, Consumer<ButtonType> the action to perform when a button of the dialog was pressed, providing the `ButtonType` that was pressed onResult) Shows an error dialog in the view.
public final WorkbenchDialog	Returns: the `WorkbenchDialog`, which will be shown showErrorDialog(String of the dialog title, String of the dialog message, Exception of which the stacktrace should be shown exception, Consumer<ButtonType> the action to perform when a button of the dialog was pressed, providing the `ButtonType` that was pressed onResult) Shows an error dialog in the view with a stacktrace of the `exception`.
public final WorkbenchDialog	Returns: the `WorkbenchDialog`, which will be shown showErrorDialog(String of the dialog title, String of the dialog message, String about the error details, Consumer<ButtonType> the action to perform when a button of the dialog was pressed, providing the `ButtonType` that was pressed onResult) Shows an error dialog in the view with `details` about the error.
public final WorkbenchDialog	Returns: the `WorkbenchDialog`, which will be shown showInformationDialog(String of the dialog title, String of the dialog message, Consumer<ButtonType> the action to perform when a button of the dialog was pressed, providing the `ButtonType` that was pressed onResult) Shows an information dialog in the view.
public final void	showNavigationDrawer()
public final boolean	Returns: true if the overlay is not being shown already showOverlay(Region to be shown overlay, boolean If false (non-blocking), clicking outside of the `overlay` will cause it to get hidden, together with its `GlassPane`. If true (blocking), clicking outside of the `overlay` will not do anything. The `overlay` itself must call `Workbench#hideOverlay(Region)` to hide it. blocking) Shows the `overlay` on top of the view, with a `GlassPane` in the background.
private boolean	Returns: true if the overlay is not being shown already showOverlay(Region to be shown overlay, boolean If false (non-blocking), clicking outside of the `overlay` will cause it to get hidden, together with its `GlassPane`. If true (blocking), clicking outside of the `overlay` will not do anything. The `overlay` itself must call `Workbench#hideOverlay(Region)` to hide it. blocking, Side from which the `overlay` should be slid when the overlay is being shown or hidden side) Shows the `overlay` on top of the view, with a `GlassPane` in the background.
public final WorkbenchDialog	Returns: the `WorkbenchDialog`, which will be shown showWarningDialog(String of the dialog title, String of the dialog message, Consumer<ButtonType> the action to perform when a button of the dialog was pressed, providing the `ButtonType` that was pressed onResult) Shows a warning dialog in the view.
private TranslateTransition	slideIn(Region overlay)
private TranslateTransition	slideOut(Region overlay)
public final ObjectProperty<Callback<Workbench, Tab>>	tabFactoryProperty()
public final ObjectProperty<Callback<Workbench, Tile>>	tileFactoryProperty()

public final Class Workbench

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary