|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ClientConnector
Interface implemented by all connectors that are capable of communicating with the client side
Method Summary | |
---|---|
void |
attach()
Notifies the connector that it is connected to an application. |
void |
detach()
Notifies the component that it is detached from the application. |
Collection<Extension> |
getExtensions()
Get a read-only collection of all extensions attached to this connector. |
ClientConnector |
getParent()
Gets the parent connector of this connector, or null if the
connector is not attached to any parent. |
Root |
getRoot()
Returns the root this connector is attached to |
Class<? extends SharedState> |
getStateType()
Returns the type of the shared state for this connector |
boolean |
isConnectorEnabled()
Checks if the communicator is enabled. |
void |
removeExtension(Extension extension)
Remove an extension from this connector. |
void |
requestRepaint()
Requests that the connector should be repainted as soon as possible. |
void |
requestRepaintAll()
Causes a repaint of this connector, and all connectors below it. |
List<ClientMethodInvocation> |
retrievePendingRpcCalls()
Returns the list of pending server to client RPC calls and clears the list. |
void |
setParent(ClientConnector parent)
Sets the parent connector of the connector. |
Methods inherited from interface com.vaadin.terminal.gwt.client.Connector |
---|
getConnectorId, getState |
Methods inherited from interface com.vaadin.terminal.gwt.server.RpcTarget |
---|
getRpcManager |
Method Detail |
---|
List<ClientMethodInvocation> retrievePendingRpcCalls()
boolean isConnectorEnabled()
Class<? extends SharedState> getStateType()
ClientConnector getParent()
Connector
null
if the
connector is not attached to any parent.
getParent
in interface Connector
null
if there is no parent.void requestRepaint()
void requestRepaintAll()
void setParent(ClientConnector parent)
This method automatically calls attach()
if the connector
becomes attached to the application, regardless of whether it was
attached previously. Conversely, if the parent is null
and the
connector is attached to the application, detach()
is called for
the connector.
This method is rarely called directly. One of the
ComponentContainer.addComponent(Component)
or
AbstractClientConnector.addExtension(Extension)
methods are
normally used for adding connectors to a parent and they will call this
method implicitly.
It is not possible to change the parent without first setting the parent
to null
.
parent
- the parent connector
IllegalStateException
- if a parent is given even though the connector already has a
parentvoid attach()
The caller of this method is setParent(ClientConnector)
if the
parent is itself already attached to the application. If not, the parent
will call the attach()
for all its children when it is attached
to the application. This method is always called before the connector's
data is sent to the client-side for the first time.
The attachment logic is implemented in AbstractClientConnector
.
void detach()
The caller of this method is setParent(ClientConnector)
if the
parent is in the application. When the parent is detached from the
application it is its response to call detach()
for all the
children and to detach itself from the terminal.
Collection<Extension> getExtensions()
void removeExtension(Extension extension)
extension
- the extension to remove.Root getRoot()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |