com.hybris.cockpitng.components.validation

Interface ValidationRenderer

All Known Implementing Classes:

ConfigurableFlowValidationRenderer, DefaultValidationRenderer, TypeAwareValidationRenderer

public interface ValidationRenderer

Returns css classes for validation results and render validation popup for editor

Method Summary

Modifier and Type	Method and Description
void	cleanAllValidationCss(org.zkoss.zk.ui.HtmlBasedComponent container) 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

Method Detail

createValidationViolationsList

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

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

Parameters:

container - container that will be validated

Returns:

fully prepared list

See Also:

createValidationViolationsPopup(ValidatableContainer, EventListener)

createValidationViolationsPopup

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.

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

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:

createValidationViolationsList(ValidatableContainer), Events.ON_OK

createValidationMessageBtn

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

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

Parameters:

validations - violations to be represented by button

validationExpanded - determines whether validation info popup is displayed on init

Returns:

button

createValidationMessageBtn

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

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

Parameters:

validations - violations to be represented by button

Returns:

button

getLabel

String getLabel(Object object,
                String path)

Gets a label for violated path of specified object

Parameters:

object - object being validated

path - violated path

Returns:

user-friendly presentation of path

getIconStyleClass

String getIconStyleClass(ValidationSeverity severity)

Gets a css class of icon representing provided severity level

Parameters:

severity - severity level to be represented

Returns:

css class for icon

getSeverityStyleClass

String getSeverityStyleClass(ValidationSeverity severity)

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

Parameters:

severity - severity level to be represented

Returns:

css class for component

cleanAllValidationCss

void cleanAllValidationCss(org.zkoss.zk.ui.HtmlBasedComponent container)

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

Parameters:

container - component to be cleared