Packagemx.states
Classpublic class SetProperty
InheritanceSetProperty Inheritance OverrideBase Inheritance OnDemandEventDispatcher Inheritance 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 SyntaxexpandedHide MXML Syntax

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

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

See also

mx.states.State
mx.states.SetEventHandler
mx.states.SetStyle
mx.effects.SetPropertyAction

Public Properties
 PropertyDefined By
  name : String
The name of the property to change.
SetProperty
  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
 MethodDefined By
  
SetProperty(target:Object = null, name:String = null, value:*, valueFactory:IDeferredInstance = null)
Constructor.
SetProperty
 Inherited
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
 Inherited
dispatchEvent(event:Event):Boolean
OnDemandEventDispatcher
 Inherited
hasEventListener(type:String):Boolean
OnDemandEventDispatcher
 Inherited
initialize():void
IOverride interface method; this class implements it as an empty method.
OverrideBase
  
remove(parent:UIComponent):void
[override] Removes the override.
SetProperty
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
OnDemandEventDispatcher
 Inherited
willTrigger(type:String):Boolean
OnDemandEventDispatcher
Property Detail
nameproperty
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.

targetproperty 
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.

valueproperty 
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
valueFactoryproperty 
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.




The Apache Software Foundation

Wed Nov 15 2017, 09:50 AM +01:00