DispatchableTextField

Kind of class:class
Inherits from:CoreTextField < CoreMovieClip < MovieClip
Implements:
Known subclasses:
Version:04/09/07
Author:Aaron Clinger
Classpath:org.casaframework.textfield.DispatchableTextField
File last modified:Monday, 09 April 2007, 16:58:43
Base "TextField" that includes org.casaframework.event.EventDispatcher and extends CoreTextField.
See also:

Class methods

create

static function create (
target:MovieClip, instanceName:String, depth:Number, width:Number, height:Number) : DispatchableTextField
Creates an empty instance of the DispatchableTextField class. Use this instead of a traditional new constructor statement due to limitations of ActionScript 2.0.
Parameters:
target :
Location where the TextField should be attached.
instanceName:
A unique instance name for the TextField.
depth :
[optional] The depth level where the TextField is placed; defaults to next highest open depth.
width :
A positive integer that specifies the width of the new text field.
height :
A positive integer that specifies the height of the new text field.
Returns:
Returns a reference to the created instance.
Example:
var myText_mc:DispatchableTextField = DispatchableTextField.create(this, "text_mc", null, 250, 50);

Instance methods

addEventObserver

function addEventObserver (
scope:Object, eventName:String, eventHandler:String) : Boolean
Registers a function to receive notification when a event handler is invoked.
#
Parameters:
scope :
The target or object in which to subscribe.
#
eventName :
Event name to subscribe to.
#
eventHandler:
[optional] Name of function to recieve the event. If undefined class assumes eventHandler matches eventName.
#
Returns:
Returns true if the observer was established successfully; otherwise false.
#

destroy

function destroy (
) : Void
Removes any internal variables, intervals, enter frames, internal MovieClips and event observers to allow the object to be garbage collected.

Always call destroy() before deleting last object pointer.
#

dispatchEvent

function dispatchEvent (
eventName:String) : Boolean
Reports event to all subscribed objects.
#
Parameters:
eventName:
Event name.
#
param(s) :
[optional] Parameters passed to the function specified by "eventName". Multiple parameters are allowed and should be separated by commas: param1,param2, ...,paramN
#
Returns:
Returns true if observer(s) listening to specifed event were found; otherwise false.
#

removeAllEventObservers

function removeAllEventObservers (
) : Boolean
Removes all observers regardless of scope or event.
#
Returns:
Returns true if observers were successfully removed; otherwise false.
#

removeEventObserver

function removeEventObserver (
scope:Object, eventName:String, eventHandler:String) : Boolean
Removes specific observer for event.
#
Parameters:
scope :
The target or object in which subscribed.
#
eventName :
Event name to unsubscribe to.
#
eventHandler:
[optional] Name of function that recieved the event. If undefined class assumes eventHandler matched eventName.
#
Returns:
Returns true if the observer was successfully found and removed; otherwise false.
#

removeEventObserversForEvent

function removeEventObserversForEvent (
eventName:String) : Boolean
Removes all observers for a specified event.
#
Parameters:
eventName:
Event name to unsubscribe to.
#
Returns:
Returns true if observers were successfully found for specified eventName and removed; otherwise false.
#

removeEventObserversForScope

function removeEventObserversForScope (
scope:Object) : Boolean
Removes all observers in a specified scope.
#
Parameters:
scope:
The target or object in which to unsubscribe.
#
Returns:
Returns true if observers were successfully found in scope and removed; otherwise false.
#