org.uberfire.client.workbench.widgets.listbar

Interface ListBarWidget

All Superinterfaces:

com.google.gwt.event.logical.shared.HasBeforeSelectionHandlers<org.uberfire.workbench.model.PartDefinition>, com.google.gwt.event.shared.HasHandlers, com.google.gwt.event.logical.shared.HasSelectionHandlers<org.uberfire.workbench.model.PartDefinition>, com.google.gwt.user.client.ui.IsWidget, MultiPartWidget, com.google.gwt.user.client.ui.RequiresResize

public interface ListBarWidget
extends MultiPartWidget

API contract for the header widget of panel views that extend AbstractSimpleWorkbenchPanelView and MultiListWorkbenchPanelView. Each application needs exactly one implementation of this class at compile time (usually this will come from the view module). The implementing type must be a Dependent-scoped CDI bean.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEBUG_TITLE_PREFIX When a part is added to the list bar, a special title widget is created for it.

Method Summary

Modifier and Type	Method and Description
void	disableClosePart() Disable support to close parts.
void	disableDnd() Disable this list bar's to support drag and drop.
void	enableClosePart() Enable support to close parts.
void	enableDnd() Enable this list bar's to support drag and drop.
MaximizeToggleButtonPresenter	getMaximizeButton() Returns the toggle button, which is initially hidden, that can be used to trigger maximizing and unmaximizing of the panel containing this list bar.
boolean	isDndEnabled()

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

addOnFocusHandler, addPart, changeTitle, clear, getParts, getPartsSize, remove, selectPart, setDndManager, setFocus, setPresenter

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

asWidget

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

onResize

Methods inherited from interface com.google.gwt.event.logical.shared.HasBeforeSelectionHandlers

addBeforeSelectionHandler

Methods inherited from interface com.google.gwt.event.logical.shared.HasSelectionHandlers

addSelectionHandler

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Field Detail

DEBUG_TITLE_PREFIX

static final String DEBUG_TITLE_PREFIX

When a part is added to the list bar, a special title widget is created for it. This title widget is draggable. To promote testability, implementations of this interface must set the draggable title widget's debug ID using the Widget.ensureDebugId() call. The debug ID must have the form DEBUG_ID_PREFIX + DEBUG_TITLE_PREFIX + partName.

Note that debug IDs are only assigned when the app inherits the GWT Debug module. See UIObject.ensureDebugId(com.google.gwt.dom.client.Element, String) for details.

See Also:

Constant Field Values

Method Detail

enableDnd

void enableDnd()

Enable this list bar's to support drag and drop.

disableDnd

void disableDnd()

Disable this list bar's to support drag and drop.

getMaximizeButton

MaximizeToggleButtonPresenter getMaximizeButton()

Returns the toggle button, which is initially hidden, that can be used to trigger maximizing and unmaximizing of the panel containing this list bar. Make the button visible by calling UIObject.setVisible(boolean) and set its maximize and unmaximize actions with MaximizeToggleButtonPresenter.setMaximizeCommand(Command) and MaximizeToggleButtonPresenter.setUnmaximizeCommand(Command).

isDndEnabled

boolean isDndEnabled()

enableClosePart

void enableClosePart()

Enable support to close parts.

disableClosePart

void disableClosePart()

Disable support to close parts.