de.hybris.platform.cockpit.widgets.browsers

Interface WidgetBrowserModel

All Superinterfaces:

BrowserModel, java.lang.Cloneable, CockpitEventProducer, CockpitListComponent<TypedObject>, ConfigurableBrowserModel

All Known Implementing Classes:

DefaultWidgetBrowserModel, WidgetDashboardBrowserModel

public interface WidgetBrowserModel
extends ConfigurableBrowserModel, CockpitEventProducer

Browser model which supports the use of Cockpit widgets.

See Also:

WidgetConfig, ConfigurableBrowserModel

Method Summary

Modifier and Type	Method and Description
void	focusWidget(java.lang.String widgetCode) Gives focus to the widget with the specified code.
java.lang.String	getFocusedWidgetCode() Returns the code of the currently focused widget.
java.lang.String	getViewTemplateURI() Returns this browser's view template URI.
WidgetConfig	getWidgetConfig(java.lang.String widgetCode) Returns the widget configuration mapped to the key widgetCode.
WidgetFactory	getWidgetFactory() Returns the widget factory used for creating widgets.
java.util.Map<java.lang.String,WidgetConfig>	getWidgetMap() Get widget configuration mappings.
void	setViewTemplateURI(java.lang.String viewUri) Sets this browser's view template URI to viewUri.
void	setWidgetFactory(WidgetFactory widgetFactory) Sets the widget factory to be used when creating widgets.
void	setWidgetMap(java.util.Map<java.lang.String,WidgetConfig> widgetMap) Sets the widget configuration map to widgetMap.

Methods inherited from interface de.hybris.platform.cockpit.session.ConfigurableBrowserModel

getBrowserCode, getViewClass, isInitiallyOpen, setBrowserCode, setInitiallyOpen, setViewClass

Methods inherited from interface de.hybris.platform.cockpit.session.BrowserModel

addBrowserModelListener, clone, collapse, createViewComponent, focus, getArea, getAvailableBrowserFilters, getBrowserFilter, getExtendedLabel, getItem, getLabel, getRootType, getSelectedIndexes, getSelectedItems, getTotalCount, hasStatusBar, isAdvancedHeaderDropdownSticky, isAdvancedHeaderDropdownVisible, isAllMarked, isCollapsed, isDuplicatable, isFocused, multiEdit, multiEdit, removeBrowserModelListener, setAllMarked, setArea, setBrowserFilter, setExtendedLabel, setLabel, setRootType, setSelectedIndexes, setTotalCount, updateItems

Methods inherited from interface de.hybris.platform.cockpit.session.CockpitListComponent

getItems

Methods inherited from interface de.hybris.platform.cockpit.events.CockpitEventProducer

addCockpitEventAcceptor, removeCockpitEventAcceptor

Method Detail

getWidgetConfig

WidgetConfig getWidgetConfig(java.lang.String widgetCode)

Returns the widget configuration mapped to the key widgetCode.

Parameters:

widgetCode - widget configuration code

Returns:

if a widget configuration is available with the specified code it is returned, otherwise null

getWidgetMap

java.util.Map<java.lang.String,WidgetConfig> getWidgetMap()

Get widget configuration mappings.

Returns:

map containing all the widget configuration mappings

setWidgetMap

void setWidgetMap(java.util.Map<java.lang.String,WidgetConfig> widgetMap)

Sets the widget configuration map to widgetMap.

Parameters:

widgetMap - the new widget configuration mapping

focusWidget

void focusWidget(java.lang.String widgetCode)

Gives focus to the widget with the specified code.

Parameters:

widgetCode - widget configuration code

getFocusedWidgetCode

java.lang.String getFocusedWidgetCode()

Returns the code of the currently focused widget.

Returns:

focused widget's widget code or null if no focused widget is available.

setWidgetFactory

void setWidgetFactory(WidgetFactory widgetFactory)

Sets the widget factory to be used when creating widgets.

Parameters:

widgetFactory - the widget factory

getWidgetFactory

WidgetFactory getWidgetFactory()

Returns the widget factory used for creating widgets.

Returns:

the widget factory

getViewTemplateURI

java.lang.String getViewTemplateURI()

Returns this browser's view template URI.

Returns:

view template URI or null if no template has been specified

setViewTemplateURI

void setViewTemplateURI(java.lang.String viewUri)

Sets this browser's view template URI to viewUri.

Parameters:

viewUri - view template URI