StaticMetawidget (Metawidget API Documentation)

java.lang.Object
- org.metawidget.statically.BaseStaticWidget
- - org.metawidget.statically.StaticMetawidget

All Implemented Interfaces:

StaticWidget

Direct Known Subclasses:

StaticJavaMetawidget, StaticXmlMetawidget
```
public abstract class StaticMetawidget
extends BaseStaticWidget
```
Base Metawidget for static code generation.
Although Metawidget focuses on runtime UI generation, there are a category of applications that require static code generation instead. It is still possible to make full use of Metawidget's 5 stage pipeline (inspectors, inspection result processors, widget builders, widget processors, layouts) during static code generation.
An important requirement for static code generation is the Metawidget should not rely on the technology being generated being available. For example, a static JSF Metawidget should not rely on FacesContext.getCurrentInstance. Architectually, this makes all static Metawidgets more similar to each other than to their corresponding runtime version. For example, the static JSF Metawidget is more similar to the static Spring Metawidget than it is to the runtime JSF Metawidget. Therefore, it makes sense to have a StaticMetawidget base class.

Author:

Richard Kennard

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected class StaticMetawidget.Pipeline
Internal Metawidget pipeline.

Nested Classes
Modifier and Type	Class and Description
`protected class`	`StaticMetawidget.Pipeline` Internal Metawidget pipeline.

Constructor Summary

Constructors
Constructor and Description

StaticMetawidget()

Constructors
Constructor and Description
`StaticMetawidget()`

Method Summary

Methods
Modifier and Type	Method and Description
`<W extends StaticWidget,M extends W> void`	`addWidgetProcessor(WidgetProcessor<W,M> widgetProcessor)`
`protected void`	`beforeBuildCompoundWidget(Element element)`
`String`	`getConfig()`
`ConfigReader`	`getConfigReader()`
`protected abstract String`	`getDefaultConfiguration()`
`Inspector`	`getInspector()`
`String`	`getLabelString(Map<String,String> attributes)`
`Layout<StaticWidget,StaticWidget,StaticMetawidget>`	`getLayout()` Useful for WidgetBuilders.
`String`	`getPath()`
`WidgetBuilder<StaticWidget,StaticMetawidget>`	`getWidgetBuilder()`
`<T> T`	`getWidgetProcessor(Class<T> widgetProcessorClass)`
`List<WidgetProcessor<StaticWidget,StaticMetawidget>>`	`getWidgetProcessors()`
`void`	`initNestedMetawidget(StaticMetawidget nestedMetawidget, Map<String,String> attributes)` Useful for WidgetBuilders to setup nested Metawidgets (eg.
`protected Element`	`inspect()`
`String`	`inspect(Object toInspect, String type, String... names)` Useful for WidgetBuilders to perform nested inspections (eg.
`boolean`	`isReadOnly()`
`protected StaticMetawidget.Pipeline`	`newPipeline()` Instantiate the Pipeline used by this Metawidget.
`<W extends StaticWidget,M extends W> void`	`removeWidgetProcessor(WidgetProcessor<W,M> widgetProcessor)`
`void`	`setConfig(String config)`
`void`	`setConfigReader(ConfigReader configReader)`
`void`	`setInspectionResultProcessors(InspectionResultProcessor<? extends StaticMetawidget>... inspectionResultProcessors)`
`void`	`setInspector(Inspector inspector)`
`<W extends StaticWidget,C extends W,M extends C> void`	`setLayout(Layout<W,C,M> layout)`
`void`	`setMaximumInspectionDepth(int maximumInspectionDepth)`
`void`	`setPath(String path)`
`void`	`setReadOnly(boolean readOnly)`
`<W extends StaticWidget,M extends W> void`	`setWidgetBuilder(WidgetBuilder<W,M> widgetBuilder)`
`<W extends StaticWidget,M extends W> void`	`setWidgetProcessors(WidgetProcessor<W,M>... widgetProcessors)`
`protected void`	`startBuild()`
`void`	`write(Writer writer)` Clients should override the version that takes `initialIndent` instead.
`void`	`write(Writer writer, int initialIndent)` Write the Metawidget output using the given Writer.

Methods inherited from class org.metawidget.statically.BaseStaticWidget
getChildren, getClientProperty, getParent, putClientProperty, toString

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

Constructor Detail
- StaticMetawidget
```
public StaticMetawidget()
```

Method Detail

setPath
```
public void setPath(String path)
```

getPath
```
public String getPath()
```

getConfigReader
```
public ConfigReader getConfigReader()
```

setConfigReader

public void setConfigReader(ConfigReader configReader)

getConfig
```
public String getConfig()
```

setConfig
```
public void setConfig(String config)
```

setMaximumInspectionDepth

public void setMaximumInspectionDepth(int maximumInspectionDepth)

getLabelString

public String getLabelString(Map<String,String> attributes)

isReadOnly
```
public boolean isReadOnly()
```

setReadOnly

public void setReadOnly(boolean readOnly)

getInspector
```
public Inspector getInspector()
```

setInspector

public void setInspector(Inspector inspector)

inspect

public String inspect(Object toInspect,
             String type,
             String... names)

Useful for WidgetBuilders to perform nested inspections (eg. for Collections).

initNestedMetawidget

public void initNestedMetawidget(StaticMetawidget nestedMetawidget,
                        Map<String,String> attributes)

Useful for WidgetBuilders to setup nested Metawidgets (eg. for wrapping them in a panelGroup).

setInspectionResultProcessors

public void setInspectionResultProcessors(InspectionResultProcessor<? extends StaticMetawidget>... inspectionResultProcessors)

getWidgetBuilder

public WidgetBuilder<StaticWidget,StaticMetawidget> getWidgetBuilder()

setWidgetBuilder

public <W extends StaticWidget,M extends W> void setWidgetBuilder(WidgetBuilder<W,M> widgetBuilder)

addWidgetProcessor

public <W extends StaticWidget,M extends W> void addWidgetProcessor(WidgetProcessor<W,M> widgetProcessor)

getWidgetProcessors

public List<WidgetProcessor<StaticWidget,StaticMetawidget>> getWidgetProcessors()

setWidgetProcessors

public <W extends StaticWidget,M extends W> void setWidgetProcessors(WidgetProcessor<W,M>... widgetProcessors)

getWidgetProcessor

public <T> T getWidgetProcessor(Class<T> widgetProcessorClass)

removeWidgetProcessor

public <W extends StaticWidget,M extends W> void removeWidgetProcessor(WidgetProcessor<W,M> widgetProcessor)

getLayout

public Layout<StaticWidget,StaticWidget,StaticMetawidget> getLayout()

Useful for WidgetBuilders.

setLayout

public <W extends StaticWidget,C extends W,M extends C> void setLayout(Layout<W,C,M> layout)

write
```
public final void write(Writer writer)
```
Clients should override the version that takes initialIndent instead.

Specified by:

write in interface StaticWidget

Overrides:

write in class BaseStaticWidget

write
```
public void write(Writer writer,
         int initialIndent)
```
Write the Metawidget output using the given Writer.

Parameters:
initialIndent - the initialIndent that will be applied to every line. 0 for no initial indent. -1 for no subsequent indenting either

newPipeline
```
protected StaticMetawidget.Pipeline newPipeline()
```
Instantiate the Pipeline used by this Metawidget.
Subclasses wishing to use their own Pipeline should override this method to instantiate their version.

startBuild
```
protected void startBuild()
```

beforeBuildCompoundWidget
```
protected void beforeBuildCompoundWidget(Element element)
```
Parameters:
element - the parent element that will be iterated over

inspect
```
protected Element inspect()
```

getDefaultConfiguration

protected abstract String getDefaultConfiguration()

Class StaticMetawidget

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class org.metawidget.statically.BaseStaticWidget

Methods inherited from class java.lang.Object

Constructor Detail

StaticMetawidget

Method Detail

setPath

getPath

getConfigReader

setConfigReader

getConfig

setConfig

setMaximumInspectionDepth

getLabelString

isReadOnly

setReadOnly

getInspector

setInspector

inspect

initNestedMetawidget

setInspectionResultProcessors

getWidgetBuilder

setWidgetBuilder

addWidgetProcessor

getWidgetProcessors

setWidgetProcessors

getWidgetProcessor

removeWidgetProcessor

getLayout

setLayout

write

write

newPipeline

startBuild

beforeBuildCompoundWidget

inspect

getDefaultConfiguration