com.vaadin.server.Extension API 7.7.46 | Vaadin

You're viewing an older version of Framework JavaDoc. Please see version 7.7.47 for the latest.

com.vaadin.server.

All Superinterfaces:

ClientConnector, Connector, Serializable

All Known Subinterfaces:

Grid.SelectionModel, Grid.SelectionModel.HasUserSelectionAllowed, Grid.SelectionModel.Multi, Grid.SelectionModel.None, Grid.SelectionModel.Single, Renderer<T>

All Known Implementing Classes:

AbstractExtension, AbstractJavaScriptExtension, AbstractJavaScriptRenderer, BrowserWindowOpener, ButtonRenderer, ClickableRenderer, DateRenderer, FileDownloader, Grid.AbstractGridExtension, Grid.AbstractRenderer, Grid.AbstractSelectionModel, Grid.DetailComponentManager, Grid.MultiSelectionModel, Grid.NoSelectionModel, Grid.SingleSelectionModel, HtmlRenderer, ImageRenderer, JavaScript, NumberRenderer, ProgressBarRenderer, Responsive, RpcDataProviderExtension, TextRenderer
```
public interface Extension
extends ClientConnector
```
An extension is an entity that is attached to a Component or another Extension and independently communicates between client and server.
An extension can only be attached once. It is not supported to move an extension from one target to another.
Extensions can use shared state and RPC in the same way as components.

Since:

7.0.0

Author:

Vaadin Ltd

- Nested Class Summary
  - Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector
    ClientConnector.AttachEvent, ClientConnector.AttachListener, ClientConnector.ConnectorErrorEvent, ClientConnector.DetachEvent, ClientConnector.DetachListener
- Method Summary
  
  All Methods
  Modifier and Type Method Description
  
  void remove()
  Remove this extension from its target.
  
  void setParent(ClientConnector parent)
  Sets the parent connector of the connector.
  - Methods inherited from interface com.vaadin.server.ClientConnector
    addAttachListener, addDetachListener, attach, beforeClientResponse, detach, encodeState, getErrorHandler, getExtensions, getParent, getRpcManager, getStateType, getUI, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler
  - Methods inherited from interface com.vaadin.shared.Connector
    getConnectorId

- Method Detail
  - remove
```
void remove()
```
    Remove this extension from its target. After an extension has been removed, it cannot be attached again.
  - setParent
```
void setParent(ClientConnector parent)
```
    Sets the parent connector of the connector. This method automatically calls ClientConnector.attach() if the connector becomes attached to the session.
    This method is rarely called directly. AbstractClientConnector.addExtension(Extension) is normally used for adding extensions to a parent and it will call this method implicitly.
    
    Parameters:
    
    parent - the parent connector
    
    Throws:
    
    IllegalStateException - if a parent is given even though the connector already has a parent