FlatSectionLayoutDecorator (Metawidget API Documentation)

java.lang.Object
- org.metawidget.layout.decorator.LayoutDecorator<W,C,M>
- - org.metawidget.layout.decorator.FlatSectionLayoutDecorator<W,C,M>

All Implemented Interfaces:

Immutable, AdvancedLayout<W,C,M>, Layout<W,C,M>

Direct Known Subclasses:

GwtFlatSectionLayoutDecorator, JspFlatSectionLayoutDecorator, StaticFlatSectionLayoutDecorator, SwingFlatSectionLayoutDecorator, SwtFlatSectionLayoutDecorator, UIComponentFlatSectionLayoutDecorator, VaadinFlatSectionLayoutDecorator
```
public abstract class FlatSectionLayoutDecorator<W,C extends W,M extends C>
extends LayoutDecorator<W,C,M>
```
Convenience base class for LayoutDecorators wishing to decorate widgets based on changing sections, rendering multi-level sections (ie. section="foo,bar") as siblings.
Because sections are rendered as siblings, FlatSectionLayoutDecorator never creates a sub container.

Author:

Richard Kennard

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class FlatSectionLayoutDecorator.State
Simple, lightweight structure for saving state.

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

Constructor Summary

Constructors
Modifier Constructor and Description

protected FlatSectionLayoutDecorator(LayoutDecoratorConfig<W,C,M> config)

Constructors
Modifier	Constructor and Description
`protected`	`FlatSectionLayoutDecorator(LayoutDecoratorConfig<W,C,M> config)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected abstract void`	`addSectionWidget(String section, int level, C container, M metawidget)`
`protected abstract String[]`	`getSections(Map<String,String> attributes)`
`protected abstract FlatSectionLayoutDecorator.State`	`getState(C container, M metawidget)`
`protected abstract boolean`	`isIgnored(W widget)` Returns `true` if the given widget should be ignored, and no section heading created for it.
`void`	`layoutWidget(W widget, String elementName, Map<String,String> attributes, C container, M 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`	`startContainerLayout(C container, M metawidget)` Initialise the given container, using the given Metawidget to access additional services if needed (such as state saving).
`protected abstract String`	`stripSection(Map<String,String> attributes)`

Methods inherited from class org.metawidget.layout.decorator.LayoutDecorator
endContainerLayout, getDelegate, onEndBuild, onStartBuild

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

- Constructor Detail
  - FlatSectionLayoutDecorator
```
protected FlatSectionLayoutDecorator(LayoutDecoratorConfig<W,C,M> config)
```
- Method Detail
  - startContainerLayout
```
public void startContainerLayout(C container,
                        M 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<W,C extends W,M extends C>
    
    Overrides:
    
    startContainerLayout in class LayoutDecorator<W,C extends W,M extends C>
    
    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(W widget,
                String elementName,
                Map<String,String> attributes,
                C container,
                M 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<W,C extends W,M extends C>
    
    Overrides:
    
    layoutWidget in class LayoutDecorator<W,C extends W,M extends C>
    
    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
  - stripSection
```
protected abstract String stripSection(Map<String,String> attributes)
```
  - getSections
```
protected abstract String[] getSections(Map<String,String> attributes)
```
  - getState
```
protected abstract FlatSectionLayoutDecorator.State getState(C container,
                                        M metawidget)
```
  - isIgnored
```
protected abstract boolean isIgnored(W widget)
```
    Returns true if the given widget should be ignored, and no section heading created for it. For example, the widget might be an empty Stub widget.
    Subclasses should override this method and return true if the widget is some other kind of ignored component (eg. HtmlInputHidden).
  - addSectionWidget
```
protected abstract void addSectionWidget(String section,
                    int level,
                    C container,
                    M metawidget)
```
    Parameters:
    section - section text (needs localizing)
    level - level of section heading (ie. 0=highest, 1=next level down etc.)
    container -
    metawidget -

Class FlatSectionLayoutDecorator<W,C extends W,M extends C>

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class org.metawidget.layout.decorator.LayoutDecorator

Methods inherited from class java.lang.Object

Constructor Detail

FlatSectionLayoutDecorator

Method Detail

startContainerLayout

layoutWidget

stripSection

getSections

getState

isIgnored

addSectionWidget