Package com.hybris.cockpitng.widgets.configurableflow

Class ConfigurableFlowController

  • All Implemented Interfaces:
    WidgetController, WidgetDragAndDropAware, WidgetInstanceManagerAware, java.io.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 Detail

      • WIZARD_CURRENT_CONTEXT

        public static final java.lang.String WIZARD_CURRENT_CONTEXT
        See Also:
        Constant Field Values

      • SOCKET_IN_CONTEXT_TYPE

        public static final java.lang.String SOCKET_IN_CONTEXT_TYPE
        See Also:
        Constant Field Values

      • SOCKET_WIZARD_RESULT

        public static final java.lang.String SOCKET_WIZARD_RESULT
        See Also:
        Constant Field Values

      • FUNCTION_NAME_EMPTY

        public static final java.lang.String FUNCTION_NAME_EMPTY
        See Also:
        Constant Field Values

      • FUNCTION_IS_BLANK

        public static final java.lang.String FUNCTION_IS_BLANK
        See Also:
        Constant Field Values

      • SCLASS_YW_MODAL_CONFIGURABLEFLOW

        public static final java.lang.String SCLASS_YW_MODAL_CONFIGURABLEFLOW
        See Also:
        Constant Field Values

      • SCLASS_YW_MODAL_CONFIGURABLEFLOW_SMALL

        public static final java.lang.String SCLASS_YW_MODAL_CONFIGURABLEFLOW_SMALL
        See Also:
        Constant Field Values

      • SCLASS_YW_MODAL_CONFIGURABLEFLOW_MEDIUM

        public static final java.lang.String SCLASS_YW_MODAL_CONFIGURABLEFLOW_MEDIUM
        See Also:
        Constant Field Values

      • SCLASS_YW_MODAL_CONFIGURABLEFLOW_LARGE

        public static final java.lang.String SCLASS_YW_MODAL_CONFIGURABLEFLOW_LARGE
        See Also:
        Constant Field Values

      • SETTING_CONFIGURABLE_FLOW_CONFIG_CTX

        public static final java.lang.String SETTING_CONFIGURABLE_FLOW_CONFIG_CTX
        See Also:
        Constant Field Values

      • FLOW_CONFIGURATION

        public static final java.lang.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 java.lang.Exception
        Specified by:
        doBeforeComposeChildren in interface org.zkoss.zk.ui.util.ComposerExt<org.zkoss.zk.ui.Component>
        Overrides:
        doBeforeComposeChildren in class DefaultWidgetController
        Throws:
        java.lang.Exception

      • initializeDelegateController

        protected void initializeDelegateController()

      • handleObjectsUpdatedEvent

        public void handleObjectsUpdatedEvent​(CockpitEvent event)

      • handleUpdate

        protected void handleUpdate​(CockpitEvent event)

      • handleObjectDeletedEvent

        public void handleObjectDeletedEvent​(CockpitEvent event)

      • displayConfig

        public void displayConfig​(java.lang.String contextType)

      • displayConfig

        public void displayConfig​(java.util.Map<java.lang.String,​java.lang.Object> context)

      • registerListeners

        protected void registerListeners()

      • applyWindowSize

        protected void applyWindowSize​(Size size)

      • cleanWindowSizeStyling

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

      • doInitialValidation

        protected void doInitialValidation()

      • doInitialValidationOnFirstWizardDisplay

        protected void doInitialValidationOnFirstWizardDisplay()

      • initFlow

        protected void initFlow​(Flow flow)

      • assignProperties

        protected void assignProperties​(java.util.List<AssignType> toAssign)

      • getAllSteps

        public java.util.List<StepType> getAllSteps()

      • getCurrentTitle

        public java.lang.String getCurrentTitle()

      • getCurrentStep

        public StepType getCurrentStep()

      • setCurrentStep

        protected void setCurrentStep​(StepType step)

      • updateNavigation

        public void updateNavigation()

      • getStep

        public StepType getStep​(java.lang.String id)

      • doNext

        public void doNext​(StepType stepType,
                   boolean shouldValidate)

      • doNext

        public void doNext​(StepType currentStep)

      • canPerformAction

        protected boolean canPerformAction​(StepType currentStep,
                                   boolean shouldValidate)

      • getQualifiersForAllSteps

        public java.util.Collection<LocalizedQualifier> getQualifiersForAllSteps()

      • getQualifiersWithLocalesForCurrentStep

        protected java.util.Collection<LocalizedQualifier> getQualifiersWithLocalesForCurrentStep​(StepType currentStep)

      • getQualifiersForCurrentStep

        @Deprecated(since="1811",
            forRemoval=true)
protected java.util.Set<java.lang.String> getQualifiersForCurrentStep​(StepType currentStep)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 1811, use getQualifiersWithLocalesForCurrentStep(StepType) instead

      • getViewTypeValidationPropertiesWithLocales

        protected java.util.Collection<LocalizedQualifier> getViewTypeValidationPropertiesWithLocales​(ViewType viewType)

      • getValidationPropertiesWithLocalesFromCustomRenderer

        protected java.util.Collection<LocalizedQualifier> getValidationPropertiesWithLocalesFromCustomRenderer​(Renderer customRenderer)

      • getSpringBean

        protected java.lang.Object getSpringBean​(java.lang.String handler)

      • getViewTypeValidationProperties

        @Deprecated(since="1811",
            forRemoval=true)
protected java.util.Set<java.lang.String> getViewTypeValidationProperties​(ViewType viewType)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 1811, use getViewTypeValidationPropertiesWithLocales(ViewType) instead

      • doCustomPersist

        public void doCustomPersist​(StepType currentStep,
                            boolean shouldValidate)

      • validateCustomStep

        public boolean validateCustomStep​(StepType currentStep)

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

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

      • addStepOrSubflows

        protected void addStepOrSubflows​(java.util.List objects)

      • initializeContext

        protected void initializeContext()

      • prefillContext

        protected void prefillContext​(java.util.Map<java.lang.String,​java.lang.Object> context)

      • initializeLocalizedProperty

        protected void initializeLocalizedProperty​(java.lang.String property,
                                           java.lang.String lang,
                                           java.lang.String valueExpression)

      • initializeProperty

        protected void initializeProperty​(java.lang.String property,
                                  java.lang.String type,
                                  java.lang.String valueExpression)

      • initializeObjectFromTemplateBean

        protected void initializeObjectFromTemplateBean​(java.lang.String property,
                                                java.lang.String templateBean)

      • closeWindow

        protected void closeWindow()

      • isTemplate

        protected boolean isTemplate()

      • updateWidgetTitle

        protected void updateWidgetTitle()

      • initConfigurableFlowRenderer

        protected void initConfigurableFlowRenderer()

      • getInitializeList

        public java.util.List<InitializeType> getInitializeList()

      • getNonPersistablePropertiesList

        public java.util.List<java.lang.String> getNonPersistablePropertiesList()
        List of properties to exclude from persistence
        Returns:
        list of non-persistable properties

      • getContentDiv

        public org.zkoss.zul.Div getContentDiv()

      • getBreadcrumbDiv

        public org.zkoss.zul.Div getBreadcrumbDiv()

      • getMsgAreaDiv

        public org.zkoss.zul.Div getMsgAreaDiv()

      • getTypeFacade

        public TypeFacade getTypeFacade()

      • cutOffLocalizationInPropertyPath

        protected java.lang.String cutOffLocalizationInPropertyPath​(java.lang.String propertyPath)

      • collectValidationInfosForCurrentObject

        protected java.util.List<ValidationInfo> collectValidationInfosForCurrentObject()

      • validateProperties

        @Deprecated(since="1811",
            forRemoval=true)
protected ValidationResult validateProperties​(java.util.Set<java.lang.String> fullPathQualifiers)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 1811, use validateProperties(Collection) instead

      • hideValidationPopUp

        protected void hideValidationPopUp()

      • showValidationPopUp

        protected void showValidationPopUp()

      • createValidationContext

        protected ValidationContext createValidationContext​(java.lang.String modelContext)

      • getCurrentValidationResult

        public ValidationResult getCurrentValidationResult()

      • getCurrentObject

        public java.lang.Object getCurrentObject​(java.lang.String modelContext)

      • prepareValidationResultModel

        protected void prepareValidationResultModel()

      • prepareValidationResultsPopup

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

      • getFlowConfiguration

        public Flow getFlowConfiguration()

      • getModelContexts

        public java.util.Set<java.lang.String> getModelContexts()

      • jumpToStep

        public void jumpToStep​(StepType stepType)