/*
 This file belongs to the Servoy development and deployment environment, Copyright (C) 1997-2010 Servoy BV

 This program is free software; you can redistribute it and/or modify it under
 the terms of the GNU Affero General Public License as published by the Free
 Software Foundation; either version 3 of the License, or (at your option) any
 later version.

 This program 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 Affero General Public License for more details.

 You should have received a copy of the GNU Affero General Public License along
 with this program; if not, see http://www.gnu.org/licenses or write to the Free
 Software Foundation,Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
 */
package com.servoy.j2db.dnd;

import java.awt.dnd.DnDConstants;

import com.servoy.base.scripting.annotations.ServoyClientSupport;
import com.servoy.j2db.documentation.ServoyDocumented;
import com.servoy.j2db.scripting.IPrefixedConstantsObject;
import com.servoy.j2db.scripting.IReturnedTypesProvider;

/**
 * Class defining drag and drop constants.
 *  
 * @author gboros
 */
@ServoyDocumented(category = ServoyDocumented.RUNTIME)
@ServoyClientSupport(ng = false, wc = true, sc = true)
public class DRAGNDROP implements IPrefixedConstantsObject, IReturnedTypesProvider
{
	/**
	 * Constant for no drag operation.
	 *
	 * @sample
	 * function startDrag(event)
	 * {
	 *	if(event.getElementName() == "copy")
	 *		return DRAGNDROP.COPY;
	 *	else if(event.getElementName() == "move")
	 *		return DRAGNDROP.MOVE
	 *
	 *	return DRAGNDROP.NONE;
	 * }
	 */
	public static final int NONE = DnDConstants.ACTION_NONE;

	/**
	 * Constant for copy drag operation.
	 *
	 * @sampleas NONE
	 * @see #NONE
	 */
	public static final int COPY = DnDConstants.ACTION_COPY;

	/**
	 * Constant for move drag operation.
	 *
	 * @sampleas NONE
	 * @see #NONE
	 */
	public static final int MOVE = DnDConstants.ACTION_MOVE;


	/**
	 * Constant used as mime type for servoy objects.
	 * 
	 * @sample
	 * if (event.dataMimeType == DRAGNDROP.MIME_TYPE_SERVOY || event.dataMimeType == DRAGNDROP.MIME_TYPE_SERVOY_RECORD) {
	 * 	application.output("Dropping is allowed" );
	 * 	return true;
	 * } else { 
	 * 	application.output("Dropping is not allowed" );
	 * 	return false;
	 * }
	 * 
	 */
	public static final String MIME_TYPE_SERVOY = "application/x-servoy-object; class=java.lang.Object";

	/**
	 * Constant used as mime type for servoy record objects.
	 * 
	 * @sampleas MIME_TYPE_SERVOY
	 * @see #MIME_TYPE_SERVOY
	 * 
	 */
	public static final String MIME_TYPE_SERVOY_RECORD = "application/x-servoy-record-object; class=com.servoy.j2db.dataprocessing.Record";

	/*
	 * @see com.servoy.j2db.scripting.IPrefixedConstantsObject#getPrefix()
	 */
	public String getPrefix()
	{
		return "DRAGNDROP"; //$NON-NLS-1$
	}

	/*
	 * @see com.servoy.j2db.scripting.IReturnedTypesProvider#getAllReturnedTypes()
	 */
	public Class< ? >[] getAllReturnedTypes()
	{
		return null;
	}
}