org.uberfire.client.workbench.panels.impl

Class AbstractWorkbenchPanelPresenter<P extends AbstractWorkbenchPanelPresenter<P>>

java.lang.Object

org.uberfire.client.workbench.panels.impl.AbstractWorkbenchPanelPresenter<P>

All Implemented Interfaces:

WorkbenchPanelPresenter

Direct Known Subclasses:

AbstractDockingWorkbenchPanelPresenter, ImmutableWorkbenchPanelPresenter, LayoutPanelPresenter, SplitLayoutPanelPresenter, StaticWorkbenchPanelPresenter, TemplatedWorkbenchPanelPresenter, UnanchoredStaticWorkbenchPanelPresenter

public abstract class AbstractWorkbenchPanelPresenter<P extends AbstractWorkbenchPanelPresenter<P>>
extends Object
implements WorkbenchPanelPresenter

Basic implementation of common functionality in a panel presenter.

At the least, concrete subclasses have to implement asPresenterType() to return this. Subclasses may override other methods as necessary to customize behaviour for use with specialized layouts and view implementations.

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<Position,WorkbenchPanelPresenter>	childPanels
protected PerspectiveManager	perspectiveManager

Constructor Summary

Constructors

Constructor and Description
AbstractWorkbenchPanelPresenter(WorkbenchPanelView<P> view, PerspectiveManager perspectiveManager)

Method Summary

Modifier and Type	Method and Description
void	addPanel(WorkbenchPanelPresenter child, Position position) This base implementation should be sufficient for most panels.
void	addPart(WorkbenchPartPresenter part) Calls addPart(org.uberfire.client.workbench.part.WorkbenchPartPresenter, String).
void	addPart(WorkbenchPartPresenter part, String contextId) Adds the given part to the view returned by getPanelView(), ignoring the given contextId.
protected abstract P	asPresenterType() Returns a reference to this.
void	changeTitle(PartDefinition part, String title, com.google.gwt.user.client.ui.IsWidget titleDecorator)
String	getDefaultChildType() Most panel types are their own default child type, so this implementation returns getClass().getName().
PanelDefinition	getDefinition() Returns a @Portable description of the current state of this panel.
Map<Position,WorkbenchPanelPresenter>	getPanels() Returns the immediate child panels of this panel.
WorkbenchPanelView<P>	getPanelView() Returns the view that was given to this panel when it was first created.
WorkbenchPanelPresenter	getParent() Returns the current parent of this panel presenter.
Class<? extends WorkbenchPartPresenter>	getPartType() Returns the type of new parts.
void	maximize() Makes this panel's view take up most of the space on the workbench.
void	onResize(int width, int height)
protected Position	positionOf(WorkbenchPanelPresenter child)
boolean	removePanel(WorkbenchPanelPresenter child) Removes the given panel presenter and its view from this panel, freeing all resources associated with them.
boolean	removePart(PartDefinition part) Removes the given part from this panel, updating this panel's definition and the part's definition to reflect that the part no longer belongs to this panel.
boolean	selectPart(PartDefinition part)
void	setDefinition(PanelDefinition definition) Called by the framework when the panel instance is first created.
void	setFocus(boolean hasFocus)
void	setParent(WorkbenchPanelPresenter parent) Sets the current parent of this panel presenter.
String	toString()
void	unmaximize() Restores this panel's view to its original unmaximized size and position.

Methods inherited from class java.lang.Object

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

Field Detail

perspectiveManager

protected final PerspectiveManager perspectiveManager

childPanels

protected final Map<Position,WorkbenchPanelPresenter> childPanels

Constructor Detail

AbstractWorkbenchPanelPresenter

public AbstractWorkbenchPanelPresenter(WorkbenchPanelView<P> view,
                                       PerspectiveManager perspectiveManager)

Method Detail

asPresenterType

protected abstract P asPresenterType()

Returns a reference to this. Helps superclass code work around generic type checking problems.

getParent

public WorkbenchPanelPresenter getParent()

Description copied from interface: WorkbenchPanelPresenter

Returns the current parent of this panel presenter.

Specified by:

getParent in interface WorkbenchPanelPresenter

Returns:

the parent panel presenter. If this panel is the root, or it is not attached to a parent, the return value is null.

setParent

public void setParent(WorkbenchPanelPresenter parent)

Description copied from interface: WorkbenchPanelPresenter

Sets the current parent of this panel presenter. This method should only be called by another WorkbenchPanelPresenter when adding or removing this panel as a child.

Specified by:

setParent in interface WorkbenchPanelPresenter

Parameters:

parent - the new parent of this panel. If this panel is being removed, the parent should be set to null.

getDefinition

public PanelDefinition getDefinition()

Description copied from interface: WorkbenchPanelPresenter

Returns a @Portable description of the current state of this panel.

Specified by:

getDefinition in interface WorkbenchPanelPresenter

setDefinition

public void setDefinition(PanelDefinition definition)

Description copied from interface: WorkbenchPanelPresenter

Called by the framework when the panel instance is first created. Application code should not call this method directly.

Specified by:

setDefinition in interface WorkbenchPanelPresenter

Parameters:

definition - description of the state this panel should put itself in. This panel is also responsible for keeping the definition up to date with the panel's current state.

getDefaultChildType

public String getDefaultChildType()

Most panel types are their own default child type, so this implementation returns getClass().getName(). Subclasses can override if they prefer a different child type.

Specified by:

getDefaultChildType in interface WorkbenchPanelPresenter

Returns:

the fully-qualified class name of a WorkbenchPanelPresenter implementation. Returns null if this panel presenter does not allow child panels.

addPart

public void addPart(WorkbenchPartPresenter part)

Calls addPart(org.uberfire.client.workbench.part.WorkbenchPartPresenter, String). Subclasses can take advantage of this by only overriding the 2-arg version.

Specified by:

addPart in interface WorkbenchPanelPresenter

Parameters:

part - the part to add. Must not be null, and must not currently belong to any panel.

addPart

public void addPart(WorkbenchPartPresenter part,
                    String contextId)

Adds the given part to the view returned by getPanelView(), ignoring the given contextId. Subclasses that care about context id's will override this method.

Specified by:

addPart in interface WorkbenchPanelPresenter

Parameters:

part - the part to add. Must not be null, and must not currently belong to any panel.

See Also:

WorkbenchPanelPresenter.addPart(WorkbenchPartPresenter)

removePart

public boolean removePart(PartDefinition part)

Description copied from interface: WorkbenchPanelPresenter

Removes the given part from this panel, updating this panel's definition and the part's definition to reflect that the part no longer belongs to this panel.

Specified by:

removePart in interface WorkbenchPanelPresenter

Returns:

true if the given part was found and removed; false if this call had no effect

See Also:

WorkbenchPanelPresenter.addPart(WorkbenchPartPresenter)

addPanel

public void addPanel(WorkbenchPanelPresenter child,
                     Position position)

This base implementation should be sufficient for most panels. It modifies the panel definition and adds the child view to this panel's view. In case the requested position is already in use for this panel, this method will throw an IllegalStateException. Subclasses may override and implement some other collision avoidance strategy.

Specified by:

addPanel in interface WorkbenchPanelPresenter

Parameters:

child - the panel to add. The presenter, its view, and its definition must not belong to any parent. As a side effect of this call (if the call is successful), the given presenter, its view, and its definition will get attached to their new parents.

position - the position to add the child at. Different panel implementations support different position types.

removePanel

public boolean removePanel(WorkbenchPanelPresenter child)

Description copied from interface: WorkbenchPanelPresenter

Removes the given panel presenter and its view from this panel, freeing all resources associated with them.

Specified by:

removePanel in interface WorkbenchPanelPresenter

Parameters:

child - The child panel to remove. Must be a direct child of this panel, and must be empty (contain no parts or child panels). Null is not permitted.

Returns:

true if the child was found and removed from this panel; false if the child panel could not be found.

getPanels

public Map<Position,WorkbenchPanelPresenter> getPanels()

Description copied from interface: WorkbenchPanelPresenter

Returns the immediate child panels of this panel. Note that panels and parts are not the same thing; this method only returns the panels.

Specified by:

getPanels in interface WorkbenchPanelPresenter

Returns:

an unmodifiable snapshot of the immediate child panels nested within this one. Never null, and will not update to reflect subsequent changes to this panel's children. Safe to iterate over when adding or removing child panels.

positionOf

protected Position positionOf(WorkbenchPanelPresenter child)

changeTitle

public void changeTitle(PartDefinition part,
                        String title,
                        com.google.gwt.user.client.ui.IsWidget titleDecorator)

Specified by:

changeTitle in interface WorkbenchPanelPresenter

setFocus

public void setFocus(boolean hasFocus)

Specified by:

setFocus in interface WorkbenchPanelPresenter

selectPart

public boolean selectPart(PartDefinition part)

Specified by:

selectPart in interface WorkbenchPanelPresenter

maximize

public void maximize()

Description copied from interface: WorkbenchPanelPresenter

Makes this panel's view take up most of the space on the workbench. The exact meaning of "maximize" is left to the implementation of WorkbenchLayout.

Specified by:

maximize in interface WorkbenchPanelPresenter

unmaximize

public void unmaximize()

Description copied from interface: WorkbenchPanelPresenter

Restores this panel's view to its original unmaximized size and position.

Specified by:

unmaximize in interface WorkbenchPanelPresenter

getPanelView

public WorkbenchPanelView<P> getPanelView()

Description copied from interface: WorkbenchPanelPresenter

Returns the view that was given to this panel when it was first created.

Specified by:

getPanelView in interface WorkbenchPanelPresenter

onResize

public void onResize(int width,
                     int height)

Specified by:

onResize in interface WorkbenchPanelPresenter

toString

public String toString()

Overrides:

toString in class Object

getPartType

public Class<? extends WorkbenchPartPresenter> getPartType()

Description copied from interface: WorkbenchPanelPresenter

Returns the type of new parts.

Specified by:

getPartType in interface WorkbenchPanelPresenter