com.vaadin.server
Interface Extension

All Superinterfaces:

ClientConnector, com.vaadin.shared.Connector, java.io.Serializable

All Known Implementing Classes:

AbstractExtension, AbstractJavaScriptExtension, BrowserWindowOpener, FileDownloader, JavaScript, Responsive

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

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:

java.lang.IllegalStateException - if a parent is given even though the connector already has a parent