info.magnolia.ui.workbench.list

Class ListPresenter

java.lang.Object

info.magnolia.ui.workbench.AbstractContentPresenterBase

info.magnolia.ui.workbench.AbstractContentPresenter

info.magnolia.ui.workbench.list.ListPresenter

All Implemented Interfaces:

ContentPresenter, ContentView.Listener

Direct Known Subclasses:

SearchPresenter, TreePresenter

public class ListPresenter
extends AbstractContentPresenter
implements ContentView.Listener

The ListPresenter is responsible for creating, configuring and updating a list of items according to the workbench definition.

Field Summary

Fields

Modifier and Type	Field and Description
protected ListView	view

Fields inherited from class info.magnolia.ui.workbench.AbstractContentPresenterBase

container, contentConnector, eventBus, ICON_PROPERTY, ICON_TRASH, viewTypeName, workbenchDefinition

Constructor Summary

Constructors

Constructor and Description
ListPresenter(ListView view, info.magnolia.objectfactory.ComponentProvider componentProvider)

Method Summary

Modifier and Type	Method and Description
protected void	configureContainer(ContentPresenterDefinition presenterDefinition, com.vaadin.v7.data.Container container)
protected com.vaadin.v7.data.Container	createContainer()
protected com.vaadin.v7.data.Container	initializeContainer()
void	refresh() Refreshes the data container and view.
void	select(List<Object> itemIds) Selects the given items in the content view.
ListView	start(WorkbenchDefinition workbenchDefinition, info.magnolia.event.EventBus eventBus, String viewTypeName, ContentConnector contentConnector) Initializes the presenter with the workbench definition, eventBus and viewType name.

Methods inherited from class info.magnolia.ui.workbench.AbstractContentPresenter

getIcon

Methods inherited from class info.magnolia.ui.workbench.AbstractContentPresenterBase

expand, getAvailableColumns, getColumnsIterator, getComponentProvider, getPresenterDefinition, getSelectedItemId, getSelectedItemIds, onDoubleClick, onItemSelection, onRightClick, onShortcutKey, setSelectedItemIds

Methods inherited from class java.lang.Object

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

Methods inherited from interface info.magnolia.ui.workbench.ContentView.Listener

getIcon, onDoubleClick, onItemSelection, onRightClick, onShortcutKey

Field Detail

view

protected final ListView view

Constructor Detail

ListPresenter

@Inject
public ListPresenter(ListView view,
                             info.magnolia.objectfactory.ComponentProvider componentProvider)

Method Detail

start

public ListView start(WorkbenchDefinition workbenchDefinition,
                      info.magnolia.event.EventBus eventBus,
                      String viewTypeName,
                      ContentConnector contentConnector)

Description copied from interface: ContentPresenter

Initializes the presenter with the workbench definition, eventBus and viewType name.

Specified by:

start in interface ContentPresenter

Overrides:

start in class AbstractContentPresenterBase

Parameters:

workbenchDefinition - the workbench definition that defines which data to present

eventBus - the event bus to fire e.g. selection events on

viewTypeName - the view type as defined in the presenter definition

Returns:

the content view

select

public void select(List<Object> itemIds)

Description copied from interface: ContentPresenter

Selects the given items in the content view.

Specified by:

select in interface ContentPresenter

Overrides:

select in class AbstractContentPresenterBase

refresh

public void refresh()

Description copied from interface: ContentPresenter

Refreshes the data container and view.

Specified by:

refresh in interface ContentPresenter

Overrides:

refresh in class AbstractContentPresenter

initializeContainer

protected com.vaadin.v7.data.Container initializeContainer()

Specified by:

initializeContainer in class AbstractContentPresenterBase

createContainer

protected com.vaadin.v7.data.Container createContainer()

configureContainer

protected void configureContainer(ContentPresenterDefinition presenterDefinition,
                                  com.vaadin.v7.data.Container container)