com.github.bordertech.wcomponents.examples.validation

Class ValidationContainer

java.lang.Object

com.github.bordertech.wcomponents.AbstractWComponent

com.github.bordertech.wcomponents.WBeanComponent

com.github.bordertech.wcomponents.WContainer

com.github.bordertech.wcomponents.WPanel

com.github.bordertech.wcomponents.examples.validation.ValidationContainer

All Implemented Interfaces:

AjaxInternalTrigger, AjaxTarget, BeanAware, BeanBound, BeanProviderBound, Container, DataBound, DropZone, Marginable, MessageContainer, MutableContainer, NamingContextable, SubordinateTarget, WComponent, WebComponent, Serializable

Direct Known Subclasses:

BasicDiagnosticComponentExample, BasicFieldLayoutValidationExample, BasicFieldsValidationExample, BasicFieldsValidationExample2, SubordinateControlExample, SubordinateControlMandatoryExample, ValidationAndDataRendererIssue

public class ValidationContainer
extends WPanel
implements MessageContainer

This class is a support class used by some of the validation examples as a container for testing the validation logic contained in another WComponent. This class has a button called "validate" to call the validation logic on the contained component, and a box for displaying any errors found. If no validation errors are found then a "success" dialog is displayed.

Author:

Martin Shevchenko

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.github.bordertech.wcomponents.WPanel

WPanel.PanelMode, WPanel.PanelModel, WPanel.Type

Nested classes/interfaces inherited from class com.github.bordertech.wcomponents.AbstractWComponent

AbstractWComponent.WComponentRef

Field Summary

Fields inherited from interface com.github.bordertech.wcomponents.WComponent

DEFAULT_APPLICATION_ID, DEFAULT_INTERNAL_ID, DEFAULT_NO_ID, ID_CONTEXT_SEPERATOR, ID_FRAMEWORK_ASSIGNED_SEPERATOR, ID_VALIDATION_PATTERN

Constructor Summary

Constructors

Constructor and Description
ValidationContainer(WComponent componentToValidate) Creates a ValidationContainer.

Method Summary

Methods

Modifier and Type	Method and Description
WComponent	getComponentToValidate()
WValidationErrors	getErrorsBox()
WMessages	getMessages()
void	setValidatingAction(Action action) Sets the action for the validation button.
void	showSuccessDialog() Displays the success dialog.

Methods inherited from class com.github.bordertech.wcomponents.WPanel

add, add, getAccessKey, getAccessKeyAsString, getComponentModel, getDefaultSubmitButton, getLayout, getLayoutConstraints, getMargin, getMode, getOrCreateComponentModel, getTitleText, getType, newComponentModel, remove, setAccessKey, setDefaultSubmitButton, setLayout, setMargin, setMode, setTitleText, setType, toString

Methods inherited from class com.github.bordertech.wcomponents.WContainer

add, add, getChildAt, getChildCount, getChildren, getIndexOfChild, getNamingContextId, isNamingContext, removeAll, setNamingContext, setTemplate, setTemplate, setTemplateMarkUp

Methods inherited from class com.github.bordertech.wcomponents.WBeanComponent

addBeanToScratchMap, doUpdateBeanValue, getBean, getBeanFromScratchMap, getBeanId, getBeanProperty, getBeanProvider, getBeanScratchMap, getBeanValue, getData, isBeanInScratchMap, isChanged, isSearchAncestors, isUseRequestScopeScratchMap, removeBeanFromScratchMap, resetData, setBean, setBeanId, setBeanProperty, setBeanProvider, setData, setSearchAncestors, updateBeanValue

Methods inherited from class com.github.bordertech.wcomponents.AbstractWComponent

addHtmlClass, addHtmlClass, addNotify, afterPaint, assertAddSupported, beforePaint, createErrorDiagnostic, createErrorDiagnostic, forward, getAccessibleText, getAttribute, getBaseUrl, getDefaultModel, getEnvironment, getHeaders, getHtmlClass, getHtmlClasses, getId, getIdName, getInternalId, getLabel, getName, getParent, getScratchMap, getTabIndex, getTag, getTemplate, getTemplateMarkUp, getToolTip, handleRequest, hasNoComponentModel, hasTabIndex, initialiseComponentModel, invokeLater, invokeLaters, isDebugStructure, isDefaultState, isFlagSet, isHidden, isInitialised, isLocked, isTracking, isTrackingEnabled, isValidate, isVisible, paint, paintComponent, preparePaint, preparePaintComponent, removeAttribute, removeComponentModel, removeHtmlClass, removeHtmlClass, removeNotify, replaceWComponent, reset, serviceRequest, setAccessibleText, setAttribute, setEnvironment, setFlag, setFocussed, setHidden, setHtmlClass, setHtmlClass, setIdName, setInitialised, setLocked, setTag, setToolTip, setTrackingEnabled, setValidate, setVisible, showErrorIndicators, showErrorIndicatorsForComponent, showWarningIndicators, showWarningIndicatorsForComponent, tidyUpUIContext, tidyUpUIContextForTree, validate, validateComponent, writeReplace

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.bordertech.wcomponents.WComponent

addHtmlClass, addHtmlClass, forward, getAccessibleText, getAttribute, getBaseUrl, getEnvironment, getHeaders, getHtmlClass, getHtmlClasses, getId, getIdName, getInternalId, getLabel, getName, getParent, getTabIndex, getTag, getToolTip, handleRequest, hasTabIndex, invokeLater, isDefaultState, isHidden, isInitialised, isLocked, isTracking, isTrackingEnabled, isValidate, isVisible, paint, preparePaint, removeAttribute, removeHtmlClass, removeHtmlClass, reset, serviceRequest, setAccessibleText, setAttribute, setEnvironment, setFocussed, setHtmlClass, setHtmlClass, setIdName, setInitialised, setLocked, setTag, setToolTip, setTrackingEnabled, setValidate, setVisible, showErrorIndicators, showWarningIndicators, tidyUpUIContextForTree, validate

Constructor Detail

ValidationContainer

public ValidationContainer(WComponent componentToValidate)

Creates a ValidationContainer.

Parameters:

componentToValidate - the component to validate.

Method Detail

getMessages

public WMessages getMessages()

Specified by:

getMessages in interface MessageContainer

getComponentToValidate

public WComponent getComponentToValidate()

Returns:

the component to validate.

getErrorsBox

public WValidationErrors getErrorsBox()

Returns:

the validation errors box.

setValidatingAction

public void setValidatingAction(Action action)

Sets the action for the validation button. The action should be a ValidatingAction for validation to actually occur.

Parameters:

action - the button action.

showSuccessDialog

public void showSuccessDialog()

Displays the success dialog.