Class DragAndDropService

Constructor Detail

• DragAndDropService

  public DragAndDropService​(VaadinSession session)

  Deprecated.

Method Detail

• changeVariables

  public void changeVariables​(Object source,
                              Map<String,​Object> variables)

  Deprecated.

  Description copied from interface: VariableOwner

  Called when one or more variables handled by the implementing class are changed.

  Specified by:

  changeVariables in interface VariableOwner

  Parameters:

  source - the Source of the variable change. This is the origin of the event. For example in Web Adapter this is the request.

  variables - the Mapping from variable names to new variable values.

• isEnabled

  public boolean isEnabled()

  Deprecated.

  Tests if the variable owner is enabled or not. The terminal should not send any variable changes to disabled variable owners.

  Implementation detail: this method is originally from the VariableOwner class, which has been removed in Vaadin 8.

  Specified by:

  isEnabled in interface VariableOwner

  Returns:

  true if the variable owner is enabled, false if not

• printJSONResponse

  public void printJSONResponse​(Writer outWriter)
                         throws IOException

  Deprecated.

  Throws:

  IOException

• getConnectorId

  public String getConnectorId()

  Deprecated.

  Description copied from interface: Connector

  Returns the id for this connector. This is set by the framework and does not change during the lifetime of a connector.

  Specified by:

  getConnectorId in interface Connector

  Returns:

  The id for the connector.

• isConnectorEnabled

  public boolean isConnectorEnabled()

  Deprecated.

  Description copied from interface: ClientConnector

  Checks if the communicator is enabled. An enabled communicator is allowed to receive messages from its counter-part.

  Specified by:

  isConnectorEnabled in interface ClientConnector

  Returns:

  true if the connector can receive messages, false otherwise

• retrievePendingRpcCalls

  public List<ClientMethodInvocation> retrievePendingRpcCalls()

  Deprecated.

  Description copied from interface: ClientConnector

  Returns the list of pending server to client RPC calls and clears the list.

  Specified by:

  retrievePendingRpcCalls in interface ClientConnector

  Returns:

  an unmodifiable ordered list of pending server to client method calls (not null)

• getRpcManager

  public ServerRpcManager<?> getRpcManager​(String interfaceName)

  Deprecated.

  Description copied from interface: ClientConnector

  Returns the RPC manager instance to use when receiving calls for an RPC interface.

  Specified by:

  getRpcManager in interface ClientConnector

  Parameters:

  interfaceName - name of the interface for which the call was made

  Returns:

  ServerRpcManager or null if none found for the interface

• getStateType

  public Class<? extends SharedState> getStateType()

  Deprecated.

  Description copied from interface: ClientConnector

  Returns the type of the shared state for this connector.

  Specified by:

  getStateType in interface ClientConnector

  Returns:

  The type of the state. Must never return null.

• requestRepaint

  @Deprecated
  public void requestRepaint()

  Deprecated.

  Specified by:

  requestRepaint in interface ClientConnector

• markAsDirty

  public void markAsDirty()

  Deprecated.

  Description copied from interface: ClientConnector

  Marks that this connector's state might have changed. When the framework is about to send new data to the client-side, it will run ClientConnector.beforeClientResponse(boolean) followed by ClientConnector.encodeState() for all connectors that are marked as dirty and send any updated state info to the client.

  Specified by:

  markAsDirty in interface ClientConnector

• getParent

  public ClientConnector getParent()

  Deprecated.

  Description copied from interface: Connector

  Gets the parent connector of this connector, or null if the connector is not attached to any parent.

  Specified by:

  getParent in interface ClientConnector

  Specified by:

  getParent in interface Connector

  Returns:

  the parent connector, or null if there is no parent.

• requestRepaintAll

  @Deprecated
  public void requestRepaintAll()

  Deprecated.

  Specified by:

  requestRepaintAll in interface ClientConnector

• markAsDirtyRecursive

  public void markAsDirtyRecursive()

  Deprecated.

  Description copied from interface: ClientConnector

  Causes this connector and all connectors below it to be marked as dirty.

  This should only be used in special cases, e.g when the state of a descendant depends on the state of an ancestor.

  Specified by:

  markAsDirtyRecursive in interface ClientConnector

  See Also:

  ClientConnector.markAsDirty()

• attach

  public void attach()

  Deprecated.

  Description copied from interface: ClientConnector

  Notifies the connector that it is connected to a VaadinSession (and therefore also to a UI).

  The caller of this method is Component.setParent(HasComponents) if the parent is itself already attached to the session. If not, the parent will call the ClientConnector.attach() for all its children when it is attached to the session. 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.

  Specified by:

  attach in interface ClientConnector

• detach

  public void detach()

  Deprecated.

  Description copied from interface: ClientConnector

  Notifies the connector that it is detached from its VaadinSession.

  The caller of this method is Component.setParent(HasComponents) if the parent is in the session. When the parent is detached from the session it is its responsibility to call ClientConnector.detach() for each of its children.

  Specified by:

  detach in interface ClientConnector

• getExtensions

  public Collection<Extension> getExtensions()

  Deprecated.

  Description copied from interface: ClientConnector

  Get a read-only collection of all extensions attached to this connector.

  Specified by:

  getExtensions in interface ClientConnector

  Returns:

  a collection of extensions

• removeExtension

  public void removeExtension​(Extension extension)

  Deprecated.

  Description copied from interface: ClientConnector

  Remove an extension from this connector.

  Specified by:

  removeExtension in interface ClientConnector

  Parameters:

  extension - the extension to remove.

• getUI

  public UI getUI()

  Deprecated.

  Description copied from interface: ClientConnector

  Returns the UI this connector is attached to.

  Specified by:

  getUI in interface ClientConnector

  Returns:

  The UI this connector is attached to or null if it is not attached to any UI

• beforeClientResponse

  public void beforeClientResponse​(boolean initial)

  Deprecated.

  Description copied from interface: ClientConnector

  Called before the shared state and RPC invocations are sent to the client. Gives the connector an opportunity to set computed/dynamic state values or to invoke last minute RPC methods depending on other component features.

  Specified by:

  beforeClientResponse in interface ClientConnector

  Parameters:

  initial - true if the client-side connector will be created and initialized after this method has been invoked. false if there is already an initialized client-side connector.

• encodeState

  public elemental.json.JsonObject encodeState()

  Deprecated.

  Description copied from interface: ClientConnector

  Called by the framework to encode the state to a JSONObject. This is typically done by calling the static method LegacyCommunicationManager.encodeState(ClientConnector, SharedState) .

  Specified by:

  encodeState in interface ClientConnector

  Returns:

  a JSON object with the encoded connector state

• handleConnectorRequest

  public boolean handleConnectorRequest​(VaadinRequest request,
                                        VaadinResponse response,
                                        String path)
                                 throws IOException

  Deprecated.

  Description copied from interface: ClientConnector

  Handle a request directed to this connector. This can be used by connectors to dynamically generate a response and it is also used internally when serving ConnectorResources.

  Requests to /APP/connector/[ui id]/[connector id]/ are routed to this method with the remaining part of the requested path available in the path parameter.

  NOTE that the session is not locked when this method is called. It is the responsibility of the connector to ensure that the session is locked while handling state or other session related data. For best performance the session should be unlocked before writing a large response to the client.

  Specified by:

  handleConnectorRequest in interface ClientConnector

  Parameters:

  request - the request that should be handled

  response - the response object to which the response should be written

  path - the requested relative path

  Returns:

  true if the request has been handled, false if no response has been written.

  Throws:

  IOException - if there is a problem generating a response.

• getErrorHandler

  public ErrorHandler getErrorHandler()

  Deprecated.

  Description copied from interface: ClientConnector

  Gets the error handler for the connector. The error handler is dispatched whenever there is an error processing the data coming from the client to this connector.

  Specified by:

  getErrorHandler in interface ClientConnector

  Returns:

  The error handler or null if not set

• setErrorHandler

  public void setErrorHandler​(ErrorHandler errorHandler)

  Deprecated.

  Description copied from interface: ClientConnector

  Sets the error handler for the connector. The error handler is dispatched whenever there is an error processing the data coming from the client for this connector.

  Specified by:

  setErrorHandler in interface ClientConnector

  Parameters:

  errorHandler - The error handler for this connector

• addAttachListener

  public Registration addAttachListener​(ClientConnector.AttachListener listener)

  Deprecated.

  Description copied from interface: ClientConnector

  Add a listener for connector attach events.

  Specified by:

  addAttachListener in interface ClientConnector

  Parameters:

  listener - an AttachListener implementation

  Returns:

  Registration for unregistering the listener

• removeAttachListener

  @Deprecated
  public void removeAttachListener​(ClientConnector.AttachListener listener)

  Deprecated.

  Specified by:

  removeAttachListener in interface ClientConnector

• addDetachListener

  public Registration addDetachListener​(ClientConnector.DetachListener listener)

  Deprecated.

  Description copied from interface: ClientConnector

  Add a listener for connector detach events.

  Specified by:

  addDetachListener in interface ClientConnector

  Parameters:

  listener - an AttachListener implementation

  Returns:

  Registration for unregistering the listener

• removeDetachListener

  @Deprecated
  public void removeDetachListener​(ClientConnector.DetachListener listener)

  Deprecated.

  Specified by:

  removeDetachListener in interface ClientConnector

• isAttached

  public boolean isAttached()

  Deprecated.

  Description copied from interface: ClientConnector

  Checks if the connector is attached to a VaadinSession.

  Specified by:

  isAttached in interface ClientConnector

  Returns:

  true if the connector is attached to a session, false otherwise