+Show TOC
×Hide TOC

CoreTextField

Kind of class:	class
Inherits from:	CoreMovieClip < MovieClip
Known subclasses:	DispatchableTextField
Version:	07/19/07
Author:	Aaron Clinger, Mike Creighton
Classpath:	org.casalib.textfield.CoreTextField
File last modified:	Monday, 01 December 2008, 13:34:40

► View source

▼ Hide source

/*
    CASA Lib for ActionScript 2.0
    Copyright (c) 2008, Aaron Clinger & Contributors of CASA Lib
    All rights reserved.
    
    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions are met:
    
    - Redistributions of source code must retain the above copyright notice,
      this list of conditions and the following disclaimer.
    
    - Redistributions in binary form must reproduce the above copyright notice,
      this list of conditions and the following disclaimer in the documentation
      and/or other materials provided with the distribution.
    
    - Neither the name of the CASA Lib nor the names of its contributors
      may be used to endorse or promote products derived from this software
      without specific prior written permission.
    
    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
    LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    POSSIBILITY OF SUCH DAMAGE.
*/

import org.casalib.movieclip.CoreMovieClip;
import org.casalib.util.MovieClipUtil;
import TextField.StyleSheet;

/**
    CoreTextField is actually a CoreMovieClip class that uses composition to emulate the standard Flash TextField class. By doing this, it is now possible to extend TextFields where it would otherwise be impossible due to the limitations of TextField instantiation in AS 2.0. All TextField classes should extend from here.
    
    @author Aaron Clinger
    @author Mike Creighton
    @version 07/19/07
    @example
        <code>
            var myText_mc:CoreTextField = CoreTextField.create(this, "text_mc", null, 250, 50);
            this.myText_mc.border = this.myText_mc.background = true;
            this.myText_mc.text = "Hello World!";
        </code>
    @usageNote If you are wanting to set focus to the CoreTextField use {@link #setFocus} instead of <code>Selection.setFocus()</code>.
*/

class org.casalib.textfield.CoreTextField extends CoreMovieClip {
    public  var field_txt:TextField; /**< @exclude */
    
    
    /**
        Creates an empty instance of the CoreTextField 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:CoreTextField = CoreTextField.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):CoreTextField {
        var tf:CoreTextField = CoreTextField(MovieClipUtil.createMovieRegisterClass('org.casalib.textfield.CoreTextField', target, instanceName, depth));
        
        tf.width  = width;
        tf.height = height;
        
        return tf;
    }
    
    
    private function CoreTextField() {
        super();
        
        this.createTextField('field_txt', 1, 0, 0, 200, 100);
        
        var context:CoreTextField = this;
        
        this.field_txt.onChanged = function(changedField:TextField):Void {
            context.onChanged(changedField);
        };
        
        this.field_txt.onKillFocus = function(newFocus:Object):Void {
            context.onKillFocus(newFocus);
        };
        
        this.field_txt.onScroller = function(scrolledField:TextField):Void {
            context.onScroller(scrolledField);
        };
        
        this.field_txt.onSetFocus = function(oldFocus:Object):Void {
            context.onSetFocus(oldFocus);
        };
        
        this.$setClassDescription('org.casalib.textfield.CoreTextField');
    }
    
    /**
        @exclude 
    */
    public static function getFontList():Array {
        return TextField.getFontList();
    }
    
    /**
        @exclude
    */
    public function addListener(listener:Object):Boolean {
        return this.field_txt.addListener(listener);
    }
    
    /**
        @exclude
    */
    public function getNewTextFormat():TextFormat {
        return this.field_txt.getNewTextFormat();
    }
    
    /**
        @exclude
    */
    public function getTextFormat(beginIndex:Number, endIndex:Number):TextFormat {
        return this.field_txt.getTextFormat(beginIndex, endIndex);
    }
    
    /**
        @exclude
    */
    public function onChanged(changedField:TextField):Void {}
    
    /**
        @exclude
    */
    public function onKillFocus(newFocus:Object):Void {}
    
    /**
        @exclude
    */
    public function onScroller(scrolledField:TextField):Void {}
    
    /**
        @exclude
    */
    public function onSetFocus(oldFocus:Object):Void {}
    
    /**
        @exclude
    */
    public function removeListener(listener:Object):Boolean {
        return this.field_txt.removeListener(listener);
    }
    
    /**
        @exclude
    */
    public function replaceSel(newText:String):Void {
        this.field_txt.replaceSel(newText);
    }
    
    /**
        @exclude
    */
    public function replaceText(beginIndex:Number, endIndex:Number, newText:String):Void {
        this.field_txt.replaceText(beginIndex, endIndex, newText);
    }
    
    /**
        @exclude
    */
    public function setNewTextFormat(tf:TextFormat):Void {
        this.field_txt.setNewTextFormat(tf);
    }
    
    /**
        @exclude
    */
    public function setTextFormat():Void {
        this.field_txt.setTextFormat.apply(this.field_txt, arguments);
    }
    
    /**
        @exclude
    */
    public function get menu():ContextMenu {
        return this.field_txt.menu;
    }
    
    /**
        @exclude
    */
    public function set menu(m:ContextMenu):Void {
        this.field_txt.menu = m;
    }
    
    /**
        @exclude
    */
    public function get antiAliasType():String {
        return this.field_txt.antiAliasType;
    }
    
    /**
        @exclude
    */
    public function set antiAliasType(a:String):Void {
        this.field_txt.antiAliasType = a;
    }
    
    /**
        @exclude
    */
    public function get autoSize():Object {
        return this.field_txt.autoSize;
    }
    
    /**
        @exclude
    */
    public function set autoSize(s:Object):Void {
        this.field_txt.autoSize = s;
    }
    
    /**
        @exclude
    */
    public function get background():Boolean {
        return this.field_txt.background;
    }
    
    /**
        @exclude
    */
    public function set background(b:Boolean):Void {
        this.field_txt.background = b;
    }
    
    /**
        @exclude
    */
    public function get backgroundColor():Number {
        return this.field_txt.backgroundColor;
    }
    
    /**
        @exclude
    */
    public function set backgroundColor(c:Number):Void {
        this.field_txt.backgroundColor = c;
    }
    
    /**
        @exclude
    */
    public function get border():Boolean {
        return this.field_txt.border;
    }
    
    /**
        @exclude
    */
    public function set border(b:Boolean):Void {
        this.field_txt.border = b;
    }
    
    /**
        @exclude
    */
    public function get borderColor():Number {
        return this.field_txt.borderColor;
    }
    
    /**
        @exclude
    */
    public function set borderColor(c:Number):Void {
        this.field_txt.borderColor = c;
    }
    
    /**
        @exclude
    */
    public function get bottomScroll():Number {
        return this.field_txt.bottomScroll;
    }
    
    /**
        @exclude
    */
    public function set bottomScroll(s:Number):Void {
        this.field_txt.bottomScroll = s;
    }
    
    /**
        @exclude
    */
    public function get condensWhite():Boolean {
        return this.field_txt.condensWhite;
    }
    
    /**
        @exclude
    */
    public function set condensWhite(c:Boolean):Void {
        this.field_txt.condensWhite = c;
    }
    
    /**
        @exclude
    */
    public function get embedFonts():Boolean {
        return this.field_txt.embedFonts;
    }
    
    /**
        @exclude
    */
    public function set embedFonts(e:Boolean):Void {
        this.field_txt.embedFonts = e;
    }
    
    /**
        @exclude
    */
    public function get gridFitType():String {
        return this.field_txt.gridFitType;
    }
    
    /**
        @exclude
    */
    public function set gridFitType(t:String):Void {
        this.field_txt.gridFitType = t;
    }
    
    /**
        @exclude
    */
    public function get hscroll():Number {
        return this.field_txt.hscroll;
    }
    
    /**
        @exclude
    */
    public function set hscroll(s:Number):Void {
        this.field_txt.hscroll = s;
    }
    
    /**
        @exclude
    */
    public function get html():Boolean {
        return this.field_txt.html;
    }
    
    /**
        @exclude
    */
    public function set html(h:Boolean):Void {
        this.field_txt.html = h;
    }
    
    /**
        @exclude
    */
    public function get htmlText():String {
        return this.field_txt.htmlText;
    }
    
    /**
        @exclude
    */
    public function set htmlText(t:String):Void {
        this.field_txt.htmlText = t;
    }
    
    /**
        @exclude
    */
    public function get length():Number {
        return this.field_txt.length;
    }
    
    /**
        @exclude
    */
    public function set length(l:Number):Void {
        this.field_txt.length = l;
    }
    
    /**
        @exclude
    */
    public function get maxChars():Number {
        return this.field_txt.maxChars;
    }
    
    /**
        @exclude
    */
    public function set maxChars(m:Number):Void {
        this.field_txt.maxChars = m;
    }
    
    /**
        @exclude
    */
    public function get maxhscroll():Number {
        return this.field_txt.maxhscroll;
    }
    
    /**
        @exclude
    */
    public function set maxhscroll(m:Number):Void {
        this.field_txt.maxhscroll = m;
    }
    
    /**
        @exclude
    */
    public function get maxscroll():Number {
        return this.field_txt.maxscroll;
    }
    
    /**
        @exclude
    */
    public function set maxscroll(m:Number):Void {
        this.field_txt.maxscroll = m;
    }
    
    /**
        @exclude
    */
    public function get mouseWheelEnabled():Boolean {
        return this.field_txt.mouseWheelEnabled;
    }
    
    /**
        @exclude
    */
    public function set mouseWheelEnabled(e:Boolean):Void {
        this.field_txt.mouseWheelEnabled = e;
    }
    
    /**
        @exclude
    */
    public function get multiline():Boolean {
        return this.field_txt.multiline;
    }
    
    /**
        @exclude
    */
    public function set multiline(m:Boolean):Void {
        this.field_txt.multiline = m;
    }
    
    /**
        @exclude
    */
    public function get password():Boolean {
        return this.field_txt.password;
    }
    
    /**
        @exclude
    */
    public function set password(p:Boolean):Void {
        this.field_txt.password = p;
    }
    
    /**
        @exclude
    */
    public function get restrict():String {
        return this.field_txt.restrict;
    }
    
    /**
        @exclude
    */
    public function set restrict(r:String):Void {
        this.field_txt.restrict = r;
    }
    
    /**
        @exclude
    */
    public function get scroll():Number {
        return this.field_txt.scroll;
    }
    
    /**
        @exclude
    */
    public function set scroll(s:Number):Void {
        this.field_txt.scroll = s;
    }
    
    /**
        @exclude
    */
    public function get selectable():Boolean {
        return this.field_txt.selectable;
    }
    
    /**
        @exclude
    */
    public function set selectable(s:Boolean):Void {
        this.field_txt.selectable = s;
    }
    
    /**
        @exclude
    */
    public function get sharpness():Number {
        return this.field_txt.sharpness;
    }
    
    /**
        @exclude
    */
    public function set sharpness(s:Number):Void {
        this.field_txt.sharpness = s;
    }
    
    /**
        @exclude
    */
    public function get styleSheet():StyleSheet {
        return this.field_txt.styleSheet;
    }
    
    /**
        @exclude
    */
    public function set styleSheet(s:StyleSheet):Void {
        this.field_txt.styleSheet = s;
    }
    
    /**
        @exclude
    */
    public function get tabEnabled():Boolean {
        return this.field_txt.tabEnabled;
    }
    
    /**        @exclude
    */
    public function set tabEnabled(e:Boolean):Void {
        this.field_txt.tabEnabled = e;
    }
    
    /**
        @exclude
    */
    public function get tabIndex():Number {
        return this.field_txt.tabIndex;
    }
    
    /**
        @exclude
    */
    public function set tabIndex(i:Number):Void {
        this.field_txt.tabIndex = i;
    }
    
    /**
        @exclude
    */
    public function get text():String {
        return this.field_txt.text;
    }
    
    /**
        @exclude
    */
    public function set text(t:String):Void {
        this.field_txt.text = t;
    }
    
    /**
        @exclude
    */
    public function get textColor():Number {
        return this.field_txt.textColor;
    }
    
    /**
        @exclude
    */
    public function set textColor(c:Number):Void {
        this.field_txt.textColor = c;
    }
    
    /**
        @exclude
    */
    public function get textHeight():Number {
        return this.field_txt.textHeight;
    }
    
    /**
        @exclude
    */
    public function set textHeight(h:Number):Void {
        this.field_txt.textHeight = h;
    }
    
    /**
        @exclude
    */
    public function get textWidth():Number {
        return this.field_txt.textWidth;
    }
    
    /**
        @exclude
    */
    public function set textWidth(w:Number):Void {
        this.field_txt.textWidth = w;
    }
    
    /**
        @exclude
    */
    public function get thickness():Number {
        return this.field_txt.thickness;
    }
    
    /**
        @exclude
    */
    public function set thickness(t:Number):Void {
        this.field_txt.thickness = t;
    }
    
    /**
        @exclude
    */
    public function get type():String {
        return this.field_txt.type;
    }
    
    /**
        @exclude
    */
    public function set type(t:String):Void {
        this.field_txt.type = t;
    }
    
    /**
        @exclude
    */
    public function get variable():String {
        return this.field_txt.variable;
    }
    
    /**
        @exclude
    */
    public function set variable(v:String):Void {
        this.field_txt.variable = v;
    }
    
    /**
        @exclude
    */
    public function get wordWrap():Boolean {
        return this.field_txt.wordWrap;
    }
    
    /**
        @exclude
    */
    public function set wordWrap(w:Boolean):Void {
        this.field_txt.wordWrap = w;
    }
    
    /**
        The width of the TextField in pixels.
        
        @usageNote Always use {@link #width} instead of <code>_width</code> to properly get/set the TextField's width.
    */
    public function get width():Number {
        return this.field_txt._width;
    }
    
    public function set width(w:Number):Void {
        this.field_txt._width = w;
    }
    
    /**
        The height of the TextField in pixels.
        
        @usageNote Always use {@link #height} instead of <code>_height</code> to properly get/set the TextField's height.
    */
    public function get height():Number {
        return this.field_txt._height;
    }
    
    public function set height(h:Number):Void {
        this.field_txt._height = h;
    }
    
    /**
        Gives focus to the TextField if the TextField is type <code>"input"</code>.
        
        @return Returns <code>true</code> if the focus attempt was successful; otherwise <code>false</code>.
    */
    public function setFocus():Boolean {
        return Selection.setFocus(this.field_txt);
    }
    
    /**
        Removes the TextField after automatically calling {@link #destroy}.
        
        @usageNote <code>removeTextField</code> and {@link #destroy} work identically; you can call either method to destroy and remove the TextField.
    */
    public function removeTextField():Void {
        this.destroy();
    }
    
    public function destroy():Void {
        delete this.field_txt.onChanged;
        delete this.field_txt.onKillFocus;
        delete this.field_txt.onScroller;
        delete this.field_txt.onSetFocus;
        
        this.field_txt.removeTextField();
        
        super.destroy();
    }
}

CoreTextField is actually a CoreMovieClip class that uses composition to emulate the standard Flash TextField class. By doing this, it is now possible to extend TextFields where it would otherwise be impossible due to the limitations of TextField instantiation in AS 2.0. All TextField classes should extend from here.

Example:

var myText_mc:CoreTextField = CoreTextField.create(this, "text_mc", null, 250, 50);
this.myText_mc.border = this.myText_mc.background = true;
this.myText_mc.text = "Hello World!";

Usage note:

If you are wanting to set focus to the CoreTextField use setFocus instead of Selection.setFocus().

Summary

Instance properties

width : Number
- The width of the TextField in pixels.
height : Number
- The height of the TextField in pixels.

Class methods

create (target:MovieClip, instanceName:String, depth:Number, width:Number, height:Number) : CoreTextField
- Creates an empty instance of the CoreTextField class.

Class methods inherited from CoreMovieClip

create

Instance methods

setFocus : Boolean
- Gives focus to the TextField if the TextField is type "input".
removeTextField : Void
- Removes the TextField after automatically calling destroy.
destroy : Void

Instance methods inherited from CoreMovieClip

$setClassDescription destroy removeMovieClip toString

Instance properties

height

height:Number

(read,write)

The height of the TextField in pixels.

Usage note:

Always use height instead of _height to properly get/set the TextField's height.

width

width:Number

(read,write)

The width of the TextField in pixels.

Usage note:

Always use width instead of _width to properly get/set the TextField's width.

Class methods

create

static function create (

target:MovieClip, instanceName:String, depth:Number, width:Number, height:Number) : CoreTextField

Creates an empty instance of the CoreTextField 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:CoreTextField = CoreTextField.create(this, "text_mc", null, 250, 50);

Since:

Flash Player 7

Instance methods

destroy

function destroy (

) : Void

Overrides:

org.casalib.movieclip.CoreMovieClip.destroy

removeTextField

function removeTextField (

) : Void

Removes the TextField after automatically calling destroy.

Usage note:

removeTextField and destroy work identically; you can call either method to destroy and remove the TextField.

setFocus

function setFocus (

) : Boolean

Gives focus to the TextField if the TextField is type "input".

Returns:

Returns true if the focus attempt was successful; otherwise false.