mx.core

# IDeferredInstantiationUIComponent - AS3 Flex

Package | mx.core
Interface | public interface IDeferredInstantiationUIComponent extends IUIComponent , IFlexDisplayObject , IBitmapDrawable , IEventDispatcher
Implementors | ModuleLoader, UIComponent, UIMovieClip

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The IDeferredInstantiationUIComponent interface defines the interface for a component or object that defers instantiation.

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | accessibilityProperties : AccessibilityProperties The current accessibility options for this display object. | IFlexDisplayObject
|  | alpha : Number Indicates the alpha transparency value of the object specified. | IFlexDisplayObject
|  | baselinePosition : Number [read-only] The y-coordinate of the baseline of the first line of text of the component. | IUIComponent
|  | blendMode : String A value from the BlendMode class that specifies which blend mode to use. | IFlexDisplayObject
|  | cacheAsBitmap : Boolean If set to true, Flash runtimes cache an internal bitmap representation of the display object. | IFlexDisplayObject
|  | cacheHeuristic : Boolean [write-only] Used by Flex to suggest bitmap caching for the object. | IDeferredInstantiationUIComponent
|  | cachePolicy : String [read-only] Specifies the bitmap caching policy for this object. | IDeferredInstantiationUIComponent
|  | descriptor : UIComponentDescriptor Reference to the UIComponentDescriptor, if any, that was used by the createComponentFromDescriptor() method to create this UIComponent instance. | IDeferredInstantiationUIComponent
|  | document : Object A reference to the document object associated with this component. | IUIComponent
|  | enabled : Boolean Whether the component can accept user interaction. | IUIComponent
|  | explicitHeight : Number The explicitly specified height for the component, in pixels, as the component's coordinates. | IUIComponent
|  | explicitMaxHeight : Number [read-only] Number that specifies the maximum height of the component, in pixels, as the component's coordinates. | IUIComponent
|  | explicitMaxWidth : Number [read-only] Number that specifies the maximum width of the component, in pixels, as the component's coordinates. | IUIComponent
|  | explicitMinHeight : Number [read-only] Number that specifies the minimum height of the component, in pixels, as the component's coordinates. | IUIComponent
|  | explicitMinWidth : Number [read-only] Number that specifies the minimum width of the component, in pixels, as the component's coordinates. | IUIComponent
|  | explicitWidth : Number The explicitly specified width for the component, in pixels, as the component's coordinates. | IUIComponent
|  | filters : Array An indexed array that contains each filter object currently associated with the display object. | IFlexDisplayObject
|  | focusPane : Sprite A single Sprite object that is shared among components and used as an overlay for drawing the focus indicator. | IUIComponent
|  | height : Number Indicates the height of the display object, in pixels. | IFlexDisplayObject
|  | id : String ID of the component. | IDeferredInstantiationUIComponent
|  | includeInLayout : Boolean Specifies whether this component is included in the layout of the parent container. | IUIComponent
|  | isPopUp : Boolean Set to true by the PopUpManager to indicate that component has been popped up. | IUIComponent
|  | loaderInfo : LoaderInfo [read-only] Returns a LoaderInfo object containing information about loading the file to which this display object belongs. | IFlexDisplayObject
|  | mask : DisplayObject The calling display object is masked by the specified mask object. | IFlexDisplayObject
|  | maxHeight : Number [read-only] Number that specifies the maximum height of the component, in pixels, as the component's coordinates. | IUIComponent
|  | maxWidth : Number [read-only] Number that specifies the maximum width of the component, in pixels, as the component's coordinates. | IUIComponent
|  | measuredHeight : Number [read-only] The measured height of this object. | IFlexDisplayObject
|  | measuredMinHeight : Number The default minimum height of the component, in pixels. | IUIComponent
|  | measuredMinWidth : Number The default minimum width of the component, in pixels. | IUIComponent
|  | measuredWidth : Number [read-only] The measured width of this object. | IFlexDisplayObject
|  | minHeight : Number [read-only] Number that specifies the minimum height of the component, in pixels, as the component's coordinates. | IUIComponent
|  | minWidth : Number [read-only] Number that specifies the minimum width of the component, in pixels, as the component's coordinates. | IUIComponent
|  | mouseX : Number [read-only] Indicates the x coordinate of the mouse or user input device position, in pixels. | IFlexDisplayObject
|  | mouseY : Number [read-only] Indicates the y coordinate of the mouse or user input device position, in pixels. | IFlexDisplayObject
|  | name : String Indicates the instance name of the DisplayObject. | IFlexDisplayObject
|  | opaqueBackground : Object Specifies whether the display object is opaque with a certain background color. | IFlexDisplayObject
|  | owner : DisplayObjectContainer The owner of this IVisualElement object. | IUIComponent
|  | parent : DisplayObjectContainer [read-only] Indicates the DisplayObjectContainer object that contains this display object. | IFlexDisplayObject
|  | percentHeight : Number Number that specifies the height of a component as a percentage of its parent's size. | IUIComponent
|  | percentWidth : Number Number that specifies the width of a component as a percentage of its parent's size. | IUIComponent
|  | root : DisplayObject [read-only] For a display object in a loaded SWF file, the root property is the top-most display object in the portion of the display list's tree structure represented by that SWF file. | IFlexDisplayObject
|  | rotation : Number Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. | IFlexDisplayObject
|  | scale9Grid : Rectangle The current scaling grid that is in effect. | IFlexDisplayObject
|  | scaleX : Number Indicates the horizontal scale (percentage) of the object as applied from the registration point. | IFlexDisplayObject
|  | scaleY : Number Indicates the vertical scale (percentage) of an object as applied from the registration point of the object. | IFlexDisplayObject
|  | scrollRect : Rectangle The scroll rectangle bounds of the display object. | IFlexDisplayObject
|  | stage : Stage [read-only] The Stage of the display object. | IFlexDisplayObject
|  | systemManager : ISystemManager A reference to the SystemManager object for this component. | IUIComponent
|  | transform : flash.geom:Transform An object with properties pertaining to a display object's matrix, color transform, and pixel bounds. | IFlexDisplayObject
|  | tweeningProperties : Array Used by EffectManager. | IUIComponent
|  | visible : Boolean Whether or not the display object is visible. | IFlexDisplayObject
|  | width : Number Indicates the width of the display object, in pixels. | IFlexDisplayObject
|  | x : Number Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. | IFlexDisplayObject
|  | y : Number Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. | IFlexDisplayObject

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event. | IEventDispatcher
|  | createReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void Creates an id reference to this IUIComponent object on its parent document object. | IDeferredInstantiationUIComponent
|  | deleteReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void Deletes the id reference to this IUIComponent object on its parent document object. | IDeferredInstantiationUIComponent
|  | dispatchEvent(event:Event):Boolean Dispatches an event into the event flow. | IEventDispatcher
|  | executeBindings(recurse:Boolean = false):void Executes all the bindings for which the UIComponent object is the destination. | IDeferredInstantiationUIComponent
|  | getBounds(targetCoordinateSpace:DisplayObject):Rectangle Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object. | IFlexDisplayObject
|  | getExplicitOrMeasuredHeight():Number A convenience method for determining whether to use the explicit or measured height | IUIComponent
|  | getExplicitOrMeasuredWidth():Number A convenience method for determining whether to use the explicit or measured width | IUIComponent
|  | getRect(targetCoordinateSpace:DisplayObject):Rectangle Returns a rectangle that defines the boundary of the display object, based on the coordinate system defined by the targetCoordinateSpace parameter, excluding any strokes on shapes. | IFlexDisplayObject
|  | globalToLocal(point:Point):Point Converts the point object from the Stage (global) coordinates to the display object's (local) coordinates. | IFlexDisplayObject
|  | hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event. | IEventDispatcher
|  | hitTestObject(obj:DisplayObject):Boolean Evaluates the bounding box of the display object to see if it overlaps or intersects with the bounding box of the obj display object. | IFlexDisplayObject
|  | hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean Evaluates the display object to see if it overlaps or intersects with the point specified by the x and y parameters. | IFlexDisplayObject
|  | initialize():void Initialize the object. | IUIComponent
|  | localToGlobal(point:Point):Point Converts the point object from the display object's (local) coordinates to the Stage (global) coordinates. | IFlexDisplayObject
|  | move(x:Number, y:Number):void Moves this object to the specified x and y coordinates. | IFlexDisplayObject
|  | owns(displayObject:DisplayObject):Boolean Returns true if the chain of owner properties points from child to this UIComponent. | IUIComponent
|  | parentChanged(p:DisplayObjectContainer):void Called by Flex when a UIComponent object is added to or removed from a parent. | IUIComponent
|  | registerEffects(effects:Array):void For each effect event, register the EffectManager as one of the event listeners. | IDeferredInstantiationUIComponent
|  | removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object. | IEventDispatcher
|  | setActualSize(newWidth:Number, newHeight:Number):void Sets the actual size of this object. | IFlexDisplayObject
|  | setVisible(value:Boolean, noEvent:Boolean = false):void Called when the visible property changes. | IUIComponent
|  | willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | IEventDispatcher

Property Detail

### cacheHeuristic

property

`cacheHeuristic:Boolean` [write-only]

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Used by Flex to suggest bitmap caching for the object. If `cachePolicy` is `UIComponentCachePolicy.AUTO`, then `cacheHeuristic` is used to control the object's `cacheAsBitmap` property.

Implementation
`public function set cacheHeuristic(value:Boolean):void`

### cachePolicy

property

`cachePolicy:String` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Specifies the bitmap caching policy for this object. Possible values in MXML are `"on"`, `"off"` and `"auto"` (default).

Possible values in ActionScript are `UIComponentCachePolicy.ON`, `UIComponentCachePolicy.OFF` and `UIComponentCachePolicy.AUTO` (default).

- A value of `UIComponentCachePolicy.ON` means that the object is always cached as a bitmap.
- A value of `UIComponentCachePolicy.OFF` means that the object is never cached as a bitmap.
- A value of `UIComponentCachePolicy.AUTO` means that the framework uses heuristics to decide whether the object should be cached as a bitmap.

Implementation
`public function get cachePolicy():String`

### descriptor

property

`descriptor:UIComponentDescriptor`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Reference to the UIComponentDescriptor, if any, that was used by the `createComponentFromDescriptor()` method to create this UIComponent instance. If this UIComponent instance was not created from a descriptor, this property is null.

Implementation
`public function get descriptor():UIComponentDescriptor`
`public function set descriptor(value:UIComponentDescriptor):void`

### id

property

`id:String`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

ID of the component. This value becomes the instance name of the object and should not contain any white space or special characters. Each component throughout an application should have a unique id.

If your application is going to be tested by third party tools, give each component a meaningful id. Testing tools use ids to represent the control in their scripts and having a meaningful name can make scripts more readable. For example, set the value of a button to submit_button rather than b1 or button1.

Implementation
`public function get id():String`
`public function set id(value:String):void`
Method Detail

### createReferenceOnParentDocument

()
method

`public function createReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Creates an `id` reference to this IUIComponent object on its parent document object. This function can create multidimensional references such as b[2][4] for objects inside one or more repeaters. If the indices are null, it creates a simple non-Array reference.

Parameters

| `parentDocument:IFlexDisplayObject` — The parent of this IUIComponent object.

### deleteReferenceOnParentDocument

()
method

`public function deleteReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Deletes the `id` reference to this IUIComponent object on its parent document object. This function can delete from multidimensional references such as b[2][4] for objects inside one or more Repeaters. If the indices are null, it deletes the simple non-Array reference.

Parameters

| `parentDocument:IFlexDisplayObject` — The parent of this IUIComponent object.

### executeBindings

()
method

`public function executeBindings(recurse:Boolean = false):void`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Executes all the bindings for which the UIComponent object is the destination.

Parameters

| `recurse:Boolean` (default = `false`)`` — Recursively execute bindings for children of this component.

### registerEffects

()
method

`public function registerEffects(effects:Array):void`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

For each effect event, register the EffectManager as one of the event listeners.

Parameters

| `effects:Array` — An Array of strings of effect names.

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00