TextArea

Kind of class:class
Inherits from:ScrollView < View < UIComponent < UIObject < MovieClip
Classpath:mx.controls.TextArea
File last modified:Tuesday, 18 December 2007, 15:44:37
Component metadata:
    Event
    "change"

    Summary


    Constructor
    Class properties
    Class properties inherited from ScrollView
    symbolName symbolOwner version
    Class properties inherited from View
    childNameBase symbolName symbolOwner version
    Class properties inherited from UIComponent
    kStretch mergedClipParameters symbolName symbolOwner version
    Class properties inherited from UIObject
    symbolName symbolOwner textColorList version
    Instance properties
    Instance properties inherited from ScrollView
    __hPosition __hScrollPolicy __maxHPosition __viewMetrics __vPosition __vScrollPolicy className columnWidth heightPadding hPosition hScroller hScrollPolicy invLayout MASK_DEPTH mask_mc maxHPosition maxVPosition numberOfCols oldRndUp owner propsInited rowC rowH scrollAreaChanged specialHScrollCase viewableColumns viewableRows vPosition vScroller vScrollPolicy vScrollPolicy widthPadding
    Instance properties inherited from View
    __tabIndex _loadExternalClass border_mc boundingBox_mc className createClassChildAtDepth depth hasBeenLayedOut loadExternal numChildren tabIndex
    Instance properties inherited from UIComponent
    clipParameters drawFocus enabled focusEnabled focusManager focusTextField groupName height origBorderStyles origBorderValues popUp tabEnabled tabIndex width
    Instance properties inherited from UIObject
    __height __onUnload __width _color _endInit _id _maxHeight _maxWidth _minHeight _minWidth _preferredHeight _preferredWidth _tf _topmost addEventListener bottom buildDepthTable changeColorStyleInChildren changeTextStyleInChildren childrenCreated className clipParameters color createAccessibilityImplementation createChildAtDepth createClassChildAtDepth createEvent dispatchEvent embedFonts findNextAvailableDepth fontFamily fontSize fontStyle fontWeight handleEvent height idNames ignoreClassStyleDeclaration initProperties invalidateFlag left lineColor lineWidth marginLeft marginRight methodTable minHeight minWidth notifyStyleChangeInChildren removeEventListener right scaleX scaleY setStyle stylecache styleName tabEnabled textAlign textDecoration textIndent tfList top validateNow visible width x y
    Class methods
    Class methods inherited from View
    extension
    Class methods inherited from UIObject
    mergeClipParameters
    Instance methods
    Instance methods inherited from 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
    Instance methods inherited from View
    addLayoutObject childLoaded convertToUIObject createChild createChildren destroyChildAt doLayout draw getChildAt init initLayout size
    Instance methods inherited from UIComponent
    dispatchValueChangedEvent enabledChanged findFocusFromObject findFocusInChildren getFocus getFocusManager init isParent onKillFocus onSetFocus pressFocus releaseFocus setEnabled setFocus setVisible size
    Instance methods inherited from 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 move redraw setColor setMinHeight setMinWidth setSize setSkin setVisible size
    Event handlers
    Event handlers inherited from ScrollView
    onScroll
    Event handlers inherited from UIComponent
    onKillFocus onSetFocus

    Constructor

    TextArea

    function TextArea (
    )

    Class properties

    mergedClipParameters

    static mergedClipParameters:Boolean = UIObject.mergeClipParameters(TextArea.prototype.clipParameters, ScrollView.prototype.clipParameters)
    (read)

    symbolName

    static symbolName:String = "TextArea"
    (read)

    symbolOwner

    static symbolOwner:Object = TextArea
    (read)

    version

    static version:String = "2.0.2.127"
    (read)

    Instance properties

    __editable

    __editable:Boolean = true
    (read)

    __hScrollPolicy

    __hScrollPolicy:String = "auto"
    (read)

    __vScrollPolicy

    __vScrollPolicy:String = "auto"
    (read)

    _accProps

    _accProps:Object
    (read)

    _hpos

    _hpos:Number
    (read)

    _vpos

    _vpos:Number
    (read)

    className

    className:String = "TextArea"
    (read)

    name of this class

    clipParameters

    clipParameters:Object = { text: 1, wordWrap: 1, editable: 1, maxChars: 1, restrict: 1, html: 1, password: 1}
    (read)

    editable

    editable:Boolean
    (read,write)

    true if the component is editable
    Component metadata:
      Inspectable
      defaultValue:
      true

      hookedH

      hookedH:Boolean
      (read)

      hookedV

      hookedV:Boolean
      (read)

      hPosition

      hPosition
      (write)

      html

      html:Boolean
      (read,write)

      true if text is supplied as html
      Component metadata:
        Inspectable
        defaultValue:
        false

        initializing

        initializing:Boolean = true
        (read)

        initText

        initText:String
        (read)

        label

        label:TextField
        (read)

        length

        length:Number
        (read)

        current length of text in component

        maxChars

        maxChars:Number
        (read,write)

        maximum number of characters that can be input into this component
        Component metadata:
          Inspectable
          category:
          "Limits"
          defaultValue:
          null,
          verbose:
          1,

          password

          password:Boolean
          (read,write)

          true to use '*' instead of the actual characters
          Component metadata:
            Inspectable
            category:
            "Other"
            defaultValue:
            false,
            verbose:
            1,

            restrict

            restrict:String
            (read,write)

            list of characters to accept or deny
            Component metadata:
              Inspectable
              category:
              "Limits"
              defaultValue:
              "",
              verbose:
              1,

              styleSheet

              styleSheet:TextField.StyleSheet
              (read)

              styleSheet

              styleSheet:TextField = .StyleSheet
              (write)

              tabIndex

              tabIndex:Number
              (read,write)

              tab order when using tab key to navigate** @tiptext tabIndex of the component* @helpid 3184

              text

              text:String
              (read,write)

              the text in the component
              Component metadata:
                Bindable
                ChangeEvent
                "change"
                Inspectable
                defaultValue:
                ""

                tfh

                tfh:Number
                (read)

                tfw

                tfw:Number
                (read)

                tfx

                tfx:Number
                (read)

                tfy

                tfy:Number
                (read)

                vPosition

                vPosition
                (write)

                vScrollPolicy

                vScrollPolicy:String
                (read)

                wordWrap

                wordWrap:Boolean
                (read,write)

                true if should wordwrap. If false, long lines get clipped
                Component metadata:
                  Inspectable
                  defaultValue:
                  true

                  Instance methods

                  adjustScrollBars

                  function adjustScrollBars (
                  )

                  draw

                  function draw (
                  Void) : Void

                  Overrides:

                  getHtml

                  function getHtml (
                  ) : Boolean

                  scrollChanged

                  function scrollChanged (
                  Void) : Void

                  setEnabled

                  function setEnabled (
                  enable:Boolean) : Void

                  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
                  #
                  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)
                  #
                  Overrides: