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

class ScrollSelectList

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

All Known Subclasses: List, Menu
class ScrollSelectList
extends ScrollView

base class selectable lists of rows which support scrolling


Field Summary


__cellRenderer



__dataProvider: Object
Props Mixed In from DataSelector


__hPosition: Number
::: Default Values of internal vars


__iconField: String



__iconFunction: Function



__labelField: String



__labelFunction: Function



__rowCount: Number



__rowHeight: Number



__rowRenderer: String



__width: Number



addItem: Function



addItemAt: Function



baseRowZ: Number



calcPreferredWidth: Function



changeFlag: Boolean



className: String



clearSelected: Function
clears all selections, redraws list


CONTENTDEPTH: Number
where the stack of rows goes.


createLabel: Function



dataProvider: Object



dragEnabled: Boolean



dragScrolling



dropEnabled: Boolean
some vars for ...


enabled: Boolean



getDataProvider: Function



getItemAt: Function



getLength: Function



getSelectedIndex: Function



getSelectedIndices: Function



getSelectedItem: Function



getSelectedItems: Function



getValue: Function



invLayoutContent: Boolean
::: Declarations


invRowHeight: Boolean



invUpdateControl: Boolean



isPressed: Boolean
keep track of whether the control has been pressed


isRowStyle: Object
anything in this list of styles will trigger an updateControl


isSelected: Function
returns true or false, depending on selection


lastPosition: Number



lastSelected: Number



lastSelID: Number



layoutX: Number



layoutY: Number



length: Number



listContent: MovieClip



minScrollInterval


static
mixIt1: Boolean
Initialize our class to "inherit" DataSelector methods.

static
mixIt2: Boolean



modelChanged: Function
catches model changed events from the dataProvider


multipleSelection: Boolean



onMouseUp: Function



propertyTable: Object



removeAll: Function



removeItemAt: Function



replaceItemAt: Function



roundUp



rows: Array



scrollInterval: Number



selectable: Boolean



selected: Object



selectedIndex: Number



selectedIndices: Array



selectedItem



selectedItems: Array



selectHolder: Number



selectionDeleted: Boolean



selectItem: Function
bookkeeps the selection of one item


setDataProvider: Function
Functions Mixed in from DataSelector


setSelectedIndex: Function



setSelectedIndices: Function



sortItems: Function



sortItemsBy: Function



tempLabel: Object



tH: Number



topRowZ: Number



tW: Number



value: Object



wasKeySelected: Boolean


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


cellRenderer (read, write)



iconField: (write)



iconField: String (read)



iconFunction: (write)



iconFunction: Function (read)



labelField: (write)



labelField: String (read)



labelFunction: (write)



labelFunction: Function (read)



rowCount: Number (read)



rowCount: (write)



rowHeight: Number (read)



rowHeight: (write)


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


ScrollSelectList ( )


Method Summary


__onMouseUp ( Void ): Void
catches mouse releases in or outside the list, fires change if appropriate


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


dragScroll ( Void ): Void
interval function that scrolls the list up or down if the mouse goes above or below the list


draw ( Void ): Void
redraw by re-laying out


findInputText ( Void ): Boolean
does ascii lookup to see if it's time to find an item


findString ( str : String ): Void
finds an item in the list based on a string and moves the selection to it


getPropertiesAt ( index : Number ): Object



getPropertiesOf ( obj : Object ): Object



getRowCount ( Void ): Number



getRowHeight ( Void ): Number



getStateAt ( index : Number ): String
figures out the state of a given item


getStyle ( styleProp: String )
get a style property


init ( Void ): Void
::: PRIVATE CONSTRUCTION METHODS


invalidateStyle ( propName : String ): Void
called if just styles are changing so subclasses don't have to redraw everything


keyDown ( e: Object ): Void
takes keystrokes and maps them to selection movement increments


layoutContent ( x : Number, y: Number, w: Number, h: Number ): Void
::: MAIN LAYOUT METHOD.


moveSelBy ( incr : Number ): Void
::: KEY Support Move selection up or down by increments Note this is for keyboard Support only..


onRowDragOut ( rowIndex : Number ): Void



onRowDragOver ( rowIndex : Number ): Void



onRowPress ( rowIndex : Number ): Void
::: PRIVATE INTERACTION METHODS all the below catch mouse events from the rows


onRowRelease ( rowIndex : Number ): Void



onRowRollOut ( rowIndex : Number ): Void



onRowRollOver ( rowIndex : Number ): Void



selectRow ( rowIndex : Number, transition : Boolean, allowChangeEvent : Boolean ): Void
used to fire a selection driven from user interaction, and update the display


setCellRenderer ( cR ): Void



setEnabled ( v : Boolean ): Void
scrollbars must be enabled/disabled when we are


setIconField ( field: String ): Void



setIconFunction ( func: Function ): Void



setLabelField ( field: String ): Void



setLabelFunction ( func: Function ): Void



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



setRowCount ( v : Number ): Void



setRowHeight ( v : Number ): Void



setVPosition ( pos : Number ): Void
::: SCROLL METHODS Move any rows that don't need rerendering Move and Rerender any rows left over


updateControl ( Void ): Void
refresh all rows (use sparingly!)

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

__cellRenderer

var __cellRenderer

__dataProvider

var __dataProvider: Object
Props Mixed In from DataSelector

__hPosition

var __hPosition: Number
::: Default Values of internal vars

__iconField

var __iconField: String

__iconFunction

var __iconFunction: Function

__labelField

var __labelField: String

__labelFunction

var __labelFunction: Function

__rowCount

var __rowCount: Number

__rowHeight

var __rowHeight: Number

__rowRenderer

var __rowRenderer: String

__width

var __width: Number

addItem

var addItem: Function

addItemAt

var addItemAt: Function

baseRowZ

var baseRowZ: Number

calcPreferredWidth

var calcPreferredWidth: Function

changeFlag

var changeFlag: Boolean

className

var className: String

clearSelected

var clearSelected: Function
clears all selections, redraws list

CONTENTDEPTH

var CONTENTDEPTH: Number
where the stack of rows goes.

createLabel

var createLabel: Function

dataProvider

var dataProvider: Object

dragEnabled

var dragEnabled: Boolean

dragScrolling

var dragScrolling

dropEnabled

var dropEnabled: Boolean
some vars for ...

later

enabled

var enabled: Boolean

getDataProvider

var getDataProvider: Function

getItemAt

var getItemAt: Function

getLength

var getLength: Function

getSelectedIndex

var getSelectedIndex: Function

getSelectedIndices

var getSelectedIndices: Function

getSelectedItem

var getSelectedItem: Function

getSelectedItems

var getSelectedItems: Function

getValue

var getValue: Function

invLayoutContent

var invLayoutContent: Boolean
::: Declarations

invRowHeight

var invRowHeight: Boolean

invUpdateControl

var invUpdateControl: Boolean

isPressed

var isPressed: Boolean
keep track of whether the control has been pressed

isRowStyle

var isRowStyle: Object
anything in this list of styles will trigger an updateControl

isSelected

var isSelected: Function
returns true or false, depending on selection

lastPosition

var lastPosition: Number

lastSelected

var lastSelected: Number

lastSelID

var lastSelID: Number

layoutX

var layoutX: Number

layoutY

var layoutY: Number

length

var length: Number

listContent

var listContent: MovieClip

minScrollInterval

var minScrollInterval

mixIt1

static var mixIt1: Boolean
Initialize our class to "inherit" DataSelector methods.

mixIt2

static var mixIt2: Boolean

modelChanged

var modelChanged: Function
catches model changed events from the dataProvider

multipleSelection

var multipleSelection: Boolean

onMouseUp

var onMouseUp: Function

propertyTable

var propertyTable: Object

removeAll

var removeAll: Function

removeItemAt

var removeItemAt: Function

replaceItemAt

var replaceItemAt: Function

roundUp

var roundUp

rows

var rows: Array

scrollInterval

var scrollInterval: Number

selectable

var selectable: Boolean

selected

var selected: Object

selectedIndex

var selectedIndex: Number

selectedIndices

var selectedIndices: Array

selectedItem

var selectedItem

selectedItems

var selectedItems: Array

selectHolder

var selectHolder: Number

selectionDeleted

var selectionDeleted: Boolean

selectItem

var selectItem: Function
bookkeeps the selection of one item

setDataProvider

var setDataProvider: Function
Functions Mixed in from DataSelector

setSelectedIndex

var setSelectedIndex: Function

setSelectedIndices

var setSelectedIndices: Function

sortItems

var sortItems: Function

sortItemsBy

var sortItemsBy: Function

tempLabel

var tempLabel: Object

tH

var tH: Number

topRowZ

var topRowZ: Number

tW

var tW: Number

value

var value: Object

wasKeySelected

var wasKeySelected: Boolean

Property Documentation

cellRenderer

cellRenderer (read, write)

iconField

iconField: (write)

iconField

iconField: String (read)

iconFunction

iconFunction: (write)

iconFunction

iconFunction: Function (read)

labelField

labelField: (write)

labelField

labelField: String (read)

labelFunction

labelFunction: (write)

labelFunction

labelFunction: Function (read)

rowCount

rowCount: Number (read)

rowCount

rowCount: (write)

rowHeight

rowHeight: Number (read)

rowHeight

rowHeight: (write)

Constructor Documentation

ScrollSelectList

function ScrollSelectList()

Method Documentation

__onMouseUp

function __onMouseUp(Void): Void
catches mouse releases in or outside the list, fires change if appropriate

createChildren

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

Overrides:
mx.core.ScrollView.createChildren in class mx.core.ScrollView

dragScroll

function dragScroll(Void): Void
interval function that scrolls the list up or down if the mouse goes above or below the list

draw

function draw(Void): Void
redraw by re-laying out

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

findInputText

function findInputText(Void): Boolean
does ascii lookup to see if it's time to find an item

findString

function findString(str : String): Void
finds an item in the list based on a string and moves the selection to it

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
figures out the state of a given item

getStyle

function getStyle(styleProp: String)
get a style property

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

Parameters:
styleProp
String prop name of style property

init

function init(Void): Void
::: PRIVATE CONSTRUCTION METHODS

Overrides:
mx.core.ScrollView.init in class mx.core.ScrollView

invalidateStyle

function invalidateStyle(propName : String): Void
called if just styles are changing so subclasses don't have to redraw everything

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

keyDown

function keyDown(e: Object): Void
takes keystrokes and maps them to selection movement increments

layoutContent

function layoutContent(x : Number,
 y: Number,
 w: Number,
 h: Number): Void
::: MAIN LAYOUT METHOD.

Find a delta, make the adjustment to the number of rows, and their width

moveSelBy

function moveSelBy(incr : Number): Void
::: KEY Support Move selection up or down by increments Note this is for keyboard Support only..

no clicks!

onRowDragOut

function onRowDragOut(rowIndex : Number): Void

onRowDragOver

function onRowDragOver(rowIndex : Number): Void

onRowPress

function onRowPress(rowIndex : Number): Void
::: PRIVATE INTERACTION METHODS all the below catch mouse events from the rows

onRowRelease

function onRowRelease(rowIndex : Number): Void

onRowRollOut

function onRowRollOut(rowIndex : Number): Void

onRowRollOver

function onRowRollOver(rowIndex : Number): Void

selectRow

function selectRow(rowIndex : Number,
 transition : Boolean,
 allowChangeEvent : Boolean): Void
used to fire a selection driven from user interaction, and update the display

setCellRenderer

function setCellRenderer(cR): Void

setEnabled

function setEnabled(v : Boolean): Void
scrollbars must be enabled/disabled when we are

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

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
index the index of the item to modify
obj
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
::: SCROLL METHODS Move any rows that don't need rerendering Move and Rerender any rows left over

Overrides:
mx.core.ScrollView.setVPosition in class mx.core.ScrollView

updateControl

function updateControl(Void): Void
refresh all rows (use sparingly!)

The documentation was generated from the following file:

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