| //////////////////////////////////////////////////////////////////////////////// |
| // |
| // 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. |
| // |
| //////////////////////////////////////////////////////////////////////////////// |
| |
| package mx.effects |
| { |
| |
| import mx.core.mx_internal; |
| import mx.effects.effectClasses.DissolveInstance; |
| import mx.geom.RoundedRectangle; |
| import mx.styles.StyleManager; |
| |
| use namespace mx_internal; |
| |
| /** |
| * Animate the component from transparent to opaque, |
| * or from opaque to transparent. |
| * When the Dissolve effect is played, it does the following: |
| * |
| * <ol> |
| * <li>When the effect begins, it creates an opaque rectangle. |
| * The rectangle floats above the target component, |
| * its color matches the <code>Dissolve.color</code> property, |
| * and its <code>alpha</code> property is initially set to |
| * (1.0 - <code>Dissolve.alphaFrom</code>).</li> |
| * <li>As the effect plays, the <code>alpha</code> property |
| * of the rectangle animates from (1.0 - <code>alphaFrom</code>) |
| * to (1.0 - <code>alphaTo</code>). |
| * As the rectangle becomes more and more opaque, |
| * the content underneath it gradually disappears.</li> |
| * <li>When the effect finishes, the rectangle is destroyed.</li> |
| * </ol> |
| * |
| * <p>When the target object is a Container, the Dissolve effect |
| * applies to the content area inside the container. |
| * The content area is the region where the container's |
| * background color is visible.</p> |
| * |
| * <p><b>Note</b>: To use the Dissolve effect with the |
| * <code>creationCompleteEffect</code> trigger of a DataGrid control, |
| * you must define the data provider of the control inline |
| * using a child tag of the DataGrid control, or using data binding. |
| * This issue is a result of the data provider not being set until the |
| * <code>creationComplete</code> event is dispatched. |
| * Therefore, when the effect starts playing, Flex has not completed |
| * the sizing of the DataGrid control. </p> |
| * |
| * @mxml |
| * |
| * <p>The <code><mx:Dissolve></code> tag |
| * inherits the tag attributes of its superclass, |
| * and adds the following tag attributes:</p> |
| * |
| * <pre> |
| * <mx:Dissolve |
| * id="ID" |
| * alphaFrom="val" |
| * alphaTo="val" |
| * color="val" |
| * /> |
| * </pre> |
| * |
| * @see mx.effects.effectClasses.DissolveInstance |
| * @see mx.effects.Tween |
| * @see mx.effects.TweenEffect |
| * |
| * @includeExample examples/DissolveEffectExample.mxml |
| * |
| * @langversion 3.0 |
| * @playerversion Flash 9 |
| * @playerversion AIR 1.1 |
| * @productversion Flex 3 |
| */ |
| public class Dissolve extends TweenEffect |
| { |
| include "../core/Version.as"; |
| |
| //-------------------------------------------------------------------------- |
| // |
| // Class constants |
| // |
| //-------------------------------------------------------------------------- |
| |
| /** |
| * @private |
| */ |
| private static var AFFECTED_PROPERTIES:Array = [ "visible" ]; |
| |
| //-------------------------------------------------------------------------- |
| // |
| // Constructor |
| // |
| //-------------------------------------------------------------------------- |
| |
| /** |
| * Constructor. |
| * |
| * @param target The Object to animate with this effect. |
| * |
| * @langversion 3.0 |
| * @playerversion Flash 9 |
| * @playerversion AIR 1.1 |
| * @productversion Flex 3 |
| */ |
| public function Dissolve(target:Object = null) |
| { |
| super(target); |
| |
| instanceClass = DissolveInstance; |
| relevantProperties = [ "visible", "alpha" ]; |
| } |
| |
| //-------------------------------------------------------------------------- |
| // |
| // Properties |
| // |
| //-------------------------------------------------------------------------- |
| |
| //---------------------------------- |
| // alphaFrom |
| //---------------------------------- |
| |
| [Inspectable(category="General", defaultValue="NaN")] |
| |
| /** |
| * Initial transparency level between 0.0 and 1.0, |
| * where 0.0 means transparent and 1.0 means fully opaque. |
| * |
| * <p>If the effect causes the target component to disappear, the default |
| * value is the current value of the target's <code>alpha</code> property. |
| * If the effect causes the target component to appear, the default |
| * value is 0.0.</p> |
| * |
| * @langversion 3.0 |
| * @playerversion Flash 9 |
| * @playerversion AIR 1.1 |
| * @productversion Flex 3 |
| */ |
| public var alphaFrom:Number; |
| |
| //---------------------------------- |
| // alphaTo |
| //---------------------------------- |
| |
| [Inspectable(category="General", defaultValue="NaN")] |
| |
| /** |
| * Final transparency level between 0.0 and 1.0, |
| * where 0.0 means transparent and 1.0 means fully opaque. |
| * |
| * <p>If the effect causes the target component to disappear, the default |
| * value is 0.0. |
| * If the effect causes the target component to appear, the default |
| * value is the current value of the target's <code>alpha</code> property.</p> |
| * |
| * @langversion 3.0 |
| * @playerversion Flash 9 |
| * @playerversion AIR 1.1 |
| * @productversion Flex 3 |
| */ |
| public var alphaTo:Number; |
| |
| //---------------------------------- |
| // color |
| //---------------------------------- |
| |
| [Inspectable(category="General", format="Color", defaultValue="0xFFFFFFFF")] |
| |
| /** |
| * Hex value that represents the color of the floating rectangle |
| * that the effect displays over the target object. |
| * |
| * The default value is the color specified by the target component's |
| * <code>backgroundColor</code> style property, or 0xFFFFFF, if |
| * <code>backgroundColor</code> is not set. |
| * |
| * @langversion 3.0 |
| * @playerversion Flash 9 |
| * @playerversion AIR 1.1 |
| * @productversion Flex 3 |
| */ |
| public var color:uint = StyleManager.NOT_A_COLOR; |
| |
| //---------------------------------- |
| // persistAfterEnd |
| //---------------------------------- |
| |
| [Inspectable(category="General", format="Boolean", defaultValue="false")] |
| |
| /** |
| * Flag indicating whether the floating rectangle is removed automatically |
| * when the effect finishes. If false, it is removed. |
| * |
| * @default true |
| * |
| * @langversion 3.0 |
| * @playerversion Flash 9 |
| * @playerversion AIR 1.1 |
| * @productversion Flex 3 |
| */ |
| mx_internal var persistAfterEnd:Boolean = false; |
| |
| //---------------------------------- |
| // targetArea |
| //---------------------------------- |
| |
| /** |
| * The area of the target to play the effect upon. |
| * The dissolve overlay is drawn using this property's dimensions. |
| * UIComponents create an overlay over the entire component. |
| * Containers create an overlay over their content area, |
| * but not their chrome. |
| * |
| * @default null |
| * |
| * @langversion 3.0 |
| * @playerversion Flash 9 |
| * @playerversion AIR 1.1 |
| * @productversion Flex 3 |
| */ |
| public var targetArea:RoundedRectangle; |
| |
| //-------------------------------------------------------------------------- |
| // |
| // Overridden methods |
| // |
| //-------------------------------------------------------------------------- |
| |
| /** |
| * @private |
| */ |
| override public function getAffectedProperties():Array /* of String */ |
| { |
| return AFFECTED_PROPERTIES; |
| } |
| |
| /** |
| * @private |
| */ |
| override protected function initInstance(instance:IEffectInstance):void |
| { |
| super.initInstance(instance); |
| |
| var dissolveInstance:DissolveInstance = DissolveInstance(instance); |
| |
| dissolveInstance.alphaFrom = alphaFrom; |
| dissolveInstance.alphaTo = alphaTo; |
| dissolveInstance.color = color; |
| dissolveInstance.persistAfterEnd = persistAfterEnd; |
| dissolveInstance.targetArea = targetArea; |
| } |
| } |
| |
| } |
