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

Package | mx.states
Interface | public interface IOverride
Implementors | OverrideBase

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The IOverride interface is used for view state overrides. All entries in the State class `overrides` property array must implement this interface.

See also

mx.states.State

Public Methods

| Method | Defined By
--- | --- | ---
|  | apply(parent:UIComponent):void Applies the override. | IOverride
|  | initialize():void Initializes the override. | IOverride
|  | remove(parent:UIComponent):void Removes the override. | IOverride

Method Detail

apply | () | method

`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.

initialize | () | method |

`public function initialize():void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Initializes the override. Flex calls this method before the first call to the `apply()` method, so you put one-time initialization code for the override in this method.

Flex calls this method automatically when the state is entered. It should not be called directly.

remove | () | method |

`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.

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