Adobe® Flex® 4 Language Reference
Hide Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
mx.states 
AddItems 
Packagemx.states
Classpublic class AddItems
InheritanceAddItems Inheritance OverrideBase Inheritance OnDemandEventDispatcher Inheritance Object

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Documentation is not currently available.

Default MXML PropertyitemsFactory



Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  creationPolicy : String
The creation policy for the items.
AddItems
  destination : Object
The object relative to which the child is added.
AddItems
  destructionPolicy : String
The destruction policy for the items.
AddItems
  isArray : Boolean = false
Denotes whether or not the collection represented by the target property is to be treated as a single array instance instead of a collection of items (the default).
AddItems
  isStyle : Boolean = false
Denotes whether or not the collection represented by the target property is a style.
AddItems
  items : *
The items to be added.
AddItems
  itemsFactory : mx.core:ITransientDeferredInstance
The factory that creates the items.
AddItems
  position : String = "last"
The position of the child in the display list, relative to the object specified by the relativeTo property.
AddItems
  propertyName : String
The name of the Array property that is being modified.
AddItems
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
  relativeTo : Object
The object relative to which the child is added.
AddItems
Public Methods
 MethodDefined By
  
Constructor.
AddItems
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
OnDemandEventDispatcher
  
[override] Applies the override.
AddItems
  
Creates the items instance from the factory.
AddItems
 Inherited
OnDemandEventDispatcher
 Inherited
OnDemandEventDispatcher
 Inherited
Indicates whether an object has a specified property defined.
Object
  
[override] IOverride interface method; this class implements it as an empty method.
AddItems
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
  
[override] Removes the override.
AddItems
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
OnDemandEventDispatcher
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
 Inherited
OnDemandEventDispatcher
Public Constants
 ConstantDefined By
  AFTER : String = "after"
[static] Documentation is not currently available.
AddItems
  BEFORE : String = "before"
[static] Documentation is not currently available.
AddItems
  FIRST : String = "first"
[static] Documentation is not currently available.
AddItems
  LAST : String = "last"
[static] Documentation is not currently available.
AddItems
Property Detail

creationPolicy

property
creationPolicy:String

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

The creation policy for the items. This property determines when the itemsFactory will create the instance of the items. Flex uses this property only if you specify an itemsFactory property. The following values are valid:

ValueMeaning
auto(default)Create the instance the first time it is needed.
allCreate the instance when the application started up.
noneDo not automatically create the instance. You must call the createInstance() method to create the instance.

The default value is "auto".



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

destination

property 
public var destination:Object

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

The object relative to which the child is added. This property is used in conjunction with the position property. This property is optional; if you omit it, Flex uses the immediate parent of the State object, that is, the component that has the states property, or <mx:states>tag that specifies the State object.

destructionPolicy

property 
destructionPolicy:String

Language Version: ActionScript 4.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

The destruction policy for the items. This property determines when the itemsFactory will destroy the deferred instances it manages. By default once instantiated, all instances are cached (destruction policy of 'never'). Flex uses this property only if you specify an itemsFactory property. The following values are valid:

ValueMeaning
never(default)Once created never destroy the instance.
autoDestroy the instance when the override no longer applies.

The default value is "never".



Implementation
    public function get destructionPolicy():String
    public function set destructionPolicy(value:String):void

isArray

property 
public var isArray:Boolean = false

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Denotes whether or not the collection represented by the target property is to be treated as a single array instance instead of a collection of items (the default).

The default value is false.

isStyle

property 
public var isStyle:Boolean = false

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Denotes whether or not the collection represented by the target property is a style.

The default value is false.

items

property 
items:*

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

The items to be added. If you set this property, the items are created at app startup. Setting this property is equivalent to setting a itemsFactory property with a creationPolicy of "all".

Do not set this property if you set the itemsFactory property.



Implementation
    public function get items():*
    public function set items(value:any):void

itemsFactory

property 
itemsFactory:mx.core:ITransientDeferredInstance

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

The factory that creates the items.

If you set this property, the items are instantiated at the time determined by the creationPolicy property.

Do not set this property if you set the items property. This propety is the AddItems class default property. Setting this property with a creationPolicy of "all" is equivalent to setting a items property.



Implementation
    public function get itemsFactory():mx.core:ITransientDeferredInstance
    public function set itemsFactory(value:mx.core:ITransientDeferredInstance):void

position

property 
public var position:String = "last"

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

The position of the child in the display list, relative to the object specified by the relativeTo property.

The default value is AddItems.LAST.

propertyName

property 
public var propertyName:String

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

The name of the Array property that is being modified. If the destination property is a Group or Container, this property is optional. If not defined, the items will be added as children of the Group/Container.

relativeTo

property 
public var relativeTo:Object

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

The object relative to which the child is added. This property is only used when the position property is AddItems.BEFORE or AddItems.AFTER.

Constructor Detail

AddItems

()Constructor
public function AddItems()

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Constructor.

Method Detail

apply

()method
override public function apply(parent:UIComponent):void

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Applies the override. Flex retains the original value, so that it can restore the value later in the remove() method.

This method is called automatically when the state is entered. It should not be called directly.

Parameters

parent:UIComponent — The parent of the state object containing this override. The override should use this as its target if an explicit target was not specified.

createInstance

()method 
public function createInstance():void

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Creates the items instance from the factory. You must use this method only if you specify a targetItems property and a creationPolicy value of "none". Flex automatically calls this method if the creationPolicy property value is "auto" or "all". If you call this method multiple times, the items instance is created only on the first call.

initialize

()method 
override public function initialize():void

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

IOverride interface method; this class implements it as an empty method.

remove

()method 
override public function remove(parent:UIComponent):void

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Removes the override. The value remembered in the apply() method is restored.

This method is called automatically when the state is entered. It should not be called directly.

Parameters

parent:UIComponent — The parent of the state object containing this override. The override should use this as its target if an explicit target was not specified.

Constant Detail

AFTER

Constant
public static const AFTER:String = "after"

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Documentation is not currently available.

BEFORE

Constant 
public static const BEFORE:String = "before"

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Documentation is not currently available.

FIRST

Constant 
public static const FIRST:String = "first"

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Documentation is not currently available.

LAST

Constant 
public static const LAST:String = "last"

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Documentation is not currently available.