Main Page | Packages | Class Tree | Index | Help

mx.controls

class TextArea

Object
  |
  +--MovieClip
        |
        +--mx.core.UIObject
              |
              +--mx.core.UIComponent
                    |
                    +--mx.core.View
                          |
                          +--mx.core.ScrollView
                                |
                                +--mx.controls.TextArea


class TextArea
extends ScrollView

a multi-line text area, complete with optional scrollbars



Field Summary


__editable: Boolean



__hScrollPolicy: String



__vScrollPolicy: String



_hpos: Number



_vpos: Number
position of the scrollbars


className: String
name of this class


clipParameters: Object



hookedH: Boolean



hookedV: Boolean
whether we've hooked up events to the scrollbars


hScrollPolicy: String



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


static
symbolName: String


static
symbolOwner: Object



tfh: Number



tfw: Number



tfx: Number
cached size of textfield


tfy: Number


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


vScrollPolicy: String


Fields inherited from class mx.core.ScrollView

__hPosition, __hScrollPolicy, __maxHPosition, __viewMetrics, __vPosition, __vScrollPolicy, className, columnWidth, heightPadding, hScroller, invLayout, MASK_DEPTH, mask_mc, numberOfCols, oldRndUp, owner, propsInited, rowC, rowH, scrollAreaChanged, specialHScrollCase, symbolName, symbolOwner, version, viewableColumns, viewableRows, vScroller, widthPadding

Fields inherited from class mx.core.View

__tabIndex, border_mc, boundingBox_mc, childNameBase, className, createClassChildAtDepth, depth, loadExternal, symbolName, symbolOwner, version

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


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


maxVPosition: Number (read-only)
maximum allowed setting for vPosition


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


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


styleSheet: TextField.StyleSheet (read, write)



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


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


vPosition: Number (read, write)
line number of the topmost line of characters displayed


wordWrap: Boolean (read, write)
true if should wordwrap.

Properties inherited from class mx.core.ScrollView

hPosition, hScrollPolicy, maxHPosition, maxVPosition, vPosition, vScrollPolicy

Properties inherited from class mx.core.View

numChildren, tabIndex

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


TextArea ( )


Method Summary


adjustScrollBars ( )



createChildren ( Void ): Void
create the mask and make it invisible


draw ( Void ): Void
draw by resetting the text and therefore the scrollbars


getHtml ( ): Boolean



getLineOffsets ( Void ): Array



getText ( ): String



init ( Void ): Void
init variables and create internal objects


keyDown ( e: Object ): Void



layoutContent ( x: Number, y: Number, totalW: Number, totalH: Number, displayW: Number, displayH: Number ): Void



onKillFocus ( x: Object ): Void



onScroll ( docObj: Object ): Void
process the scroll event


onSetFocus ( x: Object ): Void



restoreSelection ( x: Object ): Void



scrollChanged ( Void ): Void
we're done scrolling to put the selection back where we started


setColor ( col: Number ): Void



setEnabled ( enable: Boolean ): Void
disable scrollbars and textfield if we're disabled.


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


setHtml ( value: Boolean ): Void



setScrollProperties ( colCount: Number, colWidth: Number, rwCount: Number, rwHeight: Number, hPadding: Number, wPadding: Number ): Void
set the parameters for scrolling


setText ( t: String ): Void



size ( Void ): Void
respond to size changes

Methods inherited from class mx.core.ScrollView

__onMouseWheel, childLoaded, createChild, createChildren, doLayout, draw, getHPosition, getHScrollPolicy, getMaxHPosition, getViewMetrics, getVPosition, getVScrollPolicy, init, invalidate, onScroll, scrollProxy, setEnabled, setHPosition, setHScrollPolicy, setMaxHPosition, setScrollProperties, setVPosition, setVScrollPolicy, size

Methods inherited from class mx.core.View

addLayoutObject, childLoaded, convertToUIObject, createChild, createChildren, destroyChildAt, doLayout, draw, extension, getChildAt, init, initLayout, size

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

__hScrollPolicy

var __hScrollPolicy: String

__vScrollPolicy

var __vScrollPolicy: String

_hpos

var _hpos: Number

_vpos

var _vpos: Number
position of the scrollbars

className

var className: String
name of this class

clipParameters

var clipParameters: Object

hookedH

var hookedH: Boolean

hookedV

var hookedV: Boolean
whether we've hooked up events to the scrollbars

hScrollPolicy

var hScrollPolicy: String

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

symbolName

static var symbolName: String

symbolOwner

static var symbolOwner: Object

tfh

var tfh: Number

tfw

var tfw: Number

tfx

var tfx: Number
cached size of textfield

tfy

var tfy: Number

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.

vScrollPolicy

var vScrollPolicy: String

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

Overrides:

html

html: Boolean (read, write)
true if text is supplied as html

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

maxVPosition

maxVPosition: Number (read-only)
maximum allowed setting for vPosition

Overrides:

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

styleSheet

styleSheet: TextField.StyleSheet (read, write)

tabIndex

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

However, some views can be tabstops and will therefore return a tabIndex

Overrides:

text

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

vPosition

vPosition: Number (read, write)
line number of the topmost line of characters displayed

Overrides:

wordWrap

wordWrap: Boolean (read, write)
true if should wordwrap.

If false, long lines get clipped


Constructor Documentation

TextArea

function TextArea()

Method Documentation

adjustScrollBars

function adjustScrollBars()

createChildren

function createChildren(Void): Void
create the mask and make it invisible

Overrides:

draw

function draw(Void): Void
draw by resetting the text and therefore the scrollbars

Overrides:

getHtml

function getHtml(): Boolean

getLineOffsets

function getLineOffsets(Void): Array

getText

function getText(): String

init

function init(Void): Void
init variables and create internal objects

Overrides:

keyDown

function keyDown(e: Object): Void

layoutContent

function layoutContent(x: Number,
 y: Number,
 totalW: Number,
 totalH: Number,
 displayW: Number,
 displayH: Number): Void

onKillFocus

function onKillFocus(x: Object): Void
Overrides:

onScroll

function onScroll(docObj: Object): Void
process the scroll event

Overrides:

onSetFocus

function onSetFocus(x: Object): Void
Overrides:

restoreSelection

function restoreSelection(x: Object): Void

scrollChanged

function scrollChanged(Void): Void
we're done scrolling to put the selection back where we started

setColor

function setColor(col: Number): Void
Overrides:

setEnabled

function setEnabled(enable: Boolean): Void
disable scrollbars and textfield if we're disabled.

Overrides:

setFocus

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

Overrides:

setHtml

function setHtml(value: Boolean): Void

setScrollProperties

function setScrollProperties(colCount: Number,
 colWidth: Number,
 rwCount: Number,
 rwHeight: Number,
 hPadding: Number,
 wPadding: Number): Void
set the parameters for scrolling

Overrides:

Parameters:
colCount
number of units to scroll horizontally
colWidth
width in pixels of each of those units
rwCount
number of untis to scroll vertically
rwHeight
height in pixels of each of those units
hPadding
pixels on the left edge that are not scrolled (for row headers)
wPadding
wpadding pixels on the top edge that are not scrolled (for column headers)

setText

function setText(t: String): Void

size

function size(Void): Void
respond to size changes

Overrides:


The documentation was generated from the following file:


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