GridBagLayout (Metawidget API Documentation)

java.lang.Object
- org.metawidget.swing.layout.GridBagLayout

All Implemented Interfaces:

Immutable, AdvancedLayout<JComponent,JComponent,SwingMetawidget>, Layout<JComponent,JComponent,SwingMetawidget>
```
public class GridBagLayout
extends Object
implements AdvancedLayout<JComponent,JComponent,SwingMetawidget>
```
Layout to arrange widgets using java.awt.GridBagLayout.
Widgets are arranged in a table, with one column for labels and another for the widget.

Author:

Richard Kennard

Constructor Summary

Constructors
Constructor and Description

GridBagLayout()

GridBagLayout(GridBagLayoutConfig config)

Constructors
Constructor and Description
`GridBagLayout()`
`GridBagLayout(GridBagLayoutConfig config)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`endContainerLayout(JComponent container, SwingMetawidget metawidget)` Finish the given container, using the given Metawidget to access additional services if needed (such as state saving).
`protected void`	`layoutAfterChild(JComponent child, Map<String,String> attributes, JComponent container, SwingMetawidget metawidget)`
`protected void`	`layoutBeforeChild(JComponent child, String labelText, String elementName, Map<String,String> attributes, JComponent container, SwingMetawidget metawidget)`
`void`	`layoutWidget(JComponent component, String elementName, Map<String,String> attributes, JComponent container, SwingMetawidget metawidget)` Layout the given widget within the given container, using the given elementName and attributes as a guide and the given Metawidget to access additional services if needed (such as state saving)
`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 void`	`setFillConstraints(JComponent component, GridBagConstraints componentConstraints)` Sets the fill constraints for this component.
`void`	`startContainerLayout(JComponent container, SwingMetawidget metawidget)` Initialise the given container, using the given Metawidget to access additional services if needed (such as state saving).
`protected boolean`	`willFillHorizontally(JComponent component, Map<String,String> attributes)`
`protected boolean`	`willFillVertically(JComponent component, Map<String,String> attributes)`

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

- Constructor Detail
  - GridBagLayout
```
public GridBagLayout()
```
  - GridBagLayout
```
public GridBagLayout(GridBagLayoutConfig config)
```
- Method Detail
  - onStartBuild
```
public void onStartBuild(SwingMetawidget metawidget)
```
    Description copied from interface: AdvancedLayout
    
    Event called at the start of the widget building process, before the WidgetBuilder is called. Layouts may wish to act on this event to initialize themselves ready for processing, or to perform 'outermost-container-only' processing, such as adding facets. This event is only called once per inspection, not once per widget built.
    
    Specified by:
    
    onStartBuild in interface AdvancedLayout<JComponent,JComponent,SwingMetawidget>
    
    Parameters:
    metawidget - the parent Metawidget. Never null
  - startContainerLayout
```
public void startContainerLayout(JComponent container,
                        SwingMetawidget metawidget)
```
    Description copied from interface: AdvancedLayout
    
    Initialise the given container, using the given Metawidget to access additional services if needed (such as state saving).
    
    Specified by:
    
    startContainerLayout in interface AdvancedLayout<JComponent,JComponent,SwingMetawidget>
    
    Parameters:
    container - the container to layout. This is often the same as the given Metawidget
    metawidget - the parent Metawidget. Never null
  - layoutWidget
```
public void layoutWidget(JComponent component,
                String elementName,
                Map<String,String> attributes,
                JComponent container,
                SwingMetawidget metawidget)
```
    Description copied from interface: Layout
    
    Layout the given widget within the given container, using the given elementName and attributes as a guide and the given Metawidget to access additional services if needed (such as state saving)
    layoutWidget is called immediately after WidgetBuilder.buildWidget and WidgetProcessor.processWidget, and before the next widget is generated. An alternate design would be to 'collect' all widgets generated by buildWidget and processWidget, then iterate over them separately for the layout. If you prefer this approach, you can simulate it by having layoutWidget do nothing but 'remember' each widget, then iterate over them in endContainerLayout (see the AdvancedLayout interface). However not all UI frameworks allow this approach, because they do not suport widgets being instantiated independent of a layout, nor moved between layouts (e.g. SWT)
    
    Specified by:
    
    layoutWidget in interface Layout<JComponent,JComponent,SwingMetawidget>
    
    Parameters:
    component - the widget to layout. Never null
    elementName - XML node name of the business field. Typically 'entity', 'property' or 'action'. Never null
    attributes - attributes of the widget to layout. Never null. This Map is modifiable - changes will be passed to subsequent WidgetProcessors and Layouts
    container - the container to add to. This is often the same as the given Metawidget
    metawidget - the Metawidget to use to access additional services. Never null
  - endContainerLayout
```
public void endContainerLayout(JComponent container,
                      SwingMetawidget metawidget)
```
    Description copied from interface: AdvancedLayout
    
    Finish the given container, using the given Metawidget to access additional services if needed (such as state saving).
    
    Specified by:
    
    endContainerLayout in interface AdvancedLayout<JComponent,JComponent,SwingMetawidget>
    
    Parameters:
    container - the container to layout. This is often the same as the given Metawidget
    metawidget - the Metawidget to use to access additional services. Never null
  - onEndBuild
```
public void onEndBuild(SwingMetawidget metawidget)
```
    Description copied from interface: AdvancedLayout
    
    Event called at the end of widget building, after all widgets have been built and added to the Layout. Layouts may wish to act on this event to clean themselves up after processing, or to perform 'outermost-container-only' processing, such as adding facets. This event is only called once per inspection, not once per widget built.
    
    Specified by:
    
    onEndBuild in interface AdvancedLayout<JComponent,JComponent,SwingMetawidget>
    
    Parameters:
    metawidget - the parent Metawidget. Never null
  - layoutBeforeChild
```
protected void layoutBeforeChild(JComponent child,
                     String labelText,
                     String elementName,
                     Map<String,String> attributes,
                     JComponent container,
                     SwingMetawidget metawidget)
```
  - layoutAfterChild
```
protected void layoutAfterChild(JComponent child,
                    Map<String,String> attributes,
                    JComponent container,
                    SwingMetawidget metawidget)
```
    Parameters:
    child - component being laid out
  - willFillHorizontally
```
protected boolean willFillHorizontally(JComponent component,
                           Map<String,String> attributes)
```
  - willFillVertically
```
protected boolean willFillVertically(JComponent component,
                         Map<String,String> attributes)
```
  - setFillConstraints
```
protected void setFillConstraints(JComponent component,
                      GridBagConstraints componentConstraints)
```
    Sets the fill constraints for this component. Defaults to GridBagConstraints.BOTH, unless the JComponent is a JButton.
    Clients can override this method to change how the fill constraints are set. For example, you may not want any fill constraints if the JComponent has getPreferredSize() != null.

Class GridBagLayout

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GridBagLayout

GridBagLayout

Method Detail

onStartBuild

startContainerLayout

layoutWidget

endContainerLayout

onEndBuild

layoutBeforeChild

layoutAfterChild

willFillHorizontally

willFillVertically

setFillConstraints