com.vaadin.server
Class DragAndDropService

java.lang.Object
  com.vaadin.server.DragAndDropService

All Implemented Interfaces:

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

public class DragAndDropService
extends java.lang.Object
implements VariableOwner, ClientConnector

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.server.VariableOwner

VariableOwner.ErrorEvent

Constructor Summary

DragAndDropService(AbstractCommunicationManager manager)

Method Summary

void	attach() Notifies the connector that it is connected to an application.
void	beforeClientResponse(boolean initial) Called before the shared state and RPC invocations are sent to the client.
void	changeVariables(java.lang.Object source, java.util.Map<java.lang.String,java.lang.Object> variables) Called when one or more variables handled by the implementing class are changed.
void	detach() Notifies the component that it is detached from the application.
org.json.JSONObject	encodeState() Called by the framework to encode the state to a JSONObject.
java.lang.String	getConnectorId()
java.util.Collection<Extension>	getExtensions() Get a read-only collection of all extensions attached to this connector.
ClientConnector	getParent()
RpcManager	getRpcManager(java.lang.Class<?> rpcInterface) Returns the RPC manager instance to use when receiving calls for an RPC interface.
java.lang.Class<? extends com.vaadin.shared.communication.SharedState>	getStateType() Returns the type of the shared state for this connector
UI	getUI() Returns the UI this connector is attached to
boolean	handleConnectorRequest(VaadinRequest request, VaadinResponse response, java.lang.String path) Handle a request directed to this connector.
boolean	isConnectorEnabled() Checks if the communicator is enabled.
boolean	isEnabled() Tests if the variable owner is enabled or not.
boolean	isImmediate() Tests if the variable owner is in immediate mode or not.
void	markAsDirty() Marks that this connector's state might have changed.
void	markAsDirtyRecursive() Causes this connector and all connectors below it to be marked as dirty.
void	removeExtension(Extension extension) Remove an extension from this connector.
void	requestRepaint() Deprecated.
void	requestRepaintAll() Deprecated.
java.util.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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DragAndDropService

public DragAndDropService(AbstractCommunicationManager manager)

Method Detail

changeVariables

public void changeVariables(java.lang.Object source,
                            java.util.Map<java.lang.String,java.lang.Object> variables)

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()

Description copied from interface: VariableOwner

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

Specified by:

isEnabled in interface VariableOwner

Returns:

true if the variable owner is enabled, false if not

isImmediate

public boolean isImmediate()

Description copied from interface: VariableOwner

Tests if the variable owner is in immediate mode or not. Being in immediate mode means that all variable changes are required to be sent back from the terminal immediately when they occur.

Note: VariableOwner does not include a set- method for the immediateness property. This is because not all VariableOwners wish to offer the functionality. Such VariableOwners are never in the immediate mode, thus they always return false in VariableOwner.isImmediate().

Specified by:

isImmediate in interface VariableOwner

Returns:

true if the component is in immediate mode, false if not.

getConnectorId

public java.lang.String getConnectorId()

Specified by:

getConnectorId in interface com.vaadin.shared.Connector

isConnectorEnabled

public boolean isConnectorEnabled()

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 java.util.List<ClientMethodInvocation> retrievePendingRpcCalls()

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 RpcManager getRpcManager(java.lang.Class<?> rpcInterface)

Description copied from interface: RpcTarget

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

Specified by:

getRpcManager in interface RpcTarget

Parameters:

rpcInterface - interface for which the call was made

Returns:

RpcManager or null if none found for the interface

getStateType

public java.lang.Class<? extends com.vaadin.shared.communication.SharedState> getStateType()

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()

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()

Specified by:

getParent in interface ClientConnector

Specified by:

getParent in interface com.vaadin.shared.Connector

requestRepaintAll

@Deprecated
public void requestRepaintAll()

Deprecated.

Specified by:

requestRepaintAll in interface ClientConnector

markAsDirtyRecursive

public void markAsDirtyRecursive()

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()

setParent

public void setParent(ClientConnector parent)

Description copied from interface: ClientConnector

Sets the parent connector of the connector.

This method automatically calls ClientConnector.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, ClientConnector.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.

Specified by:

setParent in interface ClientConnector

Parameters:

parent - the parent connector

attach

public void attach()

Description copied from interface: ClientConnector

Notifies the connector that it is connected to an application.

The caller of this method is ClientConnector.setParent(ClientConnector) if the parent is itself already attached to the application. If not, the parent will call the ClientConnector.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.

Specified by:

attach in interface ClientConnector

detach

public void detach()

Description copied from interface: ClientConnector

Notifies the component that it is detached from the application.

The caller of this method is ClientConnector.setParent(ClientConnector) if the parent is in the application. When the parent is detached from the application it is its response to call ClientConnector.detach() for all the children and to detach itself from the terminal.

Specified by:

detach in interface ClientConnector

getExtensions

public java.util.Collection<Extension> getExtensions()

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)

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()

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)

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.

This method must not alter the component hierarchy in any way. Calling ClientConnector.markAsDirty() from this method will have no effect.

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 org.json.JSONObject encodeState()
                                throws org.json.JSONException

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 AbstractCommunicationManager.encodeState(ClientConnector, SharedState) .

Specified by:

encodeState in interface ClientConnector

Returns:

a JSON object with the encoded connector state

Throws:

org.json.JSONException - if the state can not be encoded

handleConnectorRequest

public boolean handleConnectorRequest(VaadinRequest request,
                                      VaadinResponse response,
                                      java.lang.String path)
                               throws java.io.IOException

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.

DynamicConnectorResource can be used to easily make an appropriate URL available to the client-side code.

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:

java.io.IOException - if there is a problem generating a response.