de.hybris.platform.cockpit.session.impl

Class CollectionBrowserModel

java.lang.Object

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

de.hybris.platform.cockpit.session.impl.AbstractAdvancedBrowserModel

de.hybris.platform.cockpit.session.impl.AbstractPageableBrowserModel

de.hybris.platform.cockpit.session.impl.CollectionBrowserModel

All Implemented Interfaces:

AdvancedBrowserModel, BrowserModel, CockpitListComponent<TypedObject>, CockpitListComponentExt<TypedObject>, PageableBrowserModel, Cloneable

Direct Known Subclasses:

DynamicQueryBrowserModel, PrintCockpitCollectionBrowserModel

public class CollectionBrowserModel
extends AbstractPageableBrowserModel

Field Summary

Fields

Modifier and Type	Field and Description
protected List<TypedObject>	items
protected List<MainAreaComponentFactory>	viewModes

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

contextItems, LIST_VIEW_CONFIG_CODE, viewMode

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

browserListeners, cacheView, rootType, VIEWMODE_GRID, VIEWMODE_LIST

Constructor Summary

Constructors

Constructor and Description
CollectionBrowserModel()

Method Summary

Modifier and Type	Method and Description
void	blacklistItems(Collection<Integer> indexes)
Object	clone()
AbstractContentBrowser	createViewComponent()
List<MainAreaComponentFactory>	getAvailableViewModes()
ObjectCollection	getCollection() Returns the items held by this browser.
TypedObject	getItem(int index)
List<TypedObject>	getItems()
String	getLabel()
ObjectCollectionService	getObjectCollectionService()
ObjectTemplate	getRootType() Returns the root type of this browser.
List<TypedObject>	getSelectedItems()
void	removeItems(Collection<Integer> indexes)
void	setCollection(ObjectCollection collection) Sets the collection held by this CollectionBrowserModel to collection.
void	setObjectCollectionService(ObjectCollectionService service)
void	updateItems()
void	updateItems(int activePage)

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

addBrowserModelListener, addPageSize, firePagingChanged, getContextItemsPaged, getContextItemsPageIndex, getContextItemsPageSize, getCurrentPage, getLastPage, getMaxPageSize, getOffset, getPageSize, getPageSizes, hasStatusBar, isSimplePaging, setContextItemsDirectly, setContextItemsPageIndex, setContextItemsPageSize, setCurrentPage, setMaxPageSize, setOffset, setPageSize, setPageSizes, setSimplePaging

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

collapse, doDrop, fireContextItemsChanged, fireContextRootTypeChanged, fireContextSelectionChanged, fireContextViewModeChanged, fireContextVisibilityChanged, fireItemActivated, fireItemsDropped, fireViewModeChanged, getActiveItem, getCompareModel, getContextInitialValueMapping, getContextItems, getContextRootItem, getContextRootType, getContextRootTypePropertyDescriptor, getContextTableModel, getContextViewMode, getLastType, getListViewConfiguration, getSelectedContextIndexes, getTableModel, getViewMode, isCollapsed, isContextItemsMovable, isContextItemsRemovable, isContextPropertyWritable, isContextVisible, isItemsMovable, isItemsRemovable, isPossibleAddContextSubTypes, setActiveItem, setCompareModel, setContextInitialValueMapping, setContextItems, setContextItems, setContextItemsMovable, setContextItemsRemovable, setContextRootType, setContextRootTypePropertyDescriptor, setContextTableModel, setContextViewMode, setContextVisible, setContextVisibleDirect, setItemsMovable, setItemsRemovable, setSelectedContextIndexes, setTableModel, setViewMode

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

clearSelection, fireChanged, fireItemsChanged, fireRootTypeChanged, fireSelectionChanged, focus, getArea, getAvailableBrowserFilters, getBrowserFilter, getBrowserFilterFixed, getCacheView, getExtendedLabel, getSelectedIndexes, getTotalCount, 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.AdvancedBrowserModel

doDrop, getActiveItem, getContextInitialValueMapping, getContextItems, getContextRootItem, getContextRootType, getContextRootTypePropertyDescriptor, getContextTableModel, getContextViewMode, getLastType, getSelectedContextIndexes, getTableModel, getViewMode, isContextItemsMovable, isContextItemsRemovable, isContextVisible, isItemsMovable, isItemsRemovable, setActiveItem, setContextInitialValueMapping, setContextItems, setContextItems, setContextItemsMovable, setContextItemsRemovable, setContextRootType, setContextRootTypePropertyDescriptor, setContextTableModel, setContextViewMode, setContextVisible, setContextVisibleDirect, setItemsMovable, setItemsRemovable, setSelectedContextIndexes, setTableModel, setViewMode

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

collapse, focus, getArea, getAvailableBrowserFilters, getBrowserFilter, getExtendedLabel, getSelectedIndexes, getTotalCount, isAdvancedHeaderDropdownSticky, isAdvancedHeaderDropdownVisible, isAllMarked, isCollapsed, isDuplicatable, isFocused, multiEdit, multiEdit, removeBrowserModelListener, setAllMarked, setArea, setBrowserFilter, setExtendedLabel, setLabel, setRootType, setSelectedIndexes, setTotalCount

Field Detail

items

protected transient List<TypedObject> items

viewModes

protected List<MainAreaComponentFactory> viewModes

Constructor Detail

CollectionBrowserModel

public CollectionBrowserModel()

Method Detail

getRootType

public ObjectTemplate getRootType()

Description copied from class: AbstractBrowserModel

Returns the root type of this browser.

If no root type has been set the template corresponding to the type of the first item (returned by getItem(0)) is used. As last fallback the object template for the type "Item" is returned.

Specified by:

getRootType in interface BrowserModel

Overrides:

getRootType in class AbstractBrowserModel

Returns:

the root type of this browser

getLabel

public String getLabel()

Specified by:

getLabel in interface BrowserModel

Overrides:

getLabel in class AbstractBrowserModel

clone

public Object clone()
             throws CloneNotSupportedException

Specified by:

clone in interface BrowserModel

Specified by:

clone in class AbstractBrowserModel

Throws:

CloneNotSupportedException

createViewComponent

public AbstractContentBrowser createViewComponent()

getItems

public List<TypedObject> getItems()

Specified by:

getItems in interface CockpitListComponent<TypedObject>

Specified by:

getItems in class AbstractBrowserModel

updateItems

public void updateItems()

Specified by:

updateItems in interface BrowserModel

Overrides:

updateItems in class AbstractPageableBrowserModel

updateItems

public void updateItems(int activePage)

Specified by:

updateItems in interface PageableBrowserModel

Specified by:

updateItems in class AbstractPageableBrowserModel

setCollection

public void setCollection(ObjectCollection collection)

Sets the collection held by this CollectionBrowserModel to collection.

Note: This method does not fire any events and you might want to call updateItems() explicitly.

Parameters:

collection - the collection

getCollection

public ObjectCollection getCollection()

Returns the items held by this browser.

Returns:

unmodifiable collection containing all of the items held by this browser

setObjectCollectionService

public void setObjectCollectionService(ObjectCollectionService service)

getObjectCollectionService

public ObjectCollectionService getObjectCollectionService()

getItem

public TypedObject getItem(int index)

Specified by:

getItem in interface BrowserModel

Specified by:

getItem in class AbstractBrowserModel

blacklistItems

public void blacklistItems(Collection<Integer> indexes)

removeItems

public void removeItems(Collection<Integer> indexes)

getSelectedItems

public List<TypedObject> getSelectedItems()

Specified by:

getSelectedItems in interface BrowserModel

Overrides:

getSelectedItems in class AbstractBrowserModel

getAvailableViewModes

public List<MainAreaComponentFactory> getAvailableViewModes()

Specified by:

getAvailableViewModes in interface AdvancedBrowserModel

Overrides:

getAvailableViewModes in class AbstractAdvancedBrowserModel