Function Index

$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z

O
	onCountDownComplete, TimeObject
	onCountDownTick, TimeObject
	onCountUpTick, TimeObject
	onCreateLoadEvent, LoadManager
	onExists, Introspection
	onExistsMonitor, Introspection
	onExternalEventError, Events
	onExternalEventStatus, Events
	onHTTPStatus, LoadItem
	onIOError, LoadItem
	onLoadComplete, LoadItem
	onLoadEnd, LoadManager
	onProgress, LoadItem
	onReadLoaderBuffer, LoadItem
	onSecurityError, LoadItem
	onSoundProgress, LoadItem
	onStageExists, CoreObject
P
	parseData, XMLs
Q
	queryEnvironment, CoreObject
R
	receiveExternalEvent, Events
	receiveJavaScriptEvent, Events
	registerExternalEvents, Events
	registerExternalNode, Events
	registerJavaScriptEvents, Events
	removeListener, Events
	removeSoundListeners, LoadItem
	replaceString, CoreData
	reset, Thread
	resetCountDown, TimeObject
	resetCountUp, TimeObject
S
	searchStageInstance, CoreObject
	sendExternalEvent, Events
	set concurrentLoadLimit, LoadManager
	set content, LoadItem
	set fastBuffer, LoadItem
	set hours, TimeObject
	set loadTimeout, LoadManager
	set method, LoadItem
	set milliseconds, TimeObject
	set minutes, TimeObject
	set path, LoadItem
	set seconds, TimeObject
	set sendData, LoadItem
	set totalHours, TimeObject
	set totalMilliseconds, TimeObject
	set totalMinutes, TimeObject
	set totalSeconds, TimeObject
	set type, LoadItem
	set useFIFOBuffer, LoadItem
	setBit, CoreData
	setDefaults, LoadItem
	setListeners BNMAPI LoadItem LoadManager
	setSoundListeners, LoadItem
	setStageCallback, CoreObject
	splitVersionInfo, CoreData
	start, LoadItem
	startCountDown, TimeObject
	startCountUp, TimeObject
	startFastBuffer, LoadItem
	startLoad, LoadManager
	startThreads, ThreadManager
	stopCountDown, TimeObject
	stopCountUp, TimeObject
	stopFastBuffer, LoadItem
	stopThreads, ThreadManager
	stripLeadingSpace, CoreData
	stripOutsideSpace, CoreData
	stripTrailingSpace, CoreData

public function onCountDownComplete( eventObj: TimerEvent ):void

Invoked when the countdown timer completes.

public function onCountDownTick ( eventObj: TimerEvent ):void

Invoked on every countdown interval tick.

public function onCountUpTick ( eventObj: TimerEvent ):void

Invoked on every countup interval tick.

public function onCreateLoadEvent ( eventObj: Object ):void

Invoked via the “LoadManager.CREATELOAD” event and is used as the event listener gateway for the createLoad method.

public function onExists( property: String,
target: *,
callback: Function,
... parms ):void

Begins a monitoring process for a property within a specified object.

private function onExistsMonitor( eventObj: TimerEvent ):void

Timer-based looping method that monitors specified target object(s) for properties and invokes callback methods once those properties become available.

public function onExternalEventError( eventObj: AsyncErrorEvent )

Handles asynchronous error events raised by the LocalConnection instance used for external broadcasts.

public function onExternalEventStatus( eventObj: StatusEvent )

Handles StatusEvent events sent by the LocalConnection instance used for external broadcasts.

public function onHTTPStatus ( eventObj: HTTPStatusEvent ):void

Invoked via a standard HTTPStatusEvent event whenever a load operation reports an HTTP status (404, 200, etc.)

public function onIOError ( eventObj: IOErrorEvent ):void

public function onLoadComplete ( eventObj: Event ):void

Invoked via a standard Event event whenever a load operation successfully completes.

public function onLoadEnd ( eventObj: Object ):void

All-purpose method used for tracking the end of a load.

public function onProgress ( eventObj: ProgressEvent ):void

Invoked by Flash on any ProgressEvent event for the associated load item.

public function onReadLoaderBuffer( eventObj: Event ):void

The final step in data conversion (after invoking convertData) for MovieClip, Bitmap, and Sprite types that require a buffer conversion from a ByteArray to a Loader type.

public function onSecurityError ( eventObj: SecurityErrorEvent ):void

Invoked via a standard SecurityErrorEvent event whenever a load operation halts due to a security restriction.

public function onSoundProgress ( eventObj: ProgressEvent ):void

Trackes the progress of a Sound instance via ProgressEvent broadcasts.

public function onStageExists( eventObj: Event ):void

Event listener invoked when the main `stage` object becomes available in the associated application.

private function parseData( xmlData: * ):void

private function queryEnvironment():void

Queries the environment to determine what type of functionality the API should and shouldn’t be allowed to execute.

public function receiveExternalEvent ( externalEvent: Object )

Receives external events from sending nodes via the LocalConnection object.

public function receiveJavaScriptEvent( externalEvent: Object,
argsPackage: Array )

Receives an event from a JavaScript event broadcast.

public function registerExternalEvents()

Registers this class and the API with any other external event listeners/broadcasters.

private function registerExternalNode ( nodeNum: int ):Boolean

Attempts to register a single external event node at a given node index.

private function registerJavaScriptEvents()

Registers a listening method within this class with the ExternalInterface class for invokation via JavaScript.

public function removeListener( listener: Function,
msg: String,
... args ):Boolean

Removes a listener from the stack.

private function removeSoundListeners ():void

Removes event listeners for the Sound object, typically when the load operation completes.

public function replaceString( sourceString: *,
targetString: *,
metaString: * ):String

Replaces a source string (the meta string) in a given input sring with a new string.

public function reset():void

Resets the current thread to its starting state.

public function resetCountDown( ... args ):void

Resets the count down timer.

public function resetCountUp( ... args ):void

Resets the countup timer.

private function searchStageInstance():void

Waits for the existence of the main “stage” object instance and broadcasts an event/calls associated methods when it becomes available.

public function sendExternalEvent ( externalEvent: Object )

Sends an external event to a specific node using the LocalConnection object.

Sets the limit value on the number of allowable concurrent loads.

Dummy proprty intercept that reports an error (the _content) property may only be set internally.

Enables or disables fast buffering for any subsequent load operation (will not affect an active one).

Sets the number of hours in the time object.

Sets the timeout value (in seconds) for all subsequent load operations.

Sets the server submission method to use when the load operation submits data.

Sets the number of milliseconds in the time object.

Sets the number of minutes in the time object.

Sets the path (URL or local file reference) from which to load the asset or data from.

Sets the number of seconds in the time object.

Assigns any data to be sent to the URL request.

Sets the total hours value for the whole time object.

Sets the total milliseconds value for the whole time object.

Sets the total minutes value for the whole time object.

Sets the total seconds value for the whole time object.

Specifies the target content type into which the loaded data should be converted.

Assigns a FIFOBuffer instance for use with this load item.

public function setBit( bitPos: Number,
inputNum: Number,
bitVal: Boolean )

Sets the bit at the specified position in the input number to the specified value.

private function setDefaults ():void

Sets default properties, instances, and values at class instantiation.

private function setListeners()

Sets default listeners for the API.

private function setListeners ():void

Sets event listeners for the class instance/API chain.

private function setListeners ():void

Sets event listeners for the class instance/API chain.

private function setSoundListeners ():void

Sets event listeners for the class instance/API chain.

public function setStageCallback( methodRef: Function ):void

Registers the supplied method with a list of callback methods to invoke when the main `stage` object becomes available.

public function splitVersionInfo( versionString: String ):Object

Splits a version string such as “2.1.5r12” to its constituent parts.

public function start ():void

Attempts to start the load operation.

public function startCountDown( ... args ):void

Starts a countdown timer based on the current time settings of the time object (e.g.

public function startCountUp( ... args ):void

Starts a countup timer.

private function startFastBuffer ():void

Begins the fast buffer thread used for more accurate updates of the transfer buffer.

public function startLoad ( loadItem: LoadItem,
... args ):Boolean

Begins an asset or data load from the network or local file location.

public function startThreads( ... args ):void

Begins threaded execution of any threads added via the createThread method.

public function stopCountDown():void

Stops the count down timer.

public function stopCountUp():void

Stops the count up timer.

private function stopFastBuffer ():void

Stops the fast buffer execution thread, if running, and cleans up the Thread instance for garbage collection.

public function stopThreads()

Stops any executing threads.

public function stripLeadingSpace( inputStr: String ):String

Strips the leading spaces from a string and returns the processed string.

public function stripOutsideSpace ( inputStr: String ):String

Strips spaces from both the end and the beginning of the input string.

public function stripTrailingSpace( inputStr: String ):String

Strips the trailing spaces from a string and returns the processed string.