HtmlTableLayout (Metawidget API Documentation)

java.lang.Object
- org.metawidget.statically.html.layout.HtmlLayout
- - org.metawidget.statically.html.layout.HtmlTableLayout

All Implemented Interfaces:

Immutable, AdvancedLayout<StaticXmlWidget,StaticXmlWidget,StaticHtmlMetawidget>, Layout<StaticXmlWidget,StaticXmlWidget,StaticHtmlMetawidget>

Direct Known Subclasses:

SpringTableLayout
```
public class HtmlTableLayout
extends HtmlLayout
implements AdvancedLayout<StaticXmlWidget,StaticXmlWidget,StaticHtmlMetawidget>
```
Layout to arrange widgets using an HTML table.

Author:

Richard Kennard, Ryan Bradley

Constructor Summary

Constructors
Constructor and Description

HtmlTableLayout()

HtmlTableLayout(HtmlTableLayoutConfig config)

Constructors
Constructor and Description
`HtmlTableLayout()`
`HtmlTableLayout(HtmlTableLayoutConfig config)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`endContainerLayout(StaticXmlWidget container, StaticHtmlMetawidget metawidget)` Finish the given container, using the given Metawidget to access additional services if needed (such as state saving).
`protected boolean`	`layoutLabel(HtmlTag row, StaticXmlWidget widgetNeedingLabel, String elementName, Map<String,String> attributes, StaticHtmlMetawidget metawidget)`
`void`	`layoutWidget(StaticXmlWidget widget, String elementName, Map<String,String> attributes, StaticXmlWidget container, StaticHtmlMetawidget 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(StaticHtmlMetawidget metawidget)` Event called at the end of widget building, after all widgets have been built and added to the `Layout`.
`void`	`onStartBuild(StaticHtmlMetawidget metawidget)` Event called at the start of the widget building process, before the `WidgetBuilder` is called.
`void`	`startContainerLayout(StaticXmlWidget container, StaticHtmlMetawidget metawidget)` Initialise the given container, using the given Metawidget to access additional services if needed (such as state saving).

Methods inherited from class org.metawidget.statically.html.layout.HtmlLayout
createLabel, getWidgetId

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

- Constructor Detail
  - HtmlTableLayout
```
public HtmlTableLayout()
```
  - HtmlTableLayout
```
public HtmlTableLayout(HtmlTableLayoutConfig config)
```
- Method Detail
  - onStartBuild
```
public void onStartBuild(StaticHtmlMetawidget 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<StaticXmlWidget,StaticXmlWidget,StaticHtmlMetawidget>
    
    Parameters:
    metawidget - the parent Metawidget. Never null
  - startContainerLayout
```
public void startContainerLayout(StaticXmlWidget container,
                        StaticHtmlMetawidget 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<StaticXmlWidget,StaticXmlWidget,StaticHtmlMetawidget>
    
    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(StaticXmlWidget widget,
                String elementName,
                Map<String,String> attributes,
                StaticXmlWidget container,
                StaticHtmlMetawidget 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<StaticXmlWidget,StaticXmlWidget,StaticHtmlMetawidget>
    
    Parameters:
    widget - 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(StaticXmlWidget container,
                      StaticHtmlMetawidget 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<StaticXmlWidget,StaticXmlWidget,StaticHtmlMetawidget>
    
    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(StaticHtmlMetawidget 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<StaticXmlWidget,StaticXmlWidget,StaticHtmlMetawidget>
    
    Parameters:
    metawidget - the parent Metawidget. Never null
  - layoutLabel
```
protected boolean layoutLabel(HtmlTag row,
                  StaticXmlWidget widgetNeedingLabel,
                  String elementName,
                  Map<String,String> attributes,
                  StaticHtmlMetawidget metawidget)
```
    Overrides:
    
    layoutLabel in class HtmlLayout
    
    Parameters:
    elementName - can be useful if the Layout needs to call a WidgetProcessor
    
    Returns:
    whether a label was written

Class HtmlTableLayout

Constructor Summary

Method Summary

Methods inherited from class org.metawidget.statically.html.layout.HtmlLayout

Methods inherited from class java.lang.Object

Constructor Detail

HtmlTableLayout

HtmlTableLayout

Method Detail

onStartBuild

startContainerLayout

layoutWidget

endContainerLayout

onEndBuild

layoutLabel