org.netbeans.validation.api.ui.swing

Class AbstractValidationListener<CompType extends javax.swing.JComponent,T>

java.lang.Object

org.netbeans.validation.api.ui.ValidationItem

org.netbeans.validation.api.ui.ValidationListener<CompType>

org.netbeans.validation.api.ui.swing.AbstractValidationListener<CompType,T>

All Implemented Interfaces:

java.util.EventListener

public abstract class AbstractValidationListener<CompType extends javax.swing.JComponent,T>
extends ValidationListener<CompType>

Base class for ValidationListeners.

Author:

Tim Boudreau

Constructor Summary

Constructors

Constructor and Description
AbstractValidationListener(java.lang.Class<CompType> type, CompType comp, ValidationUI ui, Validator<T> validator) Create a new AbstractValidationListener for the single component passed here as an argument.

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	findComponentName(CompType comp) Get the name of the component which should be passed to validate.
protected abstract T	getModelObject(CompType comp) Get the model object that will be passed to validate
protected void	onValidate(CompType component, Problem validationResult) Called when validation runs.
protected void	performValidation(Problems ps) Called by the simplevalidation infrastructure when it is time to perform the validation.

Methods inherited from class org.netbeans.validation.api.ui.ValidationListener

getTarget

Methods inherited from class org.netbeans.validation.api.ui.ValidationItem

performValidation, runWithValidationSuspended

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractValidationListener

public AbstractValidationListener(java.lang.Class<CompType> type,
                                  CompType comp,
                                  ValidationUI ui,
                                  Validator<T> validator)

Create a new AbstractValidationListener for the single component passed here as an argument. If the component is not expected to live after the validator is detached, you can add this object as a listener to the component in the constructor (but remember that this means the component will reference this validator forever).

Parameters:

comp -

Method Detail

findComponentName

protected java.lang.String findComponentName(CompType comp)

Get the name of the component which should be passed to validate. The default implementation delegates to nameForComponent which will either return the client-property based name or the result of getName() on the component.

Parameters:

comp - The component

Returns:

A localized name

getModelObject

protected abstract T getModelObject(CompType comp)

Get the model object that will be passed to validate

Parameters:

comp - The component

Returns:

The model object

onValidate

protected void onValidate(CompType component,
                          Problem validationResult)

Called when validation runs. The default implementation does nothing; some validators may want to change the visual appearance of the component to indicate an error.

Parameters:

component - The component

validationResult - The result of validation

performValidation

protected final void performValidation(Problems ps)

Description copied from class: ValidationListener

Called by the simplevalidation infrastructure when it is time to perform the validation. The instance of the class subclassing ValidationListener should have access to the UI-component to validate, and to a validator, and simply call the validator's validate() method with the appropriate arguments.

If the component to be validated is disabled (it is greyed out and can't be interacted with) it is usually considered to have no problems.

Specified by:

performValidation in class ValidationListener<CompType extends javax.swing.JComponent>