Language Version : | ActionScript 3.0 |
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.
Show MXML Syntax
Hide MXML Syntax The <mx:SetProperty>
tag
has the following attributes:
<mx:SetProperty
Properties
name="null"
target="null"
value="undefined"
/>
public var name:String
Language Version : | ActionScript 3.0 |
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.
public var target:Object
Language Version : | ActionScript 3.0 |
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:*
Language Version : | ActionScript 3.0 |
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:IDeferredInstance
[write-only]
Language Version : | ActionScript 3.0 |
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
public function SetProperty(target:Object = null, name:String = null, value:*, valueFactory:IDeferredInstance = null)
Language Version : | ActionScript 3.0 |
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.
|
override public function apply(parent:UIComponent):void
Language Version : | ActionScript 3.0 |
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.
|
override public function remove(parent:UIComponent):void
Language Version : | ActionScript 3.0 |
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.
|
Mon Feb 18 2013, 01:33 PM +11:00