mx.core.UIObject

mx.core.UIObject Class Reference

Inheritance diagram for mx.core.UIObject:

Inheritance graph
[legend]
Collaboration diagram for mx.core.UIObject:

Collaboration graph
[legend]
List of all members.

Detailed Description

The base class for all components and graphical objects. UIObjects support events and styles and resize by scaling.

3285 Base class for all components and graphical objects. Extends MovieClip

Definition at line 48 of file UIObject.as.

Public Member Functions

function dispatchEvent (eventObj:Object)
function dispatchEventLater (eventObj:Object)
function addEventListener (event:String, handler)
function removeEventListener (event:String, handler)

Package Functions

function UIObject ()
function get width ()
function get height ()
function get left ()
function get x ()
function get top ()
function get y ()
function get right ()
function get bottom ()
function get minHeight ()
function set minHeight (h:Number)
function get minWidth ()
function set minWidth (w:Number)
function get visible ()
function set visible (x:Boolean)
function get scaleX ()
function set scaleX (x:Number)
function get scaleY ()
function set scaleY (y:Number)
function doLater (obj:Object, fn:String)
function doLaterDispatcher (Void)
function cancelAllDoLaters (Void)
function invalidate (Void)
function invalidateStyle (Void)
function redraw (bAlways:Boolean)
function move (x:Number, y:Number, noEvent:Boolean)
function setSize (w:Number, h:Number, noEvent:Boolean)
function drawRect (x1:Number, y1:Number, x2:Number, y2:Number)
function createObject (linkageName:String, id:String, depth:Number, initobj:Object)
function createClassObject (className:Function, id:String, depth:Number, initobj:Object)
function createEmptyObject (id:String, depth:Number)
function destroyObject (id:String)
function _createChildren (Void)
function constructObject (Void)
function initFromClipParameters (Void)
function getClassStyleDeclaration (Void)
function __getTextFormat (tf:TextFormat, bAll:Boolean)
function _getTextFormat (Void)
function getStyleName (Void)
function getStyle (styleProp:String)

Package Attributes

var tabEnabled:Boolean = false
var ignoreClassStyleDeclaration:Object
var childrenCreated:Boolean
var handleEvent:Function
var buildDepthTable:Function
var findNextAvailableDepth:Function
var createChildAtDepth:Function
var createClassChildAtDepth:Function
var createAccessibilityImplementation:Function
var color:Number
var fontSize:Number
var fontWeight:String
var fontFamily:String
var fontStyle:String
var textAlign:String
var textDecoration:String
var textIndent:Number
var marginLeft:Number
var marginRight:Number
var embedFonts:Boolean
var changeTextStyleInChildren:Function
var changeColorStyleInChildren:Function
var notifyStyleChangeInChildren:Function
var _topmost:Boolean
var className:String
var stylecache:Object
var methodTable:Array
var idNames:Array
var setStyle: Function
var __width:Number
var __height:Number

Static Package Attributes

static var version:String = "2.0.1.78"

Private Member Functions

function getMinHeight (Void)
function setMinHeight (h:Number)
function getMinWidth (Void)
function setMinWidth (w:Number)
function setVisible (x:Boolean, noEvent:Boolean)
function draw (Void)
function size (Void)
function createLabel (name:String, depth:Number, text)
function getSkinIDName (tag:Number)
function setSkin (tag:Number, linkageName:String, initObj:Object)
function createSkin (tag:Number)
function createChildren (Void)
function init (Void)
function setColor (color:Number)

Static Private Member Functions

static function mergeClipParameters (o, p)

Private Attributes

var invalidateFlag:Boolean = false
var lineWidth:Number = 1
var lineColor:Number = 0
var createEvent:Function
var _id:String
var validateNow:Boolean
var _color
var styleName:String
var clipParameters:Object = {visible: 1
var minHeight: 1
var minWidth: 1
var maxHeight: 1
var maxWidth: 1
var preferredHeight: 1
var preferredWidth: 1}
var initProperties:Function
var _minHeight:Number
var _minWidth:Number
var _maxHeight:Number
var _maxWidth:Number
var _preferredHeight:Number
var _preferredWidth:Number
var _tf:TextFormat
var tfList:Object
var __onUnload:Function
var _endInit:Function

Static Private Attributes

static var symbolName:String = "UIObject"
static var symbolOwner:Object = UIObject
static var textColorList = { color: 1, disabledColor: 1 }

Constructor & Destructor Documentation

function mx.core.UIObject.UIObject (  )  [package]

Definition at line 237 of file UIObject.as.

Member Function Documentation

function mx.core.UIObject.dispatchEvent ( eventObj:Object   ) 

See also:
mx.events.EventDispatcher

Definition at line 97 of file UIObject.as.

function mx.core.UIObject.dispatchEventLater ( eventObj:Object   ) 

Definition at line 99 of file UIObject.as.

function mx.core.UIObject.addEventListener ( event:String  ,
handler   
)

See also:
mx.events.EventDispatcher Adds a listener for an event 3958

Definition at line 106 of file UIObject.as.

function mx.core.UIObject.removeEventListener ( event:String  ,
handler   
)

See also:
mx.events.EventDispatcher

Definition at line 116 of file UIObject.as.

function get mx.core.UIObject.width (  )  [package]

width of object Read-Only: use setSize() to change. 3982

Definition at line 247 of file UIObject.as.

function get mx.core.UIObject.height (  )  [package]

height of object Read-Only: use setSize() to change. 3964

Definition at line 257 of file UIObject.as.

function get mx.core.UIObject.left (  )  [package]

left of object Read-Only: use move() to change. 3967

Definition at line 267 of file UIObject.as.

function get mx.core.UIObject.x (  )  [package]

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

Definition at line 276 of file UIObject.as.

function get mx.core.UIObject.top (  )  [package]

top of object Read-Only: use move() to change. 3979

Definition at line 286 of file UIObject.as.

function get mx.core.UIObject.y (  )  [package]

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

Definition at line 295 of file UIObject.as.

function get mx.core.UIObject.right (  )  [package]

right of object relative to its parent's right edge. Read-Only: use setSize() to change. 3973

Definition at line 305 of file UIObject.as.

function get mx.core.UIObject.bottom (  )  [package]

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

Definition at line 315 of file UIObject.as.

function mx.core.UIObject.getMinHeight ( Void   )  [private]

override this instead of adding your own getter-setter for minHeight

Definition at line 324 of file UIObject.as.

function mx.core.UIObject.setMinHeight ( h:Number   )  [private]

override this instead of adding your own getter-setter for minHeight

Definition at line 333 of file UIObject.as.

function get mx.core.UIObject.minHeight (  )  [package]

minimum height of object

Definition at line 342 of file UIObject.as.

function set mx.core.UIObject.minHeight ( h:Number   )  [package]

Definition at line 347 of file UIObject.as.

function mx.core.UIObject.getMinWidth ( Void   )  [private]

override this instead of adding your own getter-setter for minWidth

Definition at line 356 of file UIObject.as.

function mx.core.UIObject.setMinWidth ( w:Number   )  [private]

override this instead of adding your own getter-setter for minWidth

Definition at line 365 of file UIObject.as.

function get mx.core.UIObject.minWidth (  )  [package]

minimum width of object

Definition at line 374 of file UIObject.as.

function set mx.core.UIObject.minWidth ( w:Number   )  [package]

Definition at line 379 of file UIObject.as.

function mx.core.UIObject.setVisible ( x:Boolean  ,
noEvent:Boolean   
) [private]

override this instead of adding your own getter-setter for visible

Definition at line 388 of file UIObject.as.

function get mx.core.UIObject.visible (  )  [package]

True if object is visible 3981

Definition at line 405 of file UIObject.as.

function set mx.core.UIObject.visible ( x:Boolean   )  [package]

Definition at line 409 of file UIObject.as.

function get mx.core.UIObject.scaleX (  )  [package]

100 is standard scale Specifies the horizontal scale factor 3974

Definition at line 419 of file UIObject.as.

function set mx.core.UIObject.scaleX ( x:Number   )  [package]

Definition at line 423 of file UIObject.as.

function get mx.core.UIObject.scaleY (  )  [package]

100 is standard scale Specifies the vertical scale factor 3975

Definition at line 434 of file UIObject.as.

function set mx.core.UIObject.scaleY ( y:Number   )  [package]

Definition at line 438 of file UIObject.as.

function mx.core.UIObject.doLater ( obj:Object  ,
fn:String   
) [package]

Queues a function to be called later

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

Definition at line 450 of file UIObject.as.

function mx.core.UIObject.doLaterDispatcher ( Void   )  [package]

Definition at line 461 of file UIObject.as.

function mx.core.UIObject.cancelAllDoLaters ( Void   )  [package]

cancel all queued functions

Definition at line 491 of file UIObject.as.

function mx.core.UIObject.invalidate ( Void   )  [package]

mark component so it will get drawn later Marks an object to be redrawn on the next frame interval 3966

Definition at line 502 of file UIObject.as.

function mx.core.UIObject.invalidateStyle ( Void   )  [package]

called if just styles are changing so subclasses don't have to redraw everything

Definition at line 511 of file UIObject.as.

function mx.core.UIObject.redraw ( bAlways:Boolean   )  [package]

redraws object if you couldn't wait for invalidation to do it

Parameters:
bAlways if False, doesn't redraw if not invalidated Redraws an object immediately 3971

Definition at line 523 of file UIObject.as.

function mx.core.UIObject.draw ( Void   )  [private]

draw the object. Called by redraw() which is called explicitly or by the system if the object is invalidated. Each component should implement this method and make subobjects visible and lay them out. Most components do the layout by calling their size() method.

Definition at line 547 of file UIObject.as.

function mx.core.UIObject.move ( x:Number  ,
y:Number  ,
noEvent:Boolean   
) [package]

move the object

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

Definition at line 561 of file UIObject.as.

function mx.core.UIObject.setSize ( w:Number  ,
h:Number  ,
noEvent:Boolean   
) [package]

size the object

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

Definition at line 586 of file UIObject.as.

function mx.core.UIObject.size ( Void   )  [private]

size the object. called by setSize(). Components should implement this method to layout their contents. The width and height properties are set to the new desired size by the time size() is called.

Definition at line 610 of file UIObject.as.

function mx.core.UIObject.drawRect ( x1:Number  ,
y1:Number  ,
x2:Number  ,
y2:Number   
) [package]

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
r (r) is corner radius of rectangle or object containing radii for each corner

Definition at line 625 of file UIObject.as.

function mx.core.UIObject.createLabel ( name:String  ,
depth:Number  ,
text   
) [private]

create a text label subobject. Used by most components to get a lightweight text object to display text in the component.

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

Definition at line 644 of file UIObject.as.

function mx.core.UIObject.createObject ( linkageName:String  ,
id:String  ,
depth:Number  ,
initobj:Object   
) [package]

create a subobject from its symbol name

Parameters:
symbol symbol name of object
id instance name of object
depth z order of object
initObj object containing initialization properties
Returns:
reference to object
Creates a sub-object using its symbol name 3960

Definition at line 678 of file UIObject.as.

function mx.core.UIObject.createClassObject ( className:Function  ,
id:String  ,
depth:Number  ,
initobj:Object   
) [package]

create a subobject from its class definition

Parameters:
class reference to class of object
id instance name of object
depth z order of object
initObj object containing initialization properties
Returns:
reference to object
Creates a sub-object using its class name 3961

Definition at line 696 of file UIObject.as.

function mx.core.UIObject.createEmptyObject ( id:String  ,
depth:Number   
) [package]

create a blank or empty subobject

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

Definition at line 721 of file UIObject.as.

function mx.core.UIObject.destroyObject ( id:String   )  [package]

destroy the subobject

Parameters:
id instance name of object
Destroys the specified object 3962

Definition at line 734 of file UIObject.as.

function mx.core.UIObject.getSkinIDName ( tag:Number   )  [private]

lookup the instance name from the skin ID number. Uses the idNames array to map to an instance name

Parameters:
tag id number in idNames

Definition at line 755 of file UIObject.as.

function mx.core.UIObject.setSkin ( tag:Number  ,
linkageName:String  ,
initObj:Object   
) [private]

create a skin element. Recommended way of adding graphical objects to a component.

Parameters:
tag id number of skin
name symbol name of object
initObj object containing initialization properties
Returns:
reference to object 3977

Definition at line 771 of file UIObject.as.

function mx.core.UIObject.createSkin ( tag:Number   )  [private]

create a blank or empty skin element. Rarely used. Recommended way is to load a skin containing graphics or drawing code

Parameters:
tag id number of skin
Returns:
reference to object

Definition at line 788 of file UIObject.as.

function mx.core.UIObject.createChildren ( Void   )  [private]

create children objects. Components implement this method to create the subobjects in the component. Recommended way is to make text objects invisible and make them visible when the draw() method is called to avoid flicker on the screen.

Definition at line 803 of file UIObject.as.

function mx.core.UIObject._createChildren ( Void   )  [package]

Definition at line 808 of file UIObject.as.

function mx.core.UIObject.constructObject ( Void   )  [package]

Definition at line 815 of file UIObject.as.

function mx.core.UIObject.initFromClipParameters ( Void   )  [package]

Definition at line 845 of file UIObject.as.

function mx.core.UIObject.init ( Void   )  [private]

init variables. Components should implement this method and call super.init() to ensure this method gets called. The width, height and clip parameters will not be properly set until after this is called.

Definition at line 877 of file UIObject.as.

function mx.core.UIObject.getClassStyleDeclaration ( Void   )  [package]

Definition at line 900 of file UIObject.as.

function mx.core.UIObject.setColor ( color:Number   )  [private]

set color on object. This method gets called if the value of a color style gets changed and that color style is listed as the _color property of the component.

Definition at line 925 of file UIObject.as.

function mx.core.UIObject.__getTextFormat ( tf:TextFormat  ,
bAll:Boolean   
) [package]

Definition at line 932 of file UIObject.as.

function mx.core.UIObject._getTextFormat ( Void   )  [package]

Definition at line 1067 of file UIObject.as.

function mx.core.UIObject.getStyleName ( Void   )  [package]

Definition at line 1087 of file UIObject.as.

function mx.core.UIObject.getStyle ( styleProp:String   )  [package]

get a style property

Parameters:
String prop name of style property
Returns:
Variant the style value
Gets the style value associated with the style property 3965

Definition at line 1116 of file UIObject.as.

static function mx.core.UIObject.mergeClipParameters ( o  ,
p   
) [static, private]

Used by component developers to create the list of clip parameters.

Definition at line 1189 of file UIObject.as.

Member Data Documentation

var mx.core.UIObject.symbolName [static, private]

SymbolName for object

Definition at line 54 of file UIObject.as.

var mx.core.UIObject.symbolOwner [static, private]

Class used in createClassObject

Definition at line 59 of file UIObject.as.

var mx.core.UIObject.version [static, package]

Definition at line 62 of file UIObject.as.

var mx.core.UIObject.textColorList = { color: 1, disabledColor: 1 } [static, private]

standard color list for text objects

Definition at line 68 of file UIObject.as.

var mx.core.UIObject.invalidateFlag [private]

Definition at line 71 of file UIObject.as.

var mx.core.UIObject.lineWidth [private]

Definition at line 73 of file UIObject.as.

var mx.core.UIObject.lineColor [private]

Definition at line 74 of file UIObject.as.

var mx.core.UIObject.tabEnabled [package]

Definition at line 77 of file UIObject.as.

var mx.core.UIObject.ignoreClassStyleDeclaration [package]

Definition at line 81 of file UIObject.as.

var mx.core.UIObject.childrenCreated [package]

Definition at line 86 of file UIObject.as.

var mx.core.UIObject.createEvent [private]

See also:
mx.events.EventDispatcher

Definition at line 92 of file UIObject.as.

var mx.core.UIObject.handleEvent [package]

See also:
mx.events.EventDispatcher Handles all events 3032

Definition at line 112 of file UIObject.as.

var mx.core.UIObject.buildDepthTable [package]

Definition at line 119 of file UIObject.as.

var mx.core.UIObject.findNextAvailableDepth [package]

Definition at line 120 of file UIObject.as.

var mx.core.UIObject.createChildAtDepth [package]

Definition at line 121 of file UIObject.as.

var mx.core.UIObject.createClassChildAtDepth [package]

Definition at line 122 of file UIObject.as.

var mx.core.UIObject.createAccessibilityImplementation [package]

See also:
mx.accessibility.accImpl

Definition at line 127 of file UIObject.as.

var mx.core.UIObject._id [private]

Definition at line 130 of file UIObject.as.

var mx.core.UIObject.validateNow [private]

Initialization property that forces immediate drawing after creation

Definition at line 136 of file UIObject.as.

var mx.core.UIObject.color [package]

Definition at line 139 of file UIObject.as.

var mx.core.UIObject.fontSize [package]

Definition at line 142 of file UIObject.as.

var mx.core.UIObject.fontWeight [package]

Definition at line 143 of file UIObject.as.

var mx.core.UIObject.fontFamily [package]

Definition at line 144 of file UIObject.as.

var mx.core.UIObject.fontStyle [package]

Definition at line 145 of file UIObject.as.

var mx.core.UIObject.textAlign [package]

Definition at line 146 of file UIObject.as.

var mx.core.UIObject.textDecoration [package]

Definition at line 147 of file UIObject.as.

var mx.core.UIObject.textIndent [package]

Definition at line 148 of file UIObject.as.

var mx.core.UIObject.marginLeft [package]

Definition at line 149 of file UIObject.as.

var mx.core.UIObject.marginRight [package]

Definition at line 150 of file UIObject.as.

var mx.core.UIObject.embedFonts [package]

Definition at line 151 of file UIObject.as.

var mx.core.UIObject.changeTextStyleInChildren [package]

Definition at line 152 of file UIObject.as.

var mx.core.UIObject.changeColorStyleInChildren [package]

Definition at line 153 of file UIObject.as.

var mx.core.UIObject.notifyStyleChangeInChildren [package]

Definition at line 154 of file UIObject.as.

var mx.core.UIObject._topmost [package]

Definition at line 157 of file UIObject.as.

var mx.core.UIObject._color [private]

The color style used by this component. If more than one color style, use an object containing the colors as properties on the object

Definition at line 166 of file UIObject.as.

var mx.core.UIObject.styleName [private]

CSSStyleDeclaration or pointer to parent to be used by component in calculating style values.

Definition at line 173 of file UIObject.as.

var mx.core.UIObject.className [package]

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

Definition at line 180 of file UIObject.as.

var mx.core.UIObject.stylecache [package]

Definition at line 183 of file UIObject.as.

var mx.core.UIObject.methodTable [package]

Definition at line 185 of file UIObject.as.

var mx.core.UIObject.idNames [package]

Definition at line 187 of file UIObject.as.

var mx.core.UIObject.setStyle [package]

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

Parameters:
String prop name of style property
Variant value new value for style
Sets a style value for the specified style property 3978

Definition at line 199 of file UIObject.as.

var mx.core.UIObject.clipParameters [private]

list of clip parameters to check at init only getter/setter properties go in this list

Definition at line 208 of file UIObject.as.

var mx.core.UIObject.minHeight [private]

Definition at line 208 of file UIObject.as.

var mx.core.UIObject.minWidth [private]

Definition at line 208 of file UIObject.as.

var mx.core.UIObject.maxHeight [private]

Definition at line 208 of file UIObject.as.

var mx.core.UIObject.maxWidth [private]

Definition at line 208 of file UIObject.as.

var mx.core.UIObject.preferredHeight [private]

Definition at line 208 of file UIObject.as.

var mx.core.UIObject.preferredWidth [private]

Definition at line 208 of file UIObject.as.

var mx.core.UIObject.initProperties [private]

method used to init objects w/ getter-setters

Definition at line 214 of file UIObject.as.

var mx.core.UIObject.__width [package]

Definition at line 217 of file UIObject.as.

var mx.core.UIObject.__height [package]

Definition at line 218 of file UIObject.as.

var mx.core.UIObject._minHeight [private]

Definition at line 219 of file UIObject.as.

var mx.core.UIObject._minWidth [private]

Definition at line 220 of file UIObject.as.

var mx.core.UIObject._maxHeight [private]

Definition at line 221 of file UIObject.as.

var mx.core.UIObject._maxWidth [private]

Definition at line 222 of file UIObject.as.

var mx.core.UIObject._preferredHeight [private]

Definition at line 223 of file UIObject.as.

var mx.core.UIObject._preferredWidth [private]

Definition at line 224 of file UIObject.as.

var mx.core.UIObject._tf [private]

Definition at line 227 of file UIObject.as.

var mx.core.UIObject.tfList [private]

Definition at line 229 of file UIObject.as.

var mx.core.UIObject.__onUnload [private]

Definition at line 232 of file UIObject.as.

var mx.core.UIObject._endInit [private]

Definition at line 235 of file UIObject.as.

Generated on Fri May 11 17:14:55 2007 for GuggaFramework by  doxygen 1.5.2