de.hybris.platform.cockpit.session.impl

Class DefaultConfigurableBrowserModel

java.lang.Object

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

DefaultWidgetBrowserModel

public class DefaultConfigurableBrowserModel
extends AbstractBrowserModel
implements ConfigurableBrowserModel

Minimalistic browser model which supports view component creation to be (Spring) configured, thus reducing the need to create customized browser models for simple rendering purposes.

This class contains no logic other than that for creating configured view components i.e. no it holds no items etc which is usually the case for browser models.

Note: This class should typically be declared as a Spring bean with prototype scope.

Field Summary

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

browserListeners, cacheView, rootType, VIEWMODE_GRID, VIEWMODE_LIST

Constructor Summary

Constructors

Constructor and Description
DefaultConfigurableBrowserModel()

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone()
void	collapse()
AbstractContentBrowser	createViewComponent()
java.lang.String	getBrowserCode() Returns this browser's code.
java.lang.String	getExtendedLabel()
TypedObject	getItem(int index)
java.util.List<TypedObject>	getItems()
java.lang.String	getLabel()
java.lang.Class<? extends AbstractContentBrowser>	getViewClass() Returns the view component (content browser) class to be used for this browser.
boolean	isCollapsed()
boolean	isInitiallyOpen() Returns whether this browser is initially open or not.
void	setBrowserCode(java.lang.String browserCode) Sets the code of this browser to browserCode.
void	setInitiallyOpen(boolean open) Sets whether this browser is initially open or not.
void	setViewClass(java.lang.Class<? extends AbstractContentBrowser> viewClass) Sets the view component (content browser) class to be used for this browser.
void	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, focus, getArea, getAvailableBrowserFilters, getBrowserFilter, getRootType, getSelectedIndexes, getSelectedItems, getTotalCount, hasStatusBar, isAdvancedHeaderDropdownSticky, isAdvancedHeaderDropdownVisible, isAllMarked, isDuplicatable, isFocused, multiEdit, multiEdit, removeBrowserModelListener, setAllMarked, setArea, setBrowserFilter, setExtendedLabel, setLabel, setRootType, setSelectedIndexes, setTotalCount

Constructor Detail

DefaultConfigurableBrowserModel

public DefaultConfigurableBrowserModel()

Method Detail

setViewClass

public void setViewClass(java.lang.Class<? extends AbstractContentBrowser> viewClass)

Description copied from interface: ConfigurableBrowserModel

Sets the view component (content browser) class to be used for this browser.

Specified by:

setViewClass in interface ConfigurableBrowserModel

Parameters:

viewClass - view component class

getViewClass

public java.lang.Class<? extends AbstractContentBrowser> getViewClass()

Description copied from interface: ConfigurableBrowserModel

Returns the view component (content browser) class to be used for this browser.

Specified by:

getViewClass in interface ConfigurableBrowserModel

Returns:

view component class

createViewComponent

public AbstractContentBrowser createViewComponent()

Specified by:

createViewComponent in interface BrowserModel

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Specified by:

clone in interface BrowserModel

Specified by:

clone in class AbstractBrowserModel

Throws:

java.lang.CloneNotSupportedException

collapse

public void collapse()

Specified by:

collapse in interface BrowserModel

Specified by:

collapse in class AbstractBrowserModel

getItem

public TypedObject getItem(int index)

Specified by:

getItem in interface BrowserModel

Specified by:

getItem in class AbstractBrowserModel

getItems

public java.util.List<TypedObject> getItems()

Specified by:

getItems in interface CockpitListComponent<TypedObject>

Specified by:

getItems in class AbstractBrowserModel

isCollapsed

public boolean isCollapsed()

Specified by:

isCollapsed in interface BrowserModel

Specified by:

isCollapsed in class AbstractBrowserModel

updateItems

public void updateItems()

Specified by:

updateItems in interface BrowserModel

Specified by:

updateItems in class AbstractBrowserModel

setInitiallyOpen

public void setInitiallyOpen(boolean open)

Description copied from interface: ConfigurableBrowserModel

Sets whether this browser is initially open or not.

Specified by:

setInitiallyOpen in interface ConfigurableBrowserModel

Parameters:

open - initial browser state

isInitiallyOpen

public boolean isInitiallyOpen()

Description copied from interface: ConfigurableBrowserModel

Returns whether this browser is initially open or not.

Specified by:

isInitiallyOpen in interface ConfigurableBrowserModel

Returns:

true if initially open, false otherwise

setBrowserCode

public void setBrowserCode(java.lang.String browserCode)

Description copied from interface: ConfigurableBrowserModel

Sets the code of this browser to browserCode.

Specified by:

setBrowserCode in interface ConfigurableBrowserModel

Parameters:

browserCode - browser code

getBrowserCode

public java.lang.String getBrowserCode()

Description copied from interface: ConfigurableBrowserModel

Returns this browser's code.

Specified by:

getBrowserCode in interface ConfigurableBrowserModel

Returns:

browser code

getLabel

public java.lang.String getLabel()

Specified by:

getLabel in interface BrowserModel

Overrides:

getLabel in class AbstractBrowserModel

getExtendedLabel

public java.lang.String getExtendedLabel()

Specified by:

getExtendedLabel in interface BrowserModel

Overrides:

getExtendedLabel in class AbstractBrowserModel