info.magnolia.ui.workbench

Interface ContentPresenter

All Known Implementing Classes:

AbstractContentPresenter, AbstractContentPresenterBase, JcrBrowserTreePresenter, ListPresenter, SearchPresenter, ThumbnailPresenter, TreePresenter

public interface ContentPresenter

The ContentPresenter is the presenter class for a ContentView, it represents a view type in the workbench. Magnolia provides default implementations of this interface for displaying data as a tree, list or thumbnails.

Implementations of this interface are responsible for configuring and populating content views according to a workbench definition (defines e.g. workspace, node-types).

Content presenters are configured using the implentationClass property of a ContentPresenterDefinition, and by registering such definition in the workbench's contentViews node in configuration.

Method Summary

Modifier and Type	Method and Description
void	expand(Object itemId) Make sure the given items are visible in the content view.
List<Object>	getSelectedItemIds()
void	refresh() Refreshes the data container and view.
void	select(List<Object> itemIds) Selects the given items in the content view.
void	setSelectedItemIds(List<Object> itemId) Sets the selected item ids for this presenter to react on, e.g.
ContentView	start(WorkbenchDefinition workbenchDefinition, info.magnolia.event.EventBus eventBus, String viewTypeName, ContentConnector contentConnector) Initializes the presenter with the workbench definition, eventBus and viewType name.

Method Detail

start

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

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

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

contentConnector -

Returns:

the content view

refresh

void refresh()

Refreshes the data container and view.

getSelectedItemIds

List<Object> getSelectedItemIds()

Returns:

the selected item ids in the content view.

setSelectedItemIds

void setSelectedItemIds(List<Object> itemId)

Sets the selected item ids for this presenter to react on, e.g. with keyboard shortcuts.

select

void select(List<Object> itemIds)

Selects the given items in the content view.

expand

void expand(Object itemId)

Make sure the given items are visible in the content view.

Parameters:

itemId -