de.hybris.platform.cockpit.model.listview

Class ListViewHelper

java.lang.Object

de.hybris.platform.cockpit.model.listview.ListViewHelper

public class ListViewHelper
extends java.lang.Object

Helper class with convenience methods for dealing with list views in a Cockpit application.

See Also:

UIListView

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListViewHelper.ListenerHandler Responsible for registering/unregistering listeners used by a list view.
static class	ListViewHelper.ListViewInfo Holds list view creation information.

Constructor Summary

Constructors

Constructor and Description
ListViewHelper()

Method Summary

Modifier and Type	Method and Description
static void	cellChanged(UIListView view, int colIndex, int rowIndex, java.lang.Object eventSource)
static ListViewConfiguration	getListViewConfiguration(ObjectTemplate objectTemplate, java.lang.String contextCode)
static boolean	isForceFireEvent()
static <E extends TypedObject> ListViewHelper.ListViewInfo	loadListView(UIListView listView, java.lang.String contextCode, ObjectTemplate oldRootType, ObjectTemplate newRootType, MutableTableModel tableModel, DefaultListModel<E> listModel, CockpitListComponent<E> cockpitListComp, ListViewHelper.ListenerHandler listenerHandler, DragAndDropContext dndCtx) Convenience method for loading a list view component.
static <E extends TypedObject> ListViewHelper.ListViewInfo	loadListView(UIListView listView, java.lang.String contextCode, ObjectTemplate oldRootType, ObjectTemplate newRootType, MutableTableModel tableModel, DefaultListModel<E> listModel, CockpitListComponent<E> cockpitListComp, ListViewHelper.ListenerHandler listenerHandler, DragAndDropContext dndCtx, ListViewConfiguration listViewConf) Convenience method for loading a list view component.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ListViewHelper

public ListViewHelper()

Method Detail

cellChanged

public static void cellChanged(UIListView view,
                               int colIndex,
                               int rowIndex,
                               java.lang.Object eventSource)
                        throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

loadListView

public static <E extends TypedObject> ListViewHelper.ListViewInfo loadListView(UIListView listView,
                                                                               java.lang.String contextCode,
                                                                               ObjectTemplate oldRootType,
                                                                               ObjectTemplate newRootType,
                                                                               MutableTableModel tableModel,
                                                                               DefaultListModel<E> listModel,
                                                                               CockpitListComponent<E> cockpitListComp,
                                                                               ListViewHelper.ListenerHandler listenerHandler,
                                                                               DragAndDropContext dndCtx)
                                                                        throws java.lang.IllegalArgumentException,
                                                                               java.lang.IllegalStateException

Convenience method for loading a list view component.

Contains logic for determining if a new list view UI configuration needs to be loaded and if so creates the related components.

Note: The specified ListViewHelper.ListenerHandler listenerHandler will only be invoked if a new UIListView instance has been created or if a new UI configuration was loaded.

Type Parameters:

E - type of elements which the list view contains

Parameters:

listView - the current list view instance

contextCode - cockpit UI configuration context code

oldRootType - last root type

newRootType - current root type

tableModel - the table model (must have a valid list component model set)

listModel - the list model which actually holds the items to be displayed in the list view - can be null

cockpitListComp - the CockpitListComponent containing the actual items

listenerHandler - the ListViewHelper.ListenerHandler responsible for registering/unregistering listeners, controllers etc

dndCtx - the drag and drop context

Returns:

a ListViewHelper.ListViewInfo instance containing the resulting UIListView instance and some additional information

Throws:

java.lang.IllegalArgumentException - if either contextCode, newRootType, itemLoader or tableModel (or its internal list component model) is null

java.lang.IllegalStateException - if no UI component configuration could be loaded for the type newRootType and the context code contextCode

See Also:

ListViewHelper.ListenerHandler

loadListView

public static <E extends TypedObject> ListViewHelper.ListViewInfo loadListView(UIListView listView,
                                                                               java.lang.String contextCode,
                                                                               ObjectTemplate oldRootType,
                                                                               ObjectTemplate newRootType,
                                                                               MutableTableModel tableModel,
                                                                               DefaultListModel<E> listModel,
                                                                               CockpitListComponent<E> cockpitListComp,
                                                                               ListViewHelper.ListenerHandler listenerHandler,
                                                                               DragAndDropContext dndCtx,
                                                                               ListViewConfiguration listViewConf)
                                                                        throws java.lang.IllegalArgumentException,
                                                                               java.lang.IllegalStateException

Convenience method for loading a list view component.

Contains logic for determining if a new list view UI configuration needs to be loaded and if so creates the related components.

Note: The specified ListViewHelper.ListenerHandler listenerHandler will only be invoked if a new UIListView instance has been created or if a new UI configuration was loaded.

Type Parameters:

E - type of elements which the list view contains

Parameters:

listView - the current list view instance

contextCode - cockpit UI configuration context code

oldRootType - last root type

newRootType - current root type

tableModel - the table model (must have a valid list component model set)

listModel - the list model which actually holds the items to be displayed in the list view - can be null

cockpitListComp - the CockpitListComponent containing the actual items

listenerHandler - the ListViewHelper.ListenerHandler responsible for registering/unregistering listeners, controllers etc

dndCtx - the drag and drop context

listViewConf - the alternative configuration of list view, if null then default list view is created according to rest of given parameters

Returns:

a ListViewHelper.ListViewInfo instance containing the resulting UIListView instance and some additional information

Throws:

java.lang.IllegalArgumentException - if either contextCode, newRootType, itemLoader or tableModel (or its internal list component model) is null

java.lang.IllegalStateException - if no UI component configuration could be loaded for the type newRootType and the context code contextCode

See Also:

ListViewHelper.ListenerHandler

isForceFireEvent

public static boolean isForceFireEvent()

getListViewConfiguration

public static ListViewConfiguration getListViewConfiguration(ObjectTemplate objectTemplate,
                                                             java.lang.String contextCode)