Packagesekati.display
Classpublic class DraggableSprite
InheritanceDraggableSprite Inheritance InteractiveSprite Inheritance CoreSprite Inheritance flash.display.Sprite

DraggableSprite provides a common API construct for drag, drop & throwable sprite objects.



Public Properties
 PropertyDefined by
  boundBottom : Number
[read-only] Bottom bounds (DisplayObject registration 0,0).
DraggableSprite
  boundLeft : Number
[read-only] Left bounds (DisplayObject registration 0,0).
DraggableSprite
  boundRight : Number
[read-only] Right bounds (DisplayObject registration 0,0).
DraggableSprite
  bounds : Rectangle
Rectangle value relative to the coordinates of the Sprite's parent that specify a constraint area for the DraggableSprite.
DraggableSprite
  boundTop : Number
[read-only] Top bounds (DisplayObject registration 0,0).
DraggableSprite
  enabled : Boolean
[write-only] Enabled property defines whether interactive eventing is available or not.
DraggableSprite
 InheritedinteractiveMode : Boolean
Specifies the mouse cursors modal state in the object as an interactive target via: buttonMode, mouseChildren & tabChildren.
CoreSprite
 Inheritedscale : Number
The scale value.
CoreSprite
Protected Properties
 PropertyDefined by
  boundRect : Rectangle
DraggableSprite
  cx : Number
DraggableSprite
  cy : Number
DraggableSprite
  friction : Number
DraggableSprite
  isDrag : Boolean
DraggableSprite
  isThrowable : Boolean
DraggableSprite
  ratio : Number
DraggableSprite
  tx : Number
DraggableSprite
  ty : Number
DraggableSprite
  xSpeed : Number
DraggableSprite
  ySpeed : Number
DraggableSprite
Public Methods
 MethodDefined by
  
DraggableSprite(bounds:Rectangle = null, isThrowable:Boolean = true, friction:Number = 0.7, ratio:Number = 1.5)
DraggableSprite Constructor
DraggableSprite
 Inherited
addChildren(... args):void
Add multiple child DisplayObject's.
CoreSprite
 Inherited
destroy():void
Clean up after thy self.
InteractiveSprite
 Inherited
toString():String
Return reflective output.
CoreSprite
Protected Methods
 MethodDefined by
 Inherited
click(e:MouseEvent = null):void
Stub: click event handler.
InteractiveSprite
  
configListeners(isAdd:Boolean = false):void
Event listener management.
DraggableSprite
  
frameHandler(e:Event = null):void
Handle throw logic.
DraggableSprite
 Inherited
invalidate():void
Request a redraw, use for deferred rendering.
CoreSprite
 Inherited
offStage(e:Event = null):void
Remove the listeners when removed from the stage.
InteractiveSprite
 Inherited
onStage(e:Event = null):void
Add listeners when added to stage.
InteractiveSprite
 Inherited
out(e:MouseEvent = null):void
Stub: mouse out event handler.
InteractiveSprite
 Inherited
over(e:MouseEvent = null):void
Stub: mouse over event handler.
InteractiveSprite
  
press(e:MouseEvent = null):void
Stub: press event handler.
DraggableSprite
  
release(e:MouseEvent = null):void
Stub: release event handler.
DraggableSprite
  
releaseOutside(e:Event = null):void
Stub: release outside event handler.
DraggableSprite
Property detail
boundBottomproperty
boundBottom:Number  [read-only]

Bottom bounds (DisplayObject registration 0,0).

Implementation
    public function get boundBottom():Number
boundLeftproperty 
boundLeft:Number  [read-only]

Left bounds (DisplayObject registration 0,0).

Implementation
    public function get boundLeft():Number
boundRectproperty 
protected var boundRect:Rectangle
boundRightproperty 
boundRight:Number  [read-only]

Right bounds (DisplayObject registration 0,0).

Implementation
    public function get boundRight():Number
boundsproperty 
bounds:Rectangle  [read-write]

Rectangle value relative to the coordinates of the Sprite's parent that specify a constraint area for the DraggableSprite.

If bounds has not been set the Canvas.stage bounds are automatically implemented instead.

Implementation
    public function get bounds():Rectangle
    public function set bounds(value:Rectangle):void
boundTopproperty 
boundTop:Number  [read-only]

Top bounds (DisplayObject registration 0,0).

Implementation
    public function get boundTop():Number
cxproperty 
protected var cx:Number
cyproperty 
protected var cy:Number
enabledproperty 
enabled:Boolean  [write-only]

Enabled property defines whether interactive eventing is available or not.

Implementation
    public function set enabled(value:Boolean):void
frictionproperty 
protected var friction:Number
isDragproperty 
protected var isDrag:Boolean
isThrowableproperty 
protected var isThrowable:Boolean
ratioproperty 
protected var ratio:Number
txproperty 
protected var tx:Number
typroperty 
protected var ty:Number
xSpeedproperty 
protected var xSpeed:Number
ySpeedproperty 
protected var ySpeed:Number
Constructor detail
DraggableSprite()constructor
public function DraggableSprite(bounds:Rectangle = null, isThrowable:Boolean = true, friction:Number = 0.7, ratio:Number = 1.5)

DraggableSprite Constructor

Parameters
bounds:Rectangle (default = null) — in which the sprite may be dragged or thrown (best when zero-zero positioned in its container).
 
isThrowable:Boolean (default = true) — determines whether the clip has throwable physics.
 
friction:Number (default = 0.7) — of the throwable physics.
 
ratio:Number (default = 1.5) — of the throwable physics.
Method detail
configListeners()method
protected override function configListeners(isAdd:Boolean = false):void

Event listener management.

Parameters
isAdd:Boolean (default = false) — if true add the listeners, if false remove them.
frameHandler()method 
protected function frameHandler(e:Event = null):void

Handle throw logic.

Parameters
e:Event (default = null)
press()method 
protected override function press(e:MouseEvent = null):void

Stub: press event handler. Starts release-outside simulation via stage.MOUSE_UP & StageEvent.LEAVE.

Parameters
e:MouseEvent (default = null)
release()method 
protected override function release(e:MouseEvent = null):void

Stub: release event handler.

Parameters
e:MouseEvent (default = null)
releaseOutside()method 
protected override function releaseOutside(e:Event = null):void

Stub: release outside event handler.

Parameters
e:Event (default = null)