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

class ScrollView

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

All Known Subclasses: ScrollPane, ScrollSelectList, TextArea, Window
class ScrollView
extends View


Field Summary


__hPosition: Number



__hScrollPolicy: String



__maxHPosition: Number



__viewMetrics: Object
offsets including borders and scrollbars


__vPosition: Number



__vScrollPolicy: String
default values of the getter/setter properties


className: String
name of this class


columnWidth: Number



heightPadding: Number



hScroller: ScrollBar



invLayout: Boolean



MASK_DEPTH: Number
mask is placed up high and then made invisible


mask_mc: MovieClip



numberOfCols: Number
cached values of the content parameters


oldRndUp: Number



owner: MovieClip
pointer to us when we get called in another scope


propsInited: Boolean



rowC: Number



rowH: Number



scrollAreaChanged: Boolean



specialHScrollCase: Boolean


static
symbolName: String


static
symbolOwner: Object


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


viewableColumns: Number



viewableRows: Number



vScroller: ScrollBar



widthPadding: Number


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


hPosition: Number (read, write)
this only moves the scrollBars -- assumes the call emanated from the scrollable content


hScrollPolicy: String (read, write)



maxHPosition: Number (read, write)



maxVPosition: Number (read-only)



vPosition: Number (read, write)



vScrollPolicy: String (read)



vScrollPolicy: Object (write)


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


ScrollView ( )


Method Summary


__onMouseWheel ( delta: Number, scrollTarget: MovieClip ): Void



childLoaded ( obj: MovieClip ): Void



createChild ( id: String, name: String, props: Object ): MovieClip
add a new child object


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


doLayout ( Void ): Void



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


getHPosition ( Void ): Number



getHScrollPolicy ( Void )



getMaxHPosition ( Void ): Number



getViewMetrics ( Void ): Object
get the thickness of the edges of the object taking into account the border and scrollbars if visible


getVPosition ( Void ): Number



getVScrollPolicy ( Void )



init ( Void ): Void
init variables and create internal objects


invalidate ( Void ): Void
if we get invalidated just call super


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


scrollProxy ( docObj: Object ): Void
handle scroll events from the scrollbar 'this' is actually the scrollbar so we just pass it to the parent


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


setHPosition ( pos: Number ): Void



setHScrollPolicy ( policy ): Void



setMaxHPosition ( pos: Number ): Void



setScrollProperties ( colCount: Number, colWidth: Number, rwCount: Number, rwHeight: Number, hPadding: Number, wPadding: Number ): Void
set the parameters for scrolling


setVPosition ( pos: Number ): Void



setVScrollPolicy ( policy ): Void



size ( Void ): Void
respond to size changes

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

__hPosition

var __hPosition: Number

__hScrollPolicy

var __hScrollPolicy: String

__maxHPosition

var __maxHPosition: Number

__viewMetrics

var __viewMetrics: Object
offsets including borders and scrollbars

__vPosition

var __vPosition: Number

__vScrollPolicy

var __vScrollPolicy: String
default values of the getter/setter properties

className

var className: String
name of this class

columnWidth

var columnWidth: Number

heightPadding

var heightPadding: Number

hScroller

var hScroller: ScrollBar

invLayout

var invLayout: Boolean

MASK_DEPTH

var MASK_DEPTH: Number
mask is placed up high and then made invisible

mask_mc

var mask_mc: MovieClip

numberOfCols

var numberOfCols: Number
cached values of the content parameters

oldRndUp

var oldRndUp: Number

owner

var owner: MovieClip
pointer to us when we get called in another scope

propsInited

var propsInited: Boolean

rowC

var rowC: Number

rowH

var rowH: Number

scrollAreaChanged

var scrollAreaChanged: Boolean

specialHScrollCase

var specialHScrollCase: Boolean

symbolName

static var symbolName: String

symbolOwner

static var symbolOwner: Object

version

static var version: String
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.

viewableColumns

var viewableColumns: Number

viewableRows

var viewableRows: Number

vScroller

var vScroller: ScrollBar

widthPadding

var widthPadding: Number

Property Documentation

hPosition

hPosition: Number (read, write)
this only moves the scrollBars -- assumes the call emanated from the scrollable content

hScrollPolicy

hScrollPolicy: String (read, write)

maxHPosition

maxHPosition: Number (read, write)

maxVPosition

maxVPosition: Number (read-only)

vPosition

vPosition: Number (read, write)

vScrollPolicy

vScrollPolicy: String (read)

vScrollPolicy

vScrollPolicy: Object (write)

Constructor Documentation

ScrollView

function ScrollView()

Method Documentation

__onMouseWheel

function __onMouseWheel(delta: Number,
 scrollTarget: MovieClip): Void

childLoaded

function childLoaded(obj: MovieClip): Void
Overrides:
View.childLoaded in class View

Parameters:
obj
the loaded child

createChild

function createChild(id: String,
 name: String,
 props: Object): MovieClip
add a new child object

Overrides:
View.createChild in class View

Parameters:
id
className the name of the symbol, a reference to a class, or file path or URL to the external content
name
instanceName the instance name of the child
props
initProps object containing initialization properties
Returns:
reference to the child object

See also:
View

createChildren

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

Overrides:
View.createChildren in class View

doLayout

function doLayout(Void): Void
Overrides:
View.doLayout in class View

draw

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

Overrides:
View.draw in class View

getHPosition

function getHPosition(Void): Number

getHScrollPolicy

function getHScrollPolicy(Void)

getMaxHPosition

function getMaxHPosition(Void): Number

getViewMetrics

function getViewMetrics(Void): Object
get the thickness of the edges of the object taking into account the border and scrollbars if visible

Returns:
object with left, right, top and bottom edge thickness in pixels

getVPosition

function getVPosition(Void): Number

getVScrollPolicy

function getVScrollPolicy(Void)

init

function init(Void): Void
init variables and create internal objects

Overrides:
View.init in class View

invalidate

function invalidate(Void): Void
if we get invalidated just call super

Overrides:
UIObject.invalidate in class UIObject

onScroll

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

scrollProxy

function scrollProxy(docObj: Object): Void
handle scroll events from the scrollbar 'this' is actually the scrollbar so we just pass it to the parent

setEnabled

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

Overrides:
UIComponent.setEnabled in class UIComponent

setHPosition

function setHPosition(pos: Number): Void

setHScrollPolicy

function setHScrollPolicy(policy): Void

setMaxHPosition

function setMaxHPosition(pos: Number): Void

setScrollProperties

function setScrollProperties(colCount: Number,
 colWidth: Number,
 rwCount: Number,
 rwHeight: Number,
 hPadding: Number,
 wPadding: Number): Void
set the parameters for scrolling

Parameters:
colCount
number of units to scroll horizontally
colWidth
width in pixels of each of those units
rwCount
number of untis to scroll vertically
rwHeight
height in pixels of each of those units
hPadding
pixels on the left edge that are not scrolled (for row headers)
wPadding
wpadding pixels on the top edge that are not scrolled (for column headers)

setVPosition

function setVPosition(pos: Number): Void

setVScrollPolicy

function setVScrollPolicy(policy): Void

size

function size(Void): Void
respond to size changes

Overrides:
View.size in class View

The documentation was generated from the following file:

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