BeanUtilsBindingProcessor (Metawidget API Documentation)

java.lang.Object
- org.metawidget.swing.widgetprocessor.binding.beanutils.BeanUtilsBindingProcessor

All Implemented Interfaces:

Immutable, BindingConverter, AdvancedWidgetProcessor<JComponent,SwingMetawidget>, WidgetProcessor<JComponent,SwingMetawidget>
```
public class BeanUtilsBindingProcessor
extends Object
implements AdvancedWidgetProcessor<JComponent,SwingMetawidget>, BindingConverter
```
Property binding implementation based on BeanUtils.
Note: BeanUtils does not bind actions, such as invoking a method when a JButton is pressed. For that, see ReflectionBindingProcessor and MetawidgetActionStyle or SwingAppFrameworkActionStyle.

Author:

Richard Kennard, Stefan Ackermann

Constructor Summary

Constructors
Constructor and Description

BeanUtilsBindingProcessor()

BeanUtilsBindingProcessor(BeanUtilsBindingProcessorConfig config)

Constructors
Constructor and Description
`BeanUtilsBindingProcessor()`
`BeanUtilsBindingProcessor(BeanUtilsBindingProcessorConfig config)`

Method Summary

Methods
Modifier and Type	Method and Description
`Object`	`convertFromString(String value, Class<?> expectedType)` Convert the given String to the given expected type, if possible.
`void`	`onEndBuild(SwingMetawidget metawidget)` Event called at the end of widget building, after all widgets have been built and added to the `Layout`.
`void`	`onStartBuild(SwingMetawidget metawidget)` Event called at the start of the widget building process, before the `WidgetBuilder` is called.
`JComponent`	`processWidget(JComponent component, String elementName, Map<String,String> attributes, SwingMetawidget metawidget)` Process the given widget.
`void`	`rebind(Object toRebind, SwingMetawidget metawidget)` Rebinds the Metawidget to the given Object.
`protected Object`	`retrieveValueFromWidget(org.metawidget.swing.widgetprocessor.binding.beanutils.BeanUtilsBindingProcessor.SavedBinding binding)`
`void`	`save(SwingMetawidget metawidget)`
`protected void`	`saveValueToObject(SwingMetawidget metawidget, String names, Object componentValue)` Save the given value into the given source at the location specified by the given names.
`protected void`	`saveValueToWidget(org.metawidget.swing.widgetprocessor.binding.beanutils.BeanUtilsBindingProcessor.SavedBinding binding, Object sourceValue)`

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

- Constructor Detail
  - BeanUtilsBindingProcessor
```
public BeanUtilsBindingProcessor()
```
  - BeanUtilsBindingProcessor
```
public BeanUtilsBindingProcessor(BeanUtilsBindingProcessorConfig config)
```
- Method Detail
  - onStartBuild
```
public void onStartBuild(SwingMetawidget metawidget)
```
    Description copied from interface: AdvancedWidgetProcessor
    
    Event called at the start of the widget building process, before the WidgetBuilder is called. WidgetProcessors 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 AdvancedWidgetProcessor<JComponent,SwingMetawidget>
    
    Parameters:
    metawidget - the parent Metawidget. Never null
  - processWidget
```
public JComponent processWidget(JComponent component,
                       String elementName,
                       Map<String,String> attributes,
                       SwingMetawidget metawidget)
```
    Description copied from interface: WidgetProcessor
    
    Process the given widget. Called after a widget has been built by the WidgetBuilder, and before it is added to the Layout.
    
    Specified by:
    
    processWidget in interface WidgetProcessor<JComponent,SwingMetawidget>
    
    Parameters:
    component - 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)
  - rebind
```
public void rebind(Object toRebind,
          SwingMetawidget metawidget)
```
    Rebinds the Metawidget to the given Object.
    This method is an optimization that allows clients to load a new object into the binding without calling setToInspect, and therefore without reinspecting the object or recreating the components. It is the client's responsbility to ensure the rebound object is compatible with the original setToInspect.
  - save
```
public void save(SwingMetawidget metawidget)
```
  - convertFromString
```
public Object convertFromString(String value,
                       Class<?> expectedType)
```
    Description copied from interface: BindingConverter
    
    Convert the given String to the given expected type, if possible. If not possible, just return the original String.
    
    Specified by:
    
    convertFromString in interface BindingConverter
  - onEndBuild
```
public void onEndBuild(SwingMetawidget metawidget)
```
    Description copied from interface: AdvancedWidgetProcessor
    
    Event called at the end of widget building, after all widgets have been built and added to the Layout. WidgetProcessors 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 AdvancedWidgetProcessor<JComponent,SwingMetawidget>
    
    Parameters:
    metawidget - the parent Metawidget. Never null
  - saveValueToObject
```
protected void saveValueToObject(SwingMetawidget metawidget,
                     String names,
                     Object componentValue)
                          throws Exception
```
    Save the given value into the given source at the location specified by the given names.
    Clients may override this method to incorporate their own setter convention.
    
    Parameters:
    componentValue - the raw value from the JComponent
    
    Throws:
    
    Exception
  - retrieveValueFromWidget
```
protected Object retrieveValueFromWidget(org.metawidget.swing.widgetprocessor.binding.beanutils.BeanUtilsBindingProcessor.SavedBinding binding)
                                  throws Exception
```
    Throws:
    
    Exception
  - saveValueToWidget
```
protected void saveValueToWidget(org.metawidget.swing.widgetprocessor.binding.beanutils.BeanUtilsBindingProcessor.SavedBinding binding,
                     Object sourceValue)
                          throws Exception
```
    Throws:
    
    Exception

Class BeanUtilsBindingProcessor

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BeanUtilsBindingProcessor

BeanUtilsBindingProcessor

Method Detail

onStartBuild

processWidget

rebind

save

convertFromString

onEndBuild

saveValueToObject

retrieveValueFromWidget

saveValueToWidget