Class ConfigurableFlowRenderer
- java.lang.Object
-
- com.hybris.cockpitng.widgets.configurableflow.renderer.ConfigurableFlowRenderer
-
public class ConfigurableFlowRenderer extends java.lang.ObjectConfigurable Flow renderer
-
-
Field Summary
Fields Modifier and Type Field Description protected ConfigurableFlowExpressionscfExpressionsstatic java.lang.StringCURRENT_OBJECTstatic intHUNDRED_PERCENTstatic java.lang.StringHUNDRED_PERCENT_Sstatic java.lang.StringIS_NESTED_OBJECT_CREATION_DISABLED_SETTINGprotected static java.lang.StringNO_READ_ACCESSstatic java.lang.StringON_FORCE_UPDATEstatic java.lang.StringSCLASS_COMPONENT_WRAPPERstatic java.lang.StringSEPARATORprotected booleanshowBreadcrumbstatic java.lang.StringSTEP_ID_ATTRIBUTEstatic java.lang.StringSTEP_INITIALIZEDstatic java.lang.StringWIZARD_PREFIXstatic java.lang.StringWIZARD_RESULT_MSG_FAIL_TILEstatic java.lang.StringWIZARD_RESULT_MSG_SUCCESS_TILEstatic java.lang.StringWIZARD_RESULT_MSG_TEXTstatic java.lang.StringWIZARD_RESULT_MSG_TITLEstatic java.lang.StringWIZARD_STYLE_ACTIVEstatic java.lang.StringWIZARD_STYLE_AFTERstatic java.lang.StringWIZARD_STYLE_BEFOREstatic java.lang.StringWIZARD_STYLE_BR_ARROWstatic java.lang.StringWIZARD_STYLE_BR_LABELstatic java.lang.StringWIZARD_STYLE_BR_PREFIXstatic java.lang.StringWIZARD_STYLE_BR_S_LABELstatic java.lang.StringWIZARD_STYLE_BR_SPstatic java.lang.StringWIZARD_STYLE_BR_SP_ARROWstatic java.lang.StringWIZARD_STYLE_BTN_BLUEstatic java.lang.StringWIZARD_STYLE_COLUMN_CONTENTstatic java.lang.StringWIZARD_STYLE_CONTENTstatic java.lang.StringWIZARD_STYLE_INFOstatic java.lang.StringWIZARD_STYLE_LAYOUTstatic java.lang.StringWIZARD_STYLE_LEFTstatic java.lang.StringWIZARD_STYLE_LEFT_PACKstatic java.lang.StringWIZARD_STYLE_NAVIstatic java.lang.StringWIZARD_STYLE_NONEstatic java.lang.StringWIZARD_STYLE_PROPERTYstatic java.lang.StringWIZARD_STYLE_PROPERTY_LABELstatic java.lang.StringWIZARD_STYLE_PROPERTY_LABEL_MANDATORYstatic java.lang.StringWIZARD_STYLE_READ_ONLY_VALUEstatic java.lang.StringWIZARD_STYLE_RIGHTstatic java.lang.StringWIZARD_STYLE_RIGHT_PACKstatic java.lang.StringWIZARD_STYLE_TOPstatic java.lang.StringWIZARD_STYLE_Z_INDEXstatic java.lang.StringZUL
-
Constructor Summary
Constructors Constructor Description ConfigurableFlowRenderer()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected voidapplyComponentsVisitor()protected voidapplyVisibilityRestriction(org.zkoss.zk.ui.Component component, AbstractActionType actionType)protected EditorbuildEditor(EditorBuilder editorBuilder, WidgetInstanceManager widgetInstanceManager)voidcleanUpRendererObservers()voidclearMessages()protected FlowActionHandlerAdaptercreateActionHandlerAdapter(StepType currentStep, org.zkoss.zk.ui.event.Event event)protected org.zkoss.zul.ButtoncreateAndAppendButton(org.zkoss.zk.ui.Component buttonsContainer, java.lang.String labelKey, StepType currentStep, AbstractActionType actionType, java.lang.String actionId)protected org.zkoss.zk.ui.HtmlBasedComponentcreateBreadcrumbEntry(StepType step)protected org.zkoss.zk.ui.ComponentcreatePropertyLine(java.lang.String prefix, PropertyType property)voiddoCustom(StepType currentStep, CustomType customType)Calls custom step handler.voiddoCustom(StepType currentStep, CustomType customType, java.util.Map<java.lang.String,ComposedHandlerType> composedHandlers)Calls custom step handler.protected java.lang.StringextractTypeQualifier(java.lang.String qualifier)protected java.lang.StringfindHandlerBean(ComposedHandlerType composedHandler, CustomType customType)java.util.List<java.util.Locale>getActiveLocales()protected java.util.List<StepType>getAllSteps()AttributeDescriptionIconRenderergetAttributeDescriptionIconRenderer()org.zkoss.zul.DivgetBreadcrumbDiv()CockpitLocaleServicegetCockpitLocaleService()CockpitUserServicegetCockpitUserService()ConfigurableFlowLabelServicegetConfigurableFlowLabelService()org.zkoss.zul.DivgetContentDiv()LabelServicegetLabelService()org.zkoss.zul.DivgetMsgAreaDiv()org.zkoss.zul.DivgetNavigationDiv()protected NotificationServicegetNotificationService()PermissionFacadegetPermissionFacade()protected java.lang.StringgetPropertyDescription(java.lang.String attributeDataDescription, PropertyType propertyType)protected StepTypegetStep(java.lang.String id)TransitionListenerFactorygetTransitionListenerFactory()protected java.lang.StringgetTypeCodeFromWizardCtx()TypeFacadegetTypeFacade()ValidationHandlergetValidationHandler()WidgetInstanceManagergetWidgetInstanceManager()protected booleanisAttributeWritable(DataAttribute attributeData, java.lang.String normalizedQualifier, java.lang.String normalizedTypeQualifier)protected booleanisNestedObjectCreationDisabled()protected java.lang.BooleanisNestedObjectCreationDisabled(java.util.List<Parameter> editorParameter)booleanisShowBreadcrumb()protected booleanisStepChangePossible(StepType currentStep, StepType targetStep)protected booleanisTypeLocalized(PropertyType property)protected DataTypeloadDataType(java.lang.Object currentObject)protected java.lang.StringnormalizePropertyQualifier(java.lang.String prefix, PropertyType property)protected java.lang.StringnormalizeQualifier(java.lang.String propertyQualifier)protected org.zkoss.zk.ui.ComponentprepareErrorRow(java.lang.String label)voidrefreshView()protected voidrefreshView(org.zkoss.zk.ui.Component comp)protected voidrenderBreadcrumb(StepType currentStep, java.util.List<StepType> stepList)protected voidrenderContent(org.zkoss.zk.ui.Component parent, ContentType content)voidrenderCurrentStep(StepType currentStep)protected java.lang.StringresolveType(DataAttribute attributeData)voidsetActiveLocales(java.util.List<java.util.Locale> activeLocales)voidsetAllSteps(java.util.List<StepType> allSteps)voidsetAttributeDescriptionIconRenderer(AttributeDescriptionIconRenderer attributeDescriptionIconRenderer)voidsetBreadcrumbDiv(org.zkoss.zul.Div breadcrumbDiv)voidsetCockpitLocaleService(CockpitLocaleService cockpitLocaleService)voidsetCockpitUserService(CockpitUserService cockpitUserService)voidsetComponentsVisitorFactory(ComponentsVisitorFactory componentsVisitorFactory)voidsetConfigurableFlowLabelService(ConfigurableFlowLabelService configurableFlowLabelService)voidsetContentDiv(org.zkoss.zul.Div contentDiv)voidsetEditorChangeListener(EditorChangeListener editorChangeListener)voidsetLabelService(LabelService labelService)voidsetMsgAreaDiv(org.zkoss.zul.Div msgAreaDiv)voidsetNotificationService(NotificationService notificationService)voidsetPermissionFacade(PermissionFacade permissionFacade)voidsetShowBreadcrumb(boolean showBreadcrumb)voidsetTransitionListenerFactory(TransitionListenerFactory transitionListenerFactory)voidsetTypeFacade(TypeFacade typeFacade)voidsetValidatableContainer(ValidatableContainer validatableContainer)voidsetValidationHandler(ValidationHandler validationHandler)voidsetValidationRenderer(ValidationRenderer validationRenderer)voidsetValidationResultsPopup(ConfigurableFlowValidationResultsPopup validationResultsPopup)voidsetWidgetInstanceManager(WidgetInstanceManager widgetInstanceManager)protected voidtoggleButtonActiveState(org.zkoss.zul.Button button, AbstractActionType actionType)protected voidunregisterComponentsFromVisitor()voidupdateNavigation()voidupdateNavigation(StepType currentStep)Deprecated, for removal: This API element is subject to removal in a future version.since 2005protected voidwrapChildAndAppend(org.zkoss.zk.ui.Component parent, org.zkoss.zk.ui.Component child)
-
-
-
Field Detail
-
WIZARD_STYLE_BR_LABEL
public static final java.lang.String WIZARD_STYLE_BR_LABEL
- See Also:
- Constant Field Values
-
WIZARD_STYLE_BR_S_LABEL
public static final java.lang.String WIZARD_STYLE_BR_S_LABEL
- See Also:
- Constant Field Values
-
WIZARD_STYLE_BR_SP
public static final java.lang.String WIZARD_STYLE_BR_SP
- See Also:
- Constant Field Values
-
WIZARD_STYLE_BR_SP_ARROW
public static final java.lang.String WIZARD_STYLE_BR_SP_ARROW
- See Also:
- Constant Field Values
-
WIZARD_STYLE_BR_ARROW
public static final java.lang.String WIZARD_STYLE_BR_ARROW
- See Also:
- Constant Field Values
-
WIZARD_STYLE_BR_PREFIX
public static final java.lang.String WIZARD_STYLE_BR_PREFIX
- See Also:
- Constant Field Values
-
WIZARD_STYLE_BEFORE
public static final java.lang.String WIZARD_STYLE_BEFORE
- See Also:
- Constant Field Values
-
WIZARD_STYLE_ACTIVE
public static final java.lang.String WIZARD_STYLE_ACTIVE
- See Also:
- Constant Field Values
-
WIZARD_STYLE_AFTER
public static final java.lang.String WIZARD_STYLE_AFTER
- See Also:
- Constant Field Values
-
WIZARD_STYLE_Z_INDEX
public static final java.lang.String WIZARD_STYLE_Z_INDEX
- See Also:
- Constant Field Values
-
WIZARD_STYLE_LAYOUT
public static final java.lang.String WIZARD_STYLE_LAYOUT
- See Also:
- Constant Field Values
-
WIZARD_STYLE_CONTENT
public static final java.lang.String WIZARD_STYLE_CONTENT
- See Also:
- Constant Field Values
-
WIZARD_STYLE_COLUMN_CONTENT
public static final java.lang.String WIZARD_STYLE_COLUMN_CONTENT
- See Also:
- Constant Field Values
-
WIZARD_STYLE_INFO
public static final java.lang.String WIZARD_STYLE_INFO
- See Also:
- Constant Field Values
-
WIZARD_STYLE_NAVI
public static final java.lang.String WIZARD_STYLE_NAVI
- See Also:
- Constant Field Values
-
WIZARD_STYLE_LEFT_PACK
public static final java.lang.String WIZARD_STYLE_LEFT_PACK
- See Also:
- Constant Field Values
-
WIZARD_STYLE_RIGHT_PACK
public static final java.lang.String WIZARD_STYLE_RIGHT_PACK
- See Also:
- Constant Field Values
-
WIZARD_STYLE_BTN_BLUE
public static final java.lang.String WIZARD_STYLE_BTN_BLUE
- See Also:
- Constant Field Values
-
WIZARD_STYLE_PROPERTY
public static final java.lang.String WIZARD_STYLE_PROPERTY
- See Also:
- Constant Field Values
-
WIZARD_STYLE_PROPERTY_LABEL
public static final java.lang.String WIZARD_STYLE_PROPERTY_LABEL
- See Also:
- Constant Field Values
-
WIZARD_STYLE_PROPERTY_LABEL_MANDATORY
public static final java.lang.String WIZARD_STYLE_PROPERTY_LABEL_MANDATORY
- See Also:
- Constant Field Values
-
WIZARD_STYLE_READ_ONLY_VALUE
public static final java.lang.String WIZARD_STYLE_READ_ONLY_VALUE
- See Also:
- Constant Field Values
-
WIZARD_STYLE_NONE
public static final java.lang.String WIZARD_STYLE_NONE
- See Also:
- Constant Field Values
-
WIZARD_STYLE_LEFT
public static final java.lang.String WIZARD_STYLE_LEFT
- See Also:
- Constant Field Values
-
WIZARD_STYLE_RIGHT
public static final java.lang.String WIZARD_STYLE_RIGHT
- See Also:
- Constant Field Values
-
WIZARD_STYLE_TOP
public static final java.lang.String WIZARD_STYLE_TOP
- See Also:
- Constant Field Values
-
WIZARD_RESULT_MSG_SUCCESS_TILE
public static final java.lang.String WIZARD_RESULT_MSG_SUCCESS_TILE
- See Also:
- Constant Field Values
-
WIZARD_RESULT_MSG_FAIL_TILE
public static final java.lang.String WIZARD_RESULT_MSG_FAIL_TILE
- See Also:
- Constant Field Values
-
WIZARD_RESULT_MSG_TITLE
public static final java.lang.String WIZARD_RESULT_MSG_TITLE
- See Also:
- Constant Field Values
-
WIZARD_RESULT_MSG_TEXT
public static final java.lang.String WIZARD_RESULT_MSG_TEXT
- See Also:
- Constant Field Values
-
ZUL
public static final java.lang.String ZUL
- See Also:
- Constant Field Values
-
HUNDRED_PERCENT_S
public static final java.lang.String HUNDRED_PERCENT_S
- See Also:
- Constant Field Values
-
WIZARD_PREFIX
public static final java.lang.String WIZARD_PREFIX
- See Also:
- Constant Field Values
-
SEPARATOR
public static final java.lang.String SEPARATOR
- See Also:
- Constant Field Values
-
HUNDRED_PERCENT
public static final int HUNDRED_PERCENT
- See Also:
- Constant Field Values
-
CURRENT_OBJECT
public static final java.lang.String CURRENT_OBJECT
- See Also:
- Constant Field Values
-
IS_NESTED_OBJECT_CREATION_DISABLED_SETTING
public static final java.lang.String IS_NESTED_OBJECT_CREATION_DISABLED_SETTING
- See Also:
- Constant Field Values
-
STEP_INITIALIZED
public static final java.lang.String STEP_INITIALIZED
- See Also:
- Constant Field Values
-
STEP_ID_ATTRIBUTE
public static final java.lang.String STEP_ID_ATTRIBUTE
- See Also:
- Constant Field Values
-
SCLASS_COMPONENT_WRAPPER
public static final java.lang.String SCLASS_COMPONENT_WRAPPER
- See Also:
- Constant Field Values
-
NO_READ_ACCESS
protected static final java.lang.String NO_READ_ACCESS
- See Also:
- Constant Field Values
-
ON_FORCE_UPDATE
public static final java.lang.String ON_FORCE_UPDATE
- See Also:
- Constant Field Values
-
cfExpressions
protected final ConfigurableFlowExpressions cfExpressions
-
showBreadcrumb
protected boolean showBreadcrumb
-
-
Method Detail
-
setValidatableContainer
public void setValidatableContainer(ValidatableContainer validatableContainer)
-
setEditorChangeListener
public void setEditorChangeListener(EditorChangeListener editorChangeListener)
-
getActiveLocales
public java.util.List<java.util.Locale> getActiveLocales()
-
setActiveLocales
public void setActiveLocales(java.util.List<java.util.Locale> activeLocales)
-
createPropertyLine
protected org.zkoss.zk.ui.Component createPropertyLine(java.lang.String prefix, PropertyType property)
-
buildEditor
protected Editor buildEditor(EditorBuilder editorBuilder, WidgetInstanceManager widgetInstanceManager)
-
isTypeLocalized
protected boolean isTypeLocalized(PropertyType property)
-
isNestedObjectCreationDisabled
protected java.lang.Boolean isNestedObjectCreationDisabled(java.util.List<Parameter> editorParameter)
-
prepareErrorRow
protected org.zkoss.zk.ui.Component prepareErrorRow(java.lang.String label)
-
isNestedObjectCreationDisabled
protected boolean isNestedObjectCreationDisabled()
-
isAttributeWritable
protected boolean isAttributeWritable(DataAttribute attributeData, java.lang.String normalizedQualifier, java.lang.String normalizedTypeQualifier)
-
resolveType
protected java.lang.String resolveType(DataAttribute attributeData)
-
normalizeQualifier
protected java.lang.String normalizeQualifier(java.lang.String propertyQualifier)
-
normalizePropertyQualifier
protected java.lang.String normalizePropertyQualifier(java.lang.String prefix, PropertyType property)
-
loadDataType
protected DataType loadDataType(java.lang.Object currentObject)
-
extractTypeQualifier
protected java.lang.String extractTypeQualifier(java.lang.String qualifier)
-
createBreadcrumbEntry
protected org.zkoss.zk.ui.HtmlBasedComponent createBreadcrumbEntry(StepType step)
-
renderBreadcrumb
protected void renderBreadcrumb(StepType currentStep, java.util.List<StepType> stepList)
-
isStepChangePossible
protected boolean isStepChangePossible(StepType currentStep, StepType targetStep)
-
renderCurrentStep
public void renderCurrentStep(StepType currentStep)
-
applyComponentsVisitor
protected void applyComponentsVisitor()
-
unregisterComponentsFromVisitor
protected void unregisterComponentsFromVisitor()
-
cleanUpRendererObservers
public void cleanUpRendererObservers()
-
getTypeCodeFromWizardCtx
protected java.lang.String getTypeCodeFromWizardCtx()
-
renderContent
protected void renderContent(org.zkoss.zk.ui.Component parent, ContentType content)
-
updateNavigation
@Deprecated(since="2005", forRemoval=true) public void updateNavigation(StepType currentStep)Deprecated, for removal: This API element is subject to removal in a future version.since 2005- See Also:
updateNavigation()
-
updateNavigation
public void updateNavigation()
-
doCustom
public void doCustom(StepType currentStep, CustomType customType, java.util.Map<java.lang.String,ComposedHandlerType> composedHandlers)
Calls custom step handler.- Parameters:
currentStep- current stepcustomType- custom type navigationcomposedHandlers- collection ofComposedHandlerTypedefined for this flow
-
findHandlerBean
protected java.lang.String findHandlerBean(ComposedHandlerType composedHandler, CustomType customType)
-
doCustom
public void doCustom(StepType currentStep, CustomType customType)
Calls custom step handler.- Parameters:
currentStep- current stepcustomType- custom type navigation
-
createAndAppendButton
protected org.zkoss.zul.Button createAndAppendButton(org.zkoss.zk.ui.Component buttonsContainer, java.lang.String labelKey, StepType currentStep, AbstractActionType actionType, java.lang.String actionId)
-
wrapChildAndAppend
protected void wrapChildAndAppend(org.zkoss.zk.ui.Component parent, org.zkoss.zk.ui.Component child)
-
createActionHandlerAdapter
protected FlowActionHandlerAdapter createActionHandlerAdapter(StepType currentStep, org.zkoss.zk.ui.event.Event event)
-
toggleButtonActiveState
protected void toggleButtonActiveState(org.zkoss.zul.Button button, AbstractActionType actionType)
-
applyVisibilityRestriction
protected void applyVisibilityRestriction(org.zkoss.zk.ui.Component component, AbstractActionType actionType)
-
clearMessages
public void clearMessages()
-
refreshView
public void refreshView()
-
refreshView
protected void refreshView(org.zkoss.zk.ui.Component comp)
-
getStep
protected StepType getStep(java.lang.String id)
-
getAllSteps
protected java.util.List<StepType> getAllSteps()
-
setAllSteps
public void setAllSteps(java.util.List<StepType> allSteps)
-
getPropertyDescription
protected java.lang.String getPropertyDescription(java.lang.String attributeDataDescription, PropertyType propertyType)
-
getContentDiv
public org.zkoss.zul.Div getContentDiv()
-
setContentDiv
public void setContentDiv(org.zkoss.zul.Div contentDiv)
-
getBreadcrumbDiv
public org.zkoss.zul.Div getBreadcrumbDiv()
-
setBreadcrumbDiv
public void setBreadcrumbDiv(org.zkoss.zul.Div breadcrumbDiv)
-
getMsgAreaDiv
public org.zkoss.zul.Div getMsgAreaDiv()
-
setMsgAreaDiv
public void setMsgAreaDiv(org.zkoss.zul.Div msgAreaDiv)
-
getNavigationDiv
public org.zkoss.zul.Div getNavigationDiv()
-
getWidgetInstanceManager
public WidgetInstanceManager getWidgetInstanceManager()
-
setWidgetInstanceManager
public void setWidgetInstanceManager(WidgetInstanceManager widgetInstanceManager)
-
getTypeFacade
public TypeFacade getTypeFacade()
-
setTypeFacade
@Autowired public void setTypeFacade(TypeFacade typeFacade)
-
getTransitionListenerFactory
public TransitionListenerFactory getTransitionListenerFactory()
-
setTransitionListenerFactory
public void setTransitionListenerFactory(TransitionListenerFactory transitionListenerFactory)
-
getConfigurableFlowLabelService
public ConfigurableFlowLabelService getConfigurableFlowLabelService()
-
setConfigurableFlowLabelService
public void setConfigurableFlowLabelService(ConfigurableFlowLabelService configurableFlowLabelService)
-
getPermissionFacade
public PermissionFacade getPermissionFacade()
-
setPermissionFacade
@Autowired public void setPermissionFacade(PermissionFacade permissionFacade)
-
getAttributeDescriptionIconRenderer
public AttributeDescriptionIconRenderer getAttributeDescriptionIconRenderer()
-
setAttributeDescriptionIconRenderer
public void setAttributeDescriptionIconRenderer(AttributeDescriptionIconRenderer attributeDescriptionIconRenderer)
-
getCockpitLocaleService
public CockpitLocaleService getCockpitLocaleService()
-
setCockpitLocaleService
@Autowired public void setCockpitLocaleService(CockpitLocaleService cockpitLocaleService)
-
getCockpitUserService
public CockpitUserService getCockpitUserService()
-
setCockpitUserService
@Autowired public void setCockpitUserService(CockpitUserService cockpitUserService)
-
setComponentsVisitorFactory
public void setComponentsVisitorFactory(ComponentsVisitorFactory componentsVisitorFactory)
-
getLabelService
public LabelService getLabelService()
-
setLabelService
public void setLabelService(LabelService labelService)
-
setValidationRenderer
public void setValidationRenderer(ValidationRenderer validationRenderer)
-
setValidationResultsPopup
public void setValidationResultsPopup(ConfigurableFlowValidationResultsPopup validationResultsPopup)
-
getNotificationService
protected NotificationService getNotificationService()
-
setNotificationService
public void setNotificationService(NotificationService notificationService)
-
getValidationHandler
public ValidationHandler getValidationHandler()
-
setValidationHandler
public void setValidationHandler(ValidationHandler validationHandler)
-
isShowBreadcrumb
public boolean isShowBreadcrumb()
-
setShowBreadcrumb
public void setShowBreadcrumb(boolean showBreadcrumb)
-
-