WidgetProcessor (Metawidget API Documentation)

Type Parameters:
W - base class of widgets that this WidgetProcessor processes
M - Metawidget that supports this WidgetProcessor

All Superinterfaces:

Immutable

All Known Subinterfaces:

AdvancedWidgetProcessor<W,M>

All Known Implementing Classes:

AjaxProcessor, BeansBindingProcessor, BeanUtilsBindingProcessor, CaptionProcessor, CssStyleProcessor, CssStyleProcessor, CssStyleProcessor, CssStyleProcessor, CssStyleProcessor, CssStyleProcessor, DataBindingProcessor, DisabledAttributeProcessor, HiddenFieldProcessor, HiddenFieldProcessor, HiddenFieldProcessor, HiddenFieldProcessor, HiddenFieldProcessor, HiddenFieldProcessor, IdProcessor, ImmediateAttributeProcessor, InputVerifierProcessor, JGoodiesValidatorProcessor, LabelProcessor, MinimumMaximumValidatorProcessor, NameProcessor, NameProcessor, PathProcessor, PathProcessor, ReadableIdProcessor, ReadableIdProcessor, ReflectionBindingProcessor, ReflectionBindingProcessor, ReflectionBindingProcessor, ReflectionBindingProcessor, RequiredAttributeProcessor, RequiredAttributeProcessor, RequiredProcessor, RichFacesProcessor, SimpleBindingProcessor, SimpleBindingProcessor, SimpleBindingProcessor, StandardBindingProcessor, StandardBindingProcessor, StandardBindingProcessor, StandardConverterProcessor, StandardConverterProcessor, StandardValidatorProcessor, StyleNameProcessor
```
public interface WidgetProcessor<W,M extends W>
extends Immutable
```
Common interface implemented by all WidgetProcessors. WidgetProcessors allow arbitrary processing of a widget following its building by the WidgetBuilder and before adding to the Layout.
WidgetProcessors must be immutable (or, at least, appear that way to clients. They can have caches or configuration settings internally, as long as they are threadsafe). If they need to store state, they should use the Metawidget passed to each method.
Note: WidgetProcessors are an example of the Strategy design pattern.

Author:

Richard Kennard

Method Summary

Methods
Modifier and Type	Method and Description
`W`	`processWidget(W widget, String elementName, Map<String,String> attributes, M metawidget)` Process the given widget.

- Method Detail
  - processWidget
```
W processWidget(W widget,
              String elementName,
              Map<String,String> attributes,
              M metawidget)
```
    Process the given widget. Called after a widget has been built by the WidgetBuilder, and before it is added to the Layout.
    
    Parameters:
    widget - 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)

Interface WidgetProcessor<W,M extends W>

Method Summary

Method Detail

processWidget