Stub (Metawidget API Documentation)

java.lang.Object
- com.vaadin.server.AbstractClientConnector
- - com.vaadin.ui.AbstractComponent
  - - com.vaadin.ui.AbstractSingleComponentContainer
    - - com.vaadin.ui.Panel
      - org.metawidget.vaadin.ui.Stub

All Implemented Interfaces:

com.vaadin.event.Action.Container, com.vaadin.event.Action.Notifier, com.vaadin.event.ConnectorEventListener, com.vaadin.event.MethodEventSource, com.vaadin.server.ClientConnector, com.vaadin.server.Scrollable, com.vaadin.server.Sizeable, com.vaadin.server.VariableOwner, com.vaadin.shared.Connector, com.vaadin.ui.Component, com.vaadin.ui.Component.Focusable, com.vaadin.ui.HasComponents, com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, com.vaadin.ui.LegacyComponent, com.vaadin.ui.SingleComponentContainer, Serializable, Iterable<com.vaadin.ui.Component>, EventListener
```
public class Stub
extends com.vaadin.ui.Panel
```
Stub for Vaadin environments.
Stubs are used to 'stub out' what Metawidget would normally create - either to suppress widget creation entirely or to create child widgets with a different name. They differ from Facets in that Facets are simply 'decorations' (such as button bars) to be recognized and arranged at the discretion of the Layout.
We define separate Stub widgets, as opposed to simply a VaadinMetawidget.addStub method, as this is more amenable to visual UI builders.

Author:

Loghman Barari

See Also:
Serialized Form

- Nested Class Summary
  - 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/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
- Field Summary
  - Fields inherited from class com.vaadin.ui.Panel
    actionManager
  - 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
  
  Stub()
  
  Stub(String data)
  Convenience constructor.
- Method Summary
  
  Methods
  Modifier and Type Method and Description
  
  Map<String,String> getAttributes()
  
  void setAttribute(String name, String value)
  - Methods inherited from class com.vaadin.ui.Panel
    addAction, addActionHandler, addClickListener, addListener, changeVariables, focus, getActionManager, getScrollLeft, getScrollTop, getState, getState, getTabIndex, paintContent, removeAction, removeActionHandler, removeAllActionHandlers, removeClickListener, removeListener, setCaption, setScrollLeft, setScrollTop, setTabIndex
  - Methods inherited from class com.vaadin.ui.AbstractSingleComponentContainer
    addComponentAttachListener, addComponentDetachListener, fireComponentAttachEvent, fireComponentDetachEvent, getComponentCount, getContent, iterator, removeComponentAttachListener, removeComponentDetachListener, removeFromParent, setContent, setHeight, setWidth
  - Methods inherited from class com.vaadin.ui.AbstractComponent
    addListener, addShortcutListener, addStyleName, attach, beforeClientResponse, detach, findAncestor, fireComponentErrorEvent, fireComponentEvent, getCaption, getComponentError, getData, getDebugId, getDescription, getErrorMessage, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getWidth, getWidthUnits, isConnectorEnabled, isEnabled, isImmediate, isOrHasAncestor, isReadOnly, isVisible, removeListener, removeShortcutListener, removeStyleName, setComponentError, setData, setDebugId, setDescription, setEnabled, setHeight, setHeightUndefined, setIcon, setId, setImmediate, setLocale, setParent, setPrimaryStyleName, setReadOnly, setSizeFull, setSizeUndefined, setStyleName, setVisible, 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.LegacyComponent
    markAsDirty
  - Methods inherited from interface com.vaadin.server.VariableOwner
    isEnabled, isImmediate
  - Methods inherited from interface com.vaadin.ui.Component
    addListener, addStyleName, attach, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isReadOnly, isVisible, removeListener, removeStyleName, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setReadOnly, setStyleName, setVisible
  - Methods inherited from interface com.vaadin.server.ClientConnector
    addAttachListener, addDetachListener, beforeClientResponse, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, 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

Constructors
Constructor and Description
`Stub()`
`Stub(String data)` Convenience constructor.

Methods
Modifier and Type	Method and Description
`Map<String,String>`	`getAttributes()`
`void`	`setAttribute(String name, String value)`

- Constructor Detail
  - Stub
```
public Stub()
```
  - Stub
```
public Stub(String data)
```
    Convenience constructor.
    Useful for creating stubs that will otherwise be empty, such as metawidget.add( new Stub( "foo" ))
- Method Detail
  - setAttribute
```
public void setAttribute(String name,
                String value)
```
  - getAttributes
```
public Map<String,String> getAttributes()
```

Class Stub

Nested Class Summary

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

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

Field Summary

Fields inherited from class com.vaadin.ui.Panel

Fields inherited from interface com.vaadin.server.Sizeable

Constructor Summary

Method Summary

Methods inherited from class com.vaadin.ui.Panel

Methods inherited from class com.vaadin.ui.AbstractSingleComponentContainer

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.LegacyComponent

Methods inherited from interface com.vaadin.server.VariableOwner

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

Stub

Stub

Method Detail

setAttribute

getAttributes