Package com.hybris.cockpitng.widgets.collectionbrowser.mold

Class DefaultCollectionBrowserContext

java.lang.Object

com.hybris.cockpitng.widgets.collectionbrowser.mold.DefaultCollectionBrowserContext

All Implemented Interfaces:

CollectionBrowserMoldContext

public class DefaultCollectionBrowserContext
extends java.lang.Object
implements CollectionBrowserMoldContext

Field Summary

Fields

Modifier and Type	Field	Description
protected CollectionBrowserController	controller

Constructor Summary

Constructors

Constructor	Description
DefaultCollectionBrowserContext(CollectionBrowserController controller)

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

controller

protected final CollectionBrowserController controller

Constructor Detail

DefaultCollectionBrowserContext

public DefaultCollectionBrowserContext(CollectionBrowserController controller)

Method Detail

getSelectedItems

public <E> java.util.Collection<E> getSelectedItems()

Description copied from interface: CollectionBrowserMoldContext

Gets all currently selected items

Specified by:

getSelectedItems in interface CollectionBrowserMoldContext

Type Parameters:

E - type of expected items

Returns:

collection of all selected items

getFocusedItem

public <E> E getFocusedItem()

Description copied from interface: CollectionBrowserMoldContext

Gets currently focused item or null if no item is focused

Specified by:

getFocusedItem in interface CollectionBrowserMoldContext

Type Parameters:

E - type of expected item

Returns:

focused item

notifyItemsSelected

public void notifyItemsSelected(java.util.Collection<?> items)

Description copied from interface: CollectionBrowserMoldContext

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).

Specified by:

notifyItemsSelected in interface CollectionBrowserMoldContext

Parameters:

items - all items that are selected

areHyperlinksSupported

public boolean areHyperlinksSupported()

Description copied from interface: CollectionBrowserMoldContext

Informs if collection browser supports hyperlinks.

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

Specified by:

areHyperlinksSupported in interface CollectionBrowserMoldContext

Returns:

notifyHyperlinkClicked

public void notifyHyperlinkClicked(java.lang.Object value)

Description copied from interface: CollectionBrowserMoldContext

Notifies that an user has clicked on element hyperlink.

Call will be ignored, if hyperlinks are not supported

Specified by:

notifyHyperlinkClicked in interface CollectionBrowserMoldContext

Parameters:

value - hyperlink's value

See Also:

CollectionBrowserMoldContext.areHyperlinksSupported()

notifyItemClicked

public void notifyItemClicked(java.lang.Object item)

Description copied from interface: CollectionBrowserMoldContext

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

Specified by:

notifyItemClicked in interface CollectionBrowserMoldContext

Parameters:

item - item that is represented by clicked element

See Also:

CollectionBrowserMoldContext.notifyItemsSelected(Collection)

getWidgetInstanceManager

public WidgetInstanceManager getWidgetInstanceManager()

Description copied from interface: CollectionBrowserMoldContext

Returns the widget instance manager of current controller.

Specified by:

getWidgetInstanceManager in interface CollectionBrowserMoldContext

Returns:

widget instance manager

isSortable

public boolean isSortable(java.lang.String attributeQualifier)

Description copied from interface: CollectionBrowserMoldContext

Checks whether provided attribute is sortable

Specified by:

isSortable in interface CollectionBrowserMoldContext

Parameters:

attributeQualifier - attributes qualifier

Returns:

true if attribute is sortable

getCurrentPage

public SinglePage getCurrentPage()

Specified by:

getCurrentPage in interface CollectionBrowserMoldContext

Returns:

currently loaded data page

sort

public void sort(SortData sortData)

Description copied from interface: CollectionBrowserMoldContext

Reads data sorted with provided parameters

Specified by:

sort in interface CollectionBrowserMoldContext

Parameters:

sortData - sorting parameters

getCurrentType

public DataType getCurrentType()

Description copied from interface: CollectionBrowserMoldContext

Gets data type that is currently being displayed

Specified by:

getCurrentType in interface CollectionBrowserMoldContext

Returns:

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

See Also:

CollectionBrowserMoldContext.getCurrentTypeCode()

getCurrentTypeCode

public java.lang.String getCurrentTypeCode()

Description copied from interface: CollectionBrowserMoldContext

Gets data type code that is currently being displayed

Specified by:

getCurrentTypeCode in interface CollectionBrowserMoldContext

Returns:

currently selected data type code

See Also:

CollectionBrowserMoldContext.getCurrentType()

isMultiSelectEnabled

public boolean isMultiSelectEnabled()

Description copied from interface: CollectionBrowserMoldContext

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

Specified by:

isMultiSelectEnabled in interface CollectionBrowserMoldContext

Returns:

true if the collection browser allows for multi-selection

getDragAndDropStrategy

public DragAndDropStrategy getDragAndDropStrategy()

Specified by:

getDragAndDropStrategy in interface CollectionBrowserMoldContext

isDragEnabled

public boolean isDragEnabled()

Specified by:

isDragEnabled in interface CollectionBrowserMoldContext

isDropEnabled

public boolean isDropEnabled()

Specified by:

isDropEnabled in interface CollectionBrowserMoldContext