BeansBindingProcessor (Metawidget API Documentation)

java.lang.Object
- org.metawidget.swing.widgetprocessor.binding.beansbinding.BeansBindingProcessor

All Implemented Interfaces:

Immutable, BindingConverter, AdvancedWidgetProcessor<JComponent,SwingMetawidget>, WidgetProcessor<JComponent,SwingMetawidget>
```
public class BeansBindingProcessor
extends Object
implements AdvancedWidgetProcessor<JComponent,SwingMetawidget>, BindingConverter
```
Property binding implementation based on BeansBinding (JSR 295).
This implementation recognizes the following SwingMetawidget.setParameter parameters:
- UpdateStrategy.class - as defined by org.jdesktop.beansbinding.AutoBinding.UpdateStrategy. Defaults to READ_ONCE. If set to READ or READ_WRITE, the object being inspected must provide PropertyChangeSupport. If set to READ, there is no need to call BeansBindingProcessor.rebind. If set to READ_WRITE, there is no need to call BeansBindingProcessor.save.
Note: BeansBinding 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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class BeansBindingProcessor.State
Simple, lightweight structure for saving state.

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`BeansBindingProcessor.State` Simple, lightweight structure for saving state.

Constructor Summary

Constructors
Constructor and Description

BeansBindingProcessor()

BeansBindingProcessor(BeansBindingProcessorConfig config)

Constructors
Constructor and Description
`BeansBindingProcessor()`
`BeansBindingProcessor(BeansBindingProcessorConfig 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.
`protected <S,V,W> org.jdesktop.beansbinding.Converter<V,W>`	`getConverter(org.jdesktop.beansbinding.BeanProperty<S,V> propertySource, S source, Class<W> targetClass, Map<String,String> attributes)` Get a converter for the given source class.
`protected BeansBindingProcessor.State`	`getState(SwingMetawidget metawidget)`
`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.
`protected <S,V,T extends Component,W> org.jdesktop.beansbinding.Binding<S,V,T,W>`	`processBinding(org.jdesktop.beansbinding.Binding<S,V,T,W> binding, SwingMetawidget metawidget)` Process the given Binding prior to calling `binding.bind()`.
`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.
`void`	`save(SwingMetawidget metawidget)`
`protected <S,V,T extends Component,W> org.jdesktop.beansbinding.Binding`	`typesafeAdd(T component, String elementName, Map<String,String> attributes, SwingMetawidget metawidget)`

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

- Constructor Detail
  - BeansBindingProcessor
```
public BeansBindingProcessor()
```
  - BeansBindingProcessor
```
public BeansBindingProcessor(BeansBindingProcessorConfig 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
  - processBinding
```
protected <S,V,T extends Component,W> org.jdesktop.beansbinding.Binding<S,V,T,W> processBinding(org.jdesktop.beansbinding.Binding<S,V,T,W> binding,
                                                                                    SwingMetawidget metawidget)
```
    Process the given Binding prior to calling binding.bind(). Source, target and converters will have already been initialized.
    Clients can subclass this WidgetProcessor and override this method to manipulate the binding, for example to add a BindingListener.
    
    Parameters:
    metawidget - the owning Metawidget. May be useful for clients
    
    Returns:
    the processed Binding, or null to abort binding this property
  - typesafeAdd
```
protected <S,V,T extends Component,W> org.jdesktop.beansbinding.Binding typesafeAdd(T component,
                                                                        String elementName,
                                                                        Map<String,String> attributes,
                                                                        SwingMetawidget metawidget)
```
  - getConverter
```
protected <S,V,W> org.jdesktop.beansbinding.Converter<V,W> getConverter(org.jdesktop.beansbinding.BeanProperty<S,V> propertySource,
                                                            S source,
                                                            Class<W> targetClass,
                                                            Map<String,String> attributes)
```
    Get a converter for the given source class. Clients can override this method to provide customized converter implementations.
    
    Parameters:
    attributes - the attributes of the given business property. May be useful if you want to lookup, say, 'actual-class'
  - getState
```
protected BeansBindingProcessor.State getState(SwingMetawidget metawidget)
```

Class BeansBindingProcessor

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BeansBindingProcessor

BeansBindingProcessor

Method Detail

onStartBuild

processWidget

rebind

save

convertFromString

onEndBuild

processBinding

typesafeAdd

getConverter

getState