com.hybris.cockpitng.widgets.configurableflow

Class ConfigurableFlowController

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.configurableflow.ConfigurableFlowController

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 ConfigurableFlowController
extends DefaultWidgetController

Default ConfigurableFlowController implementation.
There is returned a Map object in ConfigurableFlowResult.data on wizard output. The map contains all persistence object candidates.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTRIBUTE_FLOW
static String	FAILURE_MSG Deprecated. since 6.6
static String	FLOW_CONFIGURATION
static String	FUNCTION_IS_BLANK
static String	FUNCTION_NAME_EMPTY
static String	SCLASS_YW_MODAL_CONFIGURABLEFLOW
static String	SCLASS_YW_MODAL_CONFIGURABLEFLOW_LARGE
static String	SCLASS_YW_MODAL_CONFIGURABLEFLOW_MEDIUM
static String	SCLASS_YW_MODAL_CONFIGURABLEFLOW_SMALL
static String	SETTING_CONFIGURABLE_FLOW_CONFIG_CTX
static String	SOCKET_IN_CONTEXT_TYPE
static String	SOCKET_IN_CTX
static String	SOCKET_WIZARD_RESULT
static String	WIZARD_CONTEXT
static String	WIZARD_CURRENT_CONTEXT

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
ConfigurableFlowController()

Method Summary

Modifier and Type	Method and Description
protected void	addStepOrSubflows(List objects)
protected void	applyWindowSize(Size size)
protected void	assignProperties(List<AssignType> toAssign)
protected boolean	canPerformAction(StepType currentStep, boolean shouldValidate)
protected void	cleanWindowSizeStyling(org.zkoss.zul.Window window)
protected void	clearFailureNotifications() Deprecated. since 6.7, use NotificationService.clearNotifications(String, com.hybris.backoffice.widgets.notificationarea.event.NotificationEvent.Level) instead.
protected void	closeWindow()
protected ValidationContext	createValidationContext(String modelContext)
void	displayConfig(Map<String,Object> context)
void	displayConfig(String contextType)
void	doBack(StepType currentStep)
void	doBeforeComposeChildren(org.zkoss.zk.ui.Component comp)
void	doCancel(StepType currentStep)
void	doCustom(StepType currentStep)
void	doCustom(StepType currentStep, boolean shouldValidate)
void	doCustomPersist(StepType currentStep, boolean shouldValidate)
void	doDone(StepType currentStep)
void	doDone(StepType currentStep, boolean shouldValidate)
protected void	doInitialValidation()
void	doNext(StepType currentStep)
void	doNext(StepType stepType, boolean shouldValidate)
protected ValidationResult	doValidate(List<ValidationInfo> validations)
List<StepType>	getAllSteps()
AttributeDescriptionIconRenderer	getAttributeDescriptionIconRenderer()
org.zkoss.zul.Div	getBreadcrumbDiv()
CockpitConfigurationService	getCockpitConfigurationService()
CockpitLocaleService	getCockpitLocaleService()
CockpitUserService	getCockpitUserService()
protected ConfigurableFlowExpressions	getConfigurableFlowExpressions()
protected ConfigurableFlowLabelService	getConfigurableFlowLabelService()
org.zkoss.zul.Div	getContentDiv()
Object	getCurrentObject(String modelContext)
StepType	getCurrentStep()
String	getCurrentTitle()
ValidationResult	getCurrentValidationResult()
Flow	getFlowConfiguration()
protected List<InitializeType>	getInitializeList()
LabelService	getLabelService()
Set<String>	getModelContexts()
org.zkoss.zul.Div	getMsgAreaDiv()
StepType	getNextStep(StepType currentStep)
protected List<String>	getNonPersistablePropertiesList() List of properties to exclude from persistence
protected NotificationService	getNotificationService()
protected String	getNotificationSource() Deprecated. since 6.7, use NotificationService.getWidgetNotificationSource(WidgetInstanceManager) instead.
ObjectFacade	getObjectFacade()
PermissionFacade	getPermissionFacade()
protected StepType	getPreviousStep(StepType currentStep)
protected Set<String>	getQualifiersForCurrentStep(StepType currentStep)
ConfigurableFlowRenderer	getRenderer()
StepType	getStep(String id)
protected StepType	getTargetStep(StepType currentStep, AbstractActionType clickedButtonConfig, int defaultIndexShift)
protected StepType	getTargetStepType(AbstractActionType clickedButtonConfig)
TypeFacade	getTypeFacade()
ValidationHandler	getValidationHandler()
ConfigurableFlowValidationResultsPopup	getValidationViolationsPopup()
<T> T	getValue(String key, Class<T> expectedClass)
protected Set<String>	getViewTypeValidationProperties(ViewType viewType)
WidgetInstanceFacade	getWidgetInstanceFacade() Deprecated. since 6.7, not used anymore
void	handleObjectDeletedEvent(CockpitEvent event)
void	handleObjectsUpdatedEvent(CockpitEvent event)
protected void	handleUpdate(CockpitEvent event)
protected void	hideValidationPopUp()
protected void	initConfigurableFlowRenderer()
protected void	initFlow(Flow flow)
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	initializeContext()
protected void	initializeLocalizedProperty(String property, String lang, String valueExpression)
protected void	initializeObjectFromTemplateBean(String property, String templateBean)
protected void	initializeProperty(String property, String type, String valueExpression)
protected boolean	isTemplate()
void	jumpToStep(StepType stepType)
protected boolean	persistProperties(AbstractActionType actionType)
protected Object	persistWidgetProperty(String property)
protected void	prefillContext(Map<String,Object> context)
protected void	prepareValidationResultModel()
protected void	prepareValidationResultsPopup(org.zkoss.zk.ui.Component parent)
protected void	setCurrentStep(StepType step)
void	setValidationViolationsPopup(ConfigurableFlowValidationResultsPopup validationViolationsPopup)
protected void	showFailureNotification(ObjectSavingException failureException)
protected void	showSuccessNotification(Object persistedObject)
protected void	showValidationPopUp()
void	updateNavigation()
protected void	updateWidgetTitle()
protected ValidationResult	validateCurrentObject()
protected ValidationResult	validateProperties(Set<String> fullPathQualifiers)
protected boolean	validationPassed(ValidationResult validationResult)

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

doAfterCompose, doBeforeCompose, executeOperation, getDragAndDropStrategy, getLabel, getLabel, getModel, 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

ATTRIBUTE_FLOW

public static final String ATTRIBUTE_FLOW

See Also:

Constant Field Values

WIZARD_CONTEXT

public static final String WIZARD_CONTEXT

See Also:

Constant Field Values

WIZARD_CURRENT_CONTEXT

public static final String WIZARD_CURRENT_CONTEXT

See Also:

Constant Field Values

SOCKET_IN_CTX

public static final String SOCKET_IN_CTX

See Also:

Constant Field Values

SOCKET_IN_CONTEXT_TYPE

public static final String SOCKET_IN_CONTEXT_TYPE

See Also:

Constant Field Values

SOCKET_WIZARD_RESULT

public static final String SOCKET_WIZARD_RESULT

See Also:

Constant Field Values

FUNCTION_NAME_EMPTY

public static final String FUNCTION_NAME_EMPTY

See Also:

Constant Field Values

FUNCTION_IS_BLANK

public static final String FUNCTION_IS_BLANK

See Also:

Constant Field Values

SCLASS_YW_MODAL_CONFIGURABLEFLOW

public static final String SCLASS_YW_MODAL_CONFIGURABLEFLOW

See Also:

Constant Field Values

SCLASS_YW_MODAL_CONFIGURABLEFLOW_SMALL

public static final String SCLASS_YW_MODAL_CONFIGURABLEFLOW_SMALL

See Also:

Constant Field Values

SCLASS_YW_MODAL_CONFIGURABLEFLOW_MEDIUM

public static final String SCLASS_YW_MODAL_CONFIGURABLEFLOW_MEDIUM

See Also:

Constant Field Values

SCLASS_YW_MODAL_CONFIGURABLEFLOW_LARGE

public static final String SCLASS_YW_MODAL_CONFIGURABLEFLOW_LARGE

See Also:

Constant Field Values

SETTING_CONFIGURABLE_FLOW_CONFIG_CTX

public static final String SETTING_CONFIGURABLE_FLOW_CONFIG_CTX

See Also:

Constant Field Values

FAILURE_MSG

@Deprecated
public static final String FAILURE_MSG

Deprecated. since 6.6

See Also:

Constant Field Values

FLOW_CONFIGURATION

public static final String FLOW_CONFIGURATION

See Also:

Constant Field Values

Constructor Detail

ConfigurableFlowController

public ConfigurableFlowController()

Method Detail

doBeforeComposeChildren

public void doBeforeComposeChildren(org.zkoss.zk.ui.Component comp)
                             throws Exception

Specified by:

doBeforeComposeChildren in interface org.zkoss.zk.ui.util.ComposerExt<org.zkoss.zk.ui.Component>

Overrides:

doBeforeComposeChildren in class DefaultWidgetController

Throws:

Exception

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

handleObjectsUpdatedEvent

public void handleObjectsUpdatedEvent(CockpitEvent event)

handleUpdate

protected void handleUpdate(CockpitEvent event)

handleObjectDeletedEvent

public void handleObjectDeletedEvent(CockpitEvent event)

displayConfig

public void displayConfig(String contextType)

displayConfig

public void displayConfig(Map<String,Object> context)

applyWindowSize

protected void applyWindowSize(Size size)

cleanWindowSizeStyling

protected void cleanWindowSizeStyling(org.zkoss.zul.Window window)

doInitialValidation

protected void doInitialValidation()

initFlow

protected void initFlow(Flow flow)

assignProperties

protected void assignProperties(List<AssignType> toAssign)

getAllSteps

public List<StepType> getAllSteps()

getCurrentTitle

public String getCurrentTitle()

getCurrentStep

public StepType getCurrentStep()

setCurrentStep

protected void setCurrentStep(StepType step)

updateNavigation

public void updateNavigation()

getStep

public StepType getStep(String id)

getNextStep

public StepType getNextStep(StepType currentStep)

doNext

public void doNext(StepType stepType,
                   boolean shouldValidate)

doNext

public void doNext(StepType currentStep)

persistProperties

protected boolean persistProperties(AbstractActionType actionType)

canPerformAction

protected boolean canPerformAction(StepType currentStep,
                                   boolean shouldValidate)

getQualifiersForCurrentStep

protected Set<String> getQualifiersForCurrentStep(StepType currentStep)

getViewTypeValidationProperties

protected Set<String> getViewTypeValidationProperties(ViewType viewType)

doCustomPersist

public void doCustomPersist(StepType currentStep,
                            boolean shouldValidate)

doCustom

public void doCustom(StepType currentStep,
                     boolean shouldValidate)

doCustom

public void doCustom(StepType currentStep)

doBack

public void doBack(StepType currentStep)

getPreviousStep

protected StepType getPreviousStep(StepType currentStep)

getTargetStep

protected StepType getTargetStep(StepType currentStep,
                                 AbstractActionType clickedButtonConfig,
                                 int defaultIndexShift)

getTargetStepType

protected StepType getTargetStepType(AbstractActionType clickedButtonConfig)

doCancel

public void doCancel(StepType currentStep)

doDone

public void doDone(StepType currentStep,
                   boolean shouldValidate)

doDone

public void doDone(StepType currentStep)

validationPassed

protected boolean validationPassed(ValidationResult validationResult)

showSuccessNotification

protected void showSuccessNotification(Object persistedObject)

getNotificationSource

@Deprecated
protected String getNotificationSource()

Deprecated. since 6.7, use NotificationService.getWidgetNotificationSource(WidgetInstanceManager) instead.

showFailureNotification

protected void showFailureNotification(ObjectSavingException failureException)

clearFailureNotifications

@Deprecated
protected void clearFailureNotifications()

Deprecated. since 6.7, use NotificationService.clearNotifications(String, com.hybris.backoffice.widgets.notificationarea.event.NotificationEvent.Level) instead.

addStepOrSubflows

protected void addStepOrSubflows(List objects)

initializeContext

protected void initializeContext()

prefillContext

protected void prefillContext(Map<String,Object> context)

initializeLocalizedProperty

protected void initializeLocalizedProperty(String property,
                                           String lang,
                                           String valueExpression)

initializeProperty

protected void initializeProperty(String property,
                                  String type,
                                  String valueExpression)

initializeObjectFromTemplateBean

protected void initializeObjectFromTemplateBean(String property,
                                                String templateBean)

persistWidgetProperty

protected Object persistWidgetProperty(String property)
                                throws ObjectSavingException

Throws:

ObjectSavingException

closeWindow

protected void closeWindow()

isTemplate

protected boolean isTemplate()

updateWidgetTitle

protected void updateWidgetTitle()

initConfigurableFlowRenderer

protected void initConfigurableFlowRenderer()

getRenderer

public ConfigurableFlowRenderer getRenderer()

getConfigurableFlowLabelService

protected ConfigurableFlowLabelService getConfigurableFlowLabelService()

getInitializeList

protected List<InitializeType> getInitializeList()

getNonPersistablePropertiesList

protected List<String> getNonPersistablePropertiesList()

List of properties to exclude from persistence

Returns:

list of non-persistable properties

getConfigurableFlowExpressions

protected ConfigurableFlowExpressions getConfigurableFlowExpressions()

getCockpitConfigurationService

public CockpitConfigurationService getCockpitConfigurationService()

getWidgetInstanceFacade

@Deprecated
public WidgetInstanceFacade getWidgetInstanceFacade()

Deprecated. since 6.7, not used anymore

getObjectFacade

public ObjectFacade getObjectFacade()

getLabelService

public LabelService getLabelService()

getContentDiv

public org.zkoss.zul.Div getContentDiv()

getBreadcrumbDiv

public org.zkoss.zul.Div getBreadcrumbDiv()

getMsgAreaDiv

public org.zkoss.zul.Div getMsgAreaDiv()

getCockpitLocaleService

public CockpitLocaleService getCockpitLocaleService()

getCockpitUserService

public CockpitUserService getCockpitUserService()

getTypeFacade

public TypeFacade getTypeFacade()

getPermissionFacade

public PermissionFacade getPermissionFacade()

getAttributeDescriptionIconRenderer

public AttributeDescriptionIconRenderer getAttributeDescriptionIconRenderer()

getValidationHandler

public ValidationHandler getValidationHandler()

validateCurrentObject

protected ValidationResult validateCurrentObject()

validateProperties

protected ValidationResult validateProperties(Set<String> fullPathQualifiers)

doValidate

protected ValidationResult doValidate(List<ValidationInfo> validations)

hideValidationPopUp

protected void hideValidationPopUp()

showValidationPopUp

protected void showValidationPopUp()

createValidationContext

protected ValidationContext createValidationContext(String modelContext)

getCurrentValidationResult

public ValidationResult getCurrentValidationResult()

getCurrentObject

public Object getCurrentObject(String modelContext)

getValue

public <T> T getValue(String key,
                      Class<T> expectedClass)

Overrides:

getValue in class DefaultWidgetController

prepareValidationResultModel

protected void prepareValidationResultModel()

prepareValidationResultsPopup

protected void prepareValidationResultsPopup(org.zkoss.zk.ui.Component parent)

getFlowConfiguration

public Flow getFlowConfiguration()

getModelContexts

public Set<String> getModelContexts()

getValidationViolationsPopup

public ConfigurableFlowValidationResultsPopup getValidationViolationsPopup()

setValidationViolationsPopup

public void setValidationViolationsPopup(ConfigurableFlowValidationResultsPopup validationViolationsPopup)

jumpToStep

public void jumpToStep(StepType stepType)

getNotificationService

protected NotificationService getNotificationService()