com.alee.extended.dock.drag.FrameDragViewHandler Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of weblaf-ui Show documentation
WebLaF UI components
There is a newer version: 1.2.14
/*
 * This file is part of WebLookAndFeel library.
 *
 * WebLookAndFeel library is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * WebLookAndFeel library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with WebLookAndFeel library.  If not, see .
 */

package com.alee.extended.dock.drag;

import com.alee.api.annotations.NotNull;
import com.alee.extended.dock.WebDockableFrame;
import com.alee.extended.dock.WebDockablePane;
import com.alee.managers.drag.DragException;
import com.alee.managers.drag.view.ComponentDragViewHandler;
import com.alee.utils.SwingUtils;

import java.awt.*;
import java.awt.datatransfer.DataFlavor;
import java.awt.dnd.DragSourceDragEvent;
import java.awt.image.BufferedImage;
import java.lang.ref.WeakReference;

/**
 * Custom {@link ComponentDragViewHandler} for {@link WebDockableFrame} document.
 *
 * @author Mikle Garin
 * @see How to use WebDockablePane
 * @see WebDockableFrame
 * @see WebDockablePane
 * @see com.alee.managers.drag.DragManager
 */
public class FrameDragViewHandler extends ComponentDragViewHandler
{
    /**
     * {@link WeakReference} to {@link WebDockablePane} using this drag view handler.
     */
    @NotNull
    protected final WeakReference dockablePane;

    /**
     * Constructs new {@link FrameDragViewHandler}.
     *
     * @param dockablePane {@link WebDockablePane} using this drag view handler
     */
    public FrameDragViewHandler ( @NotNull final WebDockablePane dockablePane )
    {
        this.dockablePane = new WeakReference ( dockablePane );
    }

    @NotNull
    @Override
    public DataFlavor getObjectFlavor ()
    {
        return FrameTransferable.dataFlavor;
    }

    @Override
    public boolean supports ( @NotNull final FrameDragData object, @NotNull final DragSourceDragEvent event )
    {
        final WebDockablePane dockablePane = this.dockablePane.get ();
        return dockablePane != null && dockablePane.findFrame ( object.getId () ) != null;
    }

    @NotNull
    @Override
    public WebDockableFrame getComponent ( @NotNull final FrameDragData object, @NotNull final DragSourceDragEvent event )
    {
        final WebDockablePane pane = dockablePane.get ();
        if ( pane != null )
        {
            return pane.getFrame ( object.getId () );
        }
        else
        {
            final String msg = "Unable to resolve WebDockablePane for dragged frame with identifier: %s";
            throw new DragException ( String.format ( msg, object.getId () ) );
        }
    }

    @NotNull
    @Override
    protected Point calculateViewRelativeLocation ( @NotNull final WebDockableFrame frame, @NotNull final DragSourceDragEvent event )
    {
        final Point location = super.calculateViewRelativeLocation ( frame, event );
        final WebDockablePane pane = frame.getDockablePane ();
        if ( pane != null )
        {
            final Dimension size = pane.getModel ().getElement ( frame.getId () ).getSize ();
            final Dimension current = frame.getSize ();
            if ( current.width > size.width && Math.abs ( location.x ) > size.width )
            {
                location.x = location.x * size.width / current.width;
            }
            return location;
        }
        else
        {
            throw new DragException ( "Unable to drag frame that is not attached to a WebDockablePane: " + frame.getId () );
        }
    }

    @NotNull
    @Override
    protected BufferedImage createComponentView ( @NotNull final WebDockableFrame frame )
    {
        final WebDockablePane pane = frame.getDockablePane ();
        if ( pane != null )
        {
            final Dimension size = pane.getModel ().getElement ( frame.getId () ).getSize ();
            return SwingUtils.createComponentSnapshot ( frame, size.width, size.height, getSnapshotOpacity () );
        }
        else
        {
            throw new DragException ( "Unable to drag frame that is not attached to a WebDockablePane: " + frame.getId () );
        }
    }
}