| 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 |
overrides property of the State class.
MXML Syntax
Show MXML Syntax
Hide MXML SyntaxThe <mx:SetProperty> tag
has the following attributes:
<mx:SetProperty Properties name="null" target="null" value="undefined" />
More examples
Example: Creating a simple view state
Create and apply view states
Defining view state groups
Example: Controlling layout using view states groups
Learn more
Related API Elements
| 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 | ||
| 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
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | OnDemandEventDispatcher | |
[override]
Applies the override. | SetProperty | ||
|
Dispatches an event into the event flow. | OnDemandEventDispatcher | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | OnDemandEventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
|
IOverride interface method; this class implements it as an empty method. | OverrideBase | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
[override]
Removes the override. | SetProperty | ||
|
Removes a listener from the EventDispatcher object. | OnDemandEventDispatcher | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Returns the primitive value of the specified object. | Object | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | OnDemandEventDispatcher | |
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 |
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):voidSetProperty | () | 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.
Parameterstarget:Object (default = null) | |
name:String (default = null) | |
value:* (default = NaN) | |
valueFactory:IDeferredInstance (default = null) |
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.
|
Mon Nov 28 2011, 06:48 AM -08:00