scaffold.libs_as.feathers.dragDrop.IDragSource.as Maven / Gradle / Ivy

Go to download

/*
Feathers
Copyright 2012-2015 Bowler Hat LLC. All Rights Reserved.

This program is free software. You can redistribute and/or modify it in
accordance with the terms of the accompanying license agreement.
*/
package feathers.dragDrop
{
	import starling.events.Event;

	/**
	 * Dispatched when the drag and drop manager begins the drag.
	 *
	 * The properties of the event object have the following values:
	 * 
	 * 
	 * 
	 * 
	 * 
	 * 
	 * 
	 * 
	 * 
	 * 
	 * Property Value
bubbles false
currentTarget The Object that defines the
	 *   event listener that handles the event. For example, if you use
	 *   myButton.addEventListener() to register an event listener,
	 *   myButton is the value of the currentTarget.
data Same as the dragData property.
dragData The feathers.dragDrop.DragData
	 *   instance associated with this drag.
isDropped false
localX NaN
localY NaN
target The Object that dispatched the event;
	 *   it is not always the Object listening for the event. Use the
	 *   currentTarget property to always access the Object
	 *   listening for the event.
	 *
	 * @eventType feathers.events.DragDropEvent.DRAG_START
	 */
	[Event(name="dragStart",type="feathers.events.DragDropEvent")]

	/**
	 * Dispatched when the drop has been completed or when the drag has been
	 * cancelled.
	 *
	 * The properties of the event object have the following values:
	 * 
	 * 
	 * 
	 * 
	 * 
	 * 
	 * 
	 * 
	 * 
	 * 
	 * Property Value
bubbles false
currentTarget The Object that defines the
	 *   event listener that handles the event. For example, if you use
	 *   myButton.addEventListener() to register an event listener,
	 *   myButton is the value of the currentTarget.
data Same as the dragData property.
dragData The feathers.dragDrop.DragData
	 *   instance associated with this drag.
isDropped true, if the dragged object was dropped; false, if it was not.
localX NaN
localY NaN
target The Object that dispatched the event;
	 *   it is not always the Object listening for the event. Use the
	 *   currentTarget property to always access the Object
	 *   listening for the event.
	 *
	 * @eventType feathers.events.DragDropEvent.DRAG_COMPLETE
	 */
	[Event(name="dragComplete",type="feathers.events.DragDropEvent")]

	/**
	 * An object that can initiate drag actions with the drag and drop manager.
	 *
	 * @see DragDropManager
	 */
	public interface IDragSource
	{
		function dispatchEvent(event:Event):void;
		function dispatchEventWith(type:String, bubbles:Boolean = false, data:Object = null):void;
	}
}

Property	Value
`bubbles`	false
`currentTarget`	The Object that defines the * event listener that handles the event. For example, if you use * `myButton.addEventListener()` to register an event listener, * myButton is the value of the `currentTarget`.
`data`	Same as the dragData property.
`dragData`	The `feathers.dragDrop.DragData` * instance associated with this drag.
`isDropped`	false
`localX`	NaN
`localY`	NaN
`target`	The Object that dispatched the event; * it is not always the Object listening for the event. Use the * `currentTarget` property to always access the Object * listening for the event.

Property	Value
`bubbles`	false
`currentTarget`	The Object that defines the * event listener that handles the event. For example, if you use * `myButton.addEventListener()` to register an event listener, * myButton is the value of the `currentTarget`.
`data`	Same as the dragData property.
`dragData`	The `feathers.dragDrop.DragData` * instance associated with this drag.
`isDropped`	true, if the dragged object was dropped; false, if it was not.
`localX`	NaN
`localY`	NaN
`target`	The Object that dispatched the event; * it is not always the Object listening for the event. Use the * `currentTarget` property to always access the Object * listening for the event.