VaadinMetawidget (Metawidget API Documentation)

java.lang.Object
- com.vaadin.server.AbstractClientConnector
- - com.vaadin.ui.AbstractComponent
  - - com.vaadin.ui.CustomComponent
    - - org.metawidget.vaadin.ui.VaadinMetawidget

All Implemented Interfaces:

com.vaadin.event.MethodEventSource, com.vaadin.server.ClientConnector, com.vaadin.server.Sizeable, com.vaadin.shared.Connector, com.vaadin.ui.Component, com.vaadin.ui.HasComponents, Serializable, Iterable<com.vaadin.ui.Component>
```
public class VaadinMetawidget
extends com.vaadin.ui.CustomComponent
```
Metawidget for Vaadin environments.

Author:

Loghman Barari

See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected class VaadinMetawidget.Pipeline
- Nested classes/interfaces inherited from interface com.vaadin.ui.HasComponents
  com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, com.vaadin.ui.HasComponents.ComponentAttachEvent, com.vaadin.ui.HasComponents.ComponentAttachListener, com.vaadin.ui.HasComponents.ComponentDetachEvent, com.vaadin.ui.HasComponents.ComponentDetachListener
- Nested classes/interfaces inherited from interface com.vaadin.ui.Component
  com.vaadin.ui.Component.ErrorEvent, com.vaadin.ui.Component.Event, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Component.Listener
- Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector
  com.vaadin.server.ClientConnector.AttachEvent, com.vaadin.server.ClientConnector.AttachListener, com.vaadin.server.ClientConnector.ConnectorErrorEvent, com.vaadin.server.ClientConnector.DetachEvent, com.vaadin.server.ClientConnector.DetachListener
- Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable
  com.vaadin.server.Sizeable.Unit

Nested Classes
Modifier and Type	Class and Description
`protected class`	`VaadinMetawidget.Pipeline`

Field Summary
- Fields inherited from interface com.vaadin.server.Sizeable
  SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

Constructor Summary

Constructors
Constructor and Description

VaadinMetawidget()

Constructors
Constructor and Description
`VaadinMetawidget()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addComponent(com.vaadin.ui.Component component)`
`void`	`addInspectionResultProcessor(InspectionResultProcessor<VaadinMetawidget> inspectionResultProcessor)`
`void`	`addWidgetProcessor(WidgetProcessor<com.vaadin.ui.Component,VaadinMetawidget> widgetProcessor)`
`protected void`	`buildWidgets()`
`protected void`	`endBuild()`
`List<com.vaadin.ui.AbstractComponent>`	`fetchExistingUnusedComponents()` Fetch a list of `AbstractComponents` that were added manually, and have so far not been used.
`ResourceBundle`	`getBundle()`
`<T> T`	`getClientProperty(Object key)` Storage area for WidgetProcessors, Layouts, and other stateless clients.
`<T extends com.vaadin.ui.Component> T`	`getComponent(String... names)` Finds the Component with the given name.
`int`	`getComponentCount()`
`Iterator<com.vaadin.ui.Component>`	`getComponentIterator()`
`<C extends com.vaadin.ui.Component> C`	`getContent()` Named after `Panel.getContent`.
`protected String`	`getDefaultConfiguration()`
`Facet`	`getFacet(String name)`
`String`	`getLabelString(Map<String,String> attributes)` Returns a label for the given set of attributes.
`String`	`getLocalizedKey(String key)`
`int`	`getMaximumInspectionDepth()`
`String`	`getPath()`
`<T> T`	`getToInspect()` Gets the Object being inspected.
`<T> T`	`getWidgetProcessor(Class<T> widgetProcessorClass)`
`protected void`	`initNestedMetawidget(VaadinMetawidget nestedMetawidget, Map<String,String> attributes)`
`String`	`inspect(Object toInspect, String type, String... names)` Useful for WidgetBuilders to perform nested inspections (eg.
`protected void`	`invalidateInspection()` Invalidates the current inspection result (if any) and invalidates the widgets.
`protected void`	`invalidateWidgets()` Invalidates the widgets.
`boolean`	`isReadOnly()`
`protected void`	`layoutWidget(com.vaadin.ui.Component component, String elementName, Map<String,String> attributes)`
`protected VaadinMetawidget.Pipeline`	`newPipeline()` Instantiate the Pipeline used by this Metawidget.
`void`	`paintContent(com.vaadin.terminal.PaintTarget target)`
`void`	`putClientProperty(Object key, Object value)` Storage area for WidgetProcessors, Layouts, and other stateless clients.
`void`	`removeComponent(com.vaadin.ui.Component component)`
`void`	`removeInspectionResultProcessor(InspectionResultProcessor<VaadinMetawidget> inspectionResultProcessor)`
`void`	`removeWidgetProcessor(WidgetProcessor<com.vaadin.ui.Component,VaadinMetawidget> widgetProcessor)`
`void`	`setBundle(ResourceBundle bundle)`
`void`	`setConfig(String config)`
`void`	`setInspectionResultProcessors(InspectionResultProcessor<VaadinMetawidget>... inspectionResultProcessors)`
`void`	`setInspector(Inspector inspector)`
`void`	`setLayout(Layout<com.vaadin.ui.Component,com.vaadin.ui.ComponentContainer,VaadinMetawidget> layout)` Set the layout for this Metawidget.
`void`	`setMaximumInspectionDepth(int maximumInspectionDepth)`
`void`	`setPath(String path)` Sets the path to be inspected.
`void`	`setReadOnly(boolean readOnly)`
`void`	`setToInspect(Object toInspect)` Sets the Object to inspect.
`void`	`setWidgetBuilder(WidgetBuilder<com.vaadin.ui.Component,VaadinMetawidget> widgetBuilder)`
`void`	`setWidgetProcessors(WidgetProcessor<com.vaadin.ui.Component,VaadinMetawidget>... widgetProcessors)`
`protected void`	`startBuild()`

Methods inherited from class com.vaadin.ui.CustomComponent
getCompositionRoot, iterator, setCompositionRoot

Methods inherited from class com.vaadin.ui.AbstractComponent
addListener, addShortcutListener, addStyleName, attach, beforeClientResponse, detach, findAncestor, fireComponentErrorEvent, fireComponentEvent, focus, getActionManager, getCaption, getComponentError, getData, getDebugId, getDescription, getErrorMessage, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getState, getState, getStyleName, getWidth, getWidthUnits, isConnectorEnabled, isEnabled, isImmediate, isOrHasAncestor, isVisible, removeListener, removeShortcutListener, removeStyleName, setCaption, setComponentError, setData, setDebugId, setDescription, setEnabled, setHeight, setHeight, setHeightUndefined, setIcon, setId, setImmediate, setLocale, setParent, setPrimaryStyleName, setSizeFull, setSizeUndefined, setStyleName, setVisible, setWidth, setWidth, setWidthUndefined

Methods inherited from class com.vaadin.server.AbstractClientConnector
addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addMethodInvocationToQueue, createState, encodeState, equals, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getListeners, getResource, getRpcManager, getRpcProxy, getSession, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource

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

Methods inherited from interface com.vaadin.ui.Component
addListener, addStyleName, attach, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isVisible, removeListener, removeStyleName, setCaption, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setStyleName, setVisible

Methods inherited from interface com.vaadin.server.ClientConnector
addAttachListener, addDetachListener, beforeClientResponse, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.shared.Connector
getConnectorId

Methods inherited from interface com.vaadin.server.Sizeable
getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthUndefined

- Constructor Detail
  - VaadinMetawidget
```
public VaadinMetawidget()
```
- Method Detail
  - setToInspect
```
public void setToInspect(Object toInspect)
```
    Sets the Object to inspect.
    If setPath has not been set, or points to a previous setToInspect, sets it to point to the given Object.
  - getToInspect
```
public <T> T getToInspect()
```
    Gets the Object being inspected.
    Exposed for binding implementations.
    
    Returns:
    the object. Note this return type uses generics, so as to not require a cast by the caller (eg. Person p = getToInspect())
  - setPath
```
public void setPath(String path)
```
    Sets the path to be inspected.
  - getPath
```
public String getPath()
```
  - setConfig
```
public void setConfig(String config)
```
  - 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).
  - addInspectionResultProcessor
```
public void addInspectionResultProcessor(InspectionResultProcessor<VaadinMetawidget> inspectionResultProcessor)
```
  - removeInspectionResultProcessor
```
public void removeInspectionResultProcessor(InspectionResultProcessor<VaadinMetawidget> inspectionResultProcessor)
```
  - setInspectionResultProcessors
```
public void setInspectionResultProcessors(InspectionResultProcessor<VaadinMetawidget>... inspectionResultProcessors)
```
  - setWidgetBuilder
```
public void setWidgetBuilder(WidgetBuilder<com.vaadin.ui.Component,VaadinMetawidget> widgetBuilder)
```
  - addWidgetProcessor
```
public void addWidgetProcessor(WidgetProcessor<com.vaadin.ui.Component,VaadinMetawidget> widgetProcessor)
```
  - removeWidgetProcessor
```
public void removeWidgetProcessor(WidgetProcessor<com.vaadin.ui.Component,VaadinMetawidget> widgetProcessor)
```
  - setWidgetProcessors
```
public void setWidgetProcessors(WidgetProcessor<com.vaadin.ui.Component,VaadinMetawidget>... widgetProcessors)
```
  - getWidgetProcessor
```
public <T> T getWidgetProcessor(Class<T> widgetProcessorClass)
```
  - setLayout
```
public void setLayout(Layout<com.vaadin.ui.Component,com.vaadin.ui.ComponentContainer,VaadinMetawidget> layout)
```
    Set the layout for this Metawidget.
  - getBundle
```
public ResourceBundle getBundle()
```
  - setBundle
```
public void setBundle(ResourceBundle bundle)
```
  - getLabelString
```
public String getLabelString(Map<String,String> attributes)
```
    Returns a label for the given set of attributes.
    The label is determined using the following algorithm:
    - if attributes.get( "label" ) exists...
      
      attributes.get( "label" ) is camel-cased and used as a lookup into getLocalizedKey( camelCasedLabel ). This means developers can initially build their UIs without worrying about localization, then turn it on later
      
      if no such lookup exists, return attributes.get( "label" )
    - if attributes.get( "label" ) does not exist...
      
      attributes.get( "name" ) is used as a lookup into getLocalizedKey( name )
      
      if no such lookup exists, return attributes.get( "name" )
  - getLocalizedKey
```
public String getLocalizedKey(String key)
```
    Returns:
    null if no bundle, ???key??? if bundle is missing a key
  - isReadOnly
```
public boolean isReadOnly()
```
    Specified by:
    
    isReadOnly in interface com.vaadin.ui.Component
    
    Overrides:
    
    isReadOnly in class com.vaadin.ui.AbstractComponent
  - setReadOnly
```
public void setReadOnly(boolean readOnly)
```
    Specified by:
    
    setReadOnly in interface com.vaadin.ui.Component
    
    Overrides:
    
    setReadOnly in class com.vaadin.ui.AbstractComponent
  - getMaximumInspectionDepth
```
public int getMaximumInspectionDepth()
```
  - setMaximumInspectionDepth
```
public void setMaximumInspectionDepth(int maximumInspectionDepth)
```
  - fetchExistingUnusedComponents
```
public List<com.vaadin.ui.AbstractComponent> fetchExistingUnusedComponents()
```
    Fetch a list of AbstractComponents that were added manually, and have so far not been used.
    This is an internal API exposed for OverriddenWidgetBuilder. Clients should not call it directly.
  - getComponentCount
```
public int getComponentCount()
```
    Overrides:
    
    getComponentCount in class com.vaadin.ui.CustomComponent
  - getComponentIterator
```
public Iterator<com.vaadin.ui.Component> getComponentIterator()
```
  - getComponent
```
public <T extends com.vaadin.ui.Component> T getComponent(String... names)
```
    Finds the Component with the given name.
  - getFacet
```
public Facet getFacet(String name)
```
  - getContent
```
public <C extends com.vaadin.ui.Component> C getContent()
```
    Named after Panel.getContent.
  - addComponent
```
public void addComponent(com.vaadin.ui.Component component)
```
  - removeComponent
```
public void removeComponent(com.vaadin.ui.Component component)
```
  - paintContent
```
public void paintContent(com.vaadin.terminal.PaintTarget target)
                  throws com.vaadin.terminal.PaintException
```
    Throws:
    
    com.vaadin.terminal.PaintException
  - putClientProperty
```
public void putClientProperty(Object key,
                     Object value)
```
    Storage area for WidgetProcessors, Layouts, and other stateless clients.
  - getClientProperty
```
public <T> T getClientProperty(Object key)
```
    Storage area for WidgetProcessors, Layouts, and other stateless clients.
  - newPipeline
```
protected VaadinMetawidget.Pipeline newPipeline()
```
    Instantiate the Pipeline used by this Metawidget.
    Subclasses wishing to use their own Pipeline should override this method to instantiate their version.
  - getDefaultConfiguration
```
protected String getDefaultConfiguration()
```
  - invalidateInspection
```
protected void invalidateInspection()
```
    Invalidates the current inspection result (if any) and invalidates the widgets.
    As an optimisation we only invalidate the widgets, not the entire inspection result, for some operations (such as adding/removing stubs, changing read-only etc.)
  - invalidateWidgets
```
protected void invalidateWidgets()
```
    Invalidates the widgets.
  - buildWidgets
```
protected void buildWidgets()
```
  - startBuild
```
protected void startBuild()
```
  - layoutWidget
```
protected void layoutWidget(com.vaadin.ui.Component component,
                String elementName,
                Map<String,String> attributes)
```
    Parameters:
    elementName - XML node name of the business field. Typically 'entity', 'property' or 'action'. Never null
  - endBuild
```
protected void endBuild()
```
  - initNestedMetawidget
```
protected void initNestedMetawidget(VaadinMetawidget nestedMetawidget,
                        Map<String,String> attributes)
```

Class VaadinMetawidget

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.ui.HasComponents

Nested classes/interfaces inherited from interface com.vaadin.ui.Component

Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable

Field Summary

Fields inherited from interface com.vaadin.server.Sizeable

Constructor Summary

Method Summary

Methods inherited from class com.vaadin.ui.CustomComponent

Methods inherited from class com.vaadin.ui.AbstractComponent

Methods inherited from class com.vaadin.server.AbstractClientConnector

Methods inherited from class java.lang.Object

Methods inherited from interface com.vaadin.ui.Component

Methods inherited from interface com.vaadin.server.ClientConnector

Methods inherited from interface com.vaadin.shared.Connector

Methods inherited from interface com.vaadin.server.Sizeable

Constructor Detail

VaadinMetawidget

Method Detail

setToInspect

getToInspect

setPath

getPath

setConfig

setInspector

inspect

addInspectionResultProcessor

removeInspectionResultProcessor

setInspectionResultProcessors

setWidgetBuilder

addWidgetProcessor

removeWidgetProcessor

setWidgetProcessors

getWidgetProcessor

setLayout

getBundle

setBundle

getLabelString

getLocalizedKey

isReadOnly

setReadOnly

getMaximumInspectionDepth

setMaximumInspectionDepth

fetchExistingUnusedComponents

getComponentCount

getComponentIterator

getComponent

getFacet

getContent

addComponent

removeComponent

paintContent

putClientProperty

getClientProperty

newPipeline

getDefaultConfiguration

invalidateInspection

invalidateWidgets

buildWidgets

startBuild

layoutWidget

endBuild

initNestedMetawidget