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

Package | mx.events
Class | public class StyleEvent
Inheritance | StyleEvent flash.events.ProgressEvent

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The StyleEvent class represents an event object used by the StyleManager class when a style SWF is being downloaded.

See also

mx.styles.StyleManager

Public Properties

| Property | Defined By
--- | --- | ---
|  | errorText : String The error message if the type is ERROR; otherwise, it is null. | StyleEvent

Public Methods

| Method | Defined By
--- | --- | ---
|  | StyleEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, bytesLoaded:uint = 0, bytesTotal:uint = 0, errorText:String = null) Constructor. | StyleEvent

Public Constants

| Constant | Defined By
--- | --- | ---
|  | COMPLETE : String = complete [static] Dispatched when the style SWF has finished downloading. | StyleEvent
|  | ERROR : String = error [static] Dispatched when there is an error downloading the style SWF. | StyleEvent
|  | PROGRESS : String = progress [static] Dispatched when the style SWF is downloading. | StyleEvent

Property Detail

errorText | property

`public var errorText:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The error message if the `type` is `ERROR`; otherwise, it is `null`.

Constructor Detail

StyleEvent | () | Constructor

`public function StyleEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, bytesLoaded:uint = 0, bytesTotal:uint = 0, errorText:String = null)`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Constructor.

Parameters

| `type:String` — The type of the event. Possible values are: "progress" (`StyleEvent.PROGRESS`); "complete" (`StyleEvent.COMPLETE`); "error" (`StyleEvent.ERROR`);
| `bubbles:Boolean` (default = `false`)`` — Determines whether the Event object participates in the bubbling stage of the event flow.
| `cancelable:Boolean` (default = `false`)`` — Determines whether the Event object can be cancelled.
| `bytesLoaded:uint` (default = `0`)`` — The number of bytes loaded at the time the listener processes the event.
| `bytesTotal:uint` (default = `0`)`` — The total number of bytes that will ultimately be loaded if the loading process succeeds.
| `errorText:String` (default = `null`)`` — The error message of the error when type is StyleEvent.ERROR.

Constant Detail

COMPLETE | Constant

`public static const COMPLETE:String = complete`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Dispatched when the style SWF has finished downloading. The `StyleEvent.COMPLETE` constant defines the value of the `type` property of the event object for a `styleComplete` event.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`currentTarget` | The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`errorText` | Empty
`target` | The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.

ERROR | Constant |

`public static const ERROR:String = error`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Dispatched when there is an error downloading the style SWF. The `StyleEvent.ERROR` constant defines the value of the `type` property of the event object for a `styleError` event.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`bytesLoaded` | Empty
`bytesTotal` | Empty
`cancelable` | false
`currentTarget` | The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`errorText` |
`target` | The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.

PROGRESS | Constant |

`public static const PROGRESS:String = progress`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Dispatched when the style SWF is downloading. The `StyleEvent.PROGRESS` constant defines the value of the `type` property of the event object for a `styleProgress` event.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`bytesLoaded` | The number of bytes loaded.
`bytesTotal` | The total number of bytes to load.
`cancelable` | false
`currentTarget` | The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`errorText` |
`target` | The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.

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