InputTransferable.java

/*
 * Copyright (c) 2007 BUSINESS OBJECTS SOFTWARE LIMITED
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 *     * Redistributions of source code must retain the above copyright notice,
 *       this list of conditions and the following disclaimer.
 *  
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *  
 *     * Neither the name of Business Objects nor the names of its contributors
 *       may be used to endorse or promote products derived from this software
 *       without specific prior written permission.
 *  
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */


/*
 * InputTransferable.java
 * Creation date: March 25th 2003
 * By: Richard Webster
 */
package org.openquark.gems.client;

import java.awt.datatransfer.DataFlavor;
import java.awt.datatransfer.Transferable;
import java.awt.datatransfer.UnsupportedFlavorException;
import java.util.Arrays;


/**
 * This class represents the transferable that will be used to transfer data about a free input.
 * The Dataflavour supported is the SingleInputDataFlavor which allows us to do targetability calculations.
 * Most of this code is borrowed from TableTopExplorerSelection.
 * 
 * @author Richard Webster
 */
public class InputTransferable implements Transferable {
    
    private final DataFlavor[] dataFlavors;
    private final Gem.PartInput input;
    
    /**
     * Constructor for InputTransferable.
     * @param input
     */
    public InputTransferable(Gem.PartInput input) {

        this.input = input;

        this.dataFlavors = new DataFlavor[] {
                new SingleInputDataFlavor(input),
                DataFlavor.stringFlavor
        };
    }
    
    /**
     * {@inheritDoc}
     */
    public DataFlavor[] getTransferDataFlavors() {
        return dataFlavors.clone();
    }

    /**
     * {@inheritDoc}
     */
    public boolean isDataFlavorSupported(DataFlavor flavor) {
        return Arrays.asList(dataFlavors).contains(flavor);
    }
    
    /**
     * {@inheritDoc}
     */
    public Object getTransferData(DataFlavor flavor) throws UnsupportedFlavorException {
        if (flavor.equals(SingleInputDataFlavor.getSingleInputDataFlavor())) {
            return input;
            
        } else if (flavor.equals(DataFlavor.stringFlavor)) {
            return input.getNameString();
            
        } else {
            throw new UnsupportedFlavorException(flavor);
        }
    }
}