Package de.hybris.platform.cockpit.helpers.validation

Class ValidationUIHelper

java.lang.Object

de.hybris.platform.cockpit.helpers.validation.ValidationUIHelper

public class ValidationUIHelper
extends java.lang.Object

The Class ValidationUIHelper.

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	EVENT_TAG
protected static java.lang.String	NAVIGATION_EVENT
protected static java.lang.String	PERSP_ID
protected static java.lang.String	PERSP_TAG
protected static java.lang.String	PNAV_CONSTRAINT

Constructor Summary

Constructors

Constructor	Description
ValidationUIHelper()

Method Summary

Modifier and Type	Method	Description
void	addTypeConstraintMessages(SectionPanelModel panelModel, java.util.Set<CockpitValidationDescriptor> validationInfo)	Adds the type constraint messages if there are any type violations.
boolean	allWarningsForced(java.util.Set<java.lang.String> forceWritePks, java.util.Set<CockpitValidationDescriptor> violations)
org.zkoss.zul.Image	buildConstraintValidationIcon(int level, org.zkoss.zul.Menupopup menuPopup, org.zkoss.zul.Popup tooltip)
org.zkoss.zul.Popup	buildConstraintValidationTooltip(Message violation)
org.zkoss.zul.Menupopup	buildTypeConstraintValidationMenuPopup(java.lang.String constraintPk, ObjectValueContainer objectValueContainer, int messageLevel, java.util.List<java.lang.String> forceWritePks)	Deprecated. since 6.3, use buildTypeConstraintValidationMenuPopup(String, ObjectValueContainer, int, List, SectionPanelModel) instead.
org.zkoss.zul.Menupopup	buildTypeConstraintValidationMenuPopup(java.lang.String constraintPk, ObjectValueContainer objectValueContainer, int messageLevel, java.util.List<java.lang.String> forceWritePks, SectionPanelModel panelModel)	Builds the type constraint validation menu popup.
void	changeSClass(org.zkoss.zk.ui.HtmlBasedComponent parent, int cockpitMessageLevel)
void	clearRowMarkings(SectionPanelModel panelModel)	Clear row markings.
void	clearSectionHeaderMarkings(SectionPanelModel panelModel)	Clear section header markings.
ObjectValueContainer	createModelFromContainer(TypedObject typedObject, java.lang.String languageIso, PropertyDescriptor propertyDescriptor, UIEditor editor)
void	createValidationMessages(org.zkoss.zk.ui.HtmlBasedComponent parent, java.util.Set<CockpitValidationDescriptor> violations, TypedObject typedObject, java.util.Set<java.lang.String> forceWritePks, EditableComponent editableComponent)	Creates an appropriate zk-element for given validation messages.
org.zkoss.zul.Menuitem	createViewConstraintMenuItem(java.lang.String constraintPk)
java.lang.String	getValidationIcon(int messageLvl)
void	markField(SectionPanelModel panelModel, java.util.Set<CockpitValidationDescriptor> validationInfo, TypedObject currentObject)	Mark fields with validation level color.
void	markSectionHeader(SectionPanelModel panelModel, java.util.Set<CockpitValidationDescriptor> validationInfo)	Mark section header with validation level color
void	setModelLocalizedValue(ItemModel model, java.lang.String qualifier, java.lang.String languageIso, java.lang.Object value)
void	setModelSingleValue(ItemModel model, java.lang.String qualifier, java.lang.Object value)
java.util.Set<CockpitValidationDescriptor>	sortCockpitValidationDescriptors(java.util.Set<CockpitValidationDescriptor> violations)

Methods inherited from class java.lang.Object

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

Field Detail

PERSP_TAG

protected static final java.lang.String PERSP_TAG

See Also:

Constant Field Values

PERSP_ID

protected static final java.lang.String PERSP_ID

See Also:

Constant Field Values

EVENT_TAG

protected static final java.lang.String EVENT_TAG

See Also:

Constant Field Values

NAVIGATION_EVENT

protected static final java.lang.String NAVIGATION_EVENT

See Also:

Constant Field Values

PNAV_CONSTRAINT

protected static final java.lang.String PNAV_CONSTRAINT

See Also:

Constant Field Values

Constructor Detail

ValidationUIHelper

public ValidationUIHelper()

Method Detail

addTypeConstraintMessages

public void addTypeConstraintMessages(SectionPanelModel panelModel,
                                      java.util.Set<CockpitValidationDescriptor> validationInfo)

Adds the type constraint messages if there are any type violations.

Parameters:

panelModel - the panel model

validationInfo - the validation info

buildTypeConstraintValidationMenuPopup

public org.zkoss.zul.Menupopup buildTypeConstraintValidationMenuPopup(java.lang.String constraintPk,
                                                                      ObjectValueContainer objectValueContainer,
                                                                      int messageLevel,
                                                                      java.util.List<java.lang.String> forceWritePks,
                                                                      SectionPanelModel panelModel)

Builds the type constraint validation menu popup.

Parameters:

constraintPk - the constraint pk

objectValueContainer - the object value container

messageLevel - the message level

forceWritePks - the force write pks

Returns:

the menupopup

clearRowMarkings

public void clearRowMarkings(SectionPanelModel panelModel)

Clear row markings.

Parameters:

panelModel - the panel model

buildTypeConstraintValidationMenuPopup

@Deprecated
public org.zkoss.zul.Menupopup buildTypeConstraintValidationMenuPopup(java.lang.String constraintPk,
                                                                      ObjectValueContainer objectValueContainer,
                                                                      int messageLevel,
                                                                      java.util.List<java.lang.String> forceWritePks)

Deprecated.

since 6.3, use buildTypeConstraintValidationMenuPopup(String, ObjectValueContainer, int, List, SectionPanelModel) instead.

clearSectionHeaderMarkings

public void clearSectionHeaderMarkings(SectionPanelModel panelModel)

Clear section header markings.

Parameters:

panelModel - the panel model

markField

public void markField(SectionPanelModel panelModel,
                      java.util.Set<CockpitValidationDescriptor> validationInfo,
                      TypedObject currentObject)

Mark fields with validation level color.

Parameters:

panelModel - the panel model

validationInfo - the omitted props

currentObject - the current object

markSectionHeader

public void markSectionHeader(SectionPanelModel panelModel,
                              java.util.Set<CockpitValidationDescriptor> validationInfo)

Mark section header with validation level color

Parameters:

panelModel - the panel model

validationInfo - the omitted props

createViewConstraintMenuItem

public org.zkoss.zul.Menuitem createViewConstraintMenuItem(java.lang.String constraintPk)

createValidationMessages

public void createValidationMessages(org.zkoss.zk.ui.HtmlBasedComponent parent,
                                     java.util.Set<CockpitValidationDescriptor> violations,
                                     TypedObject typedObject,
                                     java.util.Set<java.lang.String> forceWritePks,
                                     EditableComponent editableComponent)

Creates an appropriate zk-element for given validation messages. This element includes other elements like popup, tooltip, error-icon, etc...

Parameters:

violations -

parent -

typedObject -

forceWritePks -

editableComponent -

sortCockpitValidationDescriptors

public java.util.Set<CockpitValidationDescriptor> sortCockpitValidationDescriptors(java.util.Set<CockpitValidationDescriptor> violations)

changeSClass

public void changeSClass(org.zkoss.zk.ui.HtmlBasedComponent parent,
                         int cockpitMessageLevel)

buildConstraintValidationTooltip

public org.zkoss.zul.Popup buildConstraintValidationTooltip(Message violation)

buildConstraintValidationIcon

public org.zkoss.zul.Image buildConstraintValidationIcon(int level,
                                                         org.zkoss.zul.Menupopup menuPopup,
                                                         org.zkoss.zul.Popup tooltip)

getValidationIcon

public java.lang.String getValidationIcon(int messageLvl)

allWarningsForced

public boolean allWarningsForced(java.util.Set<java.lang.String> forceWritePks,
                                 java.util.Set<CockpitValidationDescriptor> violations)

createModelFromContainer

public ObjectValueContainer createModelFromContainer(TypedObject typedObject,
                                                     java.lang.String languageIso,
                                                     PropertyDescriptor propertyDescriptor,
                                                     UIEditor editor)

setModelSingleValue

public void setModelSingleValue(ItemModel model,
                                java.lang.String qualifier,
                                java.lang.Object value)
                         throws AttributeNotSupportedException

Throws:

AttributeNotSupportedException

setModelLocalizedValue

public void setModelLocalizedValue(ItemModel model,
                                   java.lang.String qualifier,
                                   java.lang.String languageIso,
                                   java.lang.Object value)
                            throws AttributeNotSupportedException

Throws:

AttributeNotSupportedException