Packagemx.core
Interfacepublic interface IFlexDisplayObject extends flash.display.IBitmapDrawable, flash.events.IEventDispatcher
SubinterfacesIListItemRenderer, IToolTipManagerClient, IUIComponent
ImplementorsLoaderSkin, ProgrammaticSkin, SpriteAsset, SystemManager, UIComponent

The IFlexDisplayObject interface defines the interface for skin elements. At a minimum, a skin must be a DisplayObject and implement this interface.



Public Properties
 PropertyDefined by
  accessibilityProperties : AccessibilityProperties
IFlexDisplayObject
  alpha : Number
IFlexDisplayObject
  blendMode : String
IFlexDisplayObject
  cacheAsBitmap : Boolean
IFlexDisplayObject
  filters : Array
IFlexDisplayObject
  height : Number
IFlexDisplayObject
  loaderInfo : LoaderInfo
[read-only]
IFlexDisplayObject
  mask : DisplayObject
IFlexDisplayObject
  measuredHeight : Number
[read-only] The measured height of this object.
IFlexDisplayObject
  measuredWidth : Number
[read-only] The measured width of this object.
IFlexDisplayObject
  mouseX : Number
[read-only]
IFlexDisplayObject
  mouseY : Number
[read-only]
IFlexDisplayObject
  name : String
IFlexDisplayObject
  opaqueBackground : Object
IFlexDisplayObject
  parent : DisplayObjectContainer
[read-only]
IFlexDisplayObject
  root : DisplayObject
[read-only] The methods here would normally just be in IDisplayObject, but for backward compatibility, they have to be included directly into IFlexDisplayObject, so they are kept in this separate include file.
IFlexDisplayObject
  rotation : Number
IFlexDisplayObject
  scale9Grid : Rectangle
IFlexDisplayObject
  scaleX : Number
IFlexDisplayObject
  scaleY : Number
IFlexDisplayObject
  scrollRect : Rectangle
IFlexDisplayObject
  stage : Stage
[read-only]
IFlexDisplayObject
  transform : Transform
IFlexDisplayObject
  visible : Boolean
IFlexDisplayObject
  width : Number
IFlexDisplayObject
  x : Number
IFlexDisplayObject
  y : Number
IFlexDisplayObject
Public Methods
 MethodDefined by
  
getBounds(targetCoordinateSpace:DisplayObject):Rectangle
IFlexDisplayObject
  
getRect(targetCoordinateSpace:DisplayObject):Rectangle
IFlexDisplayObject
  
globalToLocal(point:Point):Point
IFlexDisplayObject
  
hitTestObject(obj:DisplayObject):Boolean
IFlexDisplayObject
  
hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean
IFlexDisplayObject
  
localToGlobal(point:Point):Point
IFlexDisplayObject
  
move(x:Number, y:Number):void
Moves this object to the specified x and y coordinates.
IFlexDisplayObject
  
setActualSize(newWidth:Number, newHeight:Number):void
Sets the actual size of this object.
IFlexDisplayObject
Property detail
accessibilityPropertiesproperty
accessibilityProperties:AccessibilityProperties  [read-write]

Implementation
    public function get accessibilityProperties():AccessibilityProperties
    public function set accessibilityProperties(value:AccessibilityProperties):void
alphaproperty 
alpha:Number  [read-write]

Implementation
    public function get alpha():Number
    public function set alpha(value:Number):void
blendModeproperty 
blendMode:String  [read-write]

Implementation
    public function get blendMode():String
    public function set blendMode(value:String):void
cacheAsBitmapproperty 
cacheAsBitmap:Boolean  [read-write]

Implementation
    public function get cacheAsBitmap():Boolean
    public function set cacheAsBitmap(value:Boolean):void
filtersproperty 
filters:Array  [read-write]

Implementation
    public function get filters():Array
    public function set filters(value:Array):void
heightproperty 
height:Number  [read-write]

Implementation
    public function get height():Number
    public function set height(value:Number):void
loaderInfoproperty 
loaderInfo:LoaderInfo  [read-only]

Implementation
    public function get loaderInfo():LoaderInfo
maskproperty 
mask:DisplayObject  [read-write]

Implementation
    public function get mask():DisplayObject
    public function set mask(value:DisplayObject):void
measuredHeightproperty 
measuredHeight:Number  [read-only]

The measured height of this object.

This is typically hard-coded for graphical skins because this number is simply the number of pixels in the graphic. For code skins, it can also be hard-coded if you expect to be drawn at a certain size. If your size can change based on properties, you may want to also be an ILayoutManagerClient so a measure() method will be called at an appropriate time, giving you an opportunity to compute a measuredHeight.

Implementation
    public function get measuredHeight():Number
measuredWidthproperty 
measuredWidth:Number  [read-only]

The measured width of this object.

This is typically hard-coded for graphical skins because this number is simply the number of pixels in the graphic. For code skins, it can also be hard-coded if you expect to be drawn at a certain size. If your size can change based on properties, you may want to also be an ILayoutManagerClient so a measure() method will be called at an appropriate time, giving you an opportunity to compute a measuredHeight.

Implementation
    public function get measuredWidth():Number
mouseXproperty 
mouseX:Number  [read-only]

Implementation
    public function get mouseX():Number
mouseYproperty 
mouseY:Number  [read-only]

Implementation
    public function get mouseY():Number
nameproperty 
name:String  [read-write]

Implementation
    public function get name():String
    public function set name(value:String):void
opaqueBackgroundproperty 
opaqueBackground:Object  [read-write]

Implementation
    public function get opaqueBackground():Object
    public function set opaqueBackground(value:Object):void
parentproperty 
parent:DisplayObjectContainer  [read-only]

Implementation
    public function get parent():DisplayObjectContainer
rootproperty 
root:DisplayObject  [read-only]

The methods here would normally just be in IDisplayObject, but for backward compatibility, they have to be included directly into IFlexDisplayObject, so they are kept in this separate include file.

Implementation
    public function get root():DisplayObject
rotationproperty 
rotation:Number  [read-write]

Implementation
    public function get rotation():Number
    public function set rotation(value:Number):void
scale9Gridproperty 
scale9Grid:Rectangle  [read-write]

Implementation
    public function get scale9Grid():Rectangle
    public function set scale9Grid(value:Rectangle):void
scaleXproperty 
scaleX:Number  [read-write]

Implementation
    public function get scaleX():Number
    public function set scaleX(value:Number):void
scaleYproperty 
scaleY:Number  [read-write]

Implementation
    public function get scaleY():Number
    public function set scaleY(value:Number):void
scrollRectproperty 
scrollRect:Rectangle  [read-write]

Implementation
    public function get scrollRect():Rectangle
    public function set scrollRect(value:Rectangle):void
stageproperty 
stage:Stage  [read-only]

Implementation
    public function get stage():Stage
transformproperty 
transform:Transform  [read-write]

Implementation
    public function get transform():Transform
    public function set transform(value:Transform):void
visibleproperty 
visible:Boolean  [read-write]

Implementation
    public function get visible():Boolean
    public function set visible(value:Boolean):void
widthproperty 
width:Number  [read-write]

Implementation
    public function get width():Number
    public function set width(value:Number):void
xproperty 
x:Number  [read-write]

Implementation
    public function get x():Number
    public function set x(value:Number):void
yproperty 
y:Number  [read-write]

Implementation
    public function get y():Number
    public function set y(value:Number):void
Method detail
getBounds()method
public function getBounds(targetCoordinateSpace:DisplayObject):Rectangle

Parameters
targetCoordinateSpace:DisplayObject

Returns
Rectangle
getRect()method 
public function getRect(targetCoordinateSpace:DisplayObject):Rectangle

Parameters
targetCoordinateSpace:DisplayObject

Returns
Rectangle
globalToLocal()method 
public function globalToLocal(point:Point):Point

Parameters
point:Point

Returns
Point
hitTestObject()method 
public function hitTestObject(obj:DisplayObject):Boolean

Parameters
obj:DisplayObject

Returns
Boolean
hitTestPoint()method 
public function hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean

Parameters
x:Number
 
y:Number
 
shapeFlag:Boolean (default = false)

Returns
Boolean
localToGlobal()method 
public function localToGlobal(point:Point):Point

Parameters
point:Point

Returns
Point
move()method 
public function move(x:Number, y:Number):void

Moves this object to the specified x and y coordinates.

Parameters
x:Number — The new x-position for this object.
 
y:Number — The new y-position for this object.
setActualSize()method 
public function setActualSize(newWidth:Number, newHeight:Number):void

Sets the actual size of this object.

This method is mainly for use in implementing the updateDisplayList() method, which is where you compute this object's actual size based on its explicit size, parent-relative (percent) size, and measured size. You then apply this actual size to the object by calling setActualSize().

In other situations, you should be setting properties such as width, height, percentWidth, or percentHeight rather than calling this method.

Parameters
newWidth:Number — The new width for this object.
 
newHeight:Number — The new height for this object.