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

class List

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

All Known Subclasses: DataGrid, Tree
class List
extends ScrollSelectList

List class - extends ScrollSelectList - gives the user the ability to select one or many options from a scrolling list


Field Summary


__labels: Array
::: Declarations


__selectedIndex: Number



__vScrollPolicy: String



autoHScrollAble: Boolean



boundingBox_mc: MovieClip



calcPreferredHeightFromData: Function



calcPreferredWidthFromData: Function



className: String



clipParameters: Object
::: DEFAULT VALUES


data: Array



displayWidth: Number



invScrollProps: Boolean



invScrollSize: Boolean



oldVWidth: Number



scrollDepth: Number


static
symbolName: String


static
symbolOwner: Object



totalHeight: Number



totalWidth: Number


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

Fields inherited from class mx.controls.listclasses.ScrollSelectList

__cellRenderer, __dataProvider, __hPosition, __iconField, __iconFunction, __labelField, __labelFunction, __rowCount, __rowHeight, __rowRenderer, __width, addItem, addItemAt, baseRowZ, calcPreferredWidth, changeFlag, className, clearSelected, CONTENTDEPTH, createLabel, dataProvider, dragEnabled, dragScrolling, dropEnabled, enabled, getDataProvider, getItemAt, getLength, getSelectedIndex, getSelectedIndices, getSelectedItem, getSelectedItems, getValue, invLayoutContent, invRowHeight, invUpdateControl, isPressed, isRowStyle, isSelected, lastPosition, lastSelected, lastSelID, layoutX, layoutY, length, listContent, minScrollInterval, mixIt1, mixIt2, modelChanged, multipleSelection, onMouseUp, propertyTable, removeAll, removeItemAt, replaceItemAt, roundUp, rows, scrollInterval, selectable, selected, selectedIndex, selectedIndices, selectedItem, selectedItems, selectHolder, selectionDeleted, selectItem, setDataProvider, setSelectedIndex, setSelectedIndices, sortItems, sortItemsBy, tempLabel, tH, topRowZ, tW, value, wasKeySelected

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


labels: Array (read, write)


Properties inherited from class mx.controls.listclasses.ScrollSelectList

cellRenderer, iconField, iconFunction, labelField, labelFunction, rowCount, rowHeight

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


List ( )


Method Summary


configureScrolling ( Void ): Void



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


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


getRowCount ( Void ): Number



hScroll ( pos: Number ): Void



init ( Void ): Void
::: PRIVATE CONSTRUCTION


layoutContent ( x : Number, y : Number, tW : Number, tH : Number, dW : Number, dH : Number ): Void
::: MAIN LAYOUT METHOD.


modelChanged ( eventObj : Object ): Void
::: PRIVATE METHODS event handling


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


setEnabled ( v : Boolean ): Void
::: PUBLIC METHODS


setHPosition ( pos : Number ): Void



setHScrollPolicy ( policy : String ): Void



setMaxHPosition ( pos: Number ): Void



setRowCount ( rC : Number ): Void
::: LAYOUT METHODS


setVPosition ( pos: Number ): Void
::: SCROLL METHODS


size ( Void ): Void
respond to size changes

Methods inherited from class mx.controls.listclasses.ScrollSelectList

__onMouseUp, createChildren, dragScroll, draw, findInputText, findString, getPropertiesAt, getPropertiesOf, getRowCount, getRowHeight, getStateAt, getStyle, init, invalidateStyle, keyDown, layoutContent, moveSelBy, onRowDragOut, onRowDragOver, onRowPress, onRowRelease, onRowRollOut, onRowRollOver, selectRow, setCellRenderer, setEnabled, setIconField, setIconFunction, setLabelField, setLabelFunction, setPropertiesAt, setRowCount, setRowHeight, setVPosition, updateControl

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

__labels

var __labels: Array
::: Declarations

__selectedIndex

var __selectedIndex: Number

__vScrollPolicy

var __vScrollPolicy: String

autoHScrollAble

var autoHScrollAble: Boolean

boundingBox_mc

var boundingBox_mc: MovieClip

calcPreferredHeightFromData

var calcPreferredHeightFromData: Function

calcPreferredWidthFromData

var calcPreferredWidthFromData: Function

className

var className: String

clipParameters

var clipParameters: Object
::: DEFAULT VALUES

data

var data: Array

displayWidth

var displayWidth: Number

invScrollProps

var invScrollProps: Boolean

invScrollSize

var invScrollSize: Boolean

oldVWidth

var oldVWidth: Number

scrollDepth

var scrollDepth: Number

symbolName

static var symbolName: String

symbolOwner

static var symbolOwner: Object

totalHeight

var totalHeight: Number

totalWidth

var totalWidth: Number

version

static var 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.

Property Documentation

labels

labels: Array (read, write)

Constructor Documentation

List

function List()

Method Documentation

configureScrolling

function configureScrolling(Void): Void

createChildren

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

Overrides:
mx.controls.listclasses.ScrollSelectList.createChildren in class mx.controls.listclasses.ScrollSelectList

draw

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

Overrides:
mx.controls.listclasses.ScrollSelectList.draw in class mx.controls.listclasses.ScrollSelectList

getRowCount

function getRowCount(Void): Number
Overrides:
mx.controls.listclasses.ScrollSelectList.getRowCount in class mx.controls.listclasses.ScrollSelectList

hScroll

function hScroll(pos: Number): Void

init

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

Overrides:
mx.controls.listclasses.ScrollSelectList.init in class mx.controls.listclasses.ScrollSelectList

layoutContent

function layoutContent(x : Number,
 y : Number,
 tW : Number,
 tH : Number,
 dW : Number,
 dH : Number): Void
::: MAIN LAYOUT METHOD.

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

Overrides:
mx.controls.listclasses.ScrollSelectList.layoutContent in class mx.controls.listclasses.ScrollSelectList

modelChanged

function modelChanged(eventObj : Object): Void
::: PRIVATE METHODS event handling

Overrides:
mx.controls.listclasses.ScrollSelectList.modelChanged in class mx.controls.listclasses.ScrollSelectList

onScroll

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

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

setEnabled

function setEnabled(v : Boolean): Void
::: PUBLIC METHODS

Overrides:
mx.controls.listclasses.ScrollSelectList.setEnabled in class mx.controls.listclasses.ScrollSelectList

setHPosition

function setHPosition(pos : Number): Void
Overrides:
mx.core.ScrollView.setHPosition in class mx.core.ScrollView

setHScrollPolicy

function setHScrollPolicy(policy : String): Void
Overrides:
mx.core.ScrollView.setHScrollPolicy in class mx.core.ScrollView

setMaxHPosition

function setMaxHPosition(pos: Number): Void
Overrides:
mx.core.ScrollView.setMaxHPosition in class mx.core.ScrollView

setRowCount

function setRowCount(rC : Number): Void
::: LAYOUT METHODS

Overrides:
mx.controls.listclasses.ScrollSelectList.setRowCount in class mx.controls.listclasses.ScrollSelectList

setVPosition

function setVPosition(pos: Number): Void
::: SCROLL METHODS

Overrides:
mx.controls.listclasses.ScrollSelectList.setVPosition in class mx.controls.listclasses.ScrollSelectList

size

function size(Void): Void
respond to size changes

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

The documentation was generated from the following file:

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