de.hybris.platform.cockpit.session.impl

Class AbstractBrowserModel

java.lang.Object

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

All Implemented Interfaces:

BrowserModel, CockpitListComponent<TypedObject>, Cloneable

Direct Known Subclasses:

AbstractAdvancedBrowserModel, DefaultConfigurableBrowserModel

public abstract class AbstractBrowserModel
extends Object
implements BrowserModel

Field Summary

Fields

Modifier and Type	Field and Description
protected List<BrowserModelListener>	browserListeners
protected MutableColumnModel	cacheView
protected ObjectTemplate	rootType
static String	VIEWMODE_GRID
static String	VIEWMODE_LIST

Constructor Summary

Constructors

Constructor and Description
AbstractBrowserModel()

Method Summary

Modifier and Type	Method and Description
void	addBrowserModelListener(BrowserModelListener listener)
void	clearSelection()
abstract Object	clone()
abstract void	collapse()
protected void	fireChanged()
protected void	fireItemsChanged()
protected void	fireRootTypeChanged()
protected void	fireSelectionChanged()
void	focus()
UIBrowserArea	getArea()
Set<BrowserFilter>	getAvailableBrowserFilters()
BrowserFilter	getBrowserFilter()
BrowserFilter	getBrowserFilterFixed()
MutableColumnModel	getCacheView()
String	getExtendedLabel()
abstract TypedObject	getItem(int index)
abstract List<TypedObject>	getItems()
String	getLabel()
ObjectTemplate	getRootType() Returns the root type of this browser.
List<Integer>	getSelectedIndexes()
List<TypedObject>	getSelectedItems()
int	getTotalCount()
boolean	hasStatusBar()
boolean	isAdvancedHeaderDropdownSticky()
boolean	isAdvancedHeaderDropdownVisible()
boolean	isAllMarked()
abstract boolean	isCollapsed()
boolean	isDuplicatable()
boolean	isFocused()
void	multiEdit(PropertyDescriptor propertyDesc, List<TypedObject> objects, Object value)
void	multiEdit(PropertyDescriptor propertyDesc, String languageIso, List<TypedObject> objects, Object value)
void	onClose() Called before this browser is closed.
void	onHide() Called whenever this browser is minimized.
void	onShow() Called whenever this browser is shown.
void	removeBrowserModelListener(BrowserModelListener listener)
void	setAllMarked(boolean allMarked)
void	setArea(UIBrowserArea area)
void	setBrowserFilter(BrowserFilter browserFilter)
void	setBrowserFilterFixed(BrowserFilter browserFilterFixed)
void	setCacheView(MutableColumnModel cacheView)
void	setExtendedLabel(String label)
void	setLabel(String label)
void	setRootType(ObjectTemplate rootType)
void	setSelectedIndexes(List<Integer> selectedIndexes)
void	setTotalCount(int totalCount)
abstract void	updateItems()

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

createViewComponent

Field Detail

rootType

protected ObjectTemplate rootType

browserListeners

protected final transient List<BrowserModelListener> browserListeners

cacheView

protected MutableColumnModel cacheView

VIEWMODE_LIST

public static final String VIEWMODE_LIST

See Also:

Constant Field Values

VIEWMODE_GRID

public static final String VIEWMODE_GRID

See Also:

Constant Field Values

Constructor Detail

AbstractBrowserModel

public AbstractBrowserModel()

Method Detail

isAdvancedHeaderDropdownSticky

public boolean isAdvancedHeaderDropdownSticky()

Specified by:

isAdvancedHeaderDropdownSticky in interface BrowserModel

isAdvancedHeaderDropdownVisible

public boolean isAdvancedHeaderDropdownVisible()

Specified by:

isAdvancedHeaderDropdownVisible in interface BrowserModel

isDuplicatable

public boolean isDuplicatable()

Specified by:

isDuplicatable in interface BrowserModel

focus

public void focus()

Specified by:

focus in interface BrowserModel

isFocused

public boolean isFocused()

Specified by:

isFocused in interface BrowserModel

setArea

public void setArea(UIBrowserArea area)

Specified by:

setArea in interface BrowserModel

getArea

public UIBrowserArea getArea()

Specified by:

getArea in interface BrowserModel

setExtendedLabel

public void setExtendedLabel(String label)

Specified by:

setExtendedLabel in interface BrowserModel

getExtendedLabel

public String getExtendedLabel()

Specified by:

getExtendedLabel in interface BrowserModel

setLabel

public void setLabel(String label)

Specified by:

setLabel in interface BrowserModel

getLabel

public String getLabel()

Specified by:

getLabel in interface BrowserModel

setRootType

public void setRootType(ObjectTemplate rootType)

Specified by:

setRootType in interface BrowserModel

getRootType

public ObjectTemplate getRootType()

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

Returns:

the root type of this browser

getSelectedIndexes

public List<Integer> getSelectedIndexes()

Specified by:

getSelectedIndexes in interface BrowserModel

setSelectedIndexes

public void setSelectedIndexes(List<Integer> selectedIndexes)

Specified by:

setSelectedIndexes in interface BrowserModel

addBrowserModelListener

public void addBrowserModelListener(BrowserModelListener listener)

Specified by:

addBrowserModelListener in interface BrowserModel

removeBrowserModelListener

public void removeBrowserModelListener(BrowserModelListener listener)

Specified by:

removeBrowserModelListener in interface BrowserModel

getBrowserFilterFixed

public BrowserFilter getBrowserFilterFixed()

clearSelection

public void clearSelection()

collapse

public abstract void collapse()

Specified by:

collapse in interface BrowserModel

isCollapsed

public abstract boolean isCollapsed()

Specified by:

isCollapsed in interface BrowserModel

updateItems

public abstract void updateItems()

Specified by:

updateItems in interface BrowserModel

getItem

public abstract TypedObject getItem(int index)

Specified by:

getItem in interface BrowserModel

getItems

public abstract List<TypedObject> getItems()

Specified by:

getItems in interface CockpitListComponent<TypedObject>

getSelectedItems

public List<TypedObject> getSelectedItems()

Specified by:

getSelectedItems in interface BrowserModel

setTotalCount

public void setTotalCount(int totalCount)

Specified by:

setTotalCount in interface BrowserModel

getTotalCount

public int getTotalCount()

Specified by:

getTotalCount in interface BrowserModel

isAllMarked

public boolean isAllMarked()

Specified by:

isAllMarked in interface BrowserModel

Returns:

if all items are marked as selected

setAllMarked

public void setAllMarked(boolean allMarked)
                  throws CockpitMarkAllException

Specified by:

setAllMarked in interface BrowserModel

Throws:

CockpitMarkAllException

multiEdit

public void multiEdit(PropertyDescriptor propertyDesc,
                      List<TypedObject> objects,
                      Object value)

Specified by:

multiEdit in interface BrowserModel

multiEdit

public void multiEdit(PropertyDescriptor propertyDesc,
                      String languageIso,
                      List<TypedObject> objects,
                      Object value)

Specified by:

multiEdit in interface BrowserModel

clone

public abstract Object clone()
                      throws CloneNotSupportedException

Specified by:

clone in interface BrowserModel

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

fireSelectionChanged

protected void fireSelectionChanged()

fireItemsChanged

protected void fireItemsChanged()

fireChanged

protected void fireChanged()

fireRootTypeChanged

protected void fireRootTypeChanged()

hasStatusBar

public boolean hasStatusBar()

Specified by:

hasStatusBar in interface BrowserModel

onShow

public void onShow()

Called whenever this browser is shown.

Note: This method will not be called in split mode.

onHide

public void onHide()

Called whenever this browser is minimized.

onClose

public void onClose()

Called before this browser is closed.

getCacheView

public MutableColumnModel getCacheView()

setCacheView

public void setCacheView(MutableColumnModel cacheView)

setBrowserFilter

public void setBrowserFilter(BrowserFilter browserFilter)

Specified by:

setBrowserFilter in interface BrowserModel

getBrowserFilter

public BrowserFilter getBrowserFilter()

Specified by:

getBrowserFilter in interface BrowserModel

getAvailableBrowserFilters

public Set<BrowserFilter> getAvailableBrowserFilters()

Specified by:

getAvailableBrowserFilters in interface BrowserModel

setBrowserFilterFixed

public void setBrowserFilterFixed(BrowserFilter browserFilterFixed)