OverriddenWidgetBuilder (Metawidget API Documentation)

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.metawidget.swt.widgetbuilder.OverriddenWidgetBuilder

All Implemented Interfaces:

Immutable, WidgetBuilder<org.eclipse.swt.widgets.Control,SwtMetawidget>
```
public class OverriddenWidgetBuilder
extends Object
implements WidgetBuilder<org.eclipse.swt.widgets.Control,SwtMetawidget>
```
WidgetBuilder for overridden widgets in SWT environments.
Locates overridden widgets based on a name attribute in their setData.
Because of the way SWT requires Controls to nominate their Composite up-front (ie. in their constructor), the behaviour of OverriddenWidgetBuilder is limited to only overriding Controls within their immediate Composite. Therefore OverriddenWidgetBuilder will not work if used to override Controls that are laid out inside, say, a TabFolderLayoutDecorator.

Author:

Richard Kennard

Constructor Summary

Constructors
Constructor and Description

OverriddenWidgetBuilder()

Method Summary

Methods
Modifier and Type	Method and Description
`org.eclipse.swt.widgets.Control`	`buildWidget(String elementName, Map<String,String> attributes, SwtMetawidget metawidget)` Builds the most appropriate widget for this business field.

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

- Constructor Detail
  - OverriddenWidgetBuilder
```
public OverriddenWidgetBuilder()
```
- Method Detail
  - buildWidget
```
public org.eclipse.swt.widgets.Control buildWidget(String elementName,
                                          Map<String,String> attributes,
                                          SwtMetawidget metawidget)
```
    Description copied from interface: WidgetBuilder
    
    Builds the most appropriate widget for this business field.
    
    Specified by:
    
    buildWidget in interface WidgetBuilder<org.eclipse.swt.widgets.Control,SwtMetawidget>
    
    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)

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2015. All Rights Reserved.