Main Page | Packages | Class Tree | Index | Help

mx.screens

class Screen

Object
  |
  +--MovieClip
        |
        +--mx.core.UIObject
              |
              +--mx.core.UIComponent
                    |
                    +--mx.core.View
                          |
                          +--mx.controls.Loader
                                |
                                +--mx.screens.Screen

All Known Subclasses: Form, Slide

class Screen
extends Loader

Screen class - extends Loader - Adds management of contained child Slides and Forms



Field Summary


borderStyle: String
all screens have no border so components can contain forms inside them


className: String
name of this class

static
symbolName: String
SymbolName for object

static
symbolOwner: Object
Class used in createClassObject

Fields inherited from class mx.controls.Loader

__autoLoad, __bytesLoaded, __bytesTotal, __contentPath, __scaleContent, className, clipParameters, contentHolder, livePreview, mergedClipParameters, symbolName, symbolOwner, version

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

public static
currentFocusedScreen: Screen (read-only)
Current leaf-most screen containing the global focus Read-Only: setFocus() to change focus

public
indexInParent: Number (read-only)
zero-based index of this screen in its parent (getChildScreen) Read-Only: use createChild() to add new child screens

public
numChildScreens: Number (read-only)
number of child screens of this screen Read-Only: use createChild() to add new child screens

public
parentIsScreen: Boolean (read-only)
True if this screen's _parent is a screen Read-Only: use createChild() to add new child screens

public
parentScreen: Screen (read-only)
Screen containing this screen.

public
rootScreen: Screen (read-only)
Root of the screen subtree that contains this screen Read-Only: use createChild() to add new child screens

public
transitionManager: Object (read-only)
Object that manages the current transitions for this single screen Read-Only: use transitionManager.start to add new transitions

Properties inherited from class mx.controls.Loader

autoLoad, bytesLoaded, bytesTotal, content, contentPath, percentLoaded, scaleContent

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


Screen ( )
Screen class constructor

Method Summary


allTransitionsInDone ( )
override to propagate events we receive from the transition manager to on(allTransitionsInDone) handlers defined on this screen.


allTransitionsOutDone ( )
override to propagate events we receive from the transition manager to on(allTransitionsOutDone) handlers defined on this screen.


childLoaded ( obj: MovieClip ): Void
handle fixups when we load a subtree in from an external movie using createChild()


createChild ( className: String, instanceName: String, initProps: Object ): MovieClip
Private methods Overridden to do screen-specific fixups between new screen tree and parent


createChildren ( ): Void
override to create a "fake" border movie clip -- screens do not support borders


destroyChildAt ( childIndex: Number ): Void
Override from View class.


doScaleLoader ( ): Void
Never scale the loader/parent screen


drawFocus ( )
Override from View class.


getChildScreen ( childIndex: Number ): Screen
Get the nth child of a screen (zero-based)

Methods inherited from class mx.controls.Loader

childLoaded, createChildren, dispatchEvent, doScaleContent, doScaleLoader, draw, getAutoLoad, getBytesLoaded, getBytesTotal, getContent, getContentPath, getPercentLoaded, getScaleContent, init, load, setAutoLoad, setContentPath, setScaleContent, setSize, size, unScaleContent

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

borderStyle

var borderStyle: String
all screens have no border so components can contain forms inside them

className

var className: String
name of this class

symbolName

static var symbolName: String
SymbolName for object

symbolOwner

static var symbolOwner: Object
Class used in createClassObject


Property Documentation

currentFocusedScreen

public static currentFocusedScreen: Screen (read-only)
Current leaf-most screen containing the global focus Read-Only: setFocus() to change focus

indexInParent

public indexInParent: Number (read-only)
zero-based index of this screen in its parent (getChildScreen) Read-Only: use createChild() to add new child screens

numChildScreens

public numChildScreens: Number (read-only)
number of child screens of this screen Read-Only: use createChild() to add new child screens

parentIsScreen

public parentIsScreen: Boolean (read-only)
True if this screen's _parent is a screen Read-Only: use createChild() to add new child screens

parentScreen

public parentScreen: Screen (read-only)
Screen containing this screen.

May be null for the root screen. Read-Only: use createChild() to add new child screens

rootScreen

public rootScreen: Screen (read-only)
Root of the screen subtree that contains this screen Read-Only: use createChild() to add new child screens

transitionManager

public transitionManager: Object (read-only)
Object that manages the current transitions for this single screen Read-Only: use transitionManager.start to add new transitions


Constructor Documentation

Screen

function Screen()
Screen class constructor


Method Documentation

allTransitionsInDone

function allTransitionsInDone()
override to propagate events we receive from the transition manager to on(allTransitionsInDone) handlers defined on this screen.

allTransitionsOutDone

function allTransitionsOutDone()
override to propagate events we receive from the transition manager to on(allTransitionsOutDone) handlers defined on this screen.

childLoaded

function childLoaded(obj: MovieClip): Void
handle fixups when we load a subtree in from an external movie using createChild()

Overrides:

Parameters:
obj
the loaded child

createChild

function createChild(className: String,
 instanceName: String,
 initProps: Object): MovieClip
Private methods Overridden to do screen-specific fixups between new screen tree and parent

Overrides:

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

createChildren

function createChildren(): Void
override to create a "fake" border movie clip -- screens do not support borders

Overrides:

destroyChildAt

function destroyChildAt(childIndex: Number): Void
Override from View class.

destroy n'th child screen

Overrides:

Parameters:
childIndex
a number from 0 to N-1

doScaleLoader

function doScaleLoader(): Void
Never scale the loader/parent screen

Overrides:

drawFocus

function drawFocus()
Override from View class.

Don't inherit default behavior because screens don't work with skins and it is not appropriate to draw a focus rect for screens

Overrides:

getChildScreen

function getChildScreen(childIndex: Number): Screen
Get the nth child of a screen (zero-based)

Parameters:
childIndex
which screen to get

The documentation was generated from the following file:


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