com.vaadin.client.ui.dd.VTransferable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of vaadin-client Show documentation

Vaadin is a web application framework for Rich Internet Applications (RIA). Vaadin enables easy development and maintenance of fast and secure rich web applications with a stunning look and feel and a wide browser support. It features a server-side architecture with the majority of the logic running on the server. Ajax technology is used at the browser-side to ensure a rich and interactive user experience.

The newest version!

/*
 * 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.client.ui.dd;

import java.util.Collection;
import java.util.HashMap;
import java.util.Map;

import com.vaadin.client.ComponentConnector;
import com.vaadin.client.extensions.DragSourceExtensionConnector;
import com.vaadin.event.dd.DragSource;

/**
 * Client side counterpart for Transferable in com.vaadin.event.Transferable.
 *
 * @author Vaadin Ltd
 * @deprecated Replaced in 8.1 with {@link DragSourceExtensionConnector}
 */
@Deprecated
public class VTransferable {

    private ComponentConnector component;

    private final Map variables = new HashMap<>();

    /**
     * Returns the component from which the transferable is created (e.g. a tree
     * which node is dragged).
     *
     * @return the component
     */
    public ComponentConnector getDragSource() {
        return component;
    }

    /**
     * Sets the component currently being dragged or from which the transferable
     * is created (e.g. a tree which node is dragged).
     * 
     * The server side counterpart of the component may implement
     * {@link DragSource} interface if it wants to translate or complement the
     * server side instance of this Transferable.
     *
     * @param component
     *            the component to set
     */
    public void setDragSource(ComponentConnector component) {
        this.component = component;
    }

    /**
     * Returns previously saved data that is referred to by the given
     * identifier.
     *
     * @param dataFlavor
     *            the identifier for the data object
     * @return the data object, or {@code null} if not found
     *
     * @see #setData(String, Object)
     */
    public Object getData(String dataFlavor) {
        return variables.get(dataFlavor);
    }

    /**
     * Stores any type of named data that can be useful during the DnD
     * operation.
     *
     * @param dataFlavor
     *            the identifier for the data object, should not be {@code null}
     * @param value
     *            the data to store, should not be {@code null}
     */
    public void setData(String dataFlavor, Object value) {
        variables.put(dataFlavor, value);
    }

    /**
     * Returns a collection of stored identifiers that each correspond with one
     * stored data object.
     *
     * @return the collection of identifiers, can be empty if no data has been
     *         stored yet
     *
     * @see #setData(String, Object)
     */
    public Collection getDataFlavors() {
        return variables.keySet();
    }

    /**
     * This helper method should only be called by {@link VDragAndDropManager}.
     *
     * @return data in this Transferable that needs to be moved to server.
     */
    Map getVariableMap() {
        return variables;
    }

}