ContextAreaBrowserComponent (hybris Commerce Suite 6.3.0.0-SNAPSHOT)

java.lang.Object
- Div
- - de.hybris.platform.cockpit.components.contentbrowser.AbstractBrowserComponent
  - - de.hybris.platform.cockpit.components.contentbrowser.AbstractContextBrowserComponent
    - - de.hybris.platform.cockpit.components.contentbrowser.ContextAreaBrowserComponent

All Implemented Interfaces:

BrowserComponent, CockpitComponent, DesktopRemovalAwareComponent

Direct Known Subclasses:

PageCommentsContextAreaBrowserComponent
```
public class ContextAreaBrowserComponent
extends AbstractContextBrowserComponent
implements DesktopRemovalAwareComponent
```
Context area browser component.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected class ContextAreaBrowserComponent.MyListenerHandler

protected class ContextAreaBrowserComponent.MyModelWrapper

Nested Classes
Modifier and Type	Class and Description
`protected class`	`ContextAreaBrowserComponent.MyListenerHandler`
`protected class`	`ContextAreaBrowserComponent.MyModelWrapper`

Field Summary

Fields
Modifier and Type	Field and Description
`protected static String`	`BROWSERAREA_SHOW_MAX_L10NKEY`
`protected boolean`	`cleanContextHeader`
`protected ColumnModelListener`	`columnModelListener` Listener that keeps track of visibility changes of columns and persists those changes.
`protected static String`	`CONTEXT_AREA_MAIN_DIV_SCLASS`
`protected HtmlBasedComponent`	`contextArea`
`protected Div`	`contextAreaMainDiv`
`protected Label`	`contextHeader`
`protected DefaultListModel<TypedObject>`	`contextModel`
`protected static String`	`EMPTY_MESSAGE_I3`
`protected EventListener`	`gridContextController`
`protected String`	`headerString`
`protected boolean`	`inlineCreationEnabled`
`protected String`	`internalContextViewMode`
`protected ObjectTemplate`	`lastContextType`
`protected static String`	`LIST_VIEW_CONFIG_CODE`
`protected UIListView`	`listView`
`protected LoginService`	`loginService`
`protected Div`	`multiSelectActionArea`
`protected Combobox`	`pageSizeCombo`
`protected Paging`	`paging`
`protected TypedObject`	`previouslyActiveItem`
`protected SystemService`	`systemService`
`protected ContextAreaTableController`	`tableController`
`protected Div`	`toolbarDiv`
`protected TypeService`	`typeService`
`protected UIAccessRightService`	`uiAccessRightService`
`protected UIConfigurationService`	`uiConfigurationService`

Fields inherited from class de.hybris.platform.cockpit.components.contentbrowser.AbstractBrowserComponent
ADV_QUERY_BTN_ACTIVE_IMG, ADV_QUERY_BTN_IMG, BROWSER_TOOLBAR_SCLASS, CLOSE_BTN_IMG, CONTENT_BROWSER_GB_SCLASS, CONTENT_BROWSER_STICKY_GB_SCLASS, DUPLICATE_BTN_IMG, initialized, MAIN_AREA_BL_SCLASS, MINIMIZE_BTN_IMG, SAVE_QUERY_BTN_IMG, SEARCH_MAGNIFIER_BTN_IMG, SPLIT_ACTIVE_BTN_IMG, SPLIT_INACTIVE_BTN_IMG

Constructor Summary

Constructors
Constructor and Description

ContextAreaBrowserComponent(BrowserModel model, AbstractContentBrowser contentBrowser)

Constructors
Constructor and Description
`ContextAreaBrowserComponent(BrowserModel model, AbstractContentBrowser contentBrowser)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`cleanup()`
`protected Toolbarbutton`	`createCloseButton(String closeBtnImg)`
`protected HtmlBasedComponent`	`createContextArea()`
`protected Groupbox`	`createContextGroupbox()`
`protected String`	`createContextHeader()`
`protected Div`	`createContextMainDiv()`
`protected TableModelListener`	`createContextTableModelListener()`
`protected ListViewConfiguration`	`createMultiTypeListViewConfiguration()`
`void`	`desktopRemoved(Desktop desktop)`
`void`	`detach()`
`protected ColumnModelListener`	`getColumnModelListener()` A columnModelListener to keep track of visibility changes of the ListModel columns.
`protected DefaultListModel<TypedObject>`	`getContextListModel()`
`protected ObjectTemplate`	`getContextResultType()`
`protected MutableTableModel`	`getContextTableModel()`
`EditorFactory`	`getEditorFactory()`
`protected Collection<HtmlBasedComponent>`	`getGroupboxComponents()`
`protected Collection<HtmlBasedComponent>`	`getHeaderComponents()`
`protected MutableListModel`	`getListComponentModel()`
`protected ListViewHelper.ListenerHandler`	`getListenerHandler()`
`protected ListViewConfiguration`	`getListViewConfiguration(ObjectTemplate objectTemplate, String code)`
`protected LoginService`	`getLoginService()`
`AdvancedBrowserModel`	`getModel()`
`protected AbstractPageableBrowserModel`	`getPageableBrowserModelIfPresent()`
`protected Set<PropertyDescriptor>`	`getRequiredPropertyDescriptors(ObjectTemplate template)`
`protected SystemService`	`getSystemService()`
`protected TypeService`	`getTypeService()`
`protected UIAccessRightService`	`getUIAccessRightService()`
`protected UIConfigurationService`	`getUIConfigurationService()`
`protected ObjectValueContainer`	`getValueContainer(ObjectTemplate template)`
`boolean`	`initialize()` Initializes this browser component i.e.
`protected boolean`	`isContextPagingEnabled(AbstractPageableBrowserModel browserModel)`
`protected UIListView`	`loadListView()`
`protected ListViewConfiguration`	`loadListViewConfig()` load the list view configuration
`void`	`resize()` Notifies this browser component that it should resize itself if possible, since the view state might require it.
`void`	`setActiveItem(TypedObject activeItem)` Sets the active item of this browser component to `activeItem`.
`protected void`	`setContextTableModel(MutableTableModel tableModel)`
`void`	`setParent(Component parent)`
`protected void`	`showAddItemPopup()`
`protected void`	`showAddItemRow()`
`protected void`	`storeListViewConfiguration()`
`boolean`	`update()` Updates this browser component i.e.
`boolean`	`update(boolean cleanContextHeader)` Updates this browser component i.e.
`void`	`updateActiveItems()` Re-renders the currently active item(s).
`protected void`	`updateContextItems()`
`void`	`updateItem(TypedObject item, Set<PropertyDescriptor> modifiedProperties)` Re-renders the item.
`protected void`	`updateMultiSelectAction(ListViewAction.Context context, ListViewAction action)`
`protected void`	`updateMultiSelectActionArea()`
`protected void`	`updatePaging()`
`void`	`updateSelectedItems()` Re-renders the currently selected item(s).

Methods inherited from class de.hybris.platform.cockpit.components.contentbrowser.AbstractBrowserComponent
getContentBrowser, setModel, updateItem

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

- Field Detail
  - CONTEXT_AREA_MAIN_DIV_SCLASS
```
protected static final String CONTEXT_AREA_MAIN_DIV_SCLASS
```
    See Also:
    
    Constant Field Values
  - EMPTY_MESSAGE_I3
```
protected static final String EMPTY_MESSAGE_I3
```
    See Also:
    
    Constant Field Values
  - LIST_VIEW_CONFIG_CODE
```
protected static final String LIST_VIEW_CONFIG_CODE
```
    See Also:
    
    Constant Field Values
  - BROWSERAREA_SHOW_MAX_L10NKEY
```
protected static final String BROWSERAREA_SHOW_MAX_L10NKEY
```
    See Also:
    
    Constant Field Values
  - listView
```
protected transient UIListView listView
```
  - contextArea
```
protected transient HtmlBasedComponent contextArea
```
  - internalContextViewMode
```
protected String internalContextViewMode
```
  - contextModel
```
protected final DefaultListModel<TypedObject> contextModel
```
  - gridContextController
```
protected EventListener gridContextController
```
  - contextAreaMainDiv
```
protected transient Div contextAreaMainDiv
```
  - uiConfigurationService
```
protected UIConfigurationService uiConfigurationService
```
  - typeService
```
protected TypeService typeService
```
  - uiAccessRightService
```
protected UIAccessRightService uiAccessRightService
```
  - tableController
```
protected ContextAreaTableController tableController
```
  - lastContextType
```
protected ObjectTemplate lastContextType
```
  - loginService
```
protected LoginService loginService
```
  - contextHeader
```
protected Label contextHeader
```
  - cleanContextHeader
```
protected boolean cleanContextHeader
```
  - systemService
```
protected SystemService systemService
```
  - inlineCreationEnabled
```
protected boolean inlineCreationEnabled
```
  - toolbarDiv
```
protected Div toolbarDiv
```
  - multiSelectActionArea
```
protected Div multiSelectActionArea
```
  - paging
```
protected Paging paging
```
  - pageSizeCombo
```
protected Combobox pageSizeCombo
```
  - previouslyActiveItem
```
protected TypedObject previouslyActiveItem
```
  - headerString
```
protected String headerString
```
  - columnModelListener
```
protected ColumnModelListener columnModelListener
```
    Listener that keeps track of visibility changes of columns and persists those changes.
- Constructor Detail
  - ContextAreaBrowserComponent
```
public ContextAreaBrowserComponent(BrowserModel model,
                                   AbstractContentBrowser contentBrowser)
```
- Method Detail
  - initialize
```
public boolean initialize()
```
    Description copied from class: AbstractBrowserComponent
    
    Initializes this browser component i.e. creates all required components, adds event listeners etc.
    Implementation note: Remember to set the initialized flag to true after this method has been called.
    Note: This method is automatically called when a model or browser controller is set.
    
    Specified by:
    
    initialize in interface CockpitComponent
    
    Specified by:
    
    initialize in class AbstractBrowserComponent
    
    Returns:
    
    true if initialization was successful, false otherwise
    
    See Also:
    
    AbstractBrowserComponent.setModel(BrowserModel)
  - getModel
```
public AdvancedBrowserModel getModel()
```
    Specified by:
    
    getModel in interface BrowserComponent
    
    Overrides:
    
    getModel in class AbstractBrowserComponent
  - update
```
public boolean update()
```
    Description copied from class: AbstractBrowserComponent
    
    Updates this browser component i.e. synchronizes its view width the underlying model.
    
    Specified by:
    
    update in interface CockpitComponent
    
    Specified by:
    
    update in class AbstractBrowserComponent
    
    Returns:
    
    true if this browser was successfully updated, false otherwise
  - updateMultiSelectActionArea
```
protected void updateMultiSelectActionArea()
```
  - updateMultiSelectAction
```
protected void updateMultiSelectAction(ListViewAction.Context context,
                                       ListViewAction action)
```
  - updatePaging
```
protected void updatePaging()
```
  - setActiveItem
```
public void setActiveItem(TypedObject activeItem)
```
    Description copied from class: AbstractBrowserComponent
    
    Sets the active item of this browser component to activeItem.
    
    Specified by:
    
    setActiveItem in interface CockpitComponent
    
    Specified by:
    
    setActiveItem in class AbstractBrowserComponent
    
    Parameters:
    
    activeItem - the new active item
  - updateActiveItems
```
public void updateActiveItems()
```
    Description copied from class: AbstractBrowserComponent
    
    Re-renders the currently active item(s).
    
    Specified by:
    
    updateActiveItems in interface CockpitComponent
    
    Specified by:
    
    updateActiveItems in class AbstractBrowserComponent
  - updateSelectedItems
```
public void updateSelectedItems()
```
    Description copied from class: AbstractBrowserComponent
    
    Re-renders the currently selected item(s).
    
    Specified by:
    
    updateSelectedItems in interface CockpitComponent
    
    Specified by:
    
    updateSelectedItems in class AbstractBrowserComponent
  - updateItem
```
public void updateItem(TypedObject item,
                       Set<PropertyDescriptor> modifiedProperties)
```
    Description copied from class: AbstractBrowserComponent
    
    Re-renders the item.
    
    Specified by:
    
    updateItem in interface CockpitComponent
    
    Specified by:
    
    updateItem in class AbstractBrowserComponent
    
    Parameters:
    
    item - the item to be re-rendered
    
    modifiedProperties - modified properties
  - getContextListModel
```
protected DefaultListModel<TypedObject> getContextListModel()
```
  - updateContextItems
```
protected void updateContextItems()
```
  - createContextArea
```
protected HtmlBasedComponent createContextArea()
```
  - createContextMainDiv
```
protected Div createContextMainDiv()
```
  - createContextHeader
```
protected String createContextHeader()
```
  - createContextGroupbox
```
protected Groupbox createContextGroupbox()
```
  - resize
```
public void resize()
```
    Description copied from class: AbstractBrowserComponent
    
    Notifies this browser component that it should resize itself if possible, since the view state might require it.
    This is typically only necessary for ZK's Borderlayout components.
    
    Specified by:
    
    resize in class AbstractBrowserComponent
  - getListComponentModel
```
protected MutableListModel getListComponentModel()
```
  - loadListView
```
protected UIListView loadListView()
```
  - loadListViewConfig
```
protected ListViewConfiguration loadListViewConfig()
```
    load the list view configuration
  - createMultiTypeListViewConfiguration
```
protected ListViewConfiguration createMultiTypeListViewConfiguration()
```
  - getListViewConfiguration
```
protected ListViewConfiguration getListViewConfiguration(ObjectTemplate objectTemplate,
                                                         String code)
```
  - getUIConfigurationService
```
protected UIConfigurationService getUIConfigurationService()
```
  - getUIAccessRightService
```
protected UIAccessRightService getUIAccessRightService()
```
  - getLoginService
```
protected LoginService getLoginService()
```
  - getTypeService
```
protected TypeService getTypeService()
```
  - getContextTableModel
```
protected MutableTableModel getContextTableModel()
```
  - setContextTableModel
```
protected void setContextTableModel(MutableTableModel tableModel)
```
  - getContextResultType
```
protected ObjectTemplate getContextResultType()
```
  - detach
```
public void detach()
```
  - setParent
```
public void setParent(Component parent)
```
  - desktopRemoved
```
public void desktopRemoved(Desktop desktop)
```
    Specified by:
    
    desktopRemoved in interface DesktopRemovalAwareComponent
  - cleanup
```
protected void cleanup()
```
  - getSystemService
```
protected SystemService getSystemService()
```
  - showAddItemPopup
```
protected void showAddItemPopup()
```
  - showAddItemRow
```
protected void showAddItemRow()
```
  - getValueContainer
```
protected ObjectValueContainer getValueContainer(ObjectTemplate template)
```
  - getRequiredPropertyDescriptors
```
protected Set<PropertyDescriptor> getRequiredPropertyDescriptors(ObjectTemplate template)
```
  - isContextPagingEnabled
```
protected boolean isContextPagingEnabled(AbstractPageableBrowserModel browserModel)
```
  - getPageableBrowserModelIfPresent
```
protected AbstractPageableBrowserModel getPageableBrowserModelIfPresent()
```
  - getEditorFactory
```
public EditorFactory getEditorFactory()
```
  - update
```
public boolean update(boolean cleanContextHeader)
```
    Description copied from class: AbstractContextBrowserComponent
    
    Updates this browser component i.e. synchronizes its view width the underlying model.
    
    Specified by:
    
    update in class AbstractContextBrowserComponent
    
    Parameters:
    
    cleanContextHeader - indicates if cleaning of ContextHeader is necessary
    
    Returns:
    
    true if this browser was successfully updated, false otherwise
  - getListenerHandler
```
protected ListViewHelper.ListenerHandler getListenerHandler()
```
  - getGroupboxComponents
```
protected Collection<HtmlBasedComponent> getGroupboxComponents()
```
  - getHeaderComponents
```
protected Collection<HtmlBasedComponent> getHeaderComponents()
```
  - createCloseButton
```
protected Toolbarbutton createCloseButton(String closeBtnImg)
```
  - createContextTableModelListener
```
protected TableModelListener createContextTableModelListener()
```
  - getColumnModelListener
```
protected ColumnModelListener getColumnModelListener()
```
    A columnModelListener to keep track of visibility changes of the ListModel columns.
    
    Returns:
    
    ColumnModelListener the listener that should be hooked into ColumnModel
  - storeListViewConfiguration
```
protected void storeListViewConfiguration()
```

Class ContextAreaBrowserComponent

Nested Class Summary

Field Summary

Fields inherited from class de.hybris.platform.cockpit.components.contentbrowser.AbstractBrowserComponent

Constructor Summary

Method Summary

Methods inherited from class de.hybris.platform.cockpit.components.contentbrowser.AbstractBrowserComponent

Methods inherited from class java.lang.Object

Field Detail

CONTEXT_AREA_MAIN_DIV_SCLASS

EMPTY_MESSAGE_I3

LIST_VIEW_CONFIG_CODE

BROWSERAREA_SHOW_MAX_L10NKEY

listView

contextArea

internalContextViewMode

contextModel

gridContextController

contextAreaMainDiv

uiConfigurationService

typeService

uiAccessRightService

tableController

lastContextType

loginService

contextHeader

cleanContextHeader

systemService

inlineCreationEnabled

toolbarDiv

multiSelectActionArea

paging

pageSizeCombo

previouslyActiveItem

headerString

columnModelListener

Constructor Detail

ContextAreaBrowserComponent

Method Detail

initialize

getModel

update

updateMultiSelectActionArea

updateMultiSelectAction

updatePaging

setActiveItem

updateActiveItems

updateSelectedItems

updateItem

getContextListModel

updateContextItems

createContextArea

createContextMainDiv

createContextHeader

createContextGroupbox

resize

getListComponentModel

loadListView

loadListViewConfig

createMultiTypeListViewConfiguration

getListViewConfiguration

getUIConfigurationService

getUIAccessRightService

getLoginService

getTypeService

getContextTableModel

setContextTableModel

getContextResultType

detach

setParent

desktopRemoved

cleanup

getSystemService

showAddItemPopup

showAddItemRow

getValueContainer

getRequiredPropertyDescriptors

isContextPagingEnabled

getPageableBrowserModelIfPresent

getEditorFactory