Interface ValidationRenderer
-
- All Known Implementing Classes:
ConfigurableFlowValidationRenderer,DefaultValidationRenderer,TypeAwareValidationRenderer
public interface ValidationRendererReturns css classes for validation results and render validation popup for editor
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidcleanAllValidationCss(org.zkoss.zk.ui.HtmlBasedComponent container)Removes all css classes from specified component that are related to validation violationorg.zkoss.zk.ui.ComponentcreateValidationMessageBtn(ValidationResult validations)Creates an icon indicating violation severity level.org.zkoss.zk.ui.ComponentcreateValidationMessageBtn(ValidationResult validations, boolean validationExpanded)Creates an icon indicating violation severity level.org.zkoss.zul.ListboxcreateValidationViolationsList(ValidatableContainer container)Creates a list, that displays all violations from provided validation resultorg.zkoss.zul.WindowcreateValidationViolationsPopup(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.java.lang.StringgetIconStyleClass(ValidationSeverity severity)Gets a css class of icon representing provided severity leveljava.lang.StringgetLabel(java.lang.Object object, java.lang.String path)Gets a label for violated path of specified objectjava.lang.StringgetSeverityStyleClass(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 validatedlistener- listener for confirmation - listener is notified after user clicksclose/confirmbutton 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 buttonvalidationExpanded- 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. attachonClickevent to icon, to show details of violation in popup.- Parameters:
validations- violations to be represented by button- Returns:
- button
-
getLabel
java.lang.String getLabel(java.lang.Object object, java.lang.String path)Gets a label for violated path of specified object- Parameters:
object- object being validatedpath- violated path- Returns:
- user-friendly presentation of path
-
getIconStyleClass
java.lang.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
java.lang.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
-
-