Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
IDeferredContentOwner

Package | mx.core
Interface | public interface IDeferredContentOwner extends IUIComponent, IFlexDisplayObject, flash.display.IBitmapDrawable, flash.events.IEventDispatcher
Implementors | DeferredGroup, Navigator, SkinnableContainer

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The IDeferredContentOwner interface defines the properties and methods for deferred instantiation.

See also

spark.components.SkinnableContainer
mx.core.Container
mx.core.INavigatorContent

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | accessibilityProperties : AccessibilityProperties | IFlexDisplayObject
|  | alpha : Number | IFlexDisplayObject
|  | baselinePosition : Number [read-only] The y-coordinate of the baseline of the first line of text of the component. | IUIComponent
|  | blendMode : String | IFlexDisplayObject
|  | cacheAsBitmap : Boolean | IFlexDisplayObject
|  | creationPolicy : String Content creation policy for this component. | IDeferredContentOwner
|  | deferredContentCreated : Boolean [read-only] A flag that indicates whether the deferred content has been created. | IDeferredContentOwner
|  | 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 | 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 | IFlexDisplayObject
|  | 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] | IFlexDisplayObject
|  | mask : DisplayObject | 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] | IFlexDisplayObject
|  | mouseY : Number [read-only] | IFlexDisplayObject
|  | name : String | IFlexDisplayObject
|  | opaqueBackground : Object | IFlexDisplayObject
|  | owner : DisplayObjectContainer The owner of this IVisualElement object. | IUIComponent
|  | parent : DisplayObjectContainer [read-only] | 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] | IFlexDisplayObject
|  | rotation : Number | IFlexDisplayObject
|  | scale9Grid : Rectangle | IFlexDisplayObject
|  | scaleX : Number | IFlexDisplayObject
|  | scaleY : Number | IFlexDisplayObject
|  | scrollRect : Rectangle | IFlexDisplayObject
|  | stage : Stage [read-only] | 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

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | createDeferredContent():void Create the content for this component. | IDeferredContentOwner
|  | 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(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
|  | 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

Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | contentCreationComplete | Dispatched after the content for this component has been created. | IDeferredContentOwner

Property Detail

creationPolicy | property

`creationPolicy:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Content creation policy for this component.

Possible values are:

- `auto` - Automatically create the content immediately before it is needed.
- `all` - Create the content as soon as the parent component is created. This option should only be used as a last resort because it increases startup time and memory usage.
- `none` - Content must be created manually by calling the `createDeferredContent()` method.

If no `creationPolicy` is specified for a container, that container inherits the value of its parent's `creationPolicy` property.

The default value is `"auto"`.

Implementation
`public function get creationPolicy():String`
`public function set creationPolicy(value:String):void`

deferredContentCreated | property |

`deferredContentCreated:Boolean` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

A flag that indicates whether the deferred content has been created.

Implementation
`public function get deferredContentCreated():Boolean`
Method Detail

createDeferredContent | () | method

`public function createDeferredContent():void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Create the content for this component. If the value of the `creationPolicy` property is `auto` or `all`, this the Flex framework calls this method. If the value of the `creationPolicy` property is `none`, you must explicitly call this method to create the content for the component.

Event Detail

contentCreationComplete | Event

Event Object Type: `mx.events.FlexEvent`
FlexEvent.type property = `mx.events.FlexEvent.CONTENT_CREATION_COMPLETE`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Dispatched after the content for this component has been created. With deferred instantiation, the content for a component can be created long after the component is created.

The `FlexEvent.CONTENT_CREATION_COMPLETE` constant defines the value of the `type` property of the event object for a `contentCreationComplete` event.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`currentTarget` | The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`target` | The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.

Sun Mar 5 2017, 03:42 PM +11:00