Package org.uberfire.client.workbench.panels.impl

Class LayoutPanelView

java.lang.Object

org.uberfire.client.workbench.panels.impl.LayoutPanelView

All Implemented Interfaces:

com.google.gwt.user.client.ui.IsWidget, com.google.gwt.user.client.ui.RequiresResize, org.uberfire.client.mvp.HasPresenter<LayoutPanelPresenter>, org.uberfire.client.mvp.UberView<LayoutPanelPresenter>, WorkbenchPanelView<LayoutPanelPresenter>

@Dependent
@Named("LayoutPanelView")
public class LayoutPanelView
extends Object
implements WorkbenchPanelView<LayoutPanelPresenter>

A simple LayoutPanel presenter. Can be used for both perspectives and panels. Does not support drag-and-drop.

Constructor Summary

Constructors

Constructor	Description
LayoutPanelView()

Method Summary

Modifier and Type	Method	Description
void	addPanel(org.uberfire.workbench.model.PanelDefinition panel, WorkbenchPanelView view, org.uberfire.workbench.model.Position position)	Nests the given WorkbenchPanelView inside this one at the given position, which must be unoccupied.
void	addPart(WorkbenchPartPresenter.View view)	Adds the given part view to this panel if this panel does not already contain a view that handles the same PlaceRequest as the given one.
com.google.gwt.user.client.ui.Widget	asWidget()
void	changeTitle(org.uberfire.workbench.model.PartDefinition part, String title, com.google.gwt.user.client.ui.IsWidget titleDecoration)	Assigns the given title to the given part, if the part belongs to this panel.
com.google.gwt.user.client.ui.Widget	getPartDropRegion()	Returns the widget that defines the boundaries of this panel view for purposes of drag-and-drop.
Collection<org.uberfire.workbench.model.PartDefinition>	getParts()	Returns the parts currently held by the view.
LayoutPanelPresenter	getPresenter()	Returns this view's presenter.
void	init(LayoutPanelPresenter presenter)
void	maximize()	Maximizes this view using WorkbenchLayout.maximize(Widget).
void	onResize()
boolean	removePanel(WorkbenchPanelView<?> child)	Removes the view widget associated with the given child from this panel, freeing any resources that were allocated by this panel when the child was added.
boolean	removePart(org.uberfire.workbench.model.PartDefinition part)	Removes the given part from this view, if it belonged to this view.
boolean	selectPart(org.uberfire.workbench.model.PartDefinition part)	Makes the given part visible and focused, if it belongs to this view.
void	setElementId(String elementId)	Sets the ID of the physical root element of this view.
void	setFocus(boolean hasFocus)	Informs this view that it has gained or lost keyboard focus.
void	unmaximize()	Restores this view to its original unmaximized size and position using WorkbenchLayout.unmaximize(Widget).

Methods inherited from class java.lang.Object

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

Constructor Detail

LayoutPanelView

@Inject
public LayoutPanelView()

Method Detail

addPanel

public void addPanel(org.uberfire.workbench.model.PanelDefinition panel,
                     WorkbenchPanelView view,
                     org.uberfire.workbench.model.Position position)

Description copied from interface: WorkbenchPanelView

Nests the given WorkbenchPanelView inside this one at the given position, which must be unoccupied. This is an optional feature of WorkbenchPanelView: not all implementations support nested child panels. Additionally, different panels support different Position types. Implementations should document whether or not they support child panels, and if so, what types of Positions they understand.

Specified by:

addPanel in interface WorkbenchPanelView<LayoutPanelPresenter>

Parameters:

panel - specifies the size that should be imposed on the nested view. Must not be null. FIXME: is this sensible/correct?

view - the panel to nest inside this one. Must not be null.

position - specifies which edge of this panel will be shared with the nested panel. Must not be null.

removePanel

public boolean removePanel(WorkbenchPanelView<?> child)

Description copied from interface: WorkbenchPanelView

Removes the view widget associated with the given child from this panel, freeing any resources that were allocated by this panel when the child was added.

Specified by:

removePanel in interface WorkbenchPanelView<LayoutPanelPresenter>

asWidget

public com.google.gwt.user.client.ui.Widget asWidget()

Specified by:

asWidget in interface com.google.gwt.user.client.ui.IsWidget

init

public void init(LayoutPanelPresenter presenter)

Specified by:

init in interface org.uberfire.client.mvp.HasPresenter<LayoutPanelPresenter>

getPresenter

public LayoutPanelPresenter getPresenter()

Description copied from interface: WorkbenchPanelView

Returns this view's presenter.

Specified by:

getPresenter in interface WorkbenchPanelView<LayoutPanelPresenter>

Returns:

the presenter that this view is bound to. Will return null if invoked before the presenter calls HasPresenter.init(Object); afterward, the return value is never null.

addPart

public void addPart(WorkbenchPartPresenter.View view)

Description copied from interface: WorkbenchPanelView

Adds the given part view to this panel if this panel does not already contain a view that handles the same PlaceRequest as the given one. If this panel does already contain such a part, the existing one is selected and the given one is not added.

Specified by:

addPart in interface WorkbenchPanelView<LayoutPanelPresenter>

Parameters:

view - the view to add as long as it is not a duplicate. Must not be null.

removePart

public boolean removePart(org.uberfire.workbench.model.PartDefinition part)

Description copied from interface: WorkbenchPanelView

Removes the given part from this view, if it belonged to this view.

Specified by:

removePart in interface WorkbenchPanelView<LayoutPanelPresenter>

Parameters:

part - the part to remove.

Returns:

true if the part was found and removed. False if not.

selectPart

public boolean selectPart(org.uberfire.workbench.model.PartDefinition part)

Description copied from interface: WorkbenchPanelView

Makes the given part visible and focused, if it belongs to this view.

Specified by:

selectPart in interface WorkbenchPanelView<LayoutPanelPresenter>

Parameters:

part - the part to reveal and give focus to.

Returns:

true if the part was found, made visible, and given focus. False if not.

getParts

public Collection<org.uberfire.workbench.model.PartDefinition> getParts()

Description copied from interface: WorkbenchPanelView

Returns the parts currently held by the view.

Specified by:

getParts in interface WorkbenchPanelView<LayoutPanelPresenter>

getPartDropRegion

public com.google.gwt.user.client.ui.Widget getPartDropRegion()

Description copied from interface: WorkbenchPanelView

Returns the widget that defines the boundaries of this panel view for purposes of drag-and-drop.

Specified by:

getPartDropRegion in interface WorkbenchPanelView<LayoutPanelPresenter>

Returns:

the widget whose boundaries define the region where workbench parts can be dropped into this panel. For simple panel types that do not support child panels, this will typically be the same widget returned by IsWidget.asWidget(). For fancier panels, this will typically be some child panel within the view's internal structure.

If the return value is null, parts will not be droppable on this view.

setFocus

public void setFocus(boolean hasFocus)

Description copied from interface: WorkbenchPanelView

Informs this view that it has gained or lost keyboard focus. Focused views may respond by updating their style to look more prominent than unfocused views.

Specified by:

setFocus in interface WorkbenchPanelView<LayoutPanelPresenter>

Parameters:

hasFocus - if true, this panel now has focus. If false, this panel does not have focus.

onResize

public void onResize()

Specified by:

onResize in interface com.google.gwt.user.client.ui.RequiresResize

changeTitle

public void changeTitle(org.uberfire.workbench.model.PartDefinition part,
                        String title,
                        com.google.gwt.user.client.ui.IsWidget titleDecoration)

Description copied from interface: WorkbenchPanelView

Assigns the given title to the given part, if the part belongs to this panel.

Specified by:

changeTitle in interface WorkbenchPanelView<LayoutPanelPresenter>

Parameters:

part - the part whose title to change. Must not be null.

title - the new title. Must not be null.

titleDecoration - An optional widget to display beside the title. Note that some implementations do not support title decorations, and they will ignore this. Null is permitted, and means no decoration.

setElementId

public void setElementId(String elementId)

Description copied from interface: WorkbenchPanelView

Sets the ID of the physical root element of this view. For HTML-based views, this is the id attribute of the view's top-level DOM element. Implementations for other view technologies should map this to whatever the underlying widget/component system uses for unique identifiers.

Specified by:

setElementId in interface WorkbenchPanelView<LayoutPanelPresenter>

Parameters:

elementId - the element ID to set. If null, the ID value will be cleared.

maximize

public void maximize()

Description copied from interface: WorkbenchPanelView

Maximizes this view using WorkbenchLayout.maximize(Widget).

Specified by:

maximize in interface WorkbenchPanelView<LayoutPanelPresenter>

unmaximize

public void unmaximize()

Description copied from interface: WorkbenchPanelView

Restores this view to its original unmaximized size and position using WorkbenchLayout.unmaximize(Widget).

Specified by:

unmaximize in interface WorkbenchPanelView<LayoutPanelPresenter>