com.vaadin.client.ui

Class VDragAndDropWrapper.CustomDropHandler

java.lang.Object

com.vaadin.client.ui.dd.VAbstractDropHandler

com.vaadin.client.ui.VDragAndDropWrapper.CustomDropHandler

All Implemented Interfaces:

VDropHandler

Enclosing class:

VDragAndDropWrapper

public class VDragAndDropWrapper.CustomDropHandler
extends VAbstractDropHandler

Constructor Summary

Constructors

Constructor and Description
CustomDropHandler()

Method Summary

Modifier and Type	Method and Description
protected void	dragAccepted(VDragEvent drag) This method is called when a valid drop location was found with AcceptCriterion either via client or server side check.
void	dragEnter(VDragEvent drag) The default implementation in VAbstractDropHandler checks if the Transferable is accepted.
void	dragLeave(VDragEvent drag) Default implementation does nothing.
void	dragOver(VDragEvent drag) Default implementation does nothing.
boolean	drop(VDragEvent drag) The default implemmentation visits server if AcceptCriterion can't be verified on client or if AcceptCriterion are met on client.
ApplicationConnection	getApplicationConnection() Returns the application connection to which this VDropHandler belongs to.
ComponentConnector	getConnector() Returns the Paintable who owns this VAbstractDropHandler.

Methods inherited from class com.vaadin.client.ui.dd.VAbstractDropHandler

updateAcceptRules, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomDropHandler

public CustomDropHandler()

Method Detail

dragEnter

public void dragEnter(VDragEvent drag)

Description copied from class: VAbstractDropHandler

The default implementation in VAbstractDropHandler checks if the Transferable is accepted.

If transferable is accepted (either via server visit or client side rules) the default implementation calls abstract VAbstractDropHandler.dragAccepted(VDragEvent) method.

If drop handler has distinct places where some parts may accept the Transferable and others don't, one should use similar validation logic in dragOver method and replace this method with empty implementation.

Specified by:

dragEnter in interface VDropHandler

Overrides:

dragEnter in class VAbstractDropHandler

Parameters:

drag - DragEvent which contains the transferable and other information for the operation

dragLeave

public void dragLeave(VDragEvent drag)

Description copied from class: VAbstractDropHandler

Default implementation does nothing. Implementors should clean possible emphasis or drag icons here.

Specified by:

dragLeave in interface VDropHandler

Overrides:

dragLeave in class VAbstractDropHandler

Parameters:

drag - DragEvent which contains the transferable and other information for the operation

dragOver

public void dragOver(VDragEvent drag)

Description copied from class: VAbstractDropHandler

Default implementation does nothing.

Specified by:

dragOver in interface VDropHandler

Overrides:

dragOver in class VAbstractDropHandler

Parameters:

drag - the latest drag event

drop

public boolean drop(VDragEvent drag)

Description copied from class: VAbstractDropHandler

The default implemmentation visits server if AcceptCriterion can't be verified on client or if AcceptCriterion are met on client.

Specified by:

drop in interface VDropHandler

Overrides:

drop in class VAbstractDropHandler

Parameters:

drag - VDragEvent which contains the transferable and other information for the operation

Returns:

true if the Tranferrable of this drag event needs to be sent to the server, false if drop is rejected or no server side event should be sent

dragAccepted

protected void dragAccepted(VDragEvent drag)

Description copied from class: VAbstractDropHandler

This method is called when a valid drop location was found with AcceptCriterion either via client or server side check.

Implementations can set some hints for users here to highlight that the drag is on a valid drop location.

Specified by:

dragAccepted in class VAbstractDropHandler

Parameters:

drag - the drag event

getConnector

public ComponentConnector getConnector()

Description copied from class: VAbstractDropHandler

Returns the Paintable who owns this VAbstractDropHandler. Server side counterpart of the Paintable is expected to implement DropTarget interface.

Specified by:

getConnector in interface VDropHandler

Specified by:

getConnector in class VAbstractDropHandler

Returns:

the connector

getApplicationConnection

public ApplicationConnection getApplicationConnection()

Description copied from interface: VDropHandler

Returns the application connection to which this VDropHandler belongs to. DragAndDropManager uses this function to send Transferable to server side.

Returns:

the application connection