Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
SetPropertyAction

Package | mx.effects
Class | public class SetPropertyAction
Inheritance | SetPropertyAction Effect flash.events.EventDispatcher

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

| Starting with Flex 4.0, Apache recommends that you use the spark.effects.SetAction class as an alternative to this class.

The SetPropertyAction class defines an action effect that corresponds to the `SetProperty property` of a view state definition. You use a SetPropertyAction effect within a transition definition to control when the view state change defined by a `SetProperty` property occurs during the transition.

MXML Syntax Show MXML Syntax
Hide MXML Syntax

The `<mx:SetPropertyAction>` tag inherits all of the tag attributes of its superclass, and adds the following tag attributes:

      <mx:SetPropertyAction
        Properties
        id="ID"
        name=""
        value=""
      />

View the examples

See also

mx.effects.effectClasses.SetPropertyActionInstance
mx.states.SetProperty

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | className : String [read-only] The name of the effect class, such as "Fade". | Effect
|  | customFilter : EffectTargetFilter Specifies a custom filter object, of type EffectTargetFilter, used by the effect to determine the targets on which to play the effect. | Effect
|  | effectTargetHost : IEffectTargetHost A property that lets you access the target list-based control of a data effect. | Effect
|  | filter : String Specifies an algorithm for filtering targets for an effect. | Effect
|  | hideFocusRing : Boolean Determines whether the effect should hide the focus ring when starting the effect. | Effect
|  | instanceClass : Class An object of type Class that specifies the effect instance class class for this effect class. | Effect
|  | isPlaying : Boolean [read-only] A read-only flag which is true if any instances of the effect are currently playing, and false if none are. | Effect
|  | name : String The name of the property being changed. | SetPropertyAction
|  | perElementOffset : Number Additional delay, in milliseconds, for effect targets after the first target of the effect. | Effect
|  | playheadTime : Number Current time position of the effect. | Effect
|  | relevantProperties : Array An Array of property names to use when performing filtering. | Effect
|  | relevantStyles : Array An Array of style names to use when performing filtering. | Effect
|  | repeatCount : int = 1 Number of times to repeat the effect. | Effect
|  | repeatDelay : int = 0 Amount of time, in milliseconds, to wait before repeating the effect. | Effect
|  | startDelay : int = 0 Amount of time, in milliseconds, to wait before starting the effect. | Effect
|  | suspendBackgroundProcessing : Boolean = false If true, blocks all background processing while the effect is playing. | Effect
|  | target : Object The object to which this effect is applied. | Effect
|  | targets : Array An Array of objects that are targets for the effect. | Effect
|  | triggerEvent : Event The Event object passed to this Effect by the EffectManager when an effect is triggered, or null if the effect is not being played by the EffectManager. | Effect
|  | value : * The new value for the property. | SetPropertyAction

Protected Properties
Hide Inherited Protected Properties
Show Inherited Protected Properties

| Property | Defined By
--- | --- | ---
|  | applyTransitionEndProperties : Boolean This flag controls whether the effect, when run in a transition, automatically applies the property values according to the end state, as opposed to leaving values as set by the effect itself. | Effect
|  | endValuesCaptured : Boolean = false A flag containing true if the end values of an effect have already been determined, or false if they should be acquired from the current properties of the effect targets when the effect runs. | Effect

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | SetPropertyAction(target:Object = null) Constructor. | SetPropertyAction
|  | captureEndValues():void Captures the current values of the relevant properties on the effect's targets and saves them as end values. | Effect
|  | captureMoreStartValues(targets:Array):void Captures the current values of the relevant properties of an additional set of targets Flex uses this function when a data change effect is run. | Effect
|  | captureStartValues():void Captures the current values of the relevant properties on the effect's targets. | Effect
|  | createInstance(target:Object = null):IEffectInstance Creates a single effect instance and initializes it. | Effect
|  | createInstances(targets:Array = null):Array Takes an Array of target objects and invokes the createInstance() method on each target. | Effect
|  | deleteInstance(instance:IEffectInstance):void Removes event listeners from an instance and removes it from the list of instances. | Effect
|  | end(effectInstance:IEffectInstance = null):void Interrupts an effect that is currently playing, and jumps immediately to the end of the effect. | Effect
|  | getAffectedProperties():Array Returns an Array of Strings, where each String is the name of a property changed by this effect. | Effect
|  | pause():void Pauses the effect until you call the resume() method. | Effect
|  | play(targets:Array = null, playReversedFromEnd:Boolean = false):Array Begins playing the effect. | Effect
|  | resume():void Resumes the effect after it has been paused by a call to the pause() method. | Effect
|  | reverse():void Plays the effect in reverse, if the effect is currently playing, starting from the current position of the effect. | Effect
|  | stop():void Stops the effect, leaving the effect targets in their current state. | Effect

Protected Methods
Show Inherited Protected Methods
Show Inherited Protected Methods

| Method | Defined By
--- | --- | ---
|  | applyValueToTarget(target:Object, property:String, value:*, props:Object):void Used internally by the Effect infrastructure. | Effect
|  | effectEndHandler(event:EffectEvent):void Called when an effect instance has finished playing. | Effect
|  | effectStartHandler(event:EffectEvent):void This method is called when the effect instance starts playing. | Effect
|  | effectStopHandler(event:EffectEvent):void Called when an effect instance has stopped by a call to the stop() method. | Effect
|  | filterInstance(propChanges:Array, target:Object):Boolean Determines the logic for filtering out an effect instance. | Effect
|  | getValueFromTarget(target:Object, property:String):* Called by the captureStartValues() method to get the value of a property from the target. | Effect
|  | initInstance(instance:IEffectInstance):void Copies properties of the effect to the effect instance. | Effect

Events
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | effectEnd | Dispatched when one of the effect's instances finishes playing, either when the instance finishes playing or when the effect is interrupted by a call to the end() method. | Effect
|  | effectStart | Dispatched when the effect starts playing. | Effect
|  | effectStop | Dispatched when the effect has been stopped, which only occurs when the effect is interrupted by a call to the stop() method. | Effect

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 being changed. By default, Flex determines this value from the `SetProperty` property definition in the view state definition.

value | property |

`public var value:*`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The new value for the property. By default, Flex determines this value from the `SetProperty` property definition in the view state definition.

Constructor Detail

SetPropertyAction | () | Constructor

`public function SetPropertyAction(target:Object = 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 to animate with this effect.

Examples
TransitionExample.mxml

    <?xml version="1.0" ?>
    <!--

      Licensed to the Apache Software Foundation (ASF) under one or more
      contributor license agreements.  See the NOTICE file distributed with
      this work for additional information regarding copyright ownership.
      The ASF licenses this file to You under the Apache License, Version 2.0
      (the "License"); you may not use this file except in compliance with
      the License.  You may obtain a copy of the License at

          http://www.apache.org/licenses/LICENSE-2.0

      Unless required by applicable law or agreed to in writing, software
      distributed under the License is distributed on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      See the License for the specific language governing permissions and
      limitations under the License.

    -->
    <!-- Simple example to demonstrate the Transition class. -->
    <s:Application xmlns:fx="http://ns.adobe.com/mxml/2009"
        xmlns:s="library://ns.adobe.com/flex/spark"
        xmlns:mx="library://ns.adobe.com/flex/mx" currentState="Login">

        <!-- Define the view states -->
        <s:states>
            <s:State name="Login" />
            <s:State name="Register" />
        </s:states>

        <s:transitions>
            <!-- Define the transition from the base state to the Register state.-->
            <s:Transition id="toRegister" fromState="*" toState="Register">
                <s:Sequence targets="{[loginPanel, registerLink, confirm, loginLink]}">
                    <s:RemoveAction />
                    <s:Fade />
                    <s:SetAction target="{loginPanel}" property="title" />
                    <s:SetAction target="{loginButton}" property="label" />
                    <s:SetAction target="{loginButton}" property="color" />
                    <s:Resize target="{loginPanel}"/>
                    <s:AddAction />
                    <s:Fade />
                </s:Sequence>
            </s:Transition>

            <!-- Define the transition from the Register state to the base state.-->
            <s:Transition id="toDefault" fromState="Register" toState="*">
                <s:Sequence targets="{[loginPanel, registerLink,
                        confirm, loginLink]}">
                    <s:RemoveAction/>
                    <s:SetAction target="{loginPanel}" property="title"/>
                    <s:SetAction  target="{loginButton}" property="label"/>
                    <s:SetAction target="{loginButton}" property="color"/>
                    <s:Resize target="{loginPanel}"/>
                    <s:AddAction/>
                </s:Sequence>
            </s:Transition>
        </s:transitions>

        <!-- Define a Panel container that defines the login form. The title of the Panel
             changes depending on the state. -->
        <s:Panel title="Login" title.Register="Register" id="loginPanel"
                width="75%" horizontalCenter="0" verticalCenter="0">
        <s:controlBarLayout >
            <s:BasicLayout />
        </s:controlBarLayout>
        <s:layout>
            <s:VerticalLayout paddingTop="10" paddingBottom="10" paddingRight="10" paddingLeft="10" />
        </s:layout>
            <s:Label color="blue" width="100%"
                text="Click the 'Need to Register?' link to change state. Click the 'Return to Login' link to return to the base state."/>

            <!-- The following form has  two TextInputs in the Login state and three TextInputs
                 in the Register state. -->
            <s:Form id="loginForm" >
                <s:FormItem label="Username:">
                    <s:TextInput/>
                </s:FormItem>
                <s:FormItem label="Password:">
                    <s:TextInput/>
                </s:FormItem>
                <s:FormItem id="confirm" label="Confirm:" includeIn="Register" includeInLayout="false" includeInLayout.Register="true">
                    <s:TextInput/>
                </s:FormItem>
            </s:Form>

            <!-- The controlBar includes two visible items in each state. Which LinkButton is visible is determined
                 by the state -->
            <s:controlBarContent>
                <mx:LinkButton id="registerLink"  label="Need to Register?" top="10" bottom="10"
                    click="currentState='Register'" left="10" includeIn="Login" />
                <mx:LinkButton id="loginLink" label="Return to Login" click="currentState=''" includeIn="Register" left="10"  top="10" bottom="10"/>
                <s:Button label="Login" label.Register="Register" id="loginButton" right="10" color.Register="0x0000FF"  top="10" bottom="10"/>
            </s:controlBarContent>
        </s:Panel>
    </s:Application>

Sun Mar 5 2017, 03:42 PM +11:00