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

class ScrollPane

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

class ScrollPane
extends ScrollView

Simple pixel scrolling of 1.

content loaded from library 2. contents loaded from Internet


Field Summary


__hLineScrollSize: Number



__hPageScrollSize: Number



__hScrollPolicy: String



__scrollContent: String



__scrollDrag: Boolean



__vLineScrollSize: Number



__vPageScrollSize: Number



_loaded: Number



_total: Number



className: String
name of this class


clipParameters: Object



hPosition: Number



initializing: Boolean



keyDown: Function



lastX: Number



lastY: Number


static
mergedClipParameters: Boolean



spContentHolder: MovieClip


static
symbolName: String


static
symbolOwner: Object


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


vPosition: Number


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


content: MovieClip (read-only)
The URL or linkage name of the SWF or JPEG has been loaded into the ScrollPane.


contentPath: String (read, write)
The URL or linkage name of the SWF or JPEG that is to be loaded, or has been loaded, into the ScrollPane.


hLineScrollSize: Number (read, write)
number of pixels to move when UP/DOWN arrow button (in horizontal scrollbar) is pressed


hPageScrollSize: Number (read, write)
number of pixels to move when the track in horizontal scrollbar is pressed


hScrollPolicy: Object (write-only)
Sets the horizontal scroll of a Scroll Pane to on/off or to real-time generation according to the size of the image.(Default value "auto")


scrollDrag: Boolean (read, write)
Sets/returns the drag property of a scroll pane.


vLineScrollSize: Number (read, write)
number of pixels to move when UP/DOWN arrow button (in vertical scrollbar) is pressed


vPageScrollSize: Number (read, write)
number of pixels to move when the track in vertical scrollbar is pressed


vScrollPolicy: Object (write-only)
Sets the vertical scroll of a Scroll Pane to on/off or to real-time generation according to the size of the image.(Default value "auto")

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


ScrollPane ( )


Method Summary


_onKeyDown ( e: Object ): Void
-- On Key Down ---------------------------------------


childLoaded ( obj: MovieClip ): Void



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


dispatchEvent ( o: Object ): Void



getBytesLoaded ( ): Number
Returns the number of bytes loaded in the ScrollPane.


getBytesTotal ( ): Number
Returns the total number of bytes of the content to be loaded in the ScrollPane.


init ( Void ): Void
::: PUBLIC METHODS


onComplete ( Void ): Void
This method handles the complete event for both types of content


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


refreshPane ( Void ): Void



setHPosition ( position: Number )



setScrollProperties ( columnCount: Number, columnWidth: Number, rowCount: Number, rowHeight: Number ): Void
set the parameters for scrolling


setVPosition ( position: Number )



size ( Void ): Void
respond to size changes


startDragLoop ( Void ): Void


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

__hLineScrollSize

var __hLineScrollSize: Number

__hPageScrollSize

var __hPageScrollSize: Number

__hScrollPolicy

var __hScrollPolicy: String

__scrollContent

var __scrollContent: String

__scrollDrag

var __scrollDrag: Boolean

__vLineScrollSize

var __vLineScrollSize: Number

__vPageScrollSize

var __vPageScrollSize: Number

_loaded

var _loaded: Number

_total

var _total: Number

className

var className: String
name of this class

clipParameters

var clipParameters: Object

hPosition

var hPosition: Number

initializing

var initializing: Boolean

keyDown

var keyDown: Function

lastX

var lastX: Number

lastY

var lastY: Number

mergedClipParameters

static var mergedClipParameters: Boolean

spContentHolder

var spContentHolder: MovieClip

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.

vPosition

var vPosition: Number

Property Documentation

content

content: MovieClip (read-only)
The URL or linkage name of the SWF or JPEG has been loaded into the ScrollPane.

contentPath

contentPath: String (read, write)
The URL or linkage name of the SWF or JPEG that is to be loaded, or has been loaded, into the ScrollPane.

hLineScrollSize

hLineScrollSize: Number (read, write)
number of pixels to move when UP/DOWN arrow button (in horizontal scrollbar) is pressed

hPageScrollSize

hPageScrollSize: Number (read, write)
number of pixels to move when the track in horizontal scrollbar is pressed

hScrollPolicy

hScrollPolicy: Object (write-only)
Sets the horizontal scroll of a Scroll Pane to on/off or to real-time generation according to the size of the image.(Default value "auto")

scrollDrag

scrollDrag: Boolean (read, write)
Sets/returns the drag property of a scroll pane.

This enables realtime mouse scrolling within the Scroll Pane.

vLineScrollSize

vLineScrollSize: Number (read, write)
number of pixels to move when UP/DOWN arrow button (in vertical scrollbar) is pressed

vPageScrollSize

vPageScrollSize: Number (read, write)
number of pixels to move when the track in vertical scrollbar is pressed

vScrollPolicy

vScrollPolicy: Object (write-only)
Sets the vertical scroll of a Scroll Pane to on/off or to real-time generation according to the size of the image.(Default value "auto")

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

Constructor Documentation

ScrollPane

function ScrollPane()

Method Documentation

_onKeyDown

function _onKeyDown(e: Object): Void
-- On Key Down ---------------------------------------

childLoaded

function childLoaded(obj: MovieClip): Void
Overrides:
mx.core.ScrollView.childLoaded in class mx.core.ScrollView

Parameters:
obj
the loaded child

createChildren

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

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

dispatchEvent

function dispatchEvent(o: Object): Void
Overrides:
mx.core.UIObject.dispatchEvent in class mx.core.UIObject

getBytesLoaded

function getBytesLoaded(): Number
Returns the number of bytes loaded in the ScrollPane.

Can be called at regular intervals while loading the content to check the progress.

Overrides:
MovieClip.getBytesLoaded in class MovieClip

Returns:
: Number

getBytesTotal

function getBytesTotal(): Number
Returns the total number of bytes of the content to be loaded in the ScrollPane.

Overrides:
MovieClip.getBytesTotal in class MovieClip

Returns:
: Number

init

function init(Void): Void
::: PUBLIC METHODS

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

onComplete

function onComplete(Void): Void
This method handles the complete event for both types of content

onScroll

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

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

refreshPane

function refreshPane(Void): Void

setHPosition

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

Parameters:
position
Number Position of the horizontal scrollbar

setScrollProperties

function setScrollProperties(columnCount: Number,
 columnWidth: Number,
 rowCount: Number,
 rowHeight: Number): Void
set the parameters for scrolling

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

Parameters:
columnCount
colCount number of units to scroll horizontally
columnWidth
colWidth width in pixels of each of those units
rowCount
rwCount number of untis to scroll vertically
rowHeight
rwHeight height in pixels of each of those units

setVPosition

function setVPosition(position: Number)
Overrides:
mx.core.ScrollView.setVPosition in class mx.core.ScrollView

Parameters:
position
Number Position of the vertical scrollbar

size

function size(Void): Void
respond to size changes

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

startDragLoop

function startDragLoop(Void): Void

The documentation was generated from the following file:

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