By default (read mode), the component alpha is set to 0 "hiding" all styles applied to
* the component (i.e. no background color, no border, etc). The component is more or less, transparent.
When the mouse hovers over the component, the alpha is changed to 0.3 making the styling
* options appear and (hopefully) letting the user know that it can be edited.
When the component gains focus, the alpha is set to 1.0 making all styling options fully
* visible (i.e. including the component background color).
When the component loses focus, its alpha is reset to 0 either immediately or by using a
* smooth fading effect if the value controlled by the component has been changed during the edition phase.
EditInPlaceEffect can be associated to any UIComponent as long as the component has a String * property providing the value for comparison.
* * EditInPlaceEffectInstance must not be used directly; it is created by EditInPlaceEffect. * * @mxml * *The <mx:EditInPlaceEffect> tag supports the following tag
* attributes:
* <mx:EditInPlaceEffect * Properties * textProperty="text" * alphaRead="0.0" * alphaFocus="0.3" * alphaEdit="1.0" * /> ** */ public class EditInPlaceEffect extends Effect { //-------------------------------------------------------------------------- // // Properties // //-------------------------------------------------------------------------- /** * Specifies property name of a String property of the monitored component. * The property value is stored when focus is gained by the monitored component; * on focus out, it is compared with the current property value and, if * different, the fading effect is triggered. * * @default text */ [Bindable] public var textProperty:String = "text"; /** * Specifies the alpha value applied to the component when it doesn't have focus and * mouse isn't hovering over it. * * @default 0.0 */ [Bindable] public var alphaRead:Number = 0.0; /** * Specifies the alpha value applied to the component when it has the focus. * * @default 1.0 */ [Bindable] public var alphaEdit:Number = 1.0; /** * Specifies the alpha value applied to the component when it doesn't have focus and * mouse is hovering over it. * * @default 0.3 */ [Bindable] public var alphaFocus:Number = 0.3; //-------------------------------------------------------------------------- // // Methods // //-------------------------------------------------------------------------- /** * Constructor * * @param target The component on which effect must be applied. */ public function EditInPlaceEffect(target:UIComponent = null) { super(target); instanceClass = EditInPlaceEffectInstance; } /** * @private */ override protected function initInstance(instance:IEffectInstance):void { super.initInstance(instance); var valueEditInPlaceEffectInstance:EditInPlaceEffectInstance = EditInPlaceEffectInstance(instance); valueEditInPlaceEffectInstance.textProperty = textProperty; valueEditInPlaceEffectInstance.alphaRead = alphaRead; valueEditInPlaceEffectInstance.alphaFocus = alphaFocus; valueEditInPlaceEffectInstance.alphaEdit = alphaEdit; // Trick: the effect execution just registers some vent handlers for // further effects. We use the defined duration for the further effects // and update our "own" duration to asap. valueEditInPlaceEffectInstance.effectDuration = duration; valueEditInPlaceEffectInstance.duration = 1; } /** * @private */ override public function deleteInstance(instance:IEffectInstance):void { if (instance is EditInPlaceEffectInstance) EditInPlaceEffectInstance(instance).dispose(); super.deleteInstance(instance); } } }