Package de.hybris.platform.cockpit.widgets.browsers

Class DefaultWidgetBrowserModel

java.lang.Object

de.hybris.platform.cockpit.session.impl.AbstractBrowserModel

de.hybris.platform.cockpit.session.impl.DefaultConfigurableBrowserModel

de.hybris.platform.cockpit.widgets.browsers.DefaultWidgetBrowserModel

All Implemented Interfaces:

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

Direct Known Subclasses:

WidgetDashboardBrowserModel

public class DefaultWidgetBrowserModel
extends DefaultConfigurableBrowserModel
implements WidgetBrowserModel

Default widget browser model implementation.

Typically used together with a DefaultWidgetContentBrowser.

Field Summary

Fields inherited from class de.hybris.platform.cockpit.session.impl.AbstractBrowserModel

browserListeners, cacheView, rootType, VIEWMODE_GRID, VIEWMODE_LIST

Constructor Summary

Constructors

Constructor	Description
DefaultWidgetBrowserModel()

Method Summary

Modifier and Type	Method	Description
void	addCockpitEventAcceptor(CockpitEventAcceptor acceptor)
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	removeCockpitEventAcceptor(CockpitEventAcceptor acceptor)
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 class de.hybris.platform.cockpit.session.impl.DefaultConfigurableBrowserModel

clone, collapse, createViewComponent, getBrowserCode, getExtendedLabel, getItem, getItems, getLabel, getViewClass, isCollapsed, isInitiallyOpen, setBrowserCode, setInitiallyOpen, setViewClass, updateItems

Methods inherited from class de.hybris.platform.cockpit.session.impl.AbstractBrowserModel

addBrowserModelListener, clearSelection, fireChanged, fireItemsChanged, fireRootTypeChanged, fireSelectionChanged, focus, getArea, getAvailableBrowserFilters, getBrowserFilter, getBrowserFilterFixed, getCacheView, getRootType, getSelectedIndexes, getSelectedItems, getTotalCount, hasStatusBar, isAdvancedHeaderDropdownSticky, isAdvancedHeaderDropdownVisible, isAllMarked, isDuplicatable, isFocused, multiEdit, multiEdit, onClose, onHide, onShow, removeBrowserModelListener, setAllMarked, setArea, setBrowserFilter, setBrowserFilterFixed, setCacheView, setExtendedLabel, setLabel, setRootType, setSelectedIndexes, setTotalCount

Methods inherited from class java.lang.Object

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

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.session.ConfigurableBrowserModel

getBrowserCode, getViewClass, isInitiallyOpen, setBrowserCode, setInitiallyOpen, setViewClass

Constructor Detail

DefaultWidgetBrowserModel

public DefaultWidgetBrowserModel()

Method Detail

getFocusedWidgetCode

public java.lang.String getFocusedWidgetCode()

Description copied from interface: WidgetBrowserModel

Returns the code of the currently focused widget.

Specified by:

getFocusedWidgetCode in interface WidgetBrowserModel

Returns:

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

focusWidget

public void focusWidget(java.lang.String widgetCode)

Description copied from interface: WidgetBrowserModel

Gives focus to the widget with the specified code.

Specified by:

focusWidget in interface WidgetBrowserModel

Parameters:

widgetCode - widget configuration code

getWidgetConfig

public WidgetConfig getWidgetConfig(java.lang.String widgetCode)

Description copied from interface: WidgetBrowserModel

Returns the widget configuration mapped to the key widgetCode.

Specified by:

getWidgetConfig in interface WidgetBrowserModel

Parameters:

widgetCode - widget configuration code

Returns:

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

getWidgetMap

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

Description copied from interface: WidgetBrowserModel

Get widget configuration mappings.

Specified by:

getWidgetMap in interface WidgetBrowserModel

Returns:

map containing all the widget configuration mappings

setWidgetMap

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

Description copied from interface: WidgetBrowserModel

Sets the widget configuration map to widgetMap.

Specified by:

setWidgetMap in interface WidgetBrowserModel

Parameters:

widgetMap - the new widget configuration mapping

addCockpitEventAcceptor

public void addCockpitEventAcceptor(CockpitEventAcceptor acceptor)

Specified by:

addCockpitEventAcceptor in interface CockpitEventProducer

removeCockpitEventAcceptor

public void removeCockpitEventAcceptor(CockpitEventAcceptor acceptor)

Specified by:

removeCockpitEventAcceptor in interface CockpitEventProducer

setWidgetFactory

public void setWidgetFactory(WidgetFactory widgetFactory)

Description copied from interface: WidgetBrowserModel

Sets the widget factory to be used when creating widgets.

Specified by:

setWidgetFactory in interface WidgetBrowserModel

Parameters:

widgetFactory - the widget factory

getWidgetFactory

public WidgetFactory getWidgetFactory()

Returns the widget factory used for creating widgets.

Note: If no widget factory has been explicitly set by a call to setWidgetFactory(WidgetFactory) an instance of DefaultWidgetFactory will be created automatically.

Specified by:

getWidgetFactory in interface WidgetBrowserModel

Returns:

the widget factory

setViewTemplateURI

public void setViewTemplateURI(java.lang.String viewUri)

Description copied from interface: WidgetBrowserModel

Sets this browser's view template URI to viewUri.

Specified by:

setViewTemplateURI in interface WidgetBrowserModel

Parameters:

viewUri - view template URI

getViewTemplateURI

public java.lang.String getViewTemplateURI()

Description copied from interface: WidgetBrowserModel

Returns this browser's view template URI.

Specified by:

getViewTemplateURI in interface WidgetBrowserModel

Returns:

view template URI or null if no template has been specified