+Show TOC
×Hide TOC

DispatchableTextField

Kind of class:	class
Inherits from:	CoreTextField < CoreMovieClip < MovieClip
Implements:	DispatchableInterface
Known subclasses:	EventTextField
Version:	06/21/07
Author:	Aaron Clinger
Classpath:	org.casaframework.textfield.DispatchableTextField
File last modified:	Sunday, 19 August 2007, 13:43:28

► View source

▼ Hide source

/*
    CASA Framework for ActionScript 2.0
    Copyright (C) 2007  CASA Framework
    http://casaframework.org
    
    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2.1 of the License, or (at your option) any later version.
    
    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Lesser General Public License for more details.
    
    You should have received a copy of the GNU Lesser General Public
    License along with this library; if not, write to the Free Software
    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
*/

import org.casaframework.textfield.CoreTextField;
import org.casaframework.event.DispatchableInterface;
import org.casaframework.event.EventDispatcher;
import org.casaframework.util.MovieClipUtil;

/**
    Base "TextField" that includes {@link EventDispatcher} and extends {@link CoreTextField}.
    
    @author Aaron Clinger
    @version 06/21/07
    @see {@link CoreTextField}
*/

class org.casaframework.textfield.DispatchableTextField extends CoreTextField implements DispatchableInterface {
    private var $eventDispatcher:EventDispatcher;
    
    
    /**
        Creates an empty instance of the DispatchableTextField class. Use this instead of a traditional <code>new</code> constructor statement due to limitations of ActionScript 2.0.
        
        @param target: Location where the TextField should be attached.
        @param instanceName: A unique instance name for the TextField.
        @param depth: <strong>[optional]</strong> The depth level where the TextField is placed; defaults to next highest open depth.
        @param width: A positive integer that specifies the width of the new text field.
        @param height: A positive integer that specifies the height of the new text field.
        @return Returns a reference to the created instance.
        @example <code>var myText_mc:DispatchableTextField = DispatchableTextField.create(this, "text_mc", null, 250, 50);</code>
        @since Flash Player 7
    */
    public static function create(target:MovieClip, instanceName:String, depth:Number, width:Number, height:Number):DispatchableTextField {
        var tf:DispatchableTextField = DispatchableTextField(MovieClipUtil.createMovieRegisterClass('org.casaframework.textfield.DispatchableTextField', target, instanceName, depth));
        
        tf.width  = width;
        tf.height = height;
        
        return tf;
    }
    
    
    private function DispatchableTextField() {
        super();
        
        this.$eventDispatcher = new EventDispatcher();
        
        this.$setClassDescription('org.casaframework.textfield.DispatchableTextField');
    }
    
    public function addEventObserver(scope:Object, eventName:String, eventHandler:String):Boolean {
        return this.$eventDispatcher.addEventObserver(scope, eventName, eventHandler);
    }
    
    public function removeEventObserver(scope:Object, eventName:String, eventHandler:String):Boolean {
        return this.$eventDispatcher.removeEventObserver(scope, eventName, eventHandler);
    }
    
    public function removeEventObserversForEvent(eventName:String):Boolean {
        return this.$eventDispatcher.removeEventObserversForEvent(eventName);
    }
    
    public function removeEventObserversForScope(scope:Object):Boolean {
        return this.$eventDispatcher.removeEventObserversForScope(scope);
    }
    
    public function removeAllEventObservers():Boolean {
        return this.$eventDispatcher.removeAllEventObservers();
    }
    
    /**
        {@inheritDoc}
        
        @param eventName: {@inheritDoc}
        @param param(s): {@inheritDoc}
        @return {@inheritDoc}
    */
    public function dispatchEvent(eventName:String):Boolean {
        return this.$eventDispatcher.dispatchEvent.apply(this.$eventDispatcher, arguments);
    }
    
    public function destroy():Void {
        this.$eventDispatcher.destroy();
        delete this.$eventDispatcher;
        
        super.destroy();
    }
}

Base "TextField" that includes org.casaframework.event.EventDispatcher and extends CoreTextField.

Summary

Instance properties

Instance properties inherited from CoreMovieClip

$instanceDescription

Class methods

create

Class methods inherited from CoreTextField

create getFontList

Class methods inherited from CoreMovieClip

create

Instance methods

addEventObserver
removeEventObserver
removeEventObserversForEvent
removeEventObserversForScope
removeAllEventObservers
dispatchEvent
destroy

Instance methods inherited from CoreTextField

addListener destroy getNewTextFormat getTextFormat removeListener removeTextField replaceSel replaceText setFocus setNewTextFormat setTextFormat

Instance methods inherited from CoreMovieClip

$setClassDescription destroy removeMovieClip toString

Event handlers

Event handlers inherited from CoreTextField

onChanged onKillFocus onScroller onSetFocus

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);

Since:

Flash Player 7

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.

Specified by:

org.casaframework.event.DispatchableInterface.addEventObserver

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.

Overrides:

CoreTextField.destroy

Specified by:

org.casaframework.core.CoreInterface.destroy

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.

Specified by:

org.casaframework.event.DispatchableInterface.dispatchEvent

removeAllEventObservers

function removeAllEventObservers () : Boolean

Removes all observers regardless of scope or event.

Returns:

Returns true if observers were successfully removed; otherwise false.

Specified by:

org.casaframework.event.DispatchableInterface.removeAllEventObservers

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.

Specified by:

org.casaframework.event.DispatchableInterface.removeEventObserver

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.

Specified by:

org.casaframework.event.DispatchableInterface.removeEventObserversForEvent

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.

Specified by:

org.casaframework.event.DispatchableInterface.removeEventObserversForScope