ScrollPane

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

    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

    ScrollPane

    function ScrollPane (
    )

    Class properties

    mergedClipParameters

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

    symbolName

    static symbolName:String = "ScrollPane"
    (read)

    symbolOwner

    static symbolOwner:Object = ScrollPane
    (read)

    version

    static version:String = "2.0.2.127"
    (read)

    Instance properties

    __hLineScrollSize

    __hLineScrollSize:Number = 5
    (read)

    __hPageScrollSize

    __hPageScrollSize:Number = 20
    (read)

    __hScrollPolicy

    __hScrollPolicy:String = "auto"
    (read)

    __scrollContent

    __scrollContent:String
    (read)

    __scrollDrag

    __scrollDrag:Boolean = false
    (read)

    __vLineScrollSize

    __vLineScrollSize:Number = 5
    (read)

    __vPageScrollSize

    __vPageScrollSize:Number = 20
    (read)

    _loaded

    _loaded:Number
    (read)

    _total

    _total:Number
    (read)

    className

    className:String = "ScrollPane"
    (read)

    name of this class

    clipParameters

    clipParameters:Object = {contentPath : 1,scrollDrag : 1,hScrollPolicy : 1,
    (read)

    content

    content:MovieClip
    (read)

    The URL or linkage name of the SWF or JPEG has been loaded into the ScrollPane.

    contentPath

    contentPath
    (read,write)

    The URL or linkage name of the SWF or JPEG that is to be loaded,
    or has been loaded, into the ScrollPane.
    Component metadata:
      Bindable
      "writeonly"
      Inspectable
      defaultValue:
      ""

      hLineScrollSize

      hLineScrollSize:Number
      (read,write)

      number of pixels to move when UP/DOWN arrow button (in horizontal scrollbar) is pressed

      hPageScrollSize

      hPageScrollSize:Number
      (read,write)

      number of pixels to move when the track in horizontal scrollbar is pressed

      hPosition

      hPosition:Number
      (read)

      hScrollPolicy

      hScrollPolicy
      (write)

      Sets the horizontal scroll of a Scroll Pane to on/off
      or to real-time generation according to the size of the image.(Default value "auto")
      Component metadata:
        Inspectable
        defaultValue:
        "auto"
        enumeration:
        "auto,on,off",

        initializing

        initializing:Boolean = true
        (read)

        keyDown

        keyDown:Function
        (read)

        lastX

        lastX:Number
        (read)

        lastY

        lastY:Number
        (read)

        scrollDrag

        scrollDrag:Boolean
        (read,write)

        Sets/returns the drag property of a scroll pane.
        This enables realtime mouse scrolling within the Scroll Pane.
        Component metadata:
          Inspectable
          defaultValue:
          false

          spContentHolder

          spContentHolder:MovieClip
          (read)

          vLineScrollSize

          vLineScrollSize:Number
          (read,write)

          number of pixels to move when UP/DOWN arrow button (in vertical scrollbar) is pressed

          vPageScrollSize

          vPageScrollSize:Number
          (read,write)

          number of pixels to move when the track in vertical scrollbar is pressed

          vPosition

          vPosition:Number
          (read)

          vScrollPolicy

          vScrollPolicy
          (write)

          Sets the vertical scroll of a Scroll Pane to on/off
          or to real-time generation according to the size of the image.(Default value "auto")
          Component metadata:
            Inspectable
            defaultValue:
            "auto"
            enumeration:
            "auto,on,off",

            Instance methods

            _onKeyDown

            function _onKeyDown (
            e:Object) : Void

            childLoaded

            function childLoaded (
            obj:MovieClip) : Void

            Parameters:
            obj:
            the loaded child
            #
            Overrides:

            createChildren

            function createChildren (
            Void) : Void

            Overrides:

            dispatchEvent

            function dispatchEvent (
            o:Object) : Void

            getBytesLoaded

            function getBytesLoaded (
            ) : Number

            Returns the number of bytes loaded in the ScrollPane.
            Can be called at regular intervals while loading the content to check the progress.
            Returns:
            • Number

            getBytesTotal

            function getBytesTotal (
            ) : Number

            Returns the total number of bytes of the content to be loaded in the ScrollPane.
            Returns:
            • Number

            init

            function init (
            Void) : Void

            Overrides:

            refreshPane

            function refreshPane (
            Void) : Void

            setHPosition

            function setHPosition (
            position:Number)

            Parameters:
            Number:
            Position of the horizontal scrollbar

            setScrollProperties

            function setScrollProperties (
            columnCount:Number, columnWidth:Number, rowCount:Number, rowHeight:Number) : Void

            setVPosition

            function setVPosition (
            position:Number)

            Parameters:
            Number:
            Position of the vertical scrollbar

            size

            function size (
            Void) : Void

            Overrides:

            startDragLoop

            function startDragLoop (
            Void) : Void

            Event handlers

            onComplete

            function onComplete (
            Void) : Void

            onScroll

            function onScroll (
            scrollEvent:Object) : Void