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,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 -
Method Summary
Modifier and TypeMethodDescriptionvoidaddCockpitEventAcceptor(CockpitEventAcceptor acceptor) voidfocusWidget(String widgetCode) Gives focus to the widget with the specified code.Returns the code of the currently focused widget.Returns this browser's view template URI.getWidgetConfig(String widgetCode) Returns the widget configuration mapped to the keywidgetCode.Returns the widget factory used for creating widgets.Get widget configuration mappings.voidvoidsetViewTemplateURI(String viewUri) Sets this browser's view template URI to viewUri.voidsetWidgetFactory(WidgetFactory widgetFactory) Sets the widget factory to be used when creating widgets.voidsetWidgetMap(Map<String, WidgetConfig> widgetMap) Sets the widget configuration map towidgetMap.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, updateItemsMethods 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, setTotalCountMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods 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, updateItemsMethods inherited from interface de.hybris.platform.cockpit.session.CockpitListComponent
getItemsMethods inherited from interface de.hybris.platform.cockpit.session.ConfigurableBrowserModel
getBrowserCode, getViewClass, isInitiallyOpen, setBrowserCode, setInitiallyOpen, setViewClass
-
Constructor Details
-
DefaultWidgetBrowserModel
public DefaultWidgetBrowserModel()
-
-
Method Details
-
getFocusedWidgetCode
Description copied from interface:WidgetBrowserModelReturns the code of the currently focused widget.- Specified by:
getFocusedWidgetCodein interfaceWidgetBrowserModel- Returns:
- focused widget's widget code or
nullif no focused widget is available.
-
focusWidget
Description copied from interface:WidgetBrowserModelGives focus to the widget with the specified code.- Specified by:
focusWidgetin interfaceWidgetBrowserModel- Parameters:
widgetCode- widget configuration code
-
getWidgetConfig
Description copied from interface:WidgetBrowserModelReturns the widget configuration mapped to the keywidgetCode.- Specified by:
getWidgetConfigin interfaceWidgetBrowserModel- Parameters:
widgetCode- widget configuration code- Returns:
- if a widget configuration is available with the specified code it is returned, otherwise
null
-
getWidgetMap
Description copied from interface:WidgetBrowserModelGet widget configuration mappings.- Specified by:
getWidgetMapin interfaceWidgetBrowserModel- Returns:
- map containing all the widget configuration mappings
-
setWidgetMap
Description copied from interface:WidgetBrowserModelSets the widget configuration map towidgetMap.- Specified by:
setWidgetMapin interfaceWidgetBrowserModel- Parameters:
widgetMap- the new widget configuration mapping
-
addCockpitEventAcceptor
- Specified by:
addCockpitEventAcceptorin interfaceCockpitEventProducer
-
removeCockpitEventAcceptor
- Specified by:
removeCockpitEventAcceptorin interfaceCockpitEventProducer
-
setWidgetFactory
Description copied from interface:WidgetBrowserModelSets the widget factory to be used when creating widgets.- Specified by:
setWidgetFactoryin interfaceWidgetBrowserModel- Parameters:
widgetFactory- the widget factory
-
getWidgetFactory
Returns the widget factory used for creating widgets. Note: If no widget factory has been explicitly set by a call tosetWidgetFactory(WidgetFactory)an instance ofDefaultWidgetFactorywill be created automatically.- Specified by:
getWidgetFactoryin interfaceWidgetBrowserModel- Returns:
- the widget factory
-
setViewTemplateURI
Description copied from interface:WidgetBrowserModelSets this browser's view template URI to viewUri.- Specified by:
setViewTemplateURIin interfaceWidgetBrowserModel- Parameters:
viewUri- view template URI
-
getViewTemplateURI
Description copied from interface:WidgetBrowserModelReturns this browser's view template URI.- Specified by:
getViewTemplateURIin interfaceWidgetBrowserModel- Returns:
- view template URI or null if no template has been specified
-