WidgetBuilder (Metawidget API Documentation)

Type Parameters:
W - base class of widgets that this WidgetBuilder builds
M - Metawidget that supports this WidgetBuilder

All Superinterfaces:

Immutable

All Known Subinterfaces:

AdvancedWidgetBuilder<W,M>

All Known Implementing Classes:

AndroidWidgetBuilder, CompositeWidgetBuilder, DisplayTagWidgetBuilder, ExtGwtWidgetBuilder, GwtWidgetBuilder, HtmlWidgetBuilder, HtmlWidgetBuilder, HtmlWidgetBuilder, HtmlWidgetBuilder, IceFacesWidgetBuilder, JspWidgetBuilder, OverriddenWidgetBuilder, OverriddenWidgetBuilder, OverriddenWidgetBuilder, OverriddenWidgetBuilder, OverriddenWidgetBuilder, OverriddenWidgetBuilder, OverriddenWidgetBuilder, PrimeFacesWidgetBuilder, ReadOnlyWidgetBuilder, ReadOnlyWidgetBuilder, ReadOnlyWidgetBuilder, ReadOnlyWidgetBuilder, ReadOnlyWidgetBuilder, ReadOnlyWidgetBuilder, ReadOnlyWidgetBuilder, ReadOnlyWidgetBuilder, ReadOnlyWidgetBuilder, ReadOnlyWidgetBuilder, ReadOnlyWidgetBuilder, ReadOnlyWidgetBuilder, RichFacesWidgetBuilder, RichFacesWidgetBuilder, SpringWidgetBuilder, SpringWidgetBuilder, StrutsWidgetBuilder, SwingWidgetBuilder, SwingXWidgetBuilder, SwtWidgetBuilder, TomahawkWidgetBuilder, VaadinWidgetBuilder
```
public interface WidgetBuilder<W,M extends W>
extends Immutable
```
Common interface implemented by all WidgetBuilders. WidgetBuilders decouple the process of choosing widgets based on inspection results.
WidgetBuilders 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).
Note: the name WidgetBuilder refers to the Builder design pattern.

Author:

Richard Kennard

Method Summary

Methods
Modifier and Type	Method and Description
`W`	`buildWidget(String elementName, Map<String,String> attributes, M metawidget)` Builds the most appropriate widget for this business field.

- Method Detail
  - buildWidget
```
W buildWidget(String elementName,
            Map<String,String> attributes,
            M metawidget)
```
    Builds the most appropriate widget for this business field.
    
    Parameters:
    elementName - XML node name of the business field. Typically 'entity', 'property' or 'action'. Never null
    attributes - attributes of the business field to build a widget for. Never null. This Map is modifiable - changes will be passed to subsequent WidgetBuilders, WidgetProcessors and Layouts
    metawidget - the parent Metawidget. Never null
    
    Returns:
    the built widget. To suppress a field, return a Stub. To defer to the next WidgetBuilder in the pipeline, return null. If there are no more WidgetBuilders in the pipeline, will create a nested Metawidget. This approach (return Stub for no field, null for nested Metawidget) as opposed to the other way around (return null for no field, return Metawidget for nested Metawidget) works better for those UI frameworks that cannot instatiate widgets without adding them to containers (eg. SWT)

Interface WidgetBuilder<W,M extends W>

Method Summary

Method Detail

buildWidget