org.apache.wicket.markup.html.form.validation
Class AbstractFormValidator

java.lang.Object
  org.apache.wicket.markup.html.form.validation.AbstractFormValidator

All Implemented Interfaces:

Serializable, IClusterable, IFormValidator

Direct Known Subclasses:

EqualInputValidator

public abstract class AbstractFormValidator
extends Object
implements IFormValidator

Base class for IFormValidators.

Author:

Igor Vaynberg (ivaynberg)

See Also:

Serialized Form

Constructor Summary

AbstractFormValidator()

Method Summary

void	error(FormComponent<?> fc) Reports an error against validatable using the map returned by variablesMap()for variable interpolations and message key returned by resourceKey().
void	error(FormComponent<?> fc, Map<String,Object> vars) Reports an error against the validatable using the given map for variable interpolations and message resource key provided by resourceKey()
void	error(FormComponent<?> fc, String resourceKey) Reports an error against the validatable using the given resource key
void	error(FormComponent<?> fc, String resourceKey, Map<String,Object> vars) Reports an error against the validatable using the specified resource key and variable map
protected Map<?,?>	messageModel() Deprecated. use variablesMap() instead
protected String	resourceKey() Gets the resource key for validator's error message from the ApplicationSettings class.
protected Map<String,Object>	variablesMap() Gets the default variables for interpolation.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.wicket.markup.html.form.validation.IFormValidator

getDependentFormComponents, validate

Constructor Detail

AbstractFormValidator

public AbstractFormValidator()

Method Detail

messageModel

@Deprecated
protected final Map<?,?> messageModel()

Deprecated. use variablesMap() instead

DEPRECATED/UNSUPPORTED Gets the default variables for interpolation.

Returns:

a map with the variables for interpolation

Throws:

UnsupportedOperationException - FIXME 2.0: remove asap

error

public void error(FormComponent<?> fc)

Reports an error against validatable using the map returned by variablesMap()for variable interpolations and message key returned by resourceKey().

Parameters:

fc - form component against which the error is reported

error

public void error(FormComponent<?> fc,
                  String resourceKey)

Reports an error against the validatable using the given resource key

Parameters:

fc - form component against which the error is reported

resourceKey - The message resource key to use

error

public void error(FormComponent<?> fc,
                  Map<String,Object> vars)

Reports an error against the validatable using the given map for variable interpolations and message resource key provided by resourceKey()

Parameters:

fc - form component against which the error is reported

vars - variables for variable interpolation

error

public void error(FormComponent<?> fc,
                  String resourceKey,
                  Map<String,Object> vars)

Reports an error against the validatable using the specified resource key and variable map

Parameters:

fc - form component against which the error is reported

resourceKey - The message resource key to use

vars - The model for variable interpolation

variablesMap

protected Map<String,Object> variablesMap()

Gets the default variables for interpolation. These are for every component:

• ${input(n)}: the user's input
• ${name(n)}: the name of the component
• ${label(n)}: the label of the component - either comes from FormComponent.labelModel or resource key [form-id].[form-component-id] in that order

Returns:

a map with the variables for interpolation

resourceKey

protected String resourceKey()

Gets the resource key for validator's error message from the ApplicationSettings class.

Returns:

the resource key based on the form component