| Package | mx.core |
| Interface | public interface IDeferredInstantiationUIComponent extends IUIComponent, IFlexDisplayObject, flash.display.IBitmapDrawable, flash.events.IEventDispatcher |
| Implementors | UIComponent |
| Property | Defined by | ||
|---|---|---|---|
 | accessibilityProperties : AccessibilityProperties | IFlexDisplayObject | |
| alpha : Number | IFlexDisplayObject | |
| baselinePosition : Number
The y-coordinate of the baseline
of the first line of text of the component.
| IUIComponent | |
| blendMode : String | IFlexDisplayObject | |
| cacheAsBitmap : Boolean | 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
Number that specifies the maximum height of the component,
in pixels, as the component's coordinates.
| IUIComponent | |
| explicitMaxWidth : Number
Number that specifies the maximum width of the component,
in pixels, as the component's coordinates.
| IUIComponent | |
| explicitMinHeight : Number
Number that specifies the minimum height of the component,
in pixels, as the component's coordinates.
| IUIComponent | |
| explicitMinWidth : Number
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 | IFlexDisplayObject | |
| focusPane : Sprite
A single Sprite object that is shared among components
and used as an overlay for drawing focus.
| IUIComponent | |
| height : Number | 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 | IFlexDisplayObject | |
| mask : DisplayObject | IFlexDisplayObject | |
| maxHeight : Number
Number that specifies the maximum height of the component,
in pixels, as the component's coordinates.
| IUIComponent | |
| maxWidth : Number
Number that specifies the maximum width of the component,
in pixels, as the component's coordinates.
| IUIComponent | |
| measuredHeight : Number
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
The measured width of this object.
| IFlexDisplayObject | |
| minHeight : Number
Number that specifies the minimum height of the component,
in pixels, as the component's coordinates.
| IUIComponent | |
| minWidth : Number
Number that specifies the minimum width of the component,
in pixels, as the component's coordinates.
| IUIComponent | |
| mouseX : Number | IFlexDisplayObject | |
| mouseY : Number | IFlexDisplayObject | |
| name : String | IFlexDisplayObject | |
| opaqueBackground : Object | IFlexDisplayObject | |
| owner : DisplayObjectContainer
Typically the parent container of this component.
| IUIComponent | |
| parent : DisplayObjectContainer | 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
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 | IFlexDisplayObject | |
| systemManager : ISystemManager
A reference to the SystemManager object for this component.
| IUIComponent | |
| transform : Transform | IFlexDisplayObject | |
| tweeningProperties : Array
Used by EffectManager.
| IUIComponent | |
| visible : Boolean | IFlexDisplayObject | |
| width : Number | IFlexDisplayObject | |
| x : Number | IFlexDisplayObject | |
| y : Number | IFlexDisplayObject | |
| Method | Defined by | ||
|---|---|---|---|
|
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 | ||
|
executeBindings(recurse:Boolean = false):void
Executes the data bindings into this UIComponent object.
| IDeferredInstantiationUIComponent | ||
|
getBounds(targetCoordinateSpace:DisplayObject):Rectangle
| 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
| IFlexDisplayObject | |
|
globalToLocal(point:Point):Point
| IFlexDisplayObject | |
|
hitTestObject(obj:DisplayObject):Boolean
| IFlexDisplayObject | |
|
hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean
| IFlexDisplayObject | |
|
initialize():void
Initialize the object.
| IUIComponent | |
|
localToGlobal(point:Point):Point
| IFlexDisplayObject | |
|
move(x:Number, y:Number):void
Moves this object to the specified x and y coordinates.
| IFlexDisplayObject | |
|
owns(child: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 | ||
|
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 | |
| cacheHeuristic | property |
Hide Inherited Public Properties
Show Inherited Public PropertiescacheHeuristic: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.
public function set cacheHeuristic(value:Boolean):void
| cachePolicy | property |
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).
UIComponentCachePolicy.ON means that
the object is always cached as a bitmap.UIComponentCachePolicy.OFF means that
the object is never cached as a bitmap.UIComponentCachePolicy.AUTO means that
the framework uses heuristics to decide whether the object should
be cached as a bitmap. public function get cachePolicy():String
| descriptor | property |
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.
public function get descriptor():UIComponentDescriptor
public function set descriptor(value:UIComponentDescriptor):void
| id | property |
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
| 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.
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.
parentDocument:IFlexDisplayObject — The parent of this IUIComponent object.
|
| executeBindings | () | method |
public function executeBindings(recurse:Boolean = false):voidExecutes 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.
Parametersrecurse:Boolean (default = false) |
| registerEffects | () | method |
public function registerEffects(effects:Array):voidFor each effect event, register the EffectManager as one of the event listeners.
Parameterseffects:Array — An Array of strings of effect names.
|