CompositeWidgetBuilder (Metawidget API Documentation)

java.lang.Object
- org.metawidget.widgetbuilder.composite.CompositeWidgetBuilder<W,M>

All Implemented Interfaces:

Immutable, AdvancedWidgetBuilder<W,M>, WidgetBuilder<W,M>
```
public class CompositeWidgetBuilder<W,M extends W>
extends Object
implements AdvancedWidgetBuilder<W,M>
```
Delegates widget building to one or more sub-WidgetBuilders.
Each sub-WidgetBuilder in the list is invoked, in order, calling its buildWidget method. The first non-null result is returned. If all sub-WidgetBuilders return null, null is returned (the parent Metawidget will generally instantiate a nested Metawidget in this case).
Note: the name CompositeWidgetBuilder refers to the Composite design pattern.

Author:

Richard Kennard

Constructor Summary

Constructors
Constructor and Description

CompositeWidgetBuilder(CompositeWidgetBuilderConfig<W,M> config)

Constructors
Constructor and Description
`CompositeWidgetBuilder(CompositeWidgetBuilderConfig<W,M> config)`

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.
`WidgetBuilder<W,M>[]`	`getWidgetBuilders()` Exposed for `getValue` calls.
`void`	`onEndBuild(M metawidget)` Event called at the end of widget building, after all widgets have been built and added to the `Layout`.
`void`	`onStartBuild(M metawidget)` Event called at the start of the widget building process, before any `WidgetBuilder`s are called.

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

- Constructor Detail
  - CompositeWidgetBuilder
```
public CompositeWidgetBuilder(CompositeWidgetBuilderConfig<W,M> config)
```
- Method Detail
  - onStartBuild
```
public void onStartBuild(M metawidget)
```
    Description copied from interface: AdvancedWidgetBuilder
    
    Event called at the start of the widget building process, before any WidgetBuilders are called. WidgetBuilders 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 AdvancedWidgetBuilder<W,M extends W>
    
    Parameters:
    metawidget - the parent Metawidget. Never null
  - buildWidget
```
public W buildWidget(String elementName,
            Map<String,String> attributes,
            M metawidget)
```
    Description copied from interface: WidgetBuilder
    
    Builds the most appropriate widget for this business field.
    
    Specified by:
    
    buildWidget in interface WidgetBuilder<W,M extends W>
    
    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)
  - onEndBuild
```
public void onEndBuild(M metawidget)
```
    Description copied from interface: AdvancedWidgetBuilder
    
    Event called at the end of widget building, after all widgets have been built and added to the Layout. WidgetBuilderss 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 AdvancedWidgetBuilder<W,M extends W>
    
    Parameters:
    metawidget - the parent Metawidget. Never null
  - getWidgetBuilders
```
public WidgetBuilder<W,M>[] getWidgetBuilders()
```
    Exposed for getValue calls.

Class CompositeWidgetBuilder<W,M extends W>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CompositeWidgetBuilder

Method Detail

onStartBuild

buildWidget

onEndBuild

getWidgetBuilders