com.hybris.cockpitng.components.validation

Class DefaultValidationRenderer

java.lang.Object

com.hybris.cockpitng.components.validation.DefaultValidationRenderer

All Implemented Interfaces:

ValidationRenderer

Direct Known Subclasses:

TypeAwareValidationRenderer

public class DefaultValidationRenderer
extends Object
implements ValidationRenderer

Renders validation icon above editors and dedicated popup

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	Y_ICON
protected static String	YE_EDITOR_VALIDATION_POPUP
protected static String	YE_EDITOR_VALIDATION_POPUP_CNT
protected static String	YE_EDITOR_VALIDATION_POPUP_CONTENT
protected static String	YE_EDITOR_VALIDATION_POPUP_INVISIBLE
protected static String	YE_EXCLAMATION_ICON

Constructor Summary

Constructors

Constructor and Description
DefaultValidationRenderer()

Method Summary

Modifier and Type	Method and Description
void	cleanAllValidationCss(org.zkoss.zk.ui.HtmlBasedComponent parent) Removes all css classes from specified component that are related to validation violation
org.zkoss.zk.ui.Component	createValidationMessageBtn(ValidationResult validations) Creates an icon indicating violation severity level.
org.zkoss.zk.ui.Component	createValidationMessageBtn(ValidationResult validations, boolean validationExpanded) Creates an icon indicating violation severity level.
org.zkoss.zul.Listbox	createValidationViolationsList(ValidatableContainer container) Creates a list, that displays all violations from provided validation result
org.zkoss.zul.Window	createValidationViolationsPopup(ValidatableContainer container, org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event> listener) Creates a popup, that displays all violations from provided validation result.
String	getIconStyleClass(ValidationSeverity severity) Gets a css class of icon representing provided severity level
String	getLabel(Object object, String path) Gets a label for violated path of specified object
String	getSeverityStyleClass(ValidationSeverity severity) Gets a css class for components to be marked with provided severity level
void	setValidationErrorKey(String validationErrorKey)
void	setValidationInfoKey(String validationInfoKey)
void	setValidationNoneKey(String validationNoneKey)
void	setValidationWarningKey(String validationWarningKey)

Methods inherited from class java.lang.Object

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

Field Detail

YE_EXCLAMATION_ICON

protected static final String YE_EXCLAMATION_ICON

See Also:

Constant Field Values

YE_EDITOR_VALIDATION_POPUP

protected static final String YE_EDITOR_VALIDATION_POPUP

See Also:

Constant Field Values

YE_EDITOR_VALIDATION_POPUP_INVISIBLE

protected static final String YE_EDITOR_VALIDATION_POPUP_INVISIBLE

See Also:

Constant Field Values

YE_EDITOR_VALIDATION_POPUP_CONTENT

protected static final String YE_EDITOR_VALIDATION_POPUP_CONTENT

See Also:

Constant Field Values

YE_EDITOR_VALIDATION_POPUP_CNT

protected static final String YE_EDITOR_VALIDATION_POPUP_CNT

See Also:

Constant Field Values

Y_ICON

protected static final String Y_ICON

See Also:

Constant Field Values

Constructor Detail

DefaultValidationRenderer

public DefaultValidationRenderer()

Method Detail

createValidationViolationsPopup

public org.zkoss.zul.Window createValidationViolationsPopup(ValidatableContainer container,
                                                            org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event> listener)

Description copied from interface: ValidationRenderer

Creates a popup, that displays all violations from provided validation result.

Popup also implements possibility of closing, confirming warnings, etc.

Specified by:

createValidationViolationsPopup in interface ValidationRenderer

Parameters:

container - container that will be validated

listener - listener for confirmation - listener is notified after user clicks close/ confirm button and a window is hidden

Returns:

fully prepared popup

See Also:

ValidationRenderer.createValidationViolationsList(ValidatableContainer), Events.ON_OK

createValidationViolationsList

public org.zkoss.zul.Listbox createValidationViolationsList(ValidatableContainer container)

Description copied from interface: ValidationRenderer

Creates a list, that displays all violations from provided validation result

Specified by:

createValidationViolationsList in interface ValidationRenderer

Parameters:

container - container that will be validated

Returns:

fully prepared list

See Also:

ValidationRenderer.createValidationViolationsPopup(ValidatableContainer, EventListener)

getLabel

public String getLabel(Object object,
                       String path)

Description copied from interface: ValidationRenderer

Gets a label for violated path of specified object

Specified by:

getLabel in interface ValidationRenderer

Parameters:

object - object being validated

path - violated path

Returns:

user-friendly presentation of path

createValidationMessageBtn

public org.zkoss.zk.ui.Component createValidationMessageBtn(ValidationResult validations)

Description copied from interface: ValidationRenderer

Creates an icon indicating violation severity level. It may also i.e. attach onClick event to icon, to show details of violation in popup.

Specified by:

createValidationMessageBtn in interface ValidationRenderer

Parameters:

validations - violations to be represented by button

Returns:

button

createValidationMessageBtn

public org.zkoss.zk.ui.Component createValidationMessageBtn(ValidationResult validations,
                                                            boolean validationExpanded)

Description copied from interface: ValidationRenderer

Creates an icon indicating violation severity level. It may also i.e. attach onClick event to icon, to show details of violation in popup.

Specified by:

createValidationMessageBtn in interface ValidationRenderer

Parameters:

validations - violations to be represented by button

validationExpanded - determines whether validation info popup is displayed on init

Returns:

button

getIconStyleClass

public String getIconStyleClass(ValidationSeverity severity)

Description copied from interface: ValidationRenderer

Gets a css class of icon representing provided severity level

Specified by:

getIconStyleClass in interface ValidationRenderer

Parameters:

severity - severity level to be represented

Returns:

css class for icon

getSeverityStyleClass

public String getSeverityStyleClass(ValidationSeverity severity)

Description copied from interface: ValidationRenderer

Gets a css class for components to be marked with provided severity level

Specified by:

getSeverityStyleClass in interface ValidationRenderer

Parameters:

severity - severity level to be represented

Returns:

css class for component

cleanAllValidationCss

public void cleanAllValidationCss(org.zkoss.zk.ui.HtmlBasedComponent parent)

Description copied from interface: ValidationRenderer

Removes all css classes from specified component that are related to validation violation

Specified by:

cleanAllValidationCss in interface ValidationRenderer

Parameters:

parent - component to be cleared

setValidationErrorKey

public void setValidationErrorKey(String validationErrorKey)

setValidationWarningKey

public void setValidationWarningKey(String validationWarningKey)

setValidationInfoKey

public void setValidationInfoKey(String validationInfoKey)

setValidationNoneKey

public void setValidationNoneKey(String validationNoneKey)