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

class UIObject

Object
  |
  +--MovieClip
        |
        +--mx.core.UIObject

All Known Subclasses: Border, Label, ProgressBar, UIComponent
class UIObject
extends MovieClip

The base class for all components and graphical objects.

UIObjects support events and styles and resize by scaling.


Field Summary


__height: Number



__width: Number
these hold the actual values for the getter-setters


_color



_topmost: Boolean
mixed from DepthManager;


addEventListener: Function



buildDepthTable: Function
see mx.managers.DepthManager


changeColorStyleInChildren: Function



changeTextStyleInChildren: Function



childrenCreated: Boolean
sometimes properties get set before the children components have been created.


className: String
Name of component class.


clipParameters: Object



color: Number
foreground text color


createAccessibilityImplementation: Function



createChildAtDepth: Function



createEvent: Function



ction



dispatchEvent: Function



embedFonts: Boolean



findNextAvailableDepth: Function



fontFamily: String



fontSize: Number
mixed from styles


fontStyle: String



fontWeight: String



handleEvent: Function



idNames: Array
array of skin instance names used by setSkin


ignoreClassStyleDeclaration: Object
UIObjects are not supposed to receive focus sometimes we inherit from something, but don't want to inherit its class styles.


initProperties: Function



marginLeft: Number



marginRight: Number



methodTable: Array
list of functions used by doLater()


notifyStyleChangeInChildren: Function



removeEventListener: Function



setStyle: Function
set a style property.


stylecache: Object
cache of cascading styles


styleName: String


static
symbolName: String


static
symbolOwner: Object



textAlign: String


static
textColorList



textDecoration: String



textIndent: Number



validateNow: Boolean


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

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


bottom: Number (read-only)
bottom of object relative to its parent's bottom Read-Only: use setSize() to change.


height: Number (read-only)
height of object Read-Only: use setSize() to change.


left: Number (read-only)
left of object Read-Only: use move() to change.


minHeight: Number (read, write)
minimum height of object


minWidth: Number (read, write)
minimum width of object


right: Number (read-only)
right of object relative to its parent's right edge.


scaleX: Number (read, write)
100 is standard scale


scaleY: Number (read, write)
100 is standard scale


top: Number (read-only)
top of object Read-Only: use move() to change.


visible: Boolean (read, write)
True if object is visible


width: Number (read-only)
width of object Read-Only: use setSize() to change.


x: Number (read-only)
x = left of object Read-Only: use move() to change.


y: Number (read-only)
y = top of object Read-Only: use move() to change.

Constructor


UIObject ( )


Method Summary


__getTextFormat ( tf: TextFormat, bAll: Boolean ): Boolean
called recursively to fill out a textFormat object by calling each of its parents


_createChildren ( Void ): Void
call create children and set flag.


_getTextFormat ( Void ): TextFormat
text objects call this to find out their styles


cancelAllDoLaters ( Void ): Void
cancel all queued functions


constructObject ( Void ): Void
sets up the order of construction of a component


createChildren ( Void ): Void



createClassObject ( className: Function, id: String, depth: Number, initobj: Object ): UIObject
create a subobject from its class definition


createEmptyObject ( id: String, depth: Number ): UIObject
create a blank or empty subobject


createLabel ( name: String, depth: Number, text ): TextField



createObject ( linkageName: String, id: String, depth: Number, initobj: Object ): MovieClip
create a subobject from its symbol name


createSkin ( tag: Number ): UIObject



destroyObject ( id: String ): Void
destroy the subobject


doLater ( obj: Object, fn: String ): Void
Queues a function to be called later


doLaterDispatcher ( Void ): Void
callback that then calls queued functions


draw ( Void ): Void



drawRect ( x1: Number, y1: Number, x2: Number, y2: Number ): Void
draw unfilled rectangle on the screen


getClassStyleDeclaration ( Void ): CSSStyleDeclaration
find the class style sheet for this instance.


getMinHeight ( Void ): Number



getMinWidth ( Void ): Number



getSkinIDName ( tag: Number ): String



getStyle ( styleProp: String )
get a style property


getStyleName ( Void ): String
Used to see if a styleDeclaration change might apply to this instance.


init ( Void ): Void



initFromClipParameters ( Void ): Void
process all the clipParameters in the list so the setters get fired.


invalidate ( Void ): Void
mark component so it will get drawn later


invalidateStyle ( Void ): Void
called if just styles are changing so subclasses don't have to redraw everything

static
mergeClipParameters ( o, p ): Boolean



move ( x: Number, y: Number, noEvent: Boolean ): Void
move the object


redraw ( bAlways: Boolean ): Void
redraws object if you couldn't wait for invalidation to do it


setColor ( color: Number ): Void



setMinHeight ( h: Number ): Void



setMinWidth ( w: Number ): Void



setSize ( w: Number, h: Number, noEvent: Boolean ): Void
size the object


setSkin ( tag: Number, linkageName: String, initObj: Object ): MovieClip



setVisible ( x: Boolean, noEvent: Boolean ): Void



size ( Void ): Void


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

__height

var __height: Number

__width

var __width: Number
these hold the actual values for the getter-setters

_color

var _color

_topmost

var _topmost: Boolean
mixed from DepthManager;

addEventListener

var addEventListener: Function

buildDepthTable

var buildDepthTable: Function
see mx.managers.DepthManager

changeColorStyleInChildren

var changeColorStyleInChildren: Function

changeTextStyleInChildren

var changeTextStyleInChildren: Function

childrenCreated

var childrenCreated: Boolean
sometimes properties get set before the children components have been created.

This flag can be used to guard against early property setting.

className

var className: String
Name of component class.

This is also used in calculating style values. If _global.styles[className] exists, it set defaults for a component.

clipParameters

var clipParameters: Object

color

var color: Number
foreground text color

createAccessibilityImplementation

var createAccessibilityImplementation: Function

createChildAtDepth

var createChildAtDepth: Function

createEvent

var createEvent: Function

ction

var ction

dispatchEvent

var dispatchEvent: Function

embedFonts

var embedFonts: Boolean

findNextAvailableDepth

var findNextAvailableDepth: Function

fontFamily

var fontFamily: String

fontSize

var fontSize: Number
mixed from styles

fontStyle

var fontStyle: String

fontWeight

var fontWeight: String

handleEvent

var handleEvent: Function

idNames

var idNames: Array
array of skin instance names used by setSkin

ignoreClassStyleDeclaration

var ignoreClassStyleDeclaration: Object
UIObjects are not supposed to receive focus sometimes we inherit from something, but don't want to inherit its class styles.

initProperties

var initProperties: Function

marginLeft

var marginLeft: Number

marginRight

var marginRight: Number

methodTable

var methodTable: Array
list of functions used by doLater()

notifyStyleChangeInChildren

var notifyStyleChangeInChildren: Function

removeEventListener

var removeEventListener: Function

setStyle

var setStyle: Function
set a style property.

Causes lots of processing so use sparingly. actual implementation is in mx.styles.CSSSetStyle.as

stylecache

var stylecache: Object
cache of cascading styles

styleName

var styleName: String

symbolName

static var symbolName: String

symbolOwner

static var symbolOwner: Object

textAlign

var textAlign: String

textColorList

static var textColorList

textDecoration

var textDecoration: String

textIndent

var textIndent: Number

validateNow

var validateNow: Boolean

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.

Property Documentation

bottom

bottom: Number (read-only)
bottom of object relative to its parent's bottom Read-Only: use setSize() to change.

height

height: Number (read-only)
height of object Read-Only: use setSize() to change.

left

left: Number (read-only)
left of object Read-Only: use move() to change.

minHeight

minHeight: Number (read, write)
minimum height of object

minWidth

minWidth: Number (read, write)
minimum width of object

right

right: Number (read-only)
right of object relative to its parent's right edge.

Read-Only: use setSize() to change.

scaleX

scaleX: Number (read, write)
100 is standard scale

scaleY

scaleY: Number (read, write)
100 is standard scale

top

top: Number (read-only)
top of object Read-Only: use move() to change.

visible

visible: Boolean (read, write)
True if object is visible

width

width: Number (read-only)
width of object Read-Only: use setSize() to change.

x

x: Number (read-only)
x = left of object Read-Only: use move() to change.

y

y: Number (read-only)
y = top of object Read-Only: use move() to change.

Constructor Documentation

UIObject

function UIObject()

Method Documentation

__getTextFormat

function __getTextFormat(tf: TextFormat,
 bAll: Boolean): Boolean
called recursively to fill out a textFormat object by calling each of its parents

_createChildren

function _createChildren(Void): Void
call create children and set flag.

_getTextFormat

function _getTextFormat(Void): TextFormat
text objects call this to find out their styles

cancelAllDoLaters

function cancelAllDoLaters(Void): Void
cancel all queued functions

constructObject

function constructObject(Void): Void
sets up the order of construction of a component

createChildren

function createChildren(Void): Void

createClassObject

function createClassObject(className: Function,
 id: String,
 depth: Number,
 initobj: Object): UIObject
create a subobject from its class definition

Parameters:
className
class reference to class of object
id
instance name of object
depth
z order of object
initobj
initObj object containing initialization properties
Returns:
reference to object

createEmptyObject

function createEmptyObject(id: String,
 depth: Number): UIObject
create a blank or empty subobject

Parameters:
id
instance name of object
depth
z order of object
Returns:
reference to object

createLabel

function createLabel(name: String,
 depth: Number,
 text): TextField
Parameters:
name
instance name of text object
depth
z order of object
text
text of object
Returns:
reference to text object

createObject

function createObject(linkageName: String,
 id: String,
 depth: Number,
 initobj: Object): MovieClip
create a subobject from its symbol name

Parameters:
linkageName
symbol symbol name of object
id
instance name of object
depth
z order of object
initobj
initObj object containing initialization properties
Returns:
reference to object

createSkin

function createSkin(tag: Number): UIObject
Parameters:
tag
id number of skin
Returns:
reference to object

destroyObject

function destroyObject(id: String): Void
destroy the subobject

Parameters:
id
instance name of object

doLater

function doLater(obj: Object,
 fn: String): Void
Queues a function to be called later

Parameters:
obj
Object that contains the function
fn
Name of function on Object

doLaterDispatcher

function doLaterDispatcher(Void): Void
callback that then calls queued functions

draw

function draw(Void): Void

drawRect

function drawRect(x1: Number,
 y1: Number,
 x2: Number,
 y2: Number): Void
draw unfilled rectangle on the screen

Parameters:
x1
(x1, y1) is one corner of rectangle
y1
(x1, y1) is one corner of rectangle
x2
(x2, y2) is other corner of rectangle
y2
(x2, y2) is other corner of rectangle

getClassStyleDeclaration

function getClassStyleDeclaration(Void): CSSStyleDeclaration
find the class style sheet for this instance.

Equivalent to type selectors in CSS, except that it also uses inheritance as valid types

getMinHeight

function getMinHeight(Void): Number

getMinWidth

function getMinWidth(Void): Number

getSkinIDName

function getSkinIDName(tag: Number): String
Parameters:
tag
id number in idNames

getStyle

function getStyle(styleProp: String)
get a style property

Parameters:
styleProp
String prop name of style property
Returns:
Variant the style value

getStyleName

function getStyleName(Void): String
Used to see if a styleDeclaration change might apply to this instance.

init

function init(Void): Void

initFromClipParameters

function initFromClipParameters(Void): Void
process all the clipParameters in the list so the setters get fired.

invalidate

function invalidate(Void): Void
mark component so it will get drawn later

invalidateStyle

function invalidateStyle(Void): Void
called if just styles are changing so subclasses don't have to redraw everything

mergeClipParameters

static function mergeClipParameters(o,
 p): Boolean

move

function move(x: Number,
 y: Number,
 noEvent: Boolean): Void
move the object

Parameters:
x
left position of the object
y
top position of the object
noEvent
if true, doesn't broadcast "move" event

redraw

function redraw(bAlways: Boolean): Void
redraws object if you couldn't wait for invalidation to do it

Parameters:
bAlways
if False, doesn't redraw if not invalidated

setColor

function setColor(color: Number): Void

setMinHeight

function setMinHeight(h: Number): Void

setMinWidth

function setMinWidth(w: Number): Void

setSize

function setSize(w: Number,
 h: Number,
 noEvent: Boolean): Void
size the object

Parameters:
w
width of the object
h
height of the object
noEvent
if true, doesn't broadcast "resize" event

setSkin

function setSkin(tag: Number,
 linkageName: String,
 initObj: Object): MovieClip
Parameters:
tag
id number of skin
linkageName
name symbol name of object
initObj
object containing initialization properties
Returns:
reference to object

setVisible

function setVisible(x: Boolean,
 noEvent: Boolean): Void

size

function size(Void): Void

The documentation was generated from the following file:

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