org.netbeans.validation.api.ui

Class ValidationListenerFactory<CompType,ModelType>

java.lang.Object

org.netbeans.validation.api.ui.ValidationListenerFactory<CompType,ModelType>

public abstract class ValidationListenerFactory<CompType,ModelType>
extends java.lang.Object

Factory for listeners on a particular type of component with a particular type of model. Creates listeners which can be attached to one component and run validators for the specified model type. For example, a validator for the Document of a JTextArea would most likely be a Validator<JTextComponent, Document>.

Instances of ValidationListenerFactory for specific component types may be declaratively registered in META-INF/services in your JAR (i.e. findable via JDK 6's ServiceLoader or NetBeans default Lookup).

The library contains built-in listeners for Swing components, including JList, JTextComponent, JComboBox and arrays of AbstractButton. These will be found in preference to any registered factories.

Author:

Tim Boudreau

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ValidationListenerFactory(java.lang.Class<CompType> componentType, java.lang.Class<ModelType> modelType)

Method Summary

Modifier and Type	Method and Description
protected abstract ValidationListener<CompType>	createListener(CompType component, ValidationStrategy strategy, ValidationUI validationUI, Validator<ModelType> validator)
static <CType,MType> ValidationListener<CType>	createValidationListener(CType component, ValidationStrategy strategy, ValidationUI validationUI, Validator<MType> validator) Create a ValidationListener for a specific type of component, which accepts Validators of a given type.

Methods inherited from class java.lang.Object

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

Constructor Detail

ValidationListenerFactory

protected ValidationListenerFactory(java.lang.Class<CompType> componentType,
                                    java.lang.Class<ModelType> modelType)

Method Detail

createValidationListener

public static <CType,MType> ValidationListener<CType> createValidationListener(CType component,
                                                                               ValidationStrategy strategy,
                                                                               ValidationUI validationUI,
                                                                               Validator<MType> validator)

Create a ValidationListener for a specific type of component, which accepts Validators of a given type. By default, the following combinations are supported:

• JList + Integer[]
• JList[] + ListSelectionModel
• JTextComponent + Document
• JTextComponent + String
• JComboBox + ComboBoxModel
• JComboBox + String
• AbstractButton[] + ButtonModel[]
• AbstractButton[] + Integer

To register validation listeners for additional types, subclass SwingValidationListenerFactory and register it in JDK 6's ServiceLoader/NetBeans default Lookup by placing flat files in META-INF/services in a JAR on the classpath. Each such registered type must also have an annotation of type ListenerFor, so that it can be located correctly. Example:

@SwingValidationListenerFactory.ListenerFor(componentType=JColorChooser.class, modelObjectType=Color.class)
public class ColorChooserValidationListenerFactory extends SwingValidationListenerFactory {

    @Override
    protected  ValidationListener createListener(
        JColorChooser component, ValidationStrategy strategy,
        ValidationUI validationUI, Validator validator) {
        //This cast is safe - this method will never be called unless
        //the type has first been checked
        return new ColorChooserListener(component, validationUI,
            (Validator) validator);
    }

    static final class ColorChooserListener
                    extends AbstractValidationListener
                    implements PropertyChangeListener {
        ColorChooserListener (JColorChooser comp, ValidationUI ui,
                              Validator validator) {
            super (comp, ui, color);
            comp.addPropertyChangeListener("color", this);
        }

        @Override
        protected Color getModelObject(JColorChooser comp) {
            return comp.getColor();
        }

        public void propertyChange(PropertyChangeEvent evt) {
            performValidation();
        }
    }
}

Type Parameters:

CType - The component type.

MType - The type of object the Validator accepts

Parameters:

component - A component of CType or a subclass

strategy - The validation strategy to use

validationUI - A validation UI, typically the component decorator

validator - A validator that accepts ModelType arguments

Returns:

a listener

createListener

protected abstract ValidationListener<CompType> createListener(CompType component,
                                                               ValidationStrategy strategy,
                                                               ValidationUI validationUI,
                                                               Validator<ModelType> validator)