org.uberfire.client.workbench

Class WorkbenchLayoutImpl

java.lang.Object

org.uberfire.client.workbench.WorkbenchLayoutImpl

All Implemented Interfaces:

WorkbenchLayout

@ApplicationScoped
public class WorkbenchLayoutImpl
extends Object
implements WorkbenchLayout

The default layout implementation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	WorkbenchLayoutImpl.AbstractResizeAnimation
protected static class	WorkbenchLayoutImpl.CollapseAnimation
protected static class	WorkbenchLayoutImpl.ExpandAnimation
protected static class	WorkbenchLayoutImpl.OriginalStyleInfo Holder for style information that was modified in order to maximize a panel.

Field Summary

Fields

Modifier and Type	Field and Description
static String	UF_MAXIMIZED_PANEL
static String	UF_ROOT_CSS_CLASS

Constructor Summary

Constructors

Constructor and Description
WorkbenchLayoutImpl()
WorkbenchLayoutImpl(org.jboss.errai.ioc.client.container.SyncBeanManager iocManager, com.google.gwt.user.client.ui.HeaderPanel root, WorkbenchDragAndDropManager dndManager, UberfireDocksContainer uberfireDocksContainer, WorkbenchPickupDragController dragController, org.jboss.errai.common.client.dom.Div headerPanel, org.jboss.errai.common.client.dom.Div footerPanel)

Method Summary

Modifier and Type	Method and Description
void	addWorkbenchProfileCssClass(WorkbenchProfileCssClass workbenchProfileCssClass)
protected org.jboss.errai.common.client.dom.Div	getFooterPanel()
protected org.jboss.errai.common.client.dom.Div	getHeaderPanel()
com.google.gwt.user.client.ui.HasWidgets	getPerspectiveContainer() Gives access to the element of the workbench that hosts perspective widgets.
com.google.gwt.user.client.ui.HeaderPanel	getRoot() Gives access to the root container element that will be attached to the RootLayoutPanel.
void	maximize(com.google.gwt.user.client.ui.Widget w) Makes the given widget fill the entire space normally dedicated to the perspective container.
void	maximize(com.google.gwt.user.client.ui.Widget w, Command callback) Makes the given widget fill the entire space normally dedicated to the perspective container.
void	onBootstrap() Will be invoked by the Workbench when the discovery of header and footer elements is completed.
void	onResize() The Workbench listens for resize events and hands them off to the layout.
void	resizeTo(int width, int height) See WorkbenchLayout.onResize()
void	setMarginWidgets(boolean isStandaloneMode, Set<String> headersToKeep) Will insert the implementations of Header and Footer in the Workbench
void	unmaximize(com.google.gwt.user.client.ui.Widget w) Restores a previously maximized widget to its original size and position.
void	unmaximize(com.google.gwt.user.client.ui.Widget w, Command callback) Restores a previously maximized widget to its original size and position.

Methods inherited from class java.lang.Object

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

Field Detail

UF_MAXIMIZED_PANEL

public static final String UF_MAXIMIZED_PANEL

See Also:

Constant Field Values

UF_ROOT_CSS_CLASS

public static final String UF_ROOT_CSS_CLASS

See Also:

Constant Field Values

Constructor Detail

WorkbenchLayoutImpl

public WorkbenchLayoutImpl()

WorkbenchLayoutImpl

@Inject
public WorkbenchLayoutImpl(org.jboss.errai.ioc.client.container.SyncBeanManager iocManager,
                                   com.google.gwt.user.client.ui.HeaderPanel root,
                                   WorkbenchDragAndDropManager dndManager,
                                   UberfireDocksContainer uberfireDocksContainer,
                                   WorkbenchPickupDragController dragController,
                                   org.jboss.errai.common.client.dom.Div headerPanel,
                                   org.jboss.errai.common.client.dom.Div footerPanel)

Method Detail

getRoot

public com.google.gwt.user.client.ui.HeaderPanel getRoot()

Description copied from interface: WorkbenchLayout

Gives access to the root container element that will be attached to the RootLayoutPanel.

Specified by:

getRoot in interface WorkbenchLayout

Returns:

the outer most workbench widget

getPerspectiveContainer

public com.google.gwt.user.client.ui.HasWidgets getPerspectiveContainer()

Description copied from interface: WorkbenchLayout

Gives access to the element of the workbench that hosts perspective widgets.

Specified by:

getPerspectiveContainer in interface WorkbenchLayout

Returns:

the perspective container element

onBootstrap

public void onBootstrap()

Description copied from interface: WorkbenchLayout

Will be invoked by the Workbench when the discovery of header and footer elements is completed.

Specified by:

onBootstrap in interface WorkbenchLayout

See Also:

#setHeaderContents(java.util.List)}, #setFooterContents(java.util.List)}

onResize

public void onResize()

Description copied from interface: WorkbenchLayout

The Workbench listens for resize events and hands them off to the layout. Not needed if your layout is based on LayoutPanel's. Kept for backwards compatibility.

Specified by:

onResize in interface WorkbenchLayout

resizeTo

public void resizeTo(int width,
                     int height)

Description copied from interface: WorkbenchLayout

See WorkbenchLayout.onResize()

Specified by:

resizeTo in interface WorkbenchLayout

maximize

public void maximize(com.google.gwt.user.client.ui.Widget w)

Description copied from interface: WorkbenchLayout

Makes the given widget fill the entire space normally dedicated to the perspective container. Has no effect if the given widget is already maximized.

Important: this feature is used by panels to maximize themselves. You should not pass a WorkbenchPanelView to this method yourself; instead, you should use the panel's own API to maximize it. You are free to use this method to maximize your own widgets that are not workbench panels.

Specified by:

maximize in interface WorkbenchLayout

Parameters:

w - the Widget to maximize.

maximize

public void maximize(com.google.gwt.user.client.ui.Widget w,
                     Command callback)

Description copied from interface: WorkbenchLayout

Makes the given widget fill the entire space normally dedicated to the perspective container. Has no effect if the given widget is already maximized.

Important: this feature is used by panels to maximize themselves. You should not pass a WorkbenchPanelView to this method yourself; instead, you should use the panel's own API to maximize it. You are free to use this method to maximize your own widgets that are not workbench panels.

Specified by:

maximize in interface WorkbenchLayout

Parameters:

w - the Widget to maximize.

callback - A command to be executed after the maximization is fully completed.

unmaximize

public void unmaximize(com.google.gwt.user.client.ui.Widget w)

Description copied from interface: WorkbenchLayout

Restores a previously maximized widget to its original size and position. Has no effect if the given widget is not currently in a maximized state set up by WorkbenchLayout.maximize(Widget).

Important: this feature is used by panels to unmaximize themselves. You should not pass a WorkbenchPanelView to this method yourself; instead, you should use the panel's own API to unmaximize it. You are free to use this method to unmaximize your own widgets that have previously been passed to WorkbenchLayout.maximize(Widget).

Specified by:

unmaximize in interface WorkbenchLayout

Parameters:

w - the Widget to restore to its original size and location.

unmaximize

public void unmaximize(com.google.gwt.user.client.ui.Widget w,
                       Command callback)

Description copied from interface: WorkbenchLayout

Restores a previously maximized widget to its original size and position. Has no effect if the given widget is not currently in a maximized state set up by WorkbenchLayout.maximize(Widget).

Important: this feature is used by panels to unmaximize themselves. You should not pass a WorkbenchPanelView to this method yourself; instead, you should use the panel's own API to unmaximize it. You are free to use this method to unmaximize your own widgets that have previously been passed to WorkbenchLayout.maximize(Widget).

Specified by:

unmaximize in interface WorkbenchLayout

Parameters:

w - the Widget to restore to its original size and location.

callback - A command to be executed after the unmaximization is fully completed.

setMarginWidgets

public void setMarginWidgets(boolean isStandaloneMode,
                             Set<String> headersToKeep)

Description copied from interface: WorkbenchLayout

Will insert the implementations of Header and Footer in the Workbench

Specified by:

setMarginWidgets in interface WorkbenchLayout

See Also:

#setHeaderContents(java.util.List)}, #setFooterContents(java.util.List)}

addWorkbenchProfileCssClass

public void addWorkbenchProfileCssClass(@Observes
                                        WorkbenchProfileCssClass workbenchProfileCssClass)

getHeaderPanel

protected org.jboss.errai.common.client.dom.Div getHeaderPanel()

getFooterPanel

protected org.jboss.errai.common.client.dom.Div getFooterPanel()