org.jacpfx.rcp.componentLayout

Class FXWorkbenchLayout

java.lang.Object

org.jacpfx.rcp.componentLayout.FXWorkbenchLayout

All Implemented Interfaces:

org.jacpfx.api.componentLayout.BaseLayout<javafx.scene.Node>, org.jacpfx.api.componentLayout.WorkbenchLayout<javafx.scene.Node>

public class FXWorkbenchLayout
extends java.lang.Object
implements org.jacpfx.api.componentLayout.WorkbenchLayout<javafx.scene.Node>

defines basic layout of workbench; define if menus are enabled; declare tool bars; set workbench size

Author:

Andy Moncsek

Constructor Summary

Constructors

Constructor and Description
FXWorkbenchLayout()

Method Summary

Modifier and Type	Method and Description
javafx.scene.layout.Pane	getGlassPane() Gets the glass pane.
JACPMenuBar	getMenu() Returns the application menu instance.
JACPToolBar	getRegisteredToolBar(org.jacpfx.api.util.ToolbarPosition position) Gets the registered tool bar.
java.util.Map<org.jacpfx.api.util.ToolbarPosition,JACPToolBar>	getRegisteredToolBars() Gets all registered tool bars.
<S extends java.lang.Enum> S	getStyle() Returns the workbench style.
org.jacpfx.api.util.Tupel<java.lang.Integer,java.lang.Integer>	getWorkbenchSize() Returns a tuple defining the workbench size.
boolean	isMenuEnabled() Check if menus are enabled.
void	registerToolBar(org.jacpfx.api.util.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(org.jacpfx.api.util.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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FXWorkbenchLayout

public FXWorkbenchLayout()

Method Detail

isMenuEnabled

public boolean isMenuEnabled()

Description copied from interface: org.jacpfx.api.componentLayout.WorkbenchLayout

Check if menus are enabled.

Specified by:

isMenuEnabled in interface org.jacpfx.api.componentLayout.WorkbenchLayout<javafx.scene.Node>

Returns:

if menu is enable/disable

setMenuEnabled

public void setMenuEnabled(boolean enabled)

Description copied from interface: org.jacpfx.api.componentLayout.WorkbenchLayout

Set menus to enabled state.

Specified by:

setMenuEnabled in interface org.jacpfx.api.componentLayout.WorkbenchLayout<javafx.scene.Node>

setWorkbenchXYSize

public void setWorkbenchXYSize(int x,
                               int y)

Description copied from interface: org.jacpfx.api.componentLayout.WorkbenchLayout

Set the size of the workbench.

Specified by:

setWorkbenchXYSize in interface org.jacpfx.api.componentLayout.WorkbenchLayout<javafx.scene.Node>

getWorkbenchSize

public org.jacpfx.api.util.Tupel<java.lang.Integer,java.lang.Integer> getWorkbenchSize()

Description copied from interface: org.jacpfx.api.componentLayout.WorkbenchLayout

Returns a tuple defining the workbench size.

Specified by:

getWorkbenchSize in interface org.jacpfx.api.componentLayout.WorkbenchLayout<javafx.scene.Node>

Returns:

the tuple containing the workbench size

registerToolBars

public void registerToolBars(org.jacpfx.api.util.ToolbarPosition... positions)

Description copied from interface: org.jacpfx.api.componentLayout.WorkbenchLayout

Register multiple toolbars for the workbench

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

Specified by:

registerToolBars in interface org.jacpfx.api.componentLayout.WorkbenchLayout<javafx.scene.Node>

Parameters:

positions - - NORTH, WEST, EAST, SOUTH

registerToolBar

public void registerToolBar(org.jacpfx.api.util.ToolbarPosition position)

Description copied from interface: org.jacpfx.api.componentLayout.WorkbenchLayout

Register a toolbar for the workbench

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

Specified by:

registerToolBar in interface org.jacpfx.api.componentLayout.WorkbenchLayout<javafx.scene.Node>

Parameters:

position - - NORTH, WEST, EAST, SOUTH

getStyle

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

Description copied from interface: org.jacpfx.api.componentLayout.WorkbenchLayout

Returns the workbench style.

Specified by:

getStyle in interface org.jacpfx.api.componentLayout.WorkbenchLayout<javafx.scene.Node>

Returns:

style

setStyle

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

Description copied from interface: org.jacpfx.api.componentLayout.WorkbenchLayout

Set the workbench style.

Specified by:

setStyle in interface org.jacpfx.api.componentLayout.WorkbenchLayout<javafx.scene.Node>

Parameters:

style - , the style of workbench

getMenu

public JACPMenuBar getMenu()

Description copied from interface: org.jacpfx.api.componentLayout.BaseLayout

Returns the application menu instance.

Specified by:

getMenu in interface org.jacpfx.api.componentLayout.BaseLayout<javafx.scene.Node>

Returns:

the menu instance

getRegisteredToolBar

public JACPToolBar getRegisteredToolBar(org.jacpfx.api.util.ToolbarPosition position)

Description copied from interface: org.jacpfx.api.componentLayout.BaseLayout

Gets the registered tool bar.

Specified by:

getRegisteredToolBar in interface org.jacpfx.api.componentLayout.BaseLayout<javafx.scene.Node>

Parameters:

position - the position

Returns:

the registered tool bar

getRegisteredToolBars

public java.util.Map<org.jacpfx.api.util.ToolbarPosition,JACPToolBar> getRegisteredToolBars()

Description copied from interface: org.jacpfx.api.componentLayout.BaseLayout

Gets all registered tool bars.

Specified by:

getRegisteredToolBars in interface org.jacpfx.api.componentLayout.BaseLayout<javafx.scene.Node>

Returns:

all registered tool bars

getGlassPane

public javafx.scene.layout.Pane getGlassPane()

Description copied from interface: org.jacpfx.api.componentLayout.BaseLayout

Gets the glass pane.

Specified by:

getGlassPane in interface org.jacpfx.api.componentLayout.BaseLayout<javafx.scene.Node>

Returns:

the glass pane