com.vaadin.event.dd.DropTarget Maven / Gradle / Ivy
/*
* Copyright (C) 2000-2024 Vaadin Ltd
*
* This program is available under Vaadin Commercial License and Service Terms.
*
* See for the full
* license.
*/
package com.vaadin.event.dd;
import java.util.Map;
import com.vaadin.ui.Component;
import com.vaadin.ui.dnd.DropTargetExtension;
/**
* DropTarget is an interface for components supporting drop operations. A
* component that wants to receive drop events should implement this interface
* and provide a {@link DropHandler} which will handle the actual drop event.
*
* @since 6.3
* @deprecated Replaced in 8.1 by {@link DropTargetExtension}.
*/
@Deprecated
public interface DropTarget extends Component {
/**
* @return the drop hanler that will receive the dragged data or null if
* drops are not currently accepted
*/
public DropHandler getDropHandler();
/**
* Called before the {@link DragAndDropEvent} is passed to
* {@link DropHandler}. Implementation may for example translate the drop
* target details provided by the client side (drop target) to meaningful
* server side values. If null is returned the terminal implementation will
* automatically create a {@link TargetDetails} with raw client side data.
*
* @see DragSource#getTransferable(Map)
*
* @param clientVariables
* data passed from the DropTargets client side counterpart.
* @return A DropTargetDetails object with the translated data or null to
* use a default implementation.
*/
public TargetDetails translateDropTargetDetails(
Map clientVariables);
}