com.hybris.cockpitng.widgets.configurableflow.renderer

Class ConfigurableFlowRenderer

java.lang.Object

com.hybris.cockpitng.widgets.configurableflow.renderer.ConfigurableFlowRenderer

public class ConfigurableFlowRenderer
extends Object

Configurable Flow renderer

Field Summary

Fields

Modifier and Type	Field and Description
protected ConfigurableFlowExpressions	cfExpressions
static String	CURRENT_OBJECT
static int	HUNDRED_PERCENT
static String	HUNDRED_PERCENT_S
static String	IS_NESTED_OBJECT_CREATION_DISABLED_SETTING
protected static String	NO_READ_ACCESS
static String	PARENT_OBJECT Deprecated. since 6.7, use Editor#PARENT_OBJECT instead
static String	SCLASS_COMPONENT_WRAPPER
static String	SEPARATOR
protected boolean	showBreadcrumb
static String	STEP_ID_ATTRIBUTE
static String	STEP_INITIALIZED
static String	WIZARD_PREFIX
static String	WIZARD_RESULT_MSG_FAIL_TILE
static String	WIZARD_RESULT_MSG_SUCCESS_TILE
static String	WIZARD_RESULT_MSG_TEXT
static String	WIZARD_RESULT_MSG_TITLE
static String	WIZARD_STYLE_ACTIVE
static String	WIZARD_STYLE_AFTER
static String	WIZARD_STYLE_BEFORE
static String	WIZARD_STYLE_BR_ARROW
static String	WIZARD_STYLE_BR_LABEL
static String	WIZARD_STYLE_BR_PREFIX
static String	WIZARD_STYLE_BR_S_LABEL
static String	WIZARD_STYLE_BR_SP
static String	WIZARD_STYLE_BR_SP_ARROW
static String	WIZARD_STYLE_BTN_BLUE
static String	WIZARD_STYLE_COLUMN_CONTENT
static String	WIZARD_STYLE_CONTENT
static String	WIZARD_STYLE_INFO
static String	WIZARD_STYLE_LAYOUT
static String	WIZARD_STYLE_LEFT
static String	WIZARD_STYLE_LEFT_PACK
static String	WIZARD_STYLE_NAVI
static String	WIZARD_STYLE_NONE
static String	WIZARD_STYLE_PROPERTY
static String	WIZARD_STYLE_PROPERTY_LABEL
static String	WIZARD_STYLE_PROPERTY_LABEL_MANDATORY
static String	WIZARD_STYLE_READ_ONLY_VALUE
static String	WIZARD_STYLE_RIGHT
static String	WIZARD_STYLE_RIGHT_PACK
static String	WIZARD_STYLE_TOP
static String	WIZARD_STYLE_Z_INDEX
static String	ZUL

Constructor Summary

Constructors

Constructor and Description
ConfigurableFlowRenderer()

Method Summary

Modifier and Type	Method and Description
protected void	applyComponentsVisitor()
protected void	applyVisibilityRestriction(org.zkoss.zk.ui.Component component, AbstractActionType actionType)
protected Editor	buildEditor(EditorBuilder editorBuilder, WidgetInstanceManager widgetInstanceManager)
void	cleanUpRendererObservers()
void	clearMessages()
protected FlowActionHandlerAdapter	createActionHandlerAdapter(StepType currentStep, org.zkoss.zk.ui.event.Event event)
protected org.zkoss.zul.Button	createAndAppendButton(org.zkoss.zk.ui.Component buttonsContainer, String labelKey, StepType currentStep, AbstractActionType actionType, String actionId)
protected org.zkoss.zk.ui.HtmlBasedComponent	createBreadcrumbEntry(StepType step)
protected org.zkoss.zk.ui.Component	createPropertyLine(String prefix, PropertyType property)
protected ValidationContext	createValidationContext() Deprecated. since 6.6 not used
protected void	displayMessage(ResultMessage msg) Deprecated. since 6.6 not used
protected void	displayMessages(List<ResultMessage> messages) Deprecated. since 6.6 not used
void	doCustom(StepType currentStep, CustomType customType) Calls custom step handler.
protected ValidationResult	doValidate() Deprecated. since 6.6 not used
protected String	extractTypeQualifier(String qualifier)
List<Locale>	getActiveLocales()
protected List<StepType>	getAllSteps()
AttributeDescriptionIconRenderer	getAttributeDescriptionIconRenderer()
org.zkoss.zul.Div	getBreadcrumbDiv()
CockpitLocaleService	getCockpitLocaleService()
CockpitUserService	getCockpitUserService()
ConfigurableFlowLabelService	getConfigurableFlowLabelService()
org.zkoss.zul.Div	getContentDiv()
protected Object	getCurrentObject() Deprecated. since 6.6 not used
protected ValidationResult	getCurrentValidationResult() Deprecated. since 6.6 not used
protected DataType	getEditorValueType(PropertyType property) Deprecated. since 6.6 not used
LabelService	getLabelService()
org.zkoss.zul.Div	getMsgAreaDiv()
org.zkoss.zul.Div	getNavigationDiv()
protected NotificationService	getNotificationService()
protected String	getNotificationSource() Deprecated. since 6.7, use NotificationService.getWidgetNotificationSource(WidgetInstanceManager) instead.
PermissionFacade	getPermissionFacade()
protected String	getPropertyDescription(String attributeDataDescription, PropertyType propertyType)
protected StepType	getStep(String id)
TransitionListenerFactory	getTransitionListenerFactory()
protected String	getTypeCodeFromWizardCtx()
TypeFacade	getTypeFacade()
ValidationHandler	getValidationHandler()
<T> T	getValue(String key, Class<T> expectedClass) Deprecated. since 6.6 not used
WidgetInstanceManager	getWidgetInstanceManager()
protected void	initializeEditorInstance(Editor editor, WidgetInstanceManager widgetInstanceManager, String normalizedPropertyQualifier) Deprecated. since 6.7, use buildEditor(EditorBuilder, WidgetInstanceManager) instead
protected boolean	isAttributeWritable(DataAttribute attributeData, String normalizedQualifier, String normalizedTypeQualifier)
protected boolean	isNestedObjectCreationDisabled()
protected Boolean	isNestedObjectCreationDisabled(List<Parameter> editorParameter)
boolean	isShowBreadcrumb()
protected boolean	isStepChangePossible(StepType currentStep, StepType targetStep)
protected boolean	isTypeLocalized(PropertyType property)
protected DataType	loadDataType(Object currentObject)
protected String	normalizePropertyQualifier(String prefix, PropertyType property)
protected String	normalizeQualifier(String propertyQualifier)
protected org.zkoss.zk.ui.Component	prepareErrorRow(String label)
void	refreshView()
protected void	refreshView(org.zkoss.zk.ui.Component comp)
protected void	renderBreadcrumb(StepType currentStep, List<StepType> stepList)
protected void	renderContent(org.zkoss.zk.ui.Component parent, ContentType content)
void	renderCurrentStep(StepType currentStep)
protected String	resolveType(DataAttribute attributeData)
void	setActiveLocales(List<Locale> activeLocales)
void	setAllSteps(List<StepType> allSteps)
void	setAttributeDescriptionIconRenderer(AttributeDescriptionIconRenderer attributeDescriptionIconRenderer)
void	setBreadcrumbDiv(org.zkoss.zul.Div breadcrumbDiv)
void	setCockpitLocaleService(CockpitLocaleService cockpitLocaleService)
void	setCockpitUserService(CockpitUserService cockpitUserService)
void	setComponentsVisitorFactory(ComponentsVisitorFactory componentsVisitorFactory)
void	setConfigurableFlowLabelService(ConfigurableFlowLabelService configurableFlowLabelService)
void	setContentDiv(org.zkoss.zul.Div contentDiv)
void	setEditorChangeListener(EditorChangeListener editorChangeListener)
void	setLabelService(LabelService labelService)
void	setMsgAreaDiv(org.zkoss.zul.Div msgAreaDiv)
void	setNotificationService(NotificationService notificationService)
void	setPermissionFacade(PermissionFacade permissionFacade)
void	setShowBreadcrumb(boolean showBreadcrumb)
void	setTransitionListenerFactory(TransitionListenerFactory transitionListenerFactory)
void	setTypeFacade(TypeFacade typeFacade)
void	setValidatableContainer(ValidatableContainer validatableContainer)
void	setValidationHandler(ValidationHandler validationHandler)
void	setValidationRenderer(ValidationRenderer validationRenderer)
void	setValidationResultsPopup(ConfigurableFlowValidationResultsPopup validationResultsPopup)
void	setWidgetInstanceManager(WidgetInstanceManager widgetInstanceManager)
protected void	toggleButtonActiveState(org.zkoss.zul.Button button, AbstractActionType actionType)
protected void	unregisterComponentsFromVisitor()
void	updateNavigation(StepType currentStep)
protected void	wrapChildAndAppend(org.zkoss.zk.ui.Component parent, org.zkoss.zk.ui.Component child)

Methods inherited from class java.lang.Object

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

Field Detail

WIZARD_STYLE_BR_LABEL

public static final String WIZARD_STYLE_BR_LABEL

See Also:

Constant Field Values

WIZARD_STYLE_BR_S_LABEL

public static final String WIZARD_STYLE_BR_S_LABEL

See Also:

Constant Field Values

WIZARD_STYLE_BR_SP

public static final String WIZARD_STYLE_BR_SP

See Also:

Constant Field Values

WIZARD_STYLE_BR_SP_ARROW

public static final String WIZARD_STYLE_BR_SP_ARROW

See Also:

Constant Field Values

WIZARD_STYLE_BR_ARROW

public static final String WIZARD_STYLE_BR_ARROW

See Also:

Constant Field Values

WIZARD_STYLE_BR_PREFIX

public static final String WIZARD_STYLE_BR_PREFIX

See Also:

Constant Field Values

WIZARD_STYLE_BEFORE

public static final String WIZARD_STYLE_BEFORE

See Also:

Constant Field Values

WIZARD_STYLE_ACTIVE

public static final String WIZARD_STYLE_ACTIVE

See Also:

Constant Field Values

WIZARD_STYLE_AFTER

public static final String WIZARD_STYLE_AFTER

See Also:

Constant Field Values

WIZARD_STYLE_Z_INDEX

public static final String WIZARD_STYLE_Z_INDEX

See Also:

Constant Field Values

WIZARD_STYLE_LAYOUT

public static final String WIZARD_STYLE_LAYOUT

See Also:

Constant Field Values

WIZARD_STYLE_CONTENT

public static final String WIZARD_STYLE_CONTENT

See Also:

Constant Field Values

WIZARD_STYLE_COLUMN_CONTENT

public static final String WIZARD_STYLE_COLUMN_CONTENT

See Also:

Constant Field Values

WIZARD_STYLE_INFO

public static final String WIZARD_STYLE_INFO

See Also:

Constant Field Values

WIZARD_STYLE_NAVI

public static final String WIZARD_STYLE_NAVI

See Also:

Constant Field Values

WIZARD_STYLE_LEFT_PACK

public static final String WIZARD_STYLE_LEFT_PACK

See Also:

Constant Field Values

WIZARD_STYLE_RIGHT_PACK

public static final String WIZARD_STYLE_RIGHT_PACK

See Also:

Constant Field Values

WIZARD_STYLE_BTN_BLUE

public static final String WIZARD_STYLE_BTN_BLUE

See Also:

Constant Field Values

WIZARD_STYLE_PROPERTY

public static final String WIZARD_STYLE_PROPERTY

See Also:

Constant Field Values

WIZARD_STYLE_PROPERTY_LABEL

public static final String WIZARD_STYLE_PROPERTY_LABEL

See Also:

Constant Field Values

WIZARD_STYLE_PROPERTY_LABEL_MANDATORY

public static final String WIZARD_STYLE_PROPERTY_LABEL_MANDATORY

See Also:

Constant Field Values

WIZARD_STYLE_READ_ONLY_VALUE

public static final String WIZARD_STYLE_READ_ONLY_VALUE

See Also:

Constant Field Values

WIZARD_STYLE_NONE

public static final String WIZARD_STYLE_NONE

See Also:

Constant Field Values

WIZARD_STYLE_LEFT

public static final String WIZARD_STYLE_LEFT

See Also:

Constant Field Values

WIZARD_STYLE_RIGHT

public static final String WIZARD_STYLE_RIGHT

See Also:

Constant Field Values

WIZARD_STYLE_TOP

public static final String WIZARD_STYLE_TOP

See Also:

Constant Field Values

WIZARD_RESULT_MSG_SUCCESS_TILE

public static final String WIZARD_RESULT_MSG_SUCCESS_TILE

See Also:

Constant Field Values

WIZARD_RESULT_MSG_FAIL_TILE

public static final String WIZARD_RESULT_MSG_FAIL_TILE

See Also:

Constant Field Values

WIZARD_RESULT_MSG_TITLE

public static final String WIZARD_RESULT_MSG_TITLE

See Also:

Constant Field Values

WIZARD_RESULT_MSG_TEXT

public static final String WIZARD_RESULT_MSG_TEXT

See Also:

Constant Field Values

ZUL

public static final String ZUL

See Also:

Constant Field Values

HUNDRED_PERCENT_S

public static final String HUNDRED_PERCENT_S

See Also:

Constant Field Values

WIZARD_PREFIX

public static final String WIZARD_PREFIX

See Also:

Constant Field Values

SEPARATOR

public static final 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 String CURRENT_OBJECT

See Also:

Constant Field Values

IS_NESTED_OBJECT_CREATION_DISABLED_SETTING

public static final String IS_NESTED_OBJECT_CREATION_DISABLED_SETTING

See Also:

Constant Field Values

PARENT_OBJECT

@Deprecated
public static final String PARENT_OBJECT

Deprecated. since 6.7, use Editor#PARENT_OBJECT instead

See Also:

Constant Field Values

STEP_INITIALIZED

public static final String STEP_INITIALIZED

See Also:

Constant Field Values

STEP_ID_ATTRIBUTE

public static final String STEP_ID_ATTRIBUTE

See Also:

Constant Field Values

SCLASS_COMPONENT_WRAPPER

public static final String SCLASS_COMPONENT_WRAPPER

See Also:

Constant Field Values

NO_READ_ACCESS

protected static final String NO_READ_ACCESS

See Also:

Constant Field Values

showBreadcrumb

protected boolean showBreadcrumb

cfExpressions

protected final ConfigurableFlowExpressions cfExpressions

Constructor Detail

ConfigurableFlowRenderer

public ConfigurableFlowRenderer()

Method Detail

setValidatableContainer

public void setValidatableContainer(ValidatableContainer validatableContainer)

setEditorChangeListener

public void setEditorChangeListener(EditorChangeListener editorChangeListener)

getActiveLocales

public List<Locale> getActiveLocales()

setActiveLocales

public void setActiveLocales(List<Locale> activeLocales)

createPropertyLine

protected org.zkoss.zk.ui.Component createPropertyLine(String prefix,
                                                       PropertyType property)

buildEditor

protected Editor buildEditor(EditorBuilder editorBuilder,
                             WidgetInstanceManager widgetInstanceManager)

initializeEditorInstance

@Deprecated
protected void initializeEditorInstance(Editor editor,
                                                    WidgetInstanceManager widgetInstanceManager,
                                                    String normalizedPropertyQualifier)

Deprecated. since 6.7, use buildEditor(EditorBuilder, WidgetInstanceManager) instead

isTypeLocalized

protected boolean isTypeLocalized(PropertyType property)

getEditorValueType

@Deprecated
protected DataType getEditorValueType(PropertyType property)

Deprecated. since 6.6 not used

isNestedObjectCreationDisabled

protected Boolean isNestedObjectCreationDisabled(List<Parameter> editorParameter)

prepareErrorRow

protected org.zkoss.zk.ui.Component prepareErrorRow(String label)

isNestedObjectCreationDisabled

protected boolean isNestedObjectCreationDisabled()

isAttributeWritable

protected boolean isAttributeWritable(DataAttribute attributeData,
                                      String normalizedQualifier,
                                      String normalizedTypeQualifier)

getNotificationSource

@Deprecated
protected String getNotificationSource()

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

resolveType

protected String resolveType(DataAttribute attributeData)

normalizeQualifier

protected String normalizeQualifier(String propertyQualifier)

normalizePropertyQualifier

protected String normalizePropertyQualifier(String prefix,
                                            PropertyType property)

loadDataType

protected DataType loadDataType(Object currentObject)

extractTypeQualifier

protected String extractTypeQualifier(String qualifier)

createBreadcrumbEntry

protected org.zkoss.zk.ui.HtmlBasedComponent createBreadcrumbEntry(StepType step)

renderBreadcrumb

protected void renderBreadcrumb(StepType currentStep,
                                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 String getTypeCodeFromWizardCtx()

renderContent

protected void renderContent(org.zkoss.zk.ui.Component parent,
                             ContentType content)

updateNavigation

public void updateNavigation(StepType currentStep)

doCustom

public void doCustom(StepType currentStep,
                     CustomType customType)

Calls custom step handler.

Parameters:

currentStep - current step

customType - custom type navigation

createAndAppendButton

protected org.zkoss.zul.Button createAndAppendButton(org.zkoss.zk.ui.Component buttonsContainer,
                                                     String labelKey,
                                                     StepType currentStep,
                                                     AbstractActionType actionType,
                                                     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)

displayMessages

@Deprecated
protected void displayMessages(List<ResultMessage> messages)

Deprecated. since 6.6 not used

displayMessage

@Deprecated
protected void displayMessage(ResultMessage msg)

Deprecated. since 6.6 not used

clearMessages

public void clearMessages()

refreshView

public void refreshView()

refreshView

protected void refreshView(org.zkoss.zk.ui.Component comp)

getStep

protected StepType getStep(String id)

getAllSteps

protected List<StepType> getAllSteps()

setAllSteps

public void setAllSteps(List<StepType> allSteps)

getPropertyDescription

protected String getPropertyDescription(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)

doValidate

@Deprecated
protected ValidationResult doValidate()

Deprecated. since 6.6 not used

createValidationContext

@Deprecated
protected ValidationContext createValidationContext()

Deprecated. since 6.6 not used

getCurrentValidationResult

@Deprecated
protected ValidationResult getCurrentValidationResult()

Deprecated. since 6.6 not used

getCurrentObject

@Deprecated
protected Object getCurrentObject()

Deprecated. since 6.6 not used

getValue

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

Deprecated. since 6.6 not used

getValidationHandler

public ValidationHandler getValidationHandler()

setValidationHandler

public void setValidationHandler(ValidationHandler validationHandler)

isShowBreadcrumb

public boolean isShowBreadcrumb()

setShowBreadcrumb

public void setShowBreadcrumb(boolean showBreadcrumb)