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

class ScrollBar

Object
  |
  +--MovieClip
        |
        +--mx.core.UIObject
              |
              +--mx.core.UIComponent
                    |
                    +--mx.controls.scrollClasses.ScrollBar

All Known Subclasses: HScrollBar, UIScrollBar, VScrollBar
class ScrollBar
extends UIComponent

a window with a title bar, caption and optional close button The title bar can be used to drag the window to a new location.


Field Summary


_scrollPosition: Number



boundingBox_mc: MovieClip



className: String
name of this class


clipParameters: Object



downArrow_mc: SimpleButton



downArrowDownName: String
symbol name of skin element for the down state of the downArrow button


downArrowName: String
symbol name of skin element for the disabled state of the downArrow button


downArrowOverName: String
symbol name of skin element for the over state of the downArrow button


downArrowUpName: String
symbol name of skin element for the up state of the downArrow button


idNames: Array



initializing: Boolean



isScrolling: Boolean
** 8) define uninitialized member variables.


largeScroll: Number



maxMode: String



maxPos: Number


static
mergedClipParameters: Boolean



minMode: String
strings used to build up the name of the detail property of the event object


minPos: Number



minusMode: String



pageSize: Number



plusMode: String



scrollHandler: Function
see mx.events.EventDispatcher


scrolling
setInterval reference


scrollThumb_mc: ScrollThumb



scrollTrack_mc: SkinElement



scrollTrackDownName: String
symbol name of skin element for the scroll track when pressed


scrollTrackName: String
symbol name of skin element for the scroll track


scrollTrackOverName: String
symbol name of skin element for the scroll track when mouse is over it

static
skinIDDownArrow: Number


static
skinIDThumb: Number


static
skinIDTrack: Number


static
skinIDTrackDown: Number


static
skinIDTrackOver: Number


static
skinIDUpArrow: Number



smallScroll: Number


static
symbolOwner: Object



thumbBottomName: String
symbol name of skin element for the bottom cap of the thumb in the up state


thumbGripName: String
symbol name of skin element for the grip of the thumb in the up state


thumbMiddleName: String
symbol name of skin element for the moddle piece of the thumb in the up state


thumbTopName: String
symbol name of skin element for the top cap of the thumb in the up state


upArrow_mc: SimpleButton



upArrowDownName: String
symbol name of skin element for the down state of the upArrow button


upArrowName: String
symbol name of skin element for the disabled state of the upArrow button


upArrowOverName: String
symbol name of skin element for the over state of the upArrow button


upArrowUpName: String
symbol name of skin element for the up state of the upArrow button

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


lineScrollSize: Number (read, write)
the amount to move when an arrow button is pressed


pageScrollSize: Number (read, write)
the amount to move when the track is pressed


scrollPosition: Number (read, write)
the current scroll position


virtualHeight: Number (read-only)
for internal use only.

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


ScrollBar ( )
** 10) write a constructor.

Method Summary


createButton ( linkageName: String, id: String, skinID: Number, o: Object ): Object
helper function to create the arrow buttons


createChildren ( Void ): Void



createThumb ( Void ): Void



dispatchScrollChangedEvent ( Void ): Void



dispatchScrollEvent ( detail: String ): Void



draw ( Void ): Void
** 14) create a draw method.


init ( Void ): Void



isScrollBarKey ( k: Number ): Boolean



onDownArrow ( Void ): Void



onScrollChanged ( Void ): Void



onUpArrow ( Void ): Void



releaseScrolling ( Void ): Void



scrollInterval ( inc: String, mode: Number ): Void



scrollIt ( inc: String, mode: Number ): Void



setEnabled ( enabledFlag: Boolean ): Void
turn off buttons, or turn on buttons and resync thumb


setScrollProperties ( pSize: Number, mnPos: Number, mxPos: Number, ls: Number ): Void
resizes the thumb, enables/disables arrows if there is stuff to scroll


size ( Void ): Void



startTrackScroller ( Void ): Void



stopScrolling ( Void ): Void



trackOut ( Void ): Void



trackOver ( Void ): Void



trackScroller ( Void ): Void


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

_scrollPosition

var _scrollPosition: Number

boundingBox_mc

var boundingBox_mc: MovieClip

className

var className: String
name of this class

clipParameters

var clipParameters: Object

downArrow_mc

var downArrow_mc: SimpleButton

downArrowDownName

var downArrowDownName: String
symbol name of skin element for the down state of the downArrow button

downArrowName

var downArrowName: String
symbol name of skin element for the disabled state of the downArrow button

downArrowOverName

var downArrowOverName: String
symbol name of skin element for the over state of the downArrow button

downArrowUpName

var downArrowUpName: String
symbol name of skin element for the up state of the downArrow button

idNames

var idNames: Array

initializing

var initializing: Boolean

isScrolling

var isScrolling: Boolean
** 8) define uninitialized member variables.

There won't be a property slot on these at runtime until someone assigns a property. true if servicing a scroll event

largeScroll

var largeScroll: Number

maxMode

var maxMode: String

maxPos

var maxPos: Number

mergedClipParameters

static var mergedClipParameters: Boolean

minMode

var minMode: String
strings used to build up the name of the detail property of the event object

minPos

var minPos: Number

minusMode

var minusMode: String

pageSize

var pageSize: Number

plusMode

var plusMode: String

scrollHandler

var scrollHandler: Function
see mx.events.EventDispatcher

scrolling

var scrolling
setInterval reference

scrollThumb_mc

var scrollThumb_mc: ScrollThumb

scrollTrack_mc

var scrollTrack_mc: SkinElement

scrollTrackDownName

var scrollTrackDownName: String
symbol name of skin element for the scroll track when pressed

scrollTrackName

var scrollTrackName: String
symbol name of skin element for the scroll track

scrollTrackOverName

var scrollTrackOverName: String
symbol name of skin element for the scroll track when mouse is over it

skinIDDownArrow

static var skinIDDownArrow: Number

skinIDThumb

static var skinIDThumb: Number

skinIDTrack

static var skinIDTrack: Number

skinIDTrackDown

static var skinIDTrackDown: Number

skinIDTrackOver

static var skinIDTrackOver: Number

skinIDUpArrow

static var skinIDUpArrow: Number

smallScroll

var smallScroll: Number

symbolOwner

static var symbolOwner: Object

thumbBottomName

var thumbBottomName: String
symbol name of skin element for the bottom cap of the thumb in the up state

thumbGripName

var thumbGripName: String
symbol name of skin element for the grip of the thumb in the up state

thumbMiddleName

var thumbMiddleName: String
symbol name of skin element for the moddle piece of the thumb in the up state

thumbTopName

var thumbTopName: String
symbol name of skin element for the top cap of the thumb in the up state

upArrow_mc

var upArrow_mc: SimpleButton

upArrowDownName

var upArrowDownName: String
symbol name of skin element for the down state of the upArrow button

upArrowName

var upArrowName: String
symbol name of skin element for the disabled state of the upArrow button

upArrowOverName

var upArrowOverName: String
symbol name of skin element for the over state of the upArrow button

upArrowUpName

var upArrowUpName: String
symbol name of skin element for the up state of the upArrow button

Property Documentation

lineScrollSize

lineScrollSize: Number (read, write)
the amount to move when an arrow button is pressed

pageScrollSize

pageScrollSize: Number (read, write)
the amount to move when the track is pressed

scrollPosition

scrollPosition: Number (read, write)
the current scroll position

virtualHeight

virtualHeight: Number (read-only)
for internal use only.

Used by horizontal bar to deal with rotation

Constructor Documentation

ScrollBar

function ScrollBar()
** 10) write a constructor.

It should generally be empty

Method Documentation

createButton

function createButton(linkageName: String,
 id: String,
 skinID: Number,
 o: Object): Object
helper function to create the arrow buttons

createChildren

function createChildren(Void): Void
Overrides:
mx.core.UIObject.createChildren in class mx.core.UIObject

createThumb

function createThumb(Void): Void

dispatchScrollChangedEvent

function dispatchScrollChangedEvent(Void): Void

dispatchScrollEvent

function dispatchScrollEvent(detail: String): Void

draw

function draw(Void): Void
** 14) create a draw method.

Most of the time, all you'll need to do is force a layout of your objects, and make things visible if it is the first time you are being drawn draw by making everything visible, then laying out

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

init

function init(Void): Void
Overrides:
mx.core.UIComponent.init in class mx.core.UIComponent

isScrollBarKey

function isScrollBarKey(k: Number): Boolean

onDownArrow

function onDownArrow(Void): Void

onScrollChanged

function onScrollChanged(Void): Void

onUpArrow

function onUpArrow(Void): Void

releaseScrolling

function releaseScrolling(Void): Void

scrollInterval

function scrollInterval(inc: String,
 mode: Number): Void

scrollIt

function scrollIt(inc: String,
 mode: Number): Void

setEnabled

function setEnabled(enabledFlag: Boolean): Void
turn off buttons, or turn on buttons and resync thumb

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

setScrollProperties

function setScrollProperties(pSize: Number,
 mnPos: Number,
 mxPos: Number,
 ls: Number): Void
resizes the thumb, enables/disables arrows if there is stuff to scroll

size

function size(Void): Void
Overrides:
mx.core.UIComponent.size in class mx.core.UIComponent

startTrackScroller

function startTrackScroller(Void): Void

stopScrolling

function stopScrolling(Void): Void

trackOut

function trackOut(Void): Void

trackOver

function trackOver(Void): Void

trackScroller

function trackScroller(Void): Void

The documentation was generated from the following file:

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