com.gaiaframework.api.ISprite

	Property	Defined by
		accessibilityProperties : AccessibilityProperties	IDisplayObject
		alpha : Number	IDisplayObject
		blendMode : String	IDisplayObject
		buttonMode : Boolean	ISprite
		bytes : int Returns the bytes attribute value set in the `site.xml` for byte-accurate preloading.	IAsset
		cacheAsBitmap : Boolean	IDisplayObject
		container : DisplayObject [read-only] BitmapSpriteAssets return the Sprite containing the Loader and MovieClipAssets return the Loader.	ISprite
		contextMenu : ContextMenu	ISprite
		depth : String Specifies the depth container the asset is assigned to.	IDisplayObject
		domain : String Specifies the ApplicationDomain the Asset should load into.	ISprite
		doubleClickEnabled : Boolean	ISprite
		dropTarget : DisplayObject [read-only]	ISprite
		filters : Array	IDisplayObject
		focusRect : Object	ISprite
		graphics : Graphics [read-only]	ISprite
		height : Number	IDisplayObject
		hitArea : Sprite	ISprite
		id : String Returns the ID as set in `site.xml`.	IAsset
		loader : Loader Returns the loader.	IDisplayObject
		mask : DisplayObject	IDisplayObject
		mouseChildren : Boolean	ISprite
		mouseEnabled : Boolean	ISprite
		mouseX : Number	IDisplayObject
		mouseY : Number	IDisplayObject
		name : String	IDisplayObject
		node : XML Returns the raw XML node of the asset	IAsset
		numChildren : int [read-only]	ISprite
		opaqueBackground : Object	IDisplayObject
		order : int Returns the load order and position of the asset relative to other assets of the page.	IAsset
		parent : DisplayObjectContainer	IDisplayObject
		percentLoaded : Number Returns the bytesLoaded / bytesTotal.	IAsset
		preloadAsset : Boolean Specifies a value of `true` if the asset is set to preload, or `false` if it is on-demand.	IAsset
		root : DisplayObject	IDisplayObject
		rotation : Number	IDisplayObject
		scale9Grid : Rectangle	IDisplayObject
		scaleX : Number	IDisplayObject
		scaleY : Number	IDisplayObject
		scrollRect : Rectangle	IDisplayObject
		showProgress : Boolean Specifies whether the asset will cause the asset preloader to appear when loaded on-demand.	IAsset
		soundTransform : SoundTransform	ISprite
		src : String Returns the source path of the asset.	IAsset
		stage : Stage	IDisplayObject
		tabChildren : Boolean	ISprite
		tabEnabled : Boolean	ISprite
		tabIndex : int	ISprite
		title : String Specifies the title of the asset.	IAsset
		transform : Transform	IDisplayObject
		useHandCursor : Boolean	ISprite
		visible : Boolean	IDisplayObject
		width : Number	IDisplayObject
		x : Number	IDisplayObject
		y : Number	IDisplayObject

	Method	Defined by
		abort():void Used to manually abort an on-demand asset load.	IAsset
		addChild(child:DisplayObject):DisplayObject	ISprite
		addChildAt(child:DisplayObject, index:int):DisplayObject	ISprite
		areInaccessibleObjectsUnderPoint(point:Point):Boolean	ISprite
		contains(child:DisplayObject):Boolean	ISprite
		getBounds(obj:DisplayObject):Rectangle	IDisplayObject
		getBytesLoaded():int Returns the loaded bytes of the file.	IAsset
		getBytesTotal():int Returns the total bytes of the file.	IAsset
		getChildAt(index:int):DisplayObject	ISprite
		getChildByName(name:String):DisplayObject	ISprite
		getChildIndex(child:DisplayObject):int	ISprite
		getObjectsUnderPoint(point:Point):Array	ISprite
		getRect(obj:DisplayObject):Rectangle	IDisplayObject
		globalToLocal(point:Point):Point	IDisplayObject
		hitTestObject(obj:DisplayObject):Boolean	IDisplayObject
		hitTestPoint(px:Number, py:Number, shapeFlag:Boolean = false):Boolean	IDisplayObject
		load(... args):void Used to load assets on-demand.	IAsset
		localToGlobal(point:Point):Point	IDisplayObject
		removeChild(child:DisplayObject):DisplayObject	ISprite
		removeChildAt(index:int):DisplayObject	ISprite
		setChildIndex(child:DisplayObject, index:int):void	ISprite
		startDrag(lockCenter:Boolean = false, bounds:Rectangle = null):void	ISprite
		stopDrag():void	ISprite
		swapChildren(child1:DisplayObject, child2:DisplayObject):void	ISprite
		swapChildrenAt(index1:int, index2:int):void	ISprite

	Event	Summary	Defined by
		assetComplete	Dispatched when the asset is finished loading.	IAsset

Property detail

buttonMode

property

buttonMode:Boolean [read-write]

Implementation
public function get buttonMode():Boolean
public function set buttonMode(value:Boolean):void

See also

flash.display.Sprite.buttonMode

container

property

container:DisplayObject [read-write]

[read-only] BitmapSpriteAssets return the Sprite containing the Loader and MovieClipAssets return the Loader.

Implementation
public function get container():DisplayObject
public function set container(value:DisplayObject):void

contextMenu

property

contextMenu:ContextMenu [read-write]

Implementation
public function get contextMenu():ContextMenu
public function set contextMenu(value:ContextMenu):void

domain

property

domain:String [read-write]

Specifies the ApplicationDomain the Asset should load into.

Implementation
public function get domain():String
public function set domain(value:String):void

See also

Domain Documentation

doubleClickEnabled

property

doubleClickEnabled:Boolean [read-write]

Implementation
public function get doubleClickEnabled():Boolean
public function set doubleClickEnabled(value:Boolean):void

dropTarget

property

dropTarget:DisplayObject [read-only]

Implementation
public function get dropTarget():DisplayObject

See also

flash.display.Sprite.dropTarget

focusRect

property

focusRect:Object [read-write]

Implementation
public function get focusRect():Object
public function set focusRect(value:Object):void

graphics

property

graphics:Graphics [read-only]

Implementation
public function get graphics():Graphics

See also

flash.display.Sprite.graphics

hitArea

property

hitArea:Sprite [read-write]

Implementation
public function get hitArea():Sprite
public function set hitArea(value:Sprite):void

See also

flash.display.Sprite.hitArea

mouseChildren

property

mouseChildren:Boolean [read-write]

Implementation
public function get mouseChildren():Boolean
public function set mouseChildren(value:Boolean):void

mouseEnabled

property

mouseEnabled:Boolean [read-write]

Implementation
public function get mouseEnabled():Boolean
public function set mouseEnabled(value:Boolean):void

numChildren

property

numChildren:int [read-only]

Implementation
public function get numChildren():int

soundTransform

property

soundTransform:SoundTransform [read-write]

Implementation
public function get soundTransform():SoundTransform
public function set soundTransform(value:SoundTransform):void

See also

flash.display.Sprite.soundTransform

tabChildren

property

tabChildren:Boolean [read-write]

Implementation
public function get tabChildren():Boolean
public function set tabChildren(value:Boolean):void

tabEnabled

property

tabEnabled:Boolean [read-write]

Implementation
public function get tabEnabled():Boolean
public function set tabEnabled(value:Boolean):void

tabIndex

property

tabIndex:int [read-write]

Implementation
public function get tabIndex():int
public function set tabIndex(value:int):void

useHandCursor

property

useHandCursor:Boolean [read-write]

Implementation
public function get useHandCursor():Boolean
public function set useHandCursor(value:Boolean):void

See also

flash.display.Sprite.useHandCursor

Method detail

addChild

()

method

public function addChild(child:DisplayObject):DisplayObject

Parameters

child:DisplayObject

Returns

DisplayObject

addChildAt

()

method

public function addChildAt(child:DisplayObject, index:int):DisplayObject

Parameters

	`child:DisplayObject`

	`index:int`

Returns

DisplayObject

areInaccessibleObjectsUnderPoint

()

method

public function areInaccessibleObjectsUnderPoint(point:Point):Boolean

Parameters

point:Point

Returns

Boolean

contains

()

method

public function contains(child:DisplayObject):Boolean

Parameters

child:DisplayObject

Returns

Boolean

getChildAt

()

method

public function getChildAt(index:int):DisplayObject

Parameters

index:int

Returns

DisplayObject

getChildByName

()

method

public function getChildByName(name:String):DisplayObject

Parameters

name:String

Returns

DisplayObject

getChildIndex

()

method

public function getChildIndex(child:DisplayObject):int

Parameters

child:DisplayObject

Returns

int

getObjectsUnderPoint

()

method

public function getObjectsUnderPoint(point:Point):Array

Parameters

point:Point

Returns

Array

removeChild

()

method

public function removeChild(child:DisplayObject):DisplayObject

Parameters

child:DisplayObject

Returns

DisplayObject

removeChildAt

()

method

public function removeChildAt(index:int):DisplayObject

Parameters

index:int

Returns

DisplayObject

setChildIndex

()

method

public function setChildIndex(child:DisplayObject, index:int):void

Parameters

	`child:DisplayObject`

	`index:int`

startDrag

()

method

public function startDrag(lockCenter:Boolean = false, bounds:Rectangle = null):void

Parameters

	`lockCenter:Boolean` (default = `false`)

	`bounds:Rectangle` (default = `null`)

See also

flash.display.Sprite.startDrag()

stopDrag

()

method

public function stopDrag():void

See also

flash.display.Sprite.stopDrag()

swapChildren

()

method

public function swapChildren(child1:DisplayObject, child2:DisplayObject):void

Parameters

	`child1:DisplayObject`

	`child2:DisplayObject`

swapChildrenAt

()

method

public function swapChildrenAt(index1:int, index2:int):void

Parameters

	`index1:int`

	`index2:int`

Gaia Framework API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
Interface ISprite	Properties \| Methods \| Events

Package	com.gaiaframework.api
Interface	public interface ISprite extends IDisplayObject, IAsset, flash.events.IEventDispatcher
Subinterfaces	IBitmapSprite, IMovieClip