Main Page | Packages | Class Tree | Index | Help
Previous | NextFrames | No Frames
Summary: Field | Property | Contructor | MethodDetail: Field | Property | Contructor | Method
mx.controls

class TextInput

Object
  |
  +--MovieClip
        |
        +--mx.core.UIObject
              |
              +--mx.core.UIComponent
                    |
                    +--mx.controls.TextInput

class TextInput
extends UIComponent

a single-line text input control


Field Summary


__editable: Boolean



_maxWidth: Number



bind: Boolean
true if datamodel connected


border_mc: RectBorder



borderStyle: String
style hook


changeHandler: Function



className: String
name of this class


clipParameters: Object



enterHandler: Function
event hooks


enterListener: Object
object that listens for the enter key


initializing: Boolean



initText: String
store the initial value of the component so we only stuff it into the textfield once


label: TextField


static
mergedClipParameters: Boolean



owner: MovieClip
this gets us around rescoping

static
symbolName: String


static
symbolOwner: Object



tfh: Number



tfw: Number



tfx: Number
textField's x, y, w, h


tfy: Number



updateModel: Function
databinding hook

static
version: String
Version string Copyright (C) 2003 Macromedia, Inc.

Fields inherited from class mx.core.UIComponent

clipParameters, drawFocus, enabled, focusEnabled, focusManager, focusTextField, groupName, kStretch, mergedClipParameters, origBorderStyles, origBorderValues, popUp, symbolName, symbolOwner, tabEnabled, tabIndex, version

Fields inherited from class mx.core.UIObject

__height, __width, _color, _topmost, addEventListener, buildDepthTable, changeColorStyleInChildren, changeTextStyleInChildren, childrenCreated, className, clipParameters, color, createAccessibilityImplementation, createChildAtDepth, createEvent, ction, dispatchEvent, embedFonts, findNextAvailableDepth, fontFamily, fontSize, fontStyle, fontWeight, handleEvent, idNames, ignoreClassStyleDeclaration, initProperties, marginLeft, marginRight, methodTable, notifyStyleChangeInChildren, removeEventListener, setStyle, stylecache, styleName, symbolName, symbolOwner, textAlign, textColorList, textDecoration, textIndent, validateNow, version

Fields inherited from class MovieClip

_alpha, _currentframe, _droptarget, _focusrect, _framesloaded, _height, _lockroot, _name, _parent, _quality, _rotation, _soundbuftime, _target, _totalframes, _url, _visible, _width, _x, _xmouse, _xscale, _y, _ymouse, _yscale, enabled, focusEnabled, hitArea, tabChildren, tabEnabled, tabIndex, tooltipText, trackAsMenu, useHandCursor

Fields inherited from class Object

__proto__, constructor, prototype

Property Summary


: Object (read, write)
accessibility data


editable: Boolean (read, write)
true if the component is editable


hPosition: Number (read, write)
pixel offset when scrolled horizontally


html: Boolean (read, write)
true if text is supplied as html *tiptext Whether the text field contains text or html.


length: Number (read-only)
current length of text in component


maxChars: Number (read, write)
maximum number of characters that can be input into this component


maxHPosition: Number (read-only)
maximum allowed setting for hPosition


password: Boolean (read, write)
true to use '*' instead of the actual characters


restrict: String (read, write)
list of characters to accept or deny


tabIndex: Number (read, write)
tab order when using tab key to navigate


text: String (read, write)
the text in the component

Properties inherited from class mx.core.UIComponent

height, width

Properties inherited from class mx.core.UIObject

bottom, height, left, minHeight, minWidth, right, scaleX, scaleY, top, visible, width, x, y

Constructor


TextInput ( )
Class Constructor

Method Summary


addEnterEvents ( ): Void
create the listener if needed so we can watch for the Enter key


addEventListener ( event: String, handler ): Void
override of addEventListener so we can trap and report Enter key


createChildren ( Void ): Void



draw ( Void ): Void
when drawing set the styles on the text


enterOnKeyDown ( ): Void
look for Enter key and report it


getHtml ( ): Boolean



getText ( ): String



init ( Void ): Void



onKillFocus ( newFocus: Object ): Void



onLabelChanged ( Void ): Void



onSetFocus ( oldFocus: Object ): Void



setColor ( col: Number ): Void



setEditable ( s: Boolean ): Void



setEnabled ( enable: Boolean ): Void
disable textfield when we're disabled


setFocus ( ): Void
Sets the focus to this object.


setHtml ( value: Boolean ): Void



setText ( t: String ): Void



size ( Void ): Void
stretch the border and fit the textfield inside it

Methods inherited from class mx.core.UIComponent

dispatchValueChangedEvent, enabledChanged, findFocusFromObject, findFocusInChildren, getFocus, getFocusManager, init, isParent, onKillFocus, onSetFocus, pressFocus, releaseFocus, setEnabled, setFocus, setVisible, size

Methods inherited from class mx.core.UIObject

__getTextFormat, _createChildren, _getTextFormat, cancelAllDoLaters, constructObject, createChildren, createClassObject, createEmptyObject, createLabel, createObject, createSkin, destroyObject, doLater, doLaterDispatcher, draw, drawRect, getClassStyleDeclaration, getMinHeight, getMinWidth, getSkinIDName, getStyle, getStyleName, init, initFromClipParameters, invalidate, invalidateStyle, mergeClipParameters, move, redraw, setColor, setMinHeight, setMinWidth, setSize, setSkin, setVisible, size

Methods inherited from class MovieClip

attachAudio, attachMovie, beginFill, beginGradientFill, clear, createEmptyMovieClip, createTextField, curveTo, duplicateMovieClip, endFill, getBounds, getBytesLoaded, getBytesTotal, getDepth, getInstanceAtDepth, getNextHighestDepth, getSWFVersion, getTextSnapshot, getURL, globalToLocal, gotoAndPlay, gotoAndStop, hitTest, lineStyle, lineTo, loadMovie, loadVariables, localToGlobal, moveTo, nextFrame, onData, onDragOut, onDragOver, onEnterFrame, onKeyDown, onKeyUp, onKillFocus, onLoad, onMouseDown, onMouseMove, onMouseUp, onPress, onRelease, onReleaseOutside, onRollOut, onRollOver, onSetFocus, onUnload, play, prevFrame, removeMovieClip, setMask, startDrag, stop, stopDrag, swapDepths, unloadMovie, valueOf

Methods inherited from class Object

addProperty, hasOwnProperty, isPropertyEnumerable, isPrototypeOf, registerClass, toLocaleString, toString, unwatch, valueOf, watch


Field Documentation

__editable

var __editable: Boolean

_maxWidth

var _maxWidth: Number

bind

var bind: Boolean
true if datamodel connected

border_mc

var border_mc: RectBorder

borderStyle

var borderStyle: String
style hook

changeHandler

var changeHandler: Function

className

var className: String
name of this class

clipParameters

var clipParameters: Object

enterHandler

var enterHandler: Function
event hooks

enterListener

var enterListener: Object
object that listens for the enter key

initializing

var initializing: Boolean

initText

var initText: String
store the initial value of the component so we only stuff it into the textfield once

label

var label: TextField

mergedClipParameters

static var mergedClipParameters: Boolean

owner

var owner: MovieClip
this gets us around rescoping

symbolName

static var symbolName: String

symbolOwner

static var symbolOwner: Object

tfh

var tfh: Number

tfw

var tfw: Number

tfx

var tfx: Number
textField's x, y, w, h

tfy

var tfy: Number

updateModel

var updateModel: Function
databinding hook

version

static var version: String
Version string Copyright (C) 2003 Macromedia, Inc.

All Rights Reserved. The following is Sample Code and is subject to all restrictions on such code as contained in the End User License Agreement accompanying this product.

Property Documentation

: Object (read, write)
accessibility data

editable

editable: Boolean (read, write)
true if the component is editable

hPosition

hPosition: Number (read, write)
pixel offset when scrolled horizontally

html

html: Boolean (read, write)
true if text is supplied as html *tiptext Whether the text field contains text or html.

*helpid 3189

length

length: Number (read-only)
current length of text in component

maxChars

maxChars: Number (read, write)
maximum number of characters that can be input into this component

maxHPosition

maxHPosition: Number (read-only)
maximum allowed setting for hPosition

password

password: Boolean (read, write)
true to use '*' instead of the actual characters

restrict

restrict: String (read, write)
list of characters to accept or deny

tabIndex

tabIndex: Number (read, write)
tab order when using tab key to navigate

text

text: String (read, write)
the text in the component

Constructor Documentation

TextInput

function TextInput()
Class Constructor

Method Documentation

addEnterEvents

function addEnterEvents(): Void
create the listener if needed so we can watch for the Enter key

addEventListener

function addEventListener(event: String,
 handler): Void
override of addEventListener so we can trap and report Enter key

Overrides:
mx.core.UIObject.addEventListener in class mx.core.UIObject

createChildren

function createChildren(Void): Void
Overrides:
mx.core.UIObject.createChildren in class mx.core.UIObject

draw

function draw(Void): Void
when drawing set the styles on the text

Overrides:
mx.core.UIObject.draw in class mx.core.UIObject

enterOnKeyDown

function enterOnKeyDown(): Void
look for Enter key and report it

getHtml

function getHtml(): Boolean

getText

function getText(): String

init

function init(Void): Void
Overrides:
mx.core.UIComponent.init in class mx.core.UIComponent

onKillFocus

function onKillFocus(newFocus: Object): Void
Overrides:
mx.core.UIComponent.onKillFocus in class mx.core.UIComponent

onLabelChanged

function onLabelChanged(Void): Void

onSetFocus

function onSetFocus(oldFocus: Object): Void
Overrides:
mx.core.UIComponent.onSetFocus in class mx.core.UIComponent

setColor

function setColor(col: Number): Void
Overrides:
mx.core.UIObject.setColor in class mx.core.UIObject

setEditable

function setEditable(s: Boolean): Void

setEnabled

function setEnabled(enable: Boolean): Void
disable textfield when we're disabled

Overrides:
mx.core.UIComponent.setEnabled in class mx.core.UIComponent

setFocus

function setFocus(): Void
Sets the focus to this object.

Overrides:
mx.core.UIComponent.setFocus in class mx.core.UIComponent

setHtml

function setHtml(value: Boolean): Void

setText

function setText(t: String): Void

size

function size(Void): Void
stretch the border and fit the textfield inside it

Overrides:
mx.core.UIComponent.size in class mx.core.UIComponent

The documentation was generated from the following file:

Copyright © 1997-2005 Macromedia, Inc. All rights reserved. Generated with AS2Doc