com.hybris.cockpitng.widgets.compare

Class CompareViewController

java.lang.Object

org.zkoss.zk.ui.event.GenericEventListener

org.zkoss.zk.ui.util.GenericComposer<T>

org.zkoss.zk.ui.util.GenericAutowireComposer<T>

org.zkoss.zk.ui.util.GenericForwardComposer<org.zkoss.zk.ui.Component>

com.hybris.cockpitng.util.ViewAnnotationAwareComposer

com.hybris.cockpitng.util.DefaultWidgetController

com.hybris.cockpitng.widgets.compare.CompareViewController

All Implemented Interfaces:

WidgetController, WidgetDragAndDropAware, WidgetInstanceManagerAware, Serializable, org.zkoss.zk.ui.event.EventListener, org.zkoss.zk.ui.event.SerializableEventListener, org.zkoss.zk.ui.util.ComponentActivationListener, org.zkoss.zk.ui.util.ComponentCloneListener, org.zkoss.zk.ui.util.Composer<org.zkoss.zk.ui.Component>, org.zkoss.zk.ui.util.ComposerExt<org.zkoss.zk.ui.Component>

public class CompareViewController
extends DefaultWidgetController

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	CompareViewController.PartialComparisonOperation

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	LABEL_LOADING
static String	MARK_NAME_ADD_ITEMS
static String	MARK_NAME_DIFF_ONLY
static String	MARK_NAME_HYPERLINK
static String	MARK_NAME_PIN
static String	MARK_NAME_REMOVE_ITEM
protected static String	SETTING_CONFIGURATION_CONTEXT
protected static String	SETTING_DEFAULT_TYPE_CODE
protected static String	SETTING_LAYOUT
protected static String	SOCKET_INPUT_OBJECTS
protected static String	SOCKET_INPUT_OBJECTS_ADD
protected static String	SOCKET_INPUT_OBJECTS_REMOVE
protected static String	SOCKET_INPUT_REFERENCE
protected static String	SOCKET_OUTPUT_ADD_ITEMS_REQUEST
protected static String	SOCKET_OUTPUT_SELECTED_ITEM

Fields inherited from class org.zkoss.zk.ui.util.GenericAutowireComposer

_separator, application, applicationScope, arg, componentScope, desktop, desktopScope, execution, page, pageScope, param, requestScope, self, session, sessionScope, spaceOwner, spaceScope

Fields inherited from class org.zkoss.zk.ui.util.GenericComposer

_applied

Constructor Summary

Constructors

Constructor and Description
CompareViewController()

Method Summary

Modifier and Type	Method and Description
protected void	addInProgressMarker() Marks UI component as in progress
protected void	addObjectIdsImmediately(Collection<Object> objects)
protected void	addObjectsImmediately(Collection<Object> objects)
void	addObjectsToCompare(Collection<Object> objects)
protected void	assureComparisonFinished(CompareViewData<?> data) Deprecated. since 1811. Please use assureComparisonNotFinished(CompareViewData)
protected void	assureComparisonNotFinished(CompareViewData<?> data) Checks if any other comparisons are required to meet all data marked for comparison.
protected void	assureReferenceInObjectsList()
void	changeReference(Object object)
protected void	clearComparisonStatus()
protected void	clearObjectsAndIds()
protected void	clearViewData()
protected Stream<CompareAttributeDescriptor>	compareAttributeDescriptorFromQualifier(String qualifier)
protected Operation	createBuildDataOperation() Creates an operation responsible for performing a partial comparison in background.
protected Operation	createBuildDataOperation(DefaultComparisonState status) Deprecated. since 1811. Please use createBuildDataOperation()
protected TypeAwareSelectionContext<Object>	createSelectionContext(Object selectedItem)
protected CockpitConfigurationService	getCockpitConfigurationService()
protected CockpitLocaleService	getCockpitLocaleService()
protected CockpitUserService	getCockpitUserService()
protected DefaultComparisonState	getComparisonState()
protected DefaultComparisonState	getComparisonStatus() Deprecated. since 1811. Please use getComparisonState() instead.
protected CompareViewData	getCurrentViewData()
protected CompareViewLayout	getDefaultLayout()
protected ItemComparisonFacade	getItemComparisonFacade()
protected String	getItemType()
protected CompareViewLayout	getLayout()
protected NotificationService	getNotificationService()
protected Optional<Object>	getObjectById(Object id)
ObjectFacade	getObjectFacade()
protected List<Object>	getObjectIds()
protected List<Object>	getObjectIdsMutable()
protected List<Object>	getObjects()
protected Object	getReferenceObject()
protected Object	getReferenceObjectId()
protected TypeFacade	getTypeFacade()
protected org.zkoss.zul.Div	getView()
protected WidgetRenderingUtils	getWidgetRenderingUtils()
protected GroupDescriptor	groupDescriptorFromSection(Section section)
protected void	handleAddItemsClicked()
protected void	handleDiffOnlyChecked(org.zkoss.zk.ui.HtmlBasedComponent component, org.zkoss.zk.ui.event.CheckEvent checkEvent)
protected void	handleHyperLinkClicked(Object item)
protected void	handlePartialComparisonResult(DefaultComparisonState state, org.apache.commons.lang3.tuple.Pair<Object,ComparisonResult> compareObjectIdAndResult)
protected void	handlePinClicked(Object object)
protected void	handleRemoveItemClicked(Object item)
void	initialize(org.zkoss.zk.ui.Component comp) Override this method to do initialization stuff for your widget, like initialize widget settings, restore view state from viewmodel, etc.
protected void	invalidateView() Marks current view as invalid - future calls to validateView() will trigger full comparison from scratch
protected boolean	isDiffOnlyEnabled()
protected boolean	isValidComparison(ComparisonState<?> status)
protected boolean	isValidViewData(CompareViewData<?> data)
protected CompareView	loadConfiguration()
void	objectsDeleted(CockpitEvent event)
void	objectsUpdated(CockpitEvent event)
protected ComparisonResult	performPartialComparison(Object reference, Object compareItem)
protected void	registerAddItemsListeners()
protected void	registerDiffOnlyListeners()
protected void	registerHyperlinkEventListeners()
protected void	registerListeners()
protected void	registerPinEventListeners()
protected void	registerRemoveItemListeners()
protected void	removeInProgressMarker() Removes in progress marker from UI component
protected void	removeObjectIdsImmediately(Collection<Object> objects)
protected void	removeObjectsImmediately(Collection<Object> objects)
void	removeObjectsToCompare(Collection<Object> objects)
protected void	resetView() Clears whole view built up till now, invalidates current comparison result and triggers view build from scratch.
protected void	revalidateView() Forces view to validate - new comparison is being performed and whole view is being validated from scratch.
void	setCockpitLocaleService(CockpitLocaleService cockpitLocaleService)
void	setCockpitUserService(CockpitUserService cockpitUserService)
void	setDefaultLayout(CompareViewLayout compareViewLayout)
void	setNotificationService(NotificationService notificationService)
void	setObjects(Collection<Object> objects)
protected void	setObjectsImmediately(Collection<Object> objects)
protected void	setReferenceObjectImmediately(Object reference)
void	setTypeFacade(TypeFacade typeFacade)
void	setWidgetRenderingUtils(WidgetRenderingUtils widgetRenderingUtils)
protected void	updateComparisonState(DefaultComparisonState<? super Object> comparisonState, Object objectId)
protected void	updateComparisonStatus(DefaultComparisonState<? super Object> comparisonStatus, Object comparedObject) Deprecated. since 1811. Please use updateComparisonState(DefaultComparisonState, Object)
protected void	updateDiffOnlyState(CompareViewData currentData, boolean diffOnly)
protected void	updateDiffOnlyTrigger()
protected void	updateItemType()
protected void	updateObjectsImmediately(List<Object> changedObjects)
protected void	updateView(CompareViewData data) Checks if current view reflects provided comparison data.
protected void	updateViewInternal(CompareViewData data)
protected void	validateView() Checks if current view reflects data marked for comparison and comparison result.

Methods inherited from class com.hybris.cockpitng.util.DefaultWidgetController

doAfterCompose, doBeforeCompose, doBeforeComposeChildren, executeOperation, getDragAndDropStrategy, getLabel, getLabel, getModel, getValue, getWidgetDragAndDropStrategyRepository, getWidgetInstanceManager, getWidgetRoot, getWidgetSettings, getWidgetslot, getWidgetTitle, getWidgetUtils, initDragAndDropAwareness, initWidgetSetting, initWidgetSetting, initWidgetSetting, initWidgetSetting, initWidgetSetting, invokeListenerMethod, onSocketInput, preInitialize, sendOutput, sendOutputAfterOperation, sendOutputAfterOperation, sendOutputAfterOperation, setValue, setWidgetInstanceManager, setWidgetTitle

Methods inherited from class com.hybris.cockpitng.util.ViewAnnotationAwareComposer

scanEventListeners

Methods inherited from class org.zkoss.zk.ui.util.GenericAutowireComposer

alert, didActivate, getPage, willClone, willPassivate

Methods inherited from class org.zkoss.zk.ui.util.GenericComposer

doCatch, doFinally

Methods inherited from class org.zkoss.zk.ui.event.GenericEventListener

bindComponent, getController, onEvent, unbindComponent

Methods inherited from class java.lang.Object

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

Field Detail

MARK_NAME_DIFF_ONLY

public static final String MARK_NAME_DIFF_ONLY

See Also:

Constant Field Values

MARK_NAME_PIN

public static final String MARK_NAME_PIN

See Also:

Constant Field Values

MARK_NAME_HYPERLINK

public static final String MARK_NAME_HYPERLINK

See Also:

Constant Field Values

MARK_NAME_ADD_ITEMS

public static final String MARK_NAME_ADD_ITEMS

See Also:

Constant Field Values

MARK_NAME_REMOVE_ITEM

public static final String MARK_NAME_REMOVE_ITEM

See Also:

Constant Field Values

SOCKET_INPUT_REFERENCE

protected static final String SOCKET_INPUT_REFERENCE

See Also:

Constant Field Values

SOCKET_INPUT_OBJECTS

protected static final String SOCKET_INPUT_OBJECTS

See Also:

Constant Field Values

SOCKET_INPUT_OBJECTS_REMOVE

protected static final String SOCKET_INPUT_OBJECTS_REMOVE

See Also:

Constant Field Values

SOCKET_INPUT_OBJECTS_ADD

protected static final String SOCKET_INPUT_OBJECTS_ADD

See Also:

Constant Field Values

SOCKET_OUTPUT_SELECTED_ITEM

protected static final String SOCKET_OUTPUT_SELECTED_ITEM

See Also:

Constant Field Values

SOCKET_OUTPUT_ADD_ITEMS_REQUEST

protected static final String SOCKET_OUTPUT_ADD_ITEMS_REQUEST

See Also:

Constant Field Values

SETTING_LAYOUT

protected static final String SETTING_LAYOUT

See Also:

Constant Field Values

SETTING_CONFIGURATION_CONTEXT

protected static final String SETTING_CONFIGURATION_CONTEXT

See Also:

Constant Field Values

SETTING_DEFAULT_TYPE_CODE

protected static final String SETTING_DEFAULT_TYPE_CODE

See Also:

Constant Field Values

LABEL_LOADING

protected static final String LABEL_LOADING

See Also:

Constant Field Values

Constructor Detail

CompareViewController

public CompareViewController()

Method Detail

initialize

public void initialize(org.zkoss.zk.ui.Component comp)

Description copied from class: DefaultWidgetController

Override this method to do initialization stuff for your widget, like initialize widget settings, restore view state from viewmodel, etc. This method will be invoked by DefaultWidgetController.doAfterCompose(Component) everytime your widget view is created. See GenericForwardComposer.doAfterCompose(Component) for more details.

Overrides:

initialize in class DefaultWidgetController

resetView

protected void resetView()

Clears whole view built up till now, invalidates current comparison result and triggers view build from scratch.

revalidateView

protected void revalidateView()

Forces view to validate - new comparison is being performed and whole view is being validated from scratch.

invalidateView

protected void invalidateView()

Marks current view as invalid - future calls to validateView() will trigger full comparison from scratch

validateView

protected void validateView()

Checks if current view reflects data marked for comparison and comparison result. If any comparison is required, then it is triggered in background (non-blocking operation).

addInProgressMarker

protected void addInProgressMarker()

Marks UI component as in progress

createBuildDataOperation

@Deprecated
protected Operation createBuildDataOperation(DefaultComparisonState status)

Deprecated. since 1811. Please use createBuildDataOperation()

createBuildDataOperation

protected Operation createBuildDataOperation()

Creates an operation responsible for performing a partial comparison in background. As a result of this operation a pair <Object, ComparisonResult> is expected with compared object as key and result of comparison as value.

Returns:

operation to be performed in background

handlePartialComparisonResult

protected void handlePartialComparisonResult(DefaultComparisonState state,
                                             org.apache.commons.lang3.tuple.Pair<Object,ComparisonResult> compareObjectIdAndResult)

updateView

protected void updateView(CompareViewData data)

Checks if current view reflects provided comparison data. If any comparison is still required, then it is triggered in background (non-blocking operation).

Parameters:

data - comparison data to validate view against

See Also:

assureComparisonNotFinished(CompareViewData)

updateViewInternal

protected void updateViewInternal(CompareViewData data)
                           throws TypeNotFoundException,
                                  CockpitConfigurationException

Throws:

TypeNotFoundException

CockpitConfigurationException

registerListeners

protected void registerListeners()

registerDiffOnlyListeners

protected void registerDiffOnlyListeners()

handleDiffOnlyChecked

protected void handleDiffOnlyChecked(org.zkoss.zk.ui.HtmlBasedComponent component,
                                     org.zkoss.zk.ui.event.CheckEvent checkEvent)

updateDiffOnlyTrigger

protected void updateDiffOnlyTrigger()

assureComparisonFinished

@Deprecated
protected void assureComparisonFinished(CompareViewData<?> data)

Deprecated. since 1811. Please use assureComparisonNotFinished(CompareViewData)

assureComparisonNotFinished

protected void assureComparisonNotFinished(CompareViewData<?> data)

Checks if any other comparisons are required to meet all data marked for comparison. If so view validation is triggered.

Parameters:

data - comparison data to validate view against

See Also:

validateView()

registerPinEventListeners

protected void registerPinEventListeners()

handlePinClicked

protected void handlePinClicked(Object object)

changeReference

public void changeReference(Object object)

registerHyperlinkEventListeners

protected void registerHyperlinkEventListeners()

handleHyperLinkClicked

protected void handleHyperLinkClicked(Object item)

registerAddItemsListeners

protected void registerAddItemsListeners()

handleAddItemsClicked

protected void handleAddItemsClicked()

registerRemoveItemListeners

protected void registerRemoveItemListeners()

handleRemoveItemClicked

protected void handleRemoveItemClicked(Object item)

createSelectionContext

protected TypeAwareSelectionContext<Object> createSelectionContext(Object selectedItem)

assureReferenceInObjectsList

protected void assureReferenceInObjectsList()

setReferenceObjectImmediately

protected void setReferenceObjectImmediately(Object reference)

getReferenceObject

protected Object getReferenceObject()

getReferenceObjectId

protected Object getReferenceObjectId()

updateItemType

protected void updateItemType()

getItemType

protected String getItemType()

addObjectsToCompare

public void addObjectsToCompare(Collection<Object> objects)

removeObjectsToCompare

public void removeObjectsToCompare(Collection<Object> objects)

objectsUpdated

public void objectsUpdated(CockpitEvent event)

objectsDeleted

public void objectsDeleted(CockpitEvent event)

getView

protected org.zkoss.zul.Div getView()

isValidComparison

protected boolean isValidComparison(ComparisonState<?> status)

isValidViewData

protected boolean isValidViewData(CompareViewData<?> data)

getCurrentViewData

protected CompareViewData getCurrentViewData()

isDiffOnlyEnabled

protected boolean isDiffOnlyEnabled()

updateDiffOnlyState

protected void updateDiffOnlyState(CompareViewData currentData,
                                   boolean diffOnly)

performPartialComparison

protected ComparisonResult performPartialComparison(Object reference,
                                                    Object compareItem)
                                             throws CockpitConfigurationException

Throws:

CockpitConfigurationException

groupDescriptorFromSection

protected GroupDescriptor groupDescriptorFromSection(Section section)

getComparisonStatus

@Deprecated
protected DefaultComparisonState getComparisonStatus()

Deprecated. since 1811. Please use getComparisonState() instead.

getComparisonState

protected DefaultComparisonState getComparisonState()

clearViewData

protected void clearViewData()

clearComparisonStatus

protected void clearComparisonStatus()

updateComparisonStatus

@Deprecated
protected void updateComparisonStatus(DefaultComparisonState<? super Object> comparisonStatus,
                                                  Object comparedObject)

Deprecated. since 1811. Please use updateComparisonState(DefaultComparisonState, Object)

updateComparisonState

protected void updateComparisonState(DefaultComparisonState<? super Object> comparisonState,
                                     Object objectId)

removeInProgressMarker

protected void removeInProgressMarker()

Removes in progress marker from UI component

compareAttributeDescriptorFromQualifier

protected Stream<CompareAttributeDescriptor> compareAttributeDescriptorFromQualifier(String qualifier)

loadConfiguration

protected CompareView loadConfiguration()
                                 throws CockpitConfigurationException

Throws:

CockpitConfigurationException

getObjects

protected List<Object> getObjects()

getObjectIds

protected List<Object> getObjectIds()

getObjectIdsMutable

protected List<Object> getObjectIdsMutable()

setObjects

public void setObjects(Collection<Object> objects)

removeObjectsImmediately

protected void removeObjectsImmediately(Collection<Object> objects)

removeObjectIdsImmediately

protected void removeObjectIdsImmediately(Collection<Object> objects)

setObjectsImmediately

protected void setObjectsImmediately(Collection<Object> objects)

clearObjectsAndIds

protected void clearObjectsAndIds()

addObjectsImmediately

protected void addObjectsImmediately(Collection<Object> objects)

addObjectIdsImmediately

protected void addObjectIdsImmediately(Collection<Object> objects)

updateObjectsImmediately

protected void updateObjectsImmediately(List<Object> changedObjects)

getLayout

protected CompareViewLayout getLayout()

getDefaultLayout

protected CompareViewLayout getDefaultLayout()

setDefaultLayout

public void setDefaultLayout(CompareViewLayout compareViewLayout)

getTypeFacade

protected TypeFacade getTypeFacade()

setTypeFacade

public void setTypeFacade(TypeFacade typeFacade)

getObjectFacade

public ObjectFacade getObjectFacade()

getCockpitConfigurationService

protected CockpitConfigurationService getCockpitConfigurationService()

getItemComparisonFacade

protected ItemComparisonFacade getItemComparisonFacade()

getCockpitLocaleService

protected CockpitLocaleService getCockpitLocaleService()

setCockpitLocaleService

public void setCockpitLocaleService(CockpitLocaleService cockpitLocaleService)

getCockpitUserService

protected CockpitUserService getCockpitUserService()

setCockpitUserService

public void setCockpitUserService(CockpitUserService cockpitUserService)

getWidgetRenderingUtils

protected WidgetRenderingUtils getWidgetRenderingUtils()

setWidgetRenderingUtils

public void setWidgetRenderingUtils(WidgetRenderingUtils widgetRenderingUtils)

getNotificationService

protected NotificationService getNotificationService()

setNotificationService

public void setNotificationService(NotificationService notificationService)

getObjectById

protected Optional<Object> getObjectById(Object id)