SwingWidgetBuilder (Metawidget API Documentation)

java.lang.Object
- org.metawidget.swing.widgetbuilder.SwingWidgetBuilder

All Implemented Interfaces:

Immutable, SwingValuePropertyProvider, WidgetBuilder<JComponent,SwingMetawidget>
```
public class SwingWidgetBuilder
extends Object
implements WidgetBuilder<JComponent,SwingMetawidget>, SwingValuePropertyProvider
```
WidgetBuilder for Swing environments.
Creates native Swing JComponents, such as JTextField and JComboBox, to suit the inspected fields.

Author:

Richard Kennard

Constructor Summary

Constructors
Constructor and Description

SwingWidgetBuilder()

SwingWidgetBuilder(SwingWidgetBuilderConfig config)

Constructors
Constructor and Description
`SwingWidgetBuilder()`
`SwingWidgetBuilder(SwingWidgetBuilderConfig config)`

Method Summary

Methods
Modifier and Type	Method and Description
`JComponent`	`buildWidget(String elementName, Map<String,String> attributes, SwingMetawidget metawidget)` Builds the most appropriate widget for this business field.
`protected JComponent`	`createTable(String elementName, Map<String,String> attributes, SwingMetawidget metawidget)`
`String`	`getValueProperty(Component component)` Returns the property used to get/set the value of the component.

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

- Constructor Detail
  - SwingWidgetBuilder
```
public SwingWidgetBuilder()
```
  - SwingWidgetBuilder
```
public SwingWidgetBuilder(SwingWidgetBuilderConfig config)
```
- Method Detail
  - getValueProperty
```
public String getValueProperty(Component component)
```
    Description copied from interface: SwingValuePropertyProvider
    
    Returns the property used to get/set the value of the component.
    If the component is not known, returns null.
    
    Specified by:
    
    getValueProperty in interface SwingValuePropertyProvider
  - buildWidget
```
public JComponent buildWidget(String elementName,
                     Map<String,String> attributes,
                     SwingMetawidget metawidget)
```
    Description copied from interface: WidgetBuilder
    
    Builds the most appropriate widget for this business field.
    
    Specified by:
    
    buildWidget in interface WidgetBuilder<JComponent,SwingMetawidget>
    
    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)
  - createTable
```
protected JComponent createTable(String elementName,
                     Map<String,String> attributes,
                     SwingMetawidget metawidget)
```

Class SwingWidgetBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SwingWidgetBuilder

SwingWidgetBuilder

Method Detail

getValueProperty

buildWidget

createTable