Top Description Fields Constructors Methods
com.dlsc.workbenchfx.view

public final Class WorkbenchView

extends StackPane
implements View
Class Inheritance
All Implemented Interfaces
com.dlsc.workbenchfx.view.View
Imports
com.dlsc.workbenchfx.view.controls.GlassPane, javafx.scene.layout.Priority, .Region, .StackPane, .VBox, org.slf4j.Logger, .LoggerFactory
Represents the master view, which is used to show all view parts.
Authors
François Martin, Marco Sanfratello

Field Summary

Modifier and TypeField and Description
pack-priv final AddModuleView
addModuleView

pack-priv final ContentView
contentView

private static final Logger
LOGGER

pack-priv final ToolbarView
toolbarView

pack-priv VBox
viewBox

Constructor Summary

AccessConstructor and Description
public
WorkbenchView(ToolbarView
the ToolbarView to be shown
toolbarView, AddModuleView
the AddModuleView to be shown
addModuleView, ContentView
the ContentView to be shown
contentView)

Displays all of the view parts, representing the master view.

Method Summary

Modifier and TypeMethod and Description
pack-priv final void
addOverlay(Region
to be stacked on top of the view
overlay, GlassPane
to be added in the background of the overlay
glassPane)

Stacks the overlay on top of the current view, together with its glassPane in the background and makes the glassPane hide, whenever the overlay is hidden.

pack-priv final void
hideOverlay(Region
to be made invisible
overlay)

Makes the overlay invisible.

public final void
initializeParts()

Implements com.dlsc.workbenchfx.view.View.initializeParts.

Initializes all parts of the view.

public final void
initializeSelf()

Overrides default com.dlsc.workbenchfx.view.View.initializeSelf.

Initializes the view.

public final void
layoutParts()

Implements com.dlsc.workbenchfx.view.View.layoutParts.

Defines the layout of all parts in the view.

pack-priv final void
removeOverlay(Region
to be removed from the scene graph
overlay, GlassPane
the overlay's corresponding GlassPane
glassPane)

Removes the overlay from the scene graph and removes the bindings created with the call to WorkbenchView#addOverlay(Region, GlassPane).

pack-priv final void
showOverlay(Region
to be made visible
overlay)

Makes the overlay visible.

Inherited from javafx.scene.layout.StackPane:
alignmentPropertyclearConstraintscomputeMinHeightcomputeMinWidthcomputePrefHeightcomputePrefWidthgetAlignmentgetAlignmentgetClassCssMetaDatagetContentBiasgetCssMetaDatagetMarginlayoutChildrenrequestLayoutsetAlignmentsetAlignmentsetMargin

Field Detail

addModuleViewback to summary
pack-priv final AddModuleView addModuleView
contentViewback to summary
pack-priv final ContentView contentView
LOGGERback to summary
private static final Logger LOGGER
toolbarViewback to summary
pack-priv final ToolbarView toolbarView
viewBoxback to summary
pack-priv VBox viewBox

Constructor Detail

WorkbenchViewback to summary
public WorkbenchView(ToolbarView toolbarView, AddModuleView addModuleView, ContentView contentView)

Displays all of the view parts, representing the master view.

Parameters
toolbarView:ToolbarView

the ToolbarView to be shown

addModuleView:AddModuleView

the AddModuleView to be shown

contentView:ContentView

the ContentView to be shown

Method Detail

addOverlayback to summary
pack-priv final void addOverlay(Region overlay, GlassPane glassPane)

Stacks the overlay on top of the current view, together with its glassPane in the background and makes the glassPane hide, whenever the overlay is hidden.

Parameters
overlay:Region

to be stacked on top of the view

glassPane:GlassPane

to be added in the background of the overlay

hideOverlayback to summary
pack-priv final void hideOverlay(Region overlay)

Makes the overlay invisible.

Parameters
overlay:Region

to be made invisible

initializePartsback to summary
public final void initializeParts()

Implements com.dlsc.workbenchfx.view.View.initializeParts.

Doc from com.dlsc.workbenchfx.view.View.initializeParts.

Initializes all parts of the view.

Annotations
@Override
initializeSelfback to summary
public final void initializeSelf()

Overrides default com.dlsc.workbenchfx.view.View.initializeSelf.

Doc from com.dlsc.workbenchfx.view.View.initializeSelf.

Initializes the view.

Annotations
@Override
layoutPartsback to summary
public final void layoutParts()

Implements com.dlsc.workbenchfx.view.View.layoutParts.

Doc from com.dlsc.workbenchfx.view.View.layoutParts.

Defines the layout of all parts in the view.

Annotations
@Override
removeOverlayback to summary
pack-priv final void removeOverlay(Region overlay, GlassPane glassPane)

Removes the overlay from the scene graph and removes the bindings created with the call to WorkbenchView#addOverlay(Region, GlassPane).

Parameters
overlay:Region

to be removed from the scene graph

glassPane:GlassPane

the overlay's corresponding GlassPane

showOverlayback to summary
pack-priv final void showOverlay(Region overlay)

Makes the overlay visible.

Parameters
overlay:Region

to be made visible