AddChild

(Preview)

Package	mx.states
Class	public class AddChild
Inheritance	AddChild OverrideBase OnDemandEventDispatcher Object

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The AddChild class adds a child display object, such as a component, to a container as part of a view state. You use this class in the overrides property of the State class. Use the creationPolicy property to specify to create the child at application startup or when you change to a view state.

The child does not dispatch the creationComplete event until it is added to a container. For example, the following code adds a Button control as part of a view state change:

  <mx:AddChild relativeTo="{v1}">
      <mx:Button id="b0" label="New Button"/>
  </mx:AddChild>

In the previous example, the Button control does not dispatch the creationComplete event until you change state and the Button control is added to a container. If the AddChild class defines both the Button and a container, such as a Canvas container, then the Button control dispatches the creationComplete event when it is created. For example, if the creationPolicy property is set to all, the Button control dispatches the event at application startup. If the creationPolicy property is set to auto, the Button control dispatches the event when you change to the view state.

MXML Syntax expanded

Hide MXML Syntax

The <mx:AddChild> tag has the following attributes:

  <mx:AddChild
  Properties
  target="null"
  targetFactory="null"
  creationPolicy="auto"
  position="lastChild"
  relativeTo="parent of the State object"
  />

Default MXML PropertytargetFactory

Related API Elements

mx.states.State
mx.states.RemoveChild
mx.states.Transition
mx.effects.AddChildAction

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		creationPolicy : String The creation policy for this child.	AddChild
		position : String The position of the child in the display list, relative to the object specified by the relativeTo property.	AddChild
		relativeTo : Object The object relative to which the child is added.	AddChild
		target : DisplayObject The child to be added.	AddChild
		targetFactory : IDeferredInstance The factory that creates the child.	AddChild

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		AddChild(relativeTo:UIComponent = null, target:DisplayObject = null, position:String = "lastChild") Constructor.	AddChild
		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.	OnDemandEventDispatcher
		apply(parent:UIComponent):void [override] Applies the override.	AddChild
		createInstance():void Creates the child instance from the factory.	AddChild
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	OnDemandEventDispatcher
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	OnDemandEventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		initialize():void [override] IOverride interface method; this class implements it as an empty method.	AddChild
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		remove(parent:UIComponent):void [override] Removes the override.	AddChild
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	OnDemandEventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object
		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.	OnDemandEventDispatcher

Property Detail

Value	Meaning
`auto`	(default)Create the instance the first time it is needed.
`all`	Create the instance when the application started up.
`none`	Do not automatically create the instance. You must call the `createInstance()` method to create the instance.

Constructor Detail

Method Detail

[an error occurred while processing this directive]

Legal Notices | Online Privacy Policy

AddChild - AS3 Flex

Packagesx

Language Elements

Appendixes

Package mx.states

creationPolicy

position

relativeTo

target

targetFactory

apply

createInstance

initialize

remove

	`relativeTo:UIComponent` (default = `null`) — The component relative to which child is added.

	`target:DisplayObject` (default = `null`) — The child object. All Flex components are subclasses of the DisplayObject class.

	`position:String` (default = "`lastChild`") — the location in the display list of the `target` relative to the `relativeTo` component. Must be one of the following: "firstChild", "lastChild", "before" or "after".