Class AbstractBrowserModel
- java.lang.Object
-
- de.hybris.platform.cockpit.session.impl.AbstractBrowserModel
-
- All Implemented Interfaces:
BrowserModel
,CockpitListComponent<TypedObject>
,java.lang.Cloneable
- Direct Known Subclasses:
AbstractAdvancedBrowserModel
,DefaultConfigurableBrowserModel
public abstract class AbstractBrowserModel extends java.lang.Object implements BrowserModel
-
-
Field Summary
Fields Modifier and Type Field Description protected java.util.List<BrowserModelListener>
browserListeners
protected MutableColumnModel
cacheView
protected ObjectTemplate
rootType
static java.lang.String
VIEWMODE_GRID
static java.lang.String
VIEWMODE_LIST
-
Constructor Summary
Constructors Constructor Description AbstractBrowserModel()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description void
addBrowserModelListener(BrowserModelListener listener)
void
clearSelection()
abstract java.lang.Object
clone()
abstract void
collapse()
protected void
fireChanged()
protected void
fireItemsChanged()
protected void
fireRootTypeChanged()
protected void
fireSelectionChanged()
void
focus()
UIBrowserArea
getArea()
java.util.Set<BrowserFilter>
getAvailableBrowserFilters()
BrowserFilter
getBrowserFilter()
BrowserFilter
getBrowserFilterFixed()
MutableColumnModel
getCacheView()
java.lang.String
getExtendedLabel()
abstract TypedObject
getItem(int index)
abstract java.util.List<TypedObject>
getItems()
java.lang.String
getLabel()
ObjectTemplate
getRootType()
Returns the root type of this browser.java.util.List<java.lang.Integer>
getSelectedIndexes()
java.util.List<TypedObject>
getSelectedItems()
int
getTotalCount()
boolean
hasStatusBar()
boolean
isAdvancedHeaderDropdownSticky()
boolean
isAdvancedHeaderDropdownVisible()
boolean
isAllMarked()
abstract boolean
isCollapsed()
boolean
isDuplicatable()
boolean
isFocused()
void
multiEdit(PropertyDescriptor propertyDesc, java.lang.String languageIso, java.util.List<TypedObject> objects, java.lang.Object value)
void
multiEdit(PropertyDescriptor propertyDesc, java.util.List<TypedObject> objects, java.lang.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(java.lang.String label)
void
setLabel(java.lang.String label)
void
setRootType(ObjectTemplate rootType)
void
setSelectedIndexes(java.util.List<java.lang.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 java.util.List<BrowserModelListener> browserListeners
-
cacheView
protected MutableColumnModel cacheView
-
VIEWMODE_LIST
public static final java.lang.String VIEWMODE_LIST
- See Also:
- Constant Field Values
-
VIEWMODE_GRID
public static final java.lang.String VIEWMODE_GRID
- See Also:
- Constant Field Values
-
-
Method Detail
-
isAdvancedHeaderDropdownSticky
public boolean isAdvancedHeaderDropdownSticky()
- Specified by:
isAdvancedHeaderDropdownSticky
in interfaceBrowserModel
-
isAdvancedHeaderDropdownVisible
public boolean isAdvancedHeaderDropdownVisible()
- Specified by:
isAdvancedHeaderDropdownVisible
in interfaceBrowserModel
-
isDuplicatable
public boolean isDuplicatable()
- Specified by:
isDuplicatable
in interfaceBrowserModel
-
focus
public void focus()
- Specified by:
focus
in interfaceBrowserModel
-
isFocused
public boolean isFocused()
- Specified by:
isFocused
in interfaceBrowserModel
-
setArea
public void setArea(UIBrowserArea area)
- Specified by:
setArea
in interfaceBrowserModel
-
getArea
public UIBrowserArea getArea()
- Specified by:
getArea
in interfaceBrowserModel
-
setExtendedLabel
public void setExtendedLabel(java.lang.String label)
- Specified by:
setExtendedLabel
in interfaceBrowserModel
-
getExtendedLabel
public java.lang.String getExtendedLabel()
- Specified by:
getExtendedLabel
in interfaceBrowserModel
-
setLabel
public void setLabel(java.lang.String label)
- Specified by:
setLabel
in interfaceBrowserModel
-
getLabel
public java.lang.String getLabel()
- Specified by:
getLabel
in interfaceBrowserModel
-
setRootType
public void setRootType(ObjectTemplate rootType)
- Specified by:
setRootType
in interfaceBrowserModel
-
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 bygetItem(0)
) is used. As last fallback the object template for the type "Item
" is returned.- Specified by:
getRootType
in interfaceBrowserModel
- Returns:
- the root type of this browser
-
getSelectedIndexes
public java.util.List<java.lang.Integer> getSelectedIndexes()
- Specified by:
getSelectedIndexes
in interfaceBrowserModel
-
setSelectedIndexes
public void setSelectedIndexes(java.util.List<java.lang.Integer> selectedIndexes)
- Specified by:
setSelectedIndexes
in interfaceBrowserModel
-
addBrowserModelListener
public void addBrowserModelListener(BrowserModelListener listener)
- Specified by:
addBrowserModelListener
in interfaceBrowserModel
-
removeBrowserModelListener
public void removeBrowserModelListener(BrowserModelListener listener)
- Specified by:
removeBrowserModelListener
in interfaceBrowserModel
-
getBrowserFilterFixed
public BrowserFilter getBrowserFilterFixed()
-
clearSelection
public void clearSelection()
-
collapse
public abstract void collapse()
- Specified by:
collapse
in interfaceBrowserModel
-
isCollapsed
public abstract boolean isCollapsed()
- Specified by:
isCollapsed
in interfaceBrowserModel
-
updateItems
public abstract void updateItems()
- Specified by:
updateItems
in interfaceBrowserModel
-
getItem
public abstract TypedObject getItem(int index)
- Specified by:
getItem
in interfaceBrowserModel
-
getItems
public abstract java.util.List<TypedObject> getItems()
- Specified by:
getItems
in interfaceCockpitListComponent<TypedObject>
-
getSelectedItems
public java.util.List<TypedObject> getSelectedItems()
- Specified by:
getSelectedItems
in interfaceBrowserModel
-
setTotalCount
public void setTotalCount(int totalCount)
- Specified by:
setTotalCount
in interfaceBrowserModel
-
getTotalCount
public int getTotalCount()
- Specified by:
getTotalCount
in interfaceBrowserModel
-
isAllMarked
public boolean isAllMarked()
- Specified by:
isAllMarked
in interfaceBrowserModel
- Returns:
- if all items are marked as selected
-
setAllMarked
public void setAllMarked(boolean allMarked) throws CockpitMarkAllException
- Specified by:
setAllMarked
in interfaceBrowserModel
- Throws:
CockpitMarkAllException
-
multiEdit
public void multiEdit(PropertyDescriptor propertyDesc, java.util.List<TypedObject> objects, java.lang.Object value)
- Specified by:
multiEdit
in interfaceBrowserModel
-
multiEdit
public void multiEdit(PropertyDescriptor propertyDesc, java.lang.String languageIso, java.util.List<TypedObject> objects, java.lang.Object value)
- Specified by:
multiEdit
in interfaceBrowserModel
-
clone
public abstract java.lang.Object clone() throws java.lang.CloneNotSupportedException
- Specified by:
clone
in interfaceBrowserModel
- Overrides:
clone
in classjava.lang.Object
- Throws:
java.lang.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 interfaceBrowserModel
-
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 interfaceBrowserModel
-
getBrowserFilter
public BrowserFilter getBrowserFilter()
- Specified by:
getBrowserFilter
in interfaceBrowserModel
-
getAvailableBrowserFilters
public java.util.Set<BrowserFilter> getAvailableBrowserFilters()
- Specified by:
getAvailableBrowserFilters
in interfaceBrowserModel
-
setBrowserFilterFixed
public void setBrowserFilterFixed(BrowserFilter browserFilterFixed)
-
-