org.jacpfx.api.componentLayout

Interface WorkbenchLayout<C>

Type Parameters:

C - defines the base component where others extend from

All Superinterfaces:

BaseLayout<C>

public interface WorkbenchLayout<C>
extends BaseLayout<C>

Defines the base layout of a workbench and the application.

Author:

Andy Moncsek

Method Summary

Modifier and Type	Method and Description
<S extends java.lang.Enum> S	getStyle() Returns the workbench style.
Tupel<java.lang.Integer,java.lang.Integer>	getWorkbenchSize() Returns a tuple defining the workbench size.
boolean	isMenuEnabled() Check if menus are enabled.
void	registerToolBar(ToolbarPosition position) Register a toolbar for the workbench All toolbars are added with the same priority, thus the priority is given by the order of registration.
void	registerToolBars(ToolbarPosition... positions) Register multiple toolbars for the workbench All toolbars are added with the same priority, thus the priority is given by the order of registration.
void	setMenuEnabled(boolean enabled) Set menus to enabled state.
<S extends java.lang.Enum> void	setStyle(S style) Set the workbench style.
void	setWorkbenchXYSize(int x, int y) Set the size of the workbench.

Methods inherited from interface org.jacpfx.api.componentLayout.BaseLayout

getGlassPane, getMenu, getRegisteredToolBar, getRegisteredToolBars

Method Detail

isMenuEnabled

boolean isMenuEnabled()

Check if menus are enabled.

Returns:

if menu is enable/disable

setMenuEnabled

void setMenuEnabled(boolean enabled)

Set menus to enabled state.

Parameters:

enabled, - true if menu is enabled

setWorkbenchXYSize

void setWorkbenchXYSize(int x,
                        int y)

Set the size of the workbench.

Parameters:

x, - the initial X size of workbench

y, - the initial Y size of the workbench

getWorkbenchSize

Tupel<java.lang.Integer,java.lang.Integer> getWorkbenchSize()

Returns a tuple defining the workbench size.

Returns:

the tuple containing the workbench size

registerToolBars

void registerToolBars(ToolbarPosition... positions)

Register multiple toolbars for the workbench

All toolbars are added with the same priority, thus the priority is given by the order of registration.

Parameters:

positions - - NORTH, WEST, EAST, SOUTH

registerToolBar

void registerToolBar(ToolbarPosition position)

Register a toolbar for the workbench

All toolbars are added with the same priority, thus the priority is given by the order of registration.

Parameters:

position - - NORTH, WEST, EAST, SOUTH

setStyle

<S extends java.lang.Enum> void setStyle(S style)

Set the workbench style.

Parameters:

style - , the style of workbench

, - the style is type of Enum

getStyle

<S extends java.lang.Enum> S getStyle()

Returns the workbench style.

Parameters:

, - the style is type of Enum

Returns:

style