mx.states.SetProperty - Adobe® Flex® 4 Language Reference (Flex 4)

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

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The SetProperty class specifies a property value that is in effect only during the parent view state. You use this class in the overrides property of the State class.

MXML Syntax expanded

Hide MXML Syntax

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

  <mx:SetProperty
   Properties
   name="null"
   target="null"
   value="undefined"
  />

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
		name : String The name of the property to change.	SetProperty
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		target : Object The object containing the property to be changed.	SetProperty
		value : * The new value for the property.	SetProperty
		valueFactory : IDeferredInstance [write-only] An optional write-only property from which to obtain a shared value.	SetProperty

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		SetProperty(target:Object = null, name:String = null, value:*, valueFactory:IDeferredInstance = null) Constructor.	SetProperty
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void	OnDemandEventDispatcher
		apply(parent:UIComponent):void [override] Applies the override.	SetProperty
		dispatchEvent(event:Event):Boolean	OnDemandEventDispatcher
		hasEventListener(type:String):Boolean	OnDemandEventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		initialize():void Initializes the override.	OverrideBase
		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.	SetProperty
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void	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	OnDemandEventDispatcher

Property Detail

name

property

public var name:String

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The name of the property to change. You must set this property, either in the SetProperty constructor or by setting the property value directly.

target

property

public var target:Object

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The object containing the property to be changed. If the property value is null, Flex uses the immediate parent of the State object.

The default value is null.

value

property

value:*

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The new value for the property.

The default value is undefined.

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

valueFactory

property

valueFactory:IDeferredInstance [write-only]

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 9, AIR 1.1

An optional write-only property from which to obtain a shared value. This is primarily used when this override's value is shared by multiple states or state groups.

The default value is undefined.

Implementation
public function set valueFactory(value:IDeferredInstance):void

Constructor Detail

SetProperty

()

Constructor

public function SetProperty(target:Object = null, name:String = null, value:*, valueFactory:IDeferredInstance = null)

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Constructor.

Parameters

	`target:Object` (default = `null`) — The object whose property is being set. By default, Flex uses the immediate parent of the State object.

	`name:String` (default = `null`) — The property to set.

	`value:*` (default = `NaN`) — The value of the property in the view state.

	`valueFactory:IDeferredInstance` (default = `null`) — An optional write-only property from which to obtain a shared value. This is primarily used when this override's value is shared by multiple states or state groups.

Method Detail

apply

()

method

override public function apply(parent:UIComponent):void

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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.

remove

()

method

override public function remove(parent:UIComponent):void

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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.