JGoodiesValidatorProcessor (Metawidget API Documentation)

java.lang.Object
- org.metawidget.swing.widgetprocessor.validator.jgoodies.JGoodiesValidatorProcessor

All Implemented Interfaces:

Immutable, AdvancedWidgetProcessor<JComponent,SwingMetawidget>, WidgetProcessor<JComponent,SwingMetawidget>
```
public class JGoodiesValidatorProcessor
extends Object
implements AdvancedWidgetProcessor<JComponent,SwingMetawidget>
```
Processor to add JGoodies Validators to a Component.
Out of the box, JGoodies does not provide any Validator implementations, so by default this class only calls JGoodies' setMandatory and updateComponentTreeMandatory methods. Clients are expected to extend this class and override getValidator to integrate their own validators.

Author:

Richard Kennard, Stefan Ackermann

Constructor Summary

Constructors
Constructor and Description

JGoodiesValidatorProcessor()

Constructors
Constructor and Description
`JGoodiesValidatorProcessor()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`attachValidator(JComponent component, com.jgoodies.validation.Validator<?> validator, String path, SwingMetawidget metawidget)` Attach the given Validator to the given JComponent.
`protected com.jgoodies.validation.Validator<?>`	`getValidator(JComponent component, Map<String,String> attributes, String path, SwingMetawidget metawidget)` Return the appropriate validator for the given JComponent with the given attributes.
`void`	`onEndBuild(SwingMetawidget metawidget)` Event called at the end of widget building, after all widgets have been built and added to the `Layout`.
`void`	`onStartBuild(SwingMetawidget metawidget)` Event called at the start of the widget building process, before the `WidgetBuilder` is called.
`JComponent`	`processWidget(JComponent component, String elementName, Map<String,String> attributes, SwingMetawidget metawidget)` Process the given widget.
`protected void`	`updateComponent(JComponent component, com.jgoodies.validation.ValidationResult validationResult, SwingMetawidget metawidget)` Update the given component with the given validation result.
`protected void`	`validateChange(JComponent component, com.jgoodies.validation.Validator<?> validator, String path, SwingMetawidget metawidget)` Execute the given Validator against the given JComponent.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - JGoodiesValidatorProcessor
```
public JGoodiesValidatorProcessor()
```
- Method Detail
  - onStartBuild
```
public void onStartBuild(SwingMetawidget metawidget)
```
    Description copied from interface: AdvancedWidgetProcessor
    
    Event called at the start of the widget building process, before the WidgetBuilder is called. WidgetProcessors may wish to act on this event to initialize themselves ready for processing. This event is only called once per inspection, not once per widget built.
    
    Specified by:
    
    onStartBuild in interface AdvancedWidgetProcessor<JComponent,SwingMetawidget>
    
    Parameters:
    metawidget - the parent Metawidget. Never null
  - processWidget
```
public JComponent processWidget(JComponent component,
                       String elementName,
                       Map<String,String> attributes,
                       SwingMetawidget metawidget)
```
    Description copied from interface: WidgetProcessor
    
    Process the given widget. Called after a widget has been built by the WidgetBuilder, and before it is added to the Layout.
    
    Specified by:
    
    processWidget in interface WidgetProcessor<JComponent,SwingMetawidget>
    
    Parameters:
    component - the widget to process. Never null
    elementName - XML node name of the business field. Typically 'entity', 'property' or 'action'. Never null
    attributes - attributes of the widget to process. Never null. This Map is modifiable - changes will be passed to subsequent WidgetProcessors and Layouts
    metawidget - the parent Metawidget. Never null
    
    Returns:
    generally the original widget (as passed in to the first argument). Can be a different widget if the WidgetProcessor wishes to substitute the original widget for another. Can be null if the WidgetProcessor wishes to cancel all further processing of this widget (including laying out)
  - onEndBuild
```
public void onEndBuild(SwingMetawidget metawidget)
```
    Description copied from interface: AdvancedWidgetProcessor
    
    Event called at the end of widget building, after all widgets have been built and added to the Layout. WidgetProcessors may wish to act on this event to clean themselves up after processing. This event is only called once per inspection, not once per widget built.
    
    Specified by:
    
    onEndBuild in interface AdvancedWidgetProcessor<JComponent,SwingMetawidget>
    
    Parameters:
    metawidget - the parent Metawidget. Never null
  - getValidator
```
protected com.jgoodies.validation.Validator<?> getValidator(JComponent component,
                                                Map<String,String> attributes,
                                                String path,
                                                SwingMetawidget metawidget)
```
    Return the appropriate validator for the given JComponent with the given attributes.
    
    Parameters:
    component - component validator will be attached to (by attachValidator)
    attributes - attributes of the widget to layout. Never null
    path - path to the domain object property (of the form com.myapp.Foo/bar/baz)
    metawidget - the owning Metawidget. May be useful if you wish to look up other WidgetProcessors (such as
  - attachValidator
```
protected void attachValidator(JComponent component,
                   com.jgoodies.validation.Validator<?> validator,
                   String path,
                   SwingMetawidget metawidget)
```
    Attach the given Validator to the given JComponent.
    This method attaches the Validator, but largely delegates to validateChange for the actual validation work. Clients can override this method to attach Validators to other events, whilst still calling validateChange to perform the validation.
  - validateChange
```
protected void validateChange(JComponent component,
                  com.jgoodies.validation.Validator<?> validator,
                  String path,
                  SwingMetawidget metawidget)
```
    Execute the given Validator against the given JComponent.
  - updateComponent
```
protected void updateComponent(JComponent component,
                   com.jgoodies.validation.ValidationResult validationResult,
                   SwingMetawidget metawidget)
```
    Update the given component with the given validation result.
    Clients may override this method to integrate their own Visitors. For example
    ValidationComponentUtils.visitComponentTree( getMetawidget(), validationResult.keyMap(), new MyCustomVisitor() );
    
    Parameters:
    component - the component that was validated
    validationResult - contains the latest ValidationResult plus any previous ValidationResults for other components (so can be used correctly with updateComponentTreeXXX)

Class JGoodiesValidatorProcessor

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JGoodiesValidatorProcessor

Method Detail

onStartBuild

processWidget

onEndBuild

getValidator

attachValidator

validateChange

updateComponent