GridView (hybris Commerce Suite 18.11)

java.lang.Object
- Div
- - de.hybris.platform.cockpit.model.general.impl.AbstractItemView
  - - de.hybris.platform.cockpit.model.gridview.impl.GridView

All Implemented Interfaces:: UIItemView, UIViewComponent, UIGridView

public class GridView
extends AbstractItemView
implements UIGridView

Nested Class Summary
- Nested classes/interfaces inherited from class de.hybris.platform.cockpit.model.general.impl.AbstractItemView
  AbstractItemView.LoadImage

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`DEFAULT_GRIDVIEW_CONF`
`protected Checkbox`	`focusComponent`
`protected boolean`	`initialized`
`static java.lang.String`	`ITEM_BOX_SIZE`
`protected Div`	`mainDiv`
`protected MutableListModel`	`model`

Fields inherited from class de.hybris.platform.cockpit.model.general.impl.AbstractItemView
loadingProgressContainer, ON_CONTINUE_LOADING

Constructor Summary

Constructors
Constructor and Description

GridView()

Constructors
Constructor and Description
`GridView()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addGridViewListener(GridViewListener listener)`
`protected void`	`appendScrollIntoViewComponent(HtmlBasedComponent cell)`
`protected void`	`continueRenderItems(Component parent, int index)`
`protected void`	`continueRenderItems(Component parent, int index, int numberOfItemsToRender)`
`protected HtmlBasedComponent`	`createItemBox(TypedObject item, GridViewConfiguration config)`
`protected void`	`doUserEvent(java.lang.Object[] data)`
`protected void`	`fireChangeSelection(int selectedIndex)`
`protected void`	`fireChangeSelection(java.util.List<java.lang.Integer> selectedIndexes)`
`protected void`	`fireRemove(java.util.Collection<java.lang.Integer> indexes)`
`protected void`	`focusFocusComponent()`
`java.lang.String`	`getConfigContextCode()`
`GridItemRenderer`	`getGridItemRenderer()`
`protected TypedObject`	`getItemAt(int index)`
`MutableListModel`	`getModel()`
`TypeService`	`getTypeService()`
`protected UIConfigurationService`	`getUIConfigurationService()`
`boolean`	`initialize()` Initializes this view component.
`protected void`	`rangeSelect(int index)`
`void`	`removeGridViewListener(GridViewListener listener)`
`protected void`	`removeSelectedItems()`
`protected void`	`renderActivation(boolean selected)`
`protected void`	`renderItemAsActive(HtmlBasedComponent comp, boolean active)`
`protected void`	`renderItemAsSelected(HtmlBasedComponent comp, boolean selected)`
`protected void`	`renderItems(Component parent)`
`protected void`	`renderSelection(boolean selected)`
`protected void`	`rerenderItem(TypedObject item)`
`void`	`setConfigContextCode(java.lang.String code)`
`void`	`setGridItemRenderer(GridItemRenderer gridItemRenderer)`
`void`	`setModel(MutableListModel model)`
`void`	`setRootType(ObjectTemplate template)`
`boolean`	`update()` Updates this view component completely.
`void`	`updateActivation()` Called whenever the activation needs to be updated i.e.
`void`	`updateActiveItems()` Called whenever the currently active items need to be re-rendered.
`int`	`updateItem(TypedObject item, java.util.Set<PropertyDescriptor> propertyDescriptors)` try to update rows containing the specified items
`void`	`updateItems()` Called whenever the items have changed in some way e.g.
`void`	`updateSelection()` Called whenever the selection is changed in some way and the view needs to update itself accordingly.

Methods inherited from class de.hybris.platform.cockpit.model.general.impl.AbstractItemView
delayLazyload, getDDContext, getInitialPackageSize, getLazyloadPackageSize, isSimpleSelectionMode, setDDContext, setSimpleSelectionMode, setupLazyLoading

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface de.hybris.platform.cockpit.model.general.UIItemView
setDDContext

- Field Detail
  - DEFAULT_GRIDVIEW_CONF
```
public static final java.lang.String DEFAULT_GRIDVIEW_CONF
```
    See Also:
    
    Constant Field Values
  - ITEM_BOX_SIZE
```
public static final java.lang.String ITEM_BOX_SIZE
```
    See Also:
    
    Constant Field Values
  - model
```
protected MutableListModel model
```
  - initialized
```
protected boolean initialized
```
  - mainDiv
```
protected Div mainDiv
```
  - focusComponent
```
protected Checkbox focusComponent
```
- Constructor Detail
  - GridView
```
public GridView()
```
- Method Detail
  - getConfigContextCode
```
public java.lang.String getConfigContextCode()
```
  - setConfigContextCode
```
public void setConfigContextCode(java.lang.String code)
```
    Specified by:
    
    setConfigContextCode in interface UIGridView
  - addGridViewListener
```
public void addGridViewListener(GridViewListener listener)
```
    Specified by:
    
    addGridViewListener in interface UIGridView
  - removeGridViewListener
```
public void removeGridViewListener(GridViewListener listener)
```
    Specified by:
    
    removeGridViewListener in interface UIGridView
  - setRootType
```
public void setRootType(ObjectTemplate template)
```
    Specified by:
    
    setRootType in interface UIGridView
  - getModel
```
public MutableListModel getModel()
```
    Specified by:
    
    getModel in interface UIGridView
  - setModel
```
public void setModel(MutableListModel model)
```
    Specified by:
    
    setModel in interface UIGridView
  - updateActivation
```
public void updateActivation()
```
    Description copied from interface: UIItemView
    
    Called whenever the activation needs to be updated i.e. which items are currently rendered as "active".
    Note: Does not re-render the items themselves, only the activation state of them. In order to update the items use UIItemView.updateActiveItems().
    
    Specified by:
    
    updateActivation in interface UIItemView
  - updateActiveItems
```
public void updateActiveItems()
```
    Description copied from interface: UIItemView
    
    Called whenever the currently active items need to be re-rendered.
    Note: Does not update the activation itself. For that purpose use UIItemView.updateActivation().
    
    Specified by:
    
    updateActiveItems in interface UIItemView
    
    See Also:
    
    UIItemView.updateActivation()
  - rerenderItem
```
protected void rerenderItem(TypedObject item)
```
  - updateItem
```
public int updateItem(TypedObject item,
                      java.util.Set<PropertyDescriptor> propertyDescriptors)
```
    Description copied from interface: UIItemView
    
    try to update rows containing the specified items
    
    Specified by:
    
    updateItem in interface UIItemView
    
    Parameters:
    
    item - the item
    
    propertyDescriptors - modified properties
    
    Returns:
    
    the number of updated rows
  - renderItemAsSelected
```
protected void renderItemAsSelected(HtmlBasedComponent comp,
                                    boolean selected)
```
  - renderItemAsActive
```
protected void renderItemAsActive(HtmlBasedComponent comp,
                                  boolean active)
```
  - renderSelection
```
protected void renderSelection(boolean selected)
```
  - renderActivation
```
protected void renderActivation(boolean selected)
```
  - appendScrollIntoViewComponent
```
protected void appendScrollIntoViewComponent(HtmlBasedComponent cell)
```
  - updateSelection
```
public void updateSelection()
```
    Description copied from interface: UIItemView
    
    Called whenever the selection is changed in some way and the view needs to update itself accordingly.
    
    Specified by:
    
    updateSelection in interface UIItemView
  - initialize
```
public boolean initialize()
```
    Description copied from interface: UIViewComponent
    
    Initializes this view component.
    Note: Should not be called during object creation i.e. from constructor.
    
    Specified by:
    
    initialize in interface UIViewComponent
    
    Returns:
    
    true if initialize was successful, false otherwise
  - update
```
public boolean update()
```
    Description copied from interface: UIViewComponent
    
    Updates this view component completely.
    
    Specified by:
    
    update in interface UIViewComponent
    
    Returns:
    
    true if update was successful, false otherwise
  - updateItems
```
public void updateItems()
```
    Description copied from interface: UIItemView
    
    Called whenever the items have changed in some way e.g. an item has been added or removed.
    
    Specified by:
    
    updateItems in interface UIItemView
  - focusFocusComponent
```
protected void focusFocusComponent()
```
  - renderItems
```
protected void renderItems(Component parent)
```
  - continueRenderItems
```
protected void continueRenderItems(Component parent,
                                   int index)
```
  - continueRenderItems
```
protected void continueRenderItems(Component parent,
                                   int index,
                                   int numberOfItemsToRender)
```
  - rangeSelect
```
protected void rangeSelect(int index)
```
  - createItemBox
```
protected HtmlBasedComponent createItemBox(TypedObject item,
                                           GridViewConfiguration config)
```
  - getItemAt
```
protected TypedObject getItemAt(int index)
```
  - removeSelectedItems
```
protected void removeSelectedItems()
```
  - fireRemove
```
protected void fireRemove(java.util.Collection<java.lang.Integer> indexes)
```
  - fireChangeSelection
```
protected void fireChangeSelection(java.util.List<java.lang.Integer> selectedIndexes)
```
  - fireChangeSelection
```
protected void fireChangeSelection(int selectedIndex)
```
  - doUserEvent
```
protected void doUserEvent(java.lang.Object[] data)
```
  - getUIConfigurationService
```
protected UIConfigurationService getUIConfigurationService()
```
  - setGridItemRenderer
```
public void setGridItemRenderer(GridItemRenderer gridItemRenderer)
```
    Specified by:
    
    setGridItemRenderer in interface UIGridView
  - getGridItemRenderer
```
public GridItemRenderer getGridItemRenderer()
```
  - getTypeService
```
public TypeService getTypeService()
```

Class GridView

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.cockpit.model.general.impl.AbstractItemView

Field Summary

Fields inherited from class de.hybris.platform.cockpit.model.general.impl.AbstractItemView

Constructor Summary

Method Summary

Methods inherited from class de.hybris.platform.cockpit.model.general.impl.AbstractItemView

Methods inherited from class java.lang.Object

Methods inherited from interface de.hybris.platform.cockpit.model.general.UIItemView

Field Detail

DEFAULT_GRIDVIEW_CONF

ITEM_BOX_SIZE

model

initialized

mainDiv

focusComponent

Constructor Detail

GridView

Method Detail

getConfigContextCode

setConfigContextCode

addGridViewListener

removeGridViewListener

setRootType

getModel

setModel

updateActivation

updateActiveItems

rerenderItem

updateItem

renderItemAsSelected

renderItemAsActive

renderSelection

renderActivation

appendScrollIntoViewComponent

updateSelection

initialize

update

updateItems

focusFocusComponent

renderItems

continueRenderItems

continueRenderItems

rangeSelect

createItemBox

getItemAt

removeSelectedItems

fireRemove

fireChangeSelection

fireChangeSelection

doUserEvent

getUIConfigurationService

setGridItemRenderer

getGridItemRenderer

getTypeService