/*
 * The contents of this file are subject to the terms of the Common Development and
 * Distribution License (the License). You may not use this file except in compliance with the
 * License.
 *
 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
 * specific language governing permission and limitations under the License.
 *
 * When distributing Covered Software, include this CDDL Header Notice in each file and include
 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
 * Header, with the fields enclosed by brackets [] replaced by your own identifying
 * information: "Portions Copyright [year] [name of copyright owner]".
 *
 * Copyright 2008 Sun Microsystems, Inc.
 * Portions Copyright 2015-2016 ForgeRock AS.
 */
package org.opends.guitools.controlpanel.ui.nodes;

import java.awt.Component;
import java.awt.datatransfer.DataFlavor;
import java.awt.datatransfer.Transferable;
import java.awt.datatransfer.UnsupportedFlavorException;
import java.io.IOException;

/**
 * An implementation of Transferable used in the LDAP entry browser to use
 * drag and drop.  Currently drag and drop is used for instance to drag a
 * number of entries from a browser and drop them in the list of members of
 * a group.
 */
public class DndBrowserNodes implements Transferable {
  /** The data flavor managed by this transferable. */
  public static final DataFlavor INFO_FLAVOR =
    new DataFlavor(BrowserNodeInfo.class, "Browse Node Information");

  static DataFlavor[] FLAVORS = {INFO_FLAVOR };

  private BrowserNodeInfo[] nodes;

  /** The component that contains the nodes. */
  private Component parent;

  /*
   * Transferable implementation
   * ============================================
   */

  @Override
  public boolean isDataFlavorSupported(DataFlavor df) {
    return df.equals(INFO_FLAVOR);
  }

  @Override
  public Object getTransferData(DataFlavor df)
  throws UnsupportedFlavorException, IOException {
    if (!isDataFlavorSupported(df)) {
      throw new UnsupportedFlavorException(df);
    }
    return this;
  }

  @Override
  public DataFlavor[] getTransferDataFlavors() {
    return FLAVORS;
  }

  /**
   * Returns the nodes that are being dragged (and dropped).
   * @return the nodes that are being dragged (and dropped).
   */
  public BrowserNodeInfo[] getNodes()
  {
    return nodes;
  }

  /**
   * Sets the nodes that are being dragged (and dropped).
   * @param nodes the nodes that are being dragged (and dropped).
   */
  public void setNodes(BrowserNodeInfo[] nodes)
  {
    this.nodes = nodes;
  }

  /**
   * Returns the component that contains the nodes (for instance the tree in
   * the LDAP browser).
   * @return the component that contains the nodes (for instance the tree in
   * the LDAP browser).
   */
  public Component getParent()
  {
    return parent;
  }

  /**
   * Sets the component that contains the nodes (for instance the tree in
   * the LDAP browser).
   * @param parent the component that contains the nodes.
   */
  public void setParent(Component parent)
  {
    this.parent = parent;
  }
}