ActionScript Standard Library: class mx.controls.Tree

Main Page | Packages | Class Tree | Index | Help

Previous \| Next	Frames \| No Frames
Summary: Field \| Property \| Contructor \| Method	Detail: Field \| Property \| Contructor \| Method

mx.controls

class Tree

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

class Tree
extends List

Tree class - extends List

Field Summary

__rowRenderer: String

::: Defaults

_inherited_dataProvider: Object

branchNodes: Object

var openDuration : Number = 250;

className: String

eventAfterTween: Object

eventPending: Object

isNewRowStyle

isOpening: Boolean

maskList: Array

minScrollInterval

static

mixIt2: Boolean

nodeIcons: Object

nodeIndices: Object

nodeList: Array

opening: Boolean

openNodes: Object

var __rowHeight : Number = 400; ::: Declarations

rowIndex: Number

rowList: Array

static

symbolName: String

static

symbolOwner: Object

treeDataProvider: Object

tween: Object

static

version: String

Fields inherited from class mx.controls.List

__labels, __selectedIndex, __vScrollPolicy, autoHScrollAble, boundingBox_mc, calcPreferredHeightFromData, calcPreferredWidthFromData, className, clipParameters, data, displayWidth, invScrollProps, invScrollSize, oldVWidth, scrollDepth, symbolName, symbolOwner, totalHeight, totalWidth, version

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

firstVisibleNode (read, write)

selectedNode (read, write)

selectedNodes (read, write)

Properties inherited from class mx.controls.List

labels

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

Tree ( )

Method Summary

addItemsAt ( index, arr )

addTreeNode ( label, data )

addTreeNodeAt ( index, label, data )

draw ( Void ): Void

redraw by re-laying out

getDataProvider ( )

getDisplayIndex ( node )

getDisplayList ( node, removed )

starts at a specific node and builds a display list starting from there to be used in rendering the whole tree and after opening / adding, or closing / removing branches

getFirstVisibleNode ( )

getIsBranch ( node )

getIsOpen ( node )

getNodeDepth ( node )

getNodeDisplayedAt ( index )

getTreeNodeAt ( index )

init ( )

::: PRIVATE CONSTRUCTION

invalidateStyle ( propName : String ): Void

called if just styles are changing so subclasses don't have to redraw everything

isNodeVisible ( node )

keyDown ( e: Object ): Void

takes keystrokes and maps them to selection movement increments

layoutContent ( x : Number, y : Number, tW : Number, tH : Number, dW : Number, dH : Number ): Void

::: MAIN LAYOUT METHOD.

modelChanged ( eventObj )

::: PRIVATE METHODS event handling

onScroll ( evt: Object ): Void

process the scroll event

onTweenEnd ( val )

onTweenUpdate ( val )

refresh ( )

removeAll ( )

removeTreeNodeAt ( index )

setDataProvider ( dP )

Functions Mixed in from DataSelector

setDisplayIndex ( node, UID )

setFirstVisibleNode ( node )

setIcon ( node, iconID, iconID2 )

setIsBranch ( node, branch )

setIsOpen ( node, open, animate, fireEvent )

setVPosition ( pos: Number )

::: SCROLL METHODS

size ( Void ): Void

respond to size changes

Methods inherited from class mx.controls.List

configureScrolling, createChildren, draw, getRowCount, hScroll, init, layoutContent, modelChanged, onScroll, setEnabled, setHPosition, setHScrollPolicy, setMaxHPosition, setRowCount, setVPosition, size

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

__rowRenderer

var __rowRenderer: String

::: Defaults

_inherited_dataProvider

var _inherited_dataProvider: Object

branchNodes

var branchNodes: Object

var openDuration : Number = 250;

className

var className: String

eventAfterTween

var eventAfterTween: Object

eventPending

var eventPending: Object

isNewRowStyle

var isNewRowStyle

isOpening

var isOpening: Boolean

maskList

var maskList: Array

minScrollInterval

var minScrollInterval

mixIt2

static var mixIt2: Boolean

nodeIcons

var nodeIcons: Object

nodeIndices

var nodeIndices: Object

nodeList

var nodeList: Array

opening

var opening: Boolean

openNodes

var openNodes: Object

var __rowHeight : Number = 400; ::: Declarations

rowIndex

var rowIndex: Number

rowList

var rowList: Array

symbolName

static var symbolName: String

symbolOwner

static var symbolOwner: Object

treeDataProvider

var treeDataProvider: Object

tween

var tween: Object

version

static var version: String

Property Documentation

firstVisibleNode

(read, write)

selectedNode

(read, write)

selectedNodes

(read, write)

Constructor Documentation

Tree

function Tree

()

Method Documentation

addItemsAt

function addItemsAt

(index,
arr)

addTreeNode

function addTreeNode

(label,
data)

Parameters:

label		the text for the node
data		the data for the node

Returns:: the new node

addTreeNodeAt

function addTreeNodeAt

(index,
label,
data)

Parameters:

index
label		the position (in the tree's root node's children) for the nodethe text for the node
data		the data for the node

Returns:: the new node

draw

function draw

(Void): Void

redraw by re-laying out

Overrides:: List.draw in class List

getDataProvider

function getDataProvider

()

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

getDisplayIndex

function getDisplayIndex

(node)

Parameters:

node

the node to query

Returns:: the index on the tree's display list

getDisplayList

function getDisplayList

(node,
removed)

starts at a specific node and builds a display list starting from there to be used in rendering the whole tree and after opening / adding, or closing / removing branches

getFirstVisibleNode

function getFirstVisibleNode

()

getIsBranch

function getIsBranch

(node)

Parameters:

node

the node to inspect

Returns:: true if a branch, false if not

getIsOpen

function getIsOpen

(node)

Parameters:

node

the node to inspect

Returns:: true if open, false if not

getNodeDepth

function getNodeDepth

(node)

getNodeDisplayedAt

function getNodeDisplayedAt

(index)

Parameters:

index

the position of the node in the tree's list of displayed nodes

Returns:: the node

getTreeNodeAt

function getTreeNodeAt

(index)

Parameters:

index

the position of the node in the tree's dp's children

Returns:: the node

init

function init

()

::: PRIVATE CONSTRUCTION

Overrides:: List.init in class List

invalidateStyle

function invalidateStyle

(propName : String): Void

called if just styles are changing so subclasses don't have to redraw everything

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

isNodeVisible

function isNodeVisible

(node)

keyDown

function keyDown

(e: Object): Void

takes keystrokes and maps them to selection movement increments

Overrides:: mx.controls.listclasses.ScrollSelectList.keyDown 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:: List.layoutContent in class List

modelChanged

function modelChanged

(eventObj)

::: PRIVATE METHODS event handling

Overrides:: List.modelChanged in class List

onScroll

function onScroll

(evt: Object): Void

process the scroll event

Overrides:: List.onScroll in class List

onTweenEnd

function onTweenEnd

(val)

onTweenUpdate

function onTweenUpdate

(val)

refresh

function refresh

()

removeAll

function removeAll

()

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

removeTreeNodeAt

function removeTreeNodeAt

(index)

Parameters:

index

the position of the node in the tree's root

Returns:: the node

setDataProvider

function setDataProvider

(dP)

Functions Mixed in from DataSelector

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

setDisplayIndex

function setDisplayIndex

(node,
UID)

setFirstVisibleNode

function setFirstVisibleNode

(node)

setIcon

function setIcon

(node,
iconID,
iconID2)

Parameters:

node		the node to affect
iconID		the linkage ID for the closed (or leaf) icon
iconID2		the linkage ID for the open (or leaf) icon

setIsBranch

function setIsBranch

(node,
branch)

Parameters:

node		the node to affect
branch		true if branch, false if not

setIsOpen

function setIsOpen

(node,
open,
animate,
fireEvent)

Parameters:

node		the node to affect
open		true to open, false to close
animate		true to animate the transition, false to not.
fireEvent

setVPosition

function setVPosition

(pos: Number)

::: SCROLL METHODS

Overrides:: List.setVPosition in class List

size

function size

(Void): Void

respond to size changes

Overrides:: List.size in class List

The documentation was generated from the following file:

Tree.as, Last Modified: 25.03.2004 05:00:18

Previous \| Next	Frames \| No Frames
Summary: Field \| Property \| Contructor \| Method	Detail: Field \| Property \| Contructor \| Method