ScrollSelectList

Kind of class:class
Inherits from:ScrollView < View < UIComponent < UIObject < MovieClip
Known subclasses:
Classpath:mx.controls.listclasses.ScrollSelectList
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

    ScrollSelectList

    function ScrollSelectList (
    )

    Class properties

    mixIt1

    static mixIt1:Boolean = DataSelector.Initialize(mx.controls.listclasses.ScrollSelectList)
    (read)

    mixIt2

    static mixIt2:Boolean = DataProvider.Initialize(Array)
    (read)

    Instance properties

    __cellRenderer

    __cellRenderer
    (read)

    __dataProvider

    __dataProvider:Object
    (read)

    __hPosition

    __hPosition:Number = 0
    (read)

    __iconField

    __iconField:String
    (read)

    __iconFunction

    __iconFunction:Function
    (read)

    __labelField

    __labelField:String = "label"
    (read)

    __labelFunction

    __labelFunction:Function
    (read)

    __rowCount

    __rowCount:Number = 0
    (read)

    __rowHeight

    __rowHeight:Number = 22
    (read)

    __rowRenderer

    __rowRenderer:String = "SelectableRow"
    (read)

    __width

    __width:Number
    (read)

    addItem

    addItem:Function
    (read)

    Parameters:
    label:
    the label of the new item
    data :
    the data for the new item
    Returns:
    • the added item

    addItemAt

    addItemAt:Function
    (read)

    Parameters:
    index:
    the index at which to add the item
    label:
    the label of the new item
    data :
    the data for the new item
    Returns:
    • the added item

    baseRowZ

    baseRowZ:Number
    (read)

    calcPreferredWidth

    calcPreferredWidth:Function
    (read)

    cellRenderer

    cellRenderer
    (read,write)

    changeFlag

    changeFlag:Boolean
    (read)

    className

    className:String = "ScrollSelectList"
    (read)

    clearSelected

    clearSelected:Function
    (read)

    clears all selections, redraws list

    CONTENTDEPTH

    CONTENTDEPTH:Number = 100
    (read)

    createLabel

    createLabel:Function
    (read)

    dataProvider

    dataProvider:Object
    (read)

    dragEnabled

    dragEnabled:Boolean = false
    (read)

    dragScrolling

    dragScrolling
    (read)

    dropEnabled

    dropEnabled:Boolean = false
    (read)

    enabled

    enabled:Boolean
    (read)

    getDataProvider

    getDataProvider:Function
    (read)

    getItemAt

    getItemAt:Function
    (read)

    Parameters:
    index:
    the index of the items to return
    Returns:
    • the item

    getLength

    getLength:Function
    (read)

    getSelectedIndex

    getSelectedIndex:Function
    (read)

    getSelectedIndices

    getSelectedIndices:Function
    (read)

    getSelectedItem

    getSelectedItem:Function
    (read)

    getSelectedItems

    getSelectedItems:Function
    (read)

    getValue

    getValue:Function
    (read)

    iconField

    iconField:Void
    (write)

    iconField

    iconField:String
    (read)

    iconFunction

    iconFunction:Void
    (write)

    iconFunction

    iconFunction:Function
    (read)

    invLayoutContent

    invLayoutContent:Boolean
    (read)

    invRowHeight

    invRowHeight:Boolean
    (read)

    invUpdateControl

    invUpdateControl:Boolean
    (read)

    isPressed

    isPressed:Boolean
    (read)

    isRowStyle

    isRowStyle:Object = { styleName:true, backgroundColor:true, selectionColor:true, rollOverColor:true, selectionDisabledColor:true,
    (read)

    isSelected

    isSelected:Function
    (read)

    returns true or false, depending on selection

    labelField

    labelField:Void
    (write)

    labelField

    labelField:String
    (read)

    labelFunction

    labelFunction:Void
    (write)

    labelFunction

    labelFunction:Function
    (read)

    lastPosition

    lastPosition:Number
    (read)

    lastSelected

    lastSelected:Number
    (read)

    lastSelID

    lastSelID:Number
    (read)

    layoutX

    layoutX:Number
    (read)

    layoutY

    layoutY:Number
    (read)

    length

    length:Number
    (read)

    listContent

    listContent:MovieClip
    (read)

    minScrollInterval

    minScrollInterval = 30
    (read)

    modelChanged

    modelChanged:Function
    (read)

    catches model changed events from the dataProvider

    multipleSelection

    multipleSelection:Boolean = false
    (read)

    Component metadata:
      Inspectable
      defaultValue:
      false

      propertyTable

      propertyTable:Object
      (read)

      removeAll

      removeAll:Function
      (read)

      removeItemAt

      removeItemAt:Function
      (read)

      Parameters:
      index:
      the index of the item to remove
      Returns:
      • the removed item

      replaceItemAt

      replaceItemAt:Function
      (read)

      Parameters:
      index:
      the index of the item to replace
      label:
      the label for the replacing item
      data :
      the data for the replacing item

      roundUp

      roundUp = 0
      (read)

      rowCount

      rowCount:Number
      (read)

      rowCount

      rowCount:Void
      (write)

      rowHeight

      rowHeight:Number
      (read)

      Component metadata:
        Inspectable
        defaultValue:
        20

        rowHeight

        rowHeight:Void
        (write)

        rows

        rows:Array
        (read)

        scrollInterval

        scrollInterval:Number
        (read)

        selectable

        selectable:Boolean = true
        (read)

        selected

        selected:Object
        (read)

        selectedIndex

        selectedIndex:Number
        (read)

        selectedIndices

        selectedIndices:Array
        (read)

        selectedItem

        selectedItem
        (read)

        selectedItems

        selectedItems:Array
        (read)

        selectHolder

        selectHolder:Number
        (read)

        selectionDeleted

        selectionDeleted:Boolean
        (read)

        selectItem

        selectItem:Function
        (read)

        bookkeeps the selection of one item

        setDataProvider

        setDataProvider:Function
        (read)

        setSelectedIndex

        setSelectedIndex:Function
        (read)

        setSelectedIndices

        setSelectedIndices:Function
        (read)

        sortItems

        sortItems:Function
        (read)

        Parameters:
        compareFunc:
        a function to use for comparison

        sortItemsBy

        sortItemsBy:Function
        (read)

        Parameters:
        fieldName:
        the field to sort on
        order :
        either "ASC" or "DESC"

        tempLabel

        tempLabel:Object
        (read)

        tH

        tH:Number
        (read)

        topRowZ

        topRowZ:Number
        (read)

        tW

        tW:Number
        (read)

        value

        value:Object
        (read)

        wasKeySelected

        wasKeySelected:Boolean
        (read)

        Instance methods

        __onMouseUp

        function __onMouseUp (
        Void) : Void

        createChildren

        function createChildren (
        Void) : Void

        Overrides:

        dragScroll

        function dragScroll (
        Void) : Void

        draw

        function draw (
        Void) : Void

        Overrides:

        findInputText

        function findInputText (
        Void) : Boolean

        findString

        function findString (
        str:String) : Void

        getPropertiesAt

        function getPropertiesAt (
        index:Number) : Object

        getPropertiesOf

        function getPropertiesOf (
        obj:Object) : Object

        getRowCount

        function getRowCount (
        Void) : Number

        getRowHeight

        function getRowHeight (
        Void) : Number

        getStateAt

        function getStateAt (
        index:Number) : String

        getStyle

        function getStyle (
        styleProp:String)

        get a style property
        #
        Returns:
        • Variant the style value
          #
        Overrides:

        init

        function init (
        Void) : Void

        Overrides:

        invalidateStyle

        function invalidateStyle (
        propName:String) : Void

        keyDown

        function keyDown (
        e:Object) : Void

        layoutContent

        function layoutContent (
        x:Number, y:Number, w:Number, h:Number) : Void

        moveSelBy

        function moveSelBy (
        incr:Number) : Void

        selectRow

        function selectRow (
        rowIndex:Number, transition:Boolean, allowChangeEvent:Boolean) : Void

        setCellRenderer

        function setCellRenderer (
        cR) : Void

        setEnabled

        function setEnabled (
        v:Boolean) : Void

        Overrides:

        setIconField

        function setIconField (
        field:String) : Void

        setIconFunction

        function setIconFunction (
        func:Function) : Void

        setLabelField

        function setLabelField (
        field:String) : Void

        setLabelFunction

        function setLabelFunction (
        func:Function) : Void

        setPropertiesAt

        function setPropertiesAt (
        index:Number, obj:Object) : Void

        Parameters:
        index:
        the index of the item to modify
        obj :
        the property values of the item

        setRowCount

        function setRowCount (
        v:Number) : Void

        setRowHeight

        function setRowHeight (
        v:Number) : Void

        setVPosition

        function setVPosition (
        pos:Number) : Void

        Overrides:

        updateControl

        function updateControl (
        Void) : Void

        refresh all rows (use sparingly!)

        Event handlers

        onMouseUp

        onMouseUp:Function
        (read)

        onRowDragOut

        function onRowDragOut (
        rowIndex:Number) : Void

        onRowDragOver

        function onRowDragOver (
        rowIndex:Number) : Void

        onRowPress

        function onRowPress (
        rowIndex:Number) : Void

        onRowRelease

        function onRowRelease (
        rowIndex:Number) : Void

        onRowRollOut

        function onRowRollOut (
        rowIndex:Number) : Void

        onRowRollOver

        function onRowRollOver (
        rowIndex:Number) : Void