org.uberfire.client.workbench.panels.impl

Class AbstractWorkbenchPanelView<P extends WorkbenchPanelPresenter>

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.google.gwt.user.client.ui.Composite

com.google.gwt.user.client.ui.ResizeComposite

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

Type Parameters:

P - the type of presenter this view goes with

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsRenderable, com.google.gwt.user.client.ui.IsWidget, com.google.gwt.user.client.ui.RequiresResize, UberView<P>, WorkbenchPanelView<P>

Direct Known Subclasses:

AbstractDockingWorkbenchPanelView, StaticWorkbenchPanelView, UnanchoredStaticWorkbenchPanelView

public abstract class AbstractWorkbenchPanelView<P extends WorkbenchPanelPresenter>
extends com.google.gwt.user.client.ui.ResizeComposite
implements WorkbenchPanelView<P>

Implements focus and selection handling.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Field Summary

Fields

Modifier and Type	Field and Description
protected LayoutSelection	layoutSelection
protected PanelManager	panelManager
protected P	presenter

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
AbstractWorkbenchPanelView()

Method Summary

Modifier and Type	Method and Description
protected void	addOnFocusHandler(MultiPartWidget widget)
void	addPanel(org.uberfire.workbench.model.PanelDefinition panel, WorkbenchPanelView<?> view, org.uberfire.workbench.model.Position position) Throws UnsupportedOperationException when called.
protected void	addSelectionHandler(com.google.gwt.event.logical.shared.HasSelectionHandlers<org.uberfire.workbench.model.PartDefinition> widget)
com.google.gwt.user.client.ui.Widget	getPartDropRegion() This implementation returns null, meaning this panel does not support parts being dropped on it.
P	getPresenter() Returns this view's presenter.
void	maximize() Maximizes this view using WorkbenchLayout.maximize(Widget).
boolean	removePanel(WorkbenchPanelView<?> child) Throws UnsupportedOperationException when called.
void	setElementId(String elementId) Sets the ID of the physical root element of this view.
String	toString()
void	unmaximize() Restores this view to its original unmaximized size and position using WorkbenchLayout.unmaximize(Widget).

Methods inherited from class com.google.gwt.user.client.ui.ResizeComposite

initWidget, onResize

Methods inherited from class com.google.gwt.user.client.ui.Composite

claimElement, getWidget, initializeClaimedElement, isAttached, onAttach, onBrowserEvent, onDetach, render, render, resolvePotentialElement, setWidget

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isOrWasAttached, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.uberfire.client.workbench.panels.WorkbenchPanelView

addPart, changeTitle, getParts, removePart, selectPart, setFocus

Methods inherited from interface org.uberfire.client.mvp.UberView

init

Methods inherited from interface com.google.gwt.user.client.ui.IsWidget

asWidget

Methods inherited from interface com.google.gwt.user.client.ui.RequiresResize

onResize

Field Detail

panelManager

@Inject
protected PanelManager panelManager

layoutSelection

@Inject
protected LayoutSelection layoutSelection

presenter

protected P extends WorkbenchPanelPresenter presenter

Constructor Detail

AbstractWorkbenchPanelView

public AbstractWorkbenchPanelView()

Method Detail

addPanel

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

Throws UnsupportedOperationException when called. Subclasses that wish to support child panels should override this and removePanel(WorkbenchPanelView).

Specified by:

addPanel in interface WorkbenchPanelView<P extends WorkbenchPanelPresenter>

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)

Throws UnsupportedOperationException when called. Subclasses that wish to support child panels should override this and addPanel(PanelDefinition, WorkbenchPanelView, Position).

Specified by:

removePanel in interface WorkbenchPanelView<P extends WorkbenchPanelPresenter>

getPresenter

public P getPresenter()

Description copied from interface: WorkbenchPanelView

Returns this view's presenter.

Specified by:

getPresenter in interface WorkbenchPanelView<P extends WorkbenchPanelPresenter>

Returns:

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

addOnFocusHandler

protected void addOnFocusHandler(MultiPartWidget widget)

addSelectionHandler

protected void addSelectionHandler(com.google.gwt.event.logical.shared.HasSelectionHandlers<org.uberfire.workbench.model.PartDefinition> widget)

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<P extends WorkbenchPanelPresenter>

Parameters:

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

toString

public String toString()

Overrides:

toString in class com.google.gwt.user.client.ui.UIObject

getPartDropRegion

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

This implementation returns null, meaning this panel does not support parts being dropped on it. Subclasses that want to support Drag-and-Drop can override.

Specified by:

getPartDropRegion in interface WorkbenchPanelView<P extends WorkbenchPanelPresenter>

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.

maximize

public void maximize()

Description copied from interface: WorkbenchPanelView

Maximizes this view using WorkbenchLayout.maximize(Widget).

Specified by:

maximize in interface WorkbenchPanelView<P extends WorkbenchPanelPresenter>

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<P extends WorkbenchPanelPresenter>