com.hybris.cockpitng.widgets.collectionbrowser.mold

Interface CollectionBrowserMoldContext

All Known Implementing Classes:

DefaultCollectionBrowserContext

public interface CollectionBrowserMoldContext

A set of methods that allows CollectionBrowserMoldStrategy to communicate with CollectionBrowserController

Method Summary

Modifier and Type	Method and Description
boolean	areHyperlinksSupported() Informs if collection browser supports hyperlinks.
SinglePage	getCurrentPage()
DataType	getCurrentType() Gets data type that is currently being displayed
String	getCurrentTypeCode() Gets data type code that is currently being displayed
DragAndDropStrategy	getDragAndDropStrategy()
<E> E	getFocusedItem() Gets currently focused item or null if no item is focused
<E> Collection<E>	getSelectedItems() Gets all currently selected items
WidgetInstanceManager	getWidgetInstanceManager() Returns the widget instance manager of current controller.
boolean	isMultiSelectEnabled() Allows to determine if the collection browser allows for multi-selection
boolean	isSortable(String attributeQualifier) Checks whether provided attribute is sortable
void	notifyHyperlinkClicked(Object value) Notifies that an user has clicked on element hyperlink.
void	notifyItemClicked(Object item) Notifies that an user has clicked on element, but did not select it.
void	notifyItemsSelected(Collection<?> items) Notifies that multiple items have been selected.
void	sort(SortData sortData) Reads data sorted with provided parameters

Method Detail

getSelectedItems

<E> Collection<E> getSelectedItems()

Gets all currently selected items

Type Parameters:

E - type of expected items

Returns:

collection of all selected items

getFocusedItem

<E> E getFocusedItem()

Gets currently focused item or null if no item is focused

Type Parameters:

E - type of expected item

Returns:

focused item

notifyItemsSelected

void notifyItemsSelected(Collection<?> items)

Notifies that multiple items have been selected.

Method should be called when selection is changed passing a full collection of selected items (even if a single element is added to selection, whole selection should be passed).

Parameters:

items - all items that are selected

areHyperlinksSupported

boolean areHyperlinksSupported()

Informs if collection browser supports hyperlinks.

Values in collection browser may be rendered in the way, that some

Returns:

notifyHyperlinkClicked

void notifyHyperlinkClicked(Object value)

Notifies that an user has clicked on element hyperlink.

Call will be ignored, if hyperlinks are not supported

Parameters:

value - hyperlink's value

See Also:

areHyperlinksSupported()

notifyItemClicked

void notifyItemClicked(Object item)

Notifies that an user has clicked on element, but did not select it.

Parameters:

item - item that is represented by clicked element

See Also:

notifyItemsSelected(Collection)

getWidgetInstanceManager

WidgetInstanceManager getWidgetInstanceManager()

Returns the widget instance manager of current controller.

Returns:

widget instance manager

isSortable

boolean isSortable(String attributeQualifier)

Checks whether provided attribute is sortable

Parameters:

attributeQualifier - attributes qualifier

Returns:

true if attribute is sortable

getCurrentPage

SinglePage getCurrentPage()

Returns:

currently loaded data page

sort

void sort(SortData sortData)

Reads data sorted with provided parameters

Parameters:

sortData - sorting parameters

getCurrentType

DataType getCurrentType()

Gets data type that is currently being displayed

Returns:

currently selected data type or null if selected type code does not match any of types

See Also:

getCurrentTypeCode()

getCurrentTypeCode

String getCurrentTypeCode()

Gets data type code that is currently being displayed

Returns:

currently selected data type code

See Also:

getCurrentType()

isMultiSelectEnabled

boolean isMultiSelectEnabled()

Allows to determine if the collection browser allows for multi-selection

Returns:

true if the collection browser allows for multi-selection

getDragAndDropStrategy

DragAndDropStrategy getDragAndDropStrategy()