Packagemx.core
Interfacepublic interface IDeferredInstantiationUIComponent extends IUIComponent, IFlexDisplayObject, IBitmapDrawable, IEventDispatcher
ImplementorsModuleLoader, UIComponent

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



Public Properties
 PropertyDefined by
 Inheritedalpha : Number
The transparency of this object.
IFlexDisplayObject
 InheritedbaselinePosition : Number
Determines the baseline y-coordinate of the first line of text of the component.
IUIComponent
 InheritedcacheAsBitmap : Boolean
If set to true, Flash Player caches an internal bitmap representation of the object.
IUIComponent
  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
 Inheriteddocument : Object
A reference to the document object associated with this component.
IUIComponent
 Inheritedenabled : Boolean
Whether the component can accept user interaction.
IUIComponent
 InheritedexplicitHeight : Number
The explicitly specified height for the component, in pixels, as the component's coordinates.
IUIComponent
 InheritedexplicitMaxHeight : Number
Number that specifies the maximum height of the component, in pixels, as the component's coordinates.
IUIComponent
 InheritedexplicitMaxWidth : Number
Number that specifies the maximum width of the component, in pixels, as the component's coordinates.
IUIComponent
 InheritedexplicitMinHeight : Number
Number that specifies the minimum height of the component, in pixels, as the component's coordinates.
IUIComponent
 InheritedexplicitMinWidth : Number
Number that specifies the minimum width of the component, in pixels, as the component's coordinates.
IUIComponent
 InheritedexplicitWidth : Number
The explicitly specified width for the component, in pixels, as the component's coordinates.
IUIComponent
 InheritedfocusPane : Sprite
A single Sprite object that is shared among components and used as an overlay for drawing focus.
IUIComponent
 Inheritedheight : Number
The height of this object, in pixels.
IFlexDisplayObject
  id : String
ID of the component.
IDeferredInstantiationUIComponent
 InheritedincludeInLayout : Boolean
Specifies whether this component is included in the layout of the parent container.
IUIComponent
 InheritedisPopUp : Boolean
Set to true by the PopUpManager to indicate that component has been popped up.
IUIComponent
 Inheritedmask : DisplayObject
The DisplayObject used to mask this object so that only part of it is actually drawn.
IFlexDisplayObject
 InheritedmaxHeight : Number
Number that specifies the maximum height of the component, in pixels, as the component's coordinates.
IUIComponent
 InheritedmaxWidth : Number
Number that specifies the maximum width of the component, in pixels, as the component's coordinates.
IUIComponent
 InheritedmeasuredHeight : Number
The measured height of this object.
IFlexDisplayObject
 InheritedmeasuredMinHeight : Number
The default minimum height of the component, in pixels.
IUIComponent
 InheritedmeasuredMinWidth : Number
The default minimum width of the component, in pixels.
IUIComponent
 InheritedmeasuredWidth : Number
The measured width of this object.
IFlexDisplayObject
 InheritedminHeight : Number
Number that specifies the minimum height of the component, in pixels, as the component's coordinates.
IUIComponent
 InheritedminWidth : Number
Number that specifies the minimum width of the component, in pixels, as the component's coordinates.
IUIComponent
 Inheritedname : String
The instance name of this object.
IFlexDisplayObject
 InheritedopaqueBackground : Object
Specifies whether the display object is opaque with a certain background color.
IUIComponent
 Inheritedowner : DisplayObjectContainer
Your owner is usually your parent, however If you are a popup subcomponent, your owner will be the component that popped you up.
IUIComponent
 Inheritedparent : DisplayObjectContainer
The parent of this object.
IFlexDisplayObject
 InheritedpercentHeight : Number
Number that specifies the height of a component as a percentage of its parent's size.
IUIComponent
 InheritedpercentWidth : Number
Number that specifies the width of a component as a percentage of its parent's size.
IUIComponent
 InheritedscaleX : Number
The horizontal scaling factor for this object.
IFlexDisplayObject
 InheritedscaleY : Number
The vertical scaling factor for this object.
IFlexDisplayObject
 InheritedscrollRect : Rectangle
The scroll rectangle bounds of the surface of the component.
IUIComponent
 InheritedsystemManager : ISystemManager
A reference to the SystemManager object for this component.
IUIComponent
 InheritedtweeningProperties : Array
Used by EffectManager.
IUIComponent
 Inheritedvisible : Boolean
A flag that indicates whether this object is visible.
IFlexDisplayObject
 Inheritedwidth : Number
The width of this object, in pixels.
IFlexDisplayObject
 Inheritedx : Number
The horizontal position of this object relative to its parent, in pixel coordinates.
IFlexDisplayObject
 Inheritedy : Number
The vertical position of this object relative to its parent, in pixel coordinates.
IFlexDisplayObject
Public Methods
 MethodDefined by
 Inherited
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
  
Creates an id reference to this IUIComponent object on its parent document object.
IDeferredInstantiationUIComponent
  
Deletes the id reference to this IUIComponent object on its parent document object.
IDeferredInstantiationUIComponent
 Inherited
Dispatches an event into the event flow.
IEventDispatcher
  
executeBindings(recurse:Boolean = false):void
Executes the data bindings into this UIComponent object.
IDeferredInstantiationUIComponent
 Inherited
A convenience method for determining whether to use the explicit or measured height
IUIComponent
 Inherited
A convenience method for determining whether to use the explicit or measured width
IUIComponent
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
IEventDispatcher
 Inherited
Initialize the object.
IUIComponent
 Inherited
Moves this object to the specified x and y coordinates.
IFlexDisplayObject
 Inherited
Returns true if the chain of owner properties points from child to this UIComponent.
IUIComponent
 Inherited
Called by Flex when a UIComponent object is added to or removed from a parent.
IUIComponent
  
For each effect event, register the EffectManager as one of the event listeners.
IDeferredInstantiationUIComponent
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
IEventDispatcher
 Inherited
setActualSize(newWidth:Number, newHeight:Number):void
Sets the actual size of this object.
IFlexDisplayObject
 Inherited
setVisible(value:Boolean, noEvent:Boolean = false):void
Called when the visible property changes.
IUIComponent
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
IEventDispatcher
Property detail
cacheHeuristicproperty
cacheHeuristic:Boolean  [write-only]

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
cachePolicyproperty 
cachePolicy:String  [read-only]

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).

Implementation
    public function get cachePolicy():String
descriptorproperty 
descriptor:UIComponentDescriptor  [read-write]

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
idproperty 
id:String  [read-write]

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

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

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

Executes the data bindings into this UIComponent object. Workaround for MXML container/bindings problem (177074): override Container.executeBindings() to prefer descriptor.document over parentDocument in the call to BindingManager.executeBindings(). This should always provide the correct behavior for instances created by descriptor, and will provide the original behavior for procedurally-created instances. (The bug may or may not appear in the latter case.) A more complete fix, guaranteeing correct behavior in both non-DI and reparented-component scenarios, is anticipated for updater 1.

Parameters
recurse:Boolean (default = false) — Recursively execute bindings for children of this component.
registerEffects()method 
public function registerEffects(effects:Array):void

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

Parameters
effects:Array — An Array of strings of effect names.




Take a survey


 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/flex/201/langref/mx/core/IDeferredInstantiationUIComponent.html