com.vaadin.ui.components.grid.TreeGridDropTarget Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vaadin-server Show documentation
Vaadin server
There is a newer version: 8.27.3
/*
 * 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.ui.components.grid;

import java.util.LinkedHashMap;
import java.util.Locale;
import java.util.Map;

import com.vaadin.shared.Registration;
import com.vaadin.shared.ui.dnd.DropEffect;
import com.vaadin.shared.ui.grid.DropMode;
import com.vaadin.shared.ui.treegrid.TreeGridDropTargetRpc;
import com.vaadin.shared.ui.treegrid.TreeGridDropTargetState;
import com.vaadin.ui.TreeGrid;

/**
 * Makes the rows of a TreeGrid HTML5 drop targets. This is the server side
 * counterpart of GridDropTargetExtensionConnector.
 *
 * @param 
 *            Type of the TreeGrid bean.
 * @author Vaadin Ltd
 * @since 8.1
 */
public class TreeGridDropTarget extends GridDropTarget {

    /**
     * Extends a TreeGrid and makes it's rows drop targets for HTML5 drag and
     * drop.
     *
     * @param target
     *            TreeGrid to be extended.
     * @param dropMode
     *            Drop mode that describes the allowed drop locations within the
     *            TreeGrid's row.
     */
    public TreeGridDropTarget(TreeGrid target, DropMode dropMode) {
        super(target, dropMode);
    }

    /**
     * Attaches drop listener for the current drop target.
     * {@link TreeGridDropListener#drop(TreeGridDropEvent)} is called when drop
     * event happens on the client side.
     *
     * @param listener
     *            Listener to handle drop event.
     * @return Handle to be used to remove this listener.
     */
    public Registration addTreeGridDropListener(
            TreeGridDropListener listener) {
        return addListener(TreeGridDropEvent.class, listener,
                TreeGridDropListener.DROP_METHOD);
    }

    @Override
    protected void registerDropTargetRpc() {
        registerRpc((TreeGridDropTargetRpc) (types, data, dropEffect, rowKey,
                depth, collapsed, dropLocation, mouseEventDetails) -> {

            // Create a linked map that preserves the order of types
            Map dataPreserveOrder = new LinkedHashMap<>();
            types.forEach(type -> dataPreserveOrder.put(type, data.get(type)));

            T dropTargetRow = getParent().getDataCommunicator().getKeyMapper()
                    .get(rowKey);

            TreeGridDropEvent event = new TreeGridDropEvent<>(getParent(),
                    dataPreserveOrder,
                    DropEffect.valueOf(dropEffect.toUpperCase(Locale.ROOT)),
                    getUI().getActiveDragSource(), dropTargetRow, dropLocation,
                    mouseEventDetails, depth, collapsed);

            fireEvent(event);
        });
    }

    @Override
    public TreeGrid getParent() {
        return (TreeGrid) super.getParent();
    }

    @Override
    protected TreeGridDropTargetState getState() {
        return (TreeGridDropTargetState) super.getState();
    }

    @Override
    protected TreeGridDropTargetState getState(boolean markAsDirty) {
        return (TreeGridDropTargetState) super.getState(markAsDirty);
    }
}