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

Package | flashx.textLayout.events
Class | public class StatusChangeEvent
Inheritance | StatusChangeEvent flash.events.Event

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

A TextFlow instance dispatches this event when the status of a FlowElement changes. This event can be used to detect when an inline graphic element has completed loading. You can use your event handler to recompose the text flow based on the presence of the newly loaded inline graphic element.

Public Properties

| Property | Defined By
--- | --- | ---
|  | element : FlowElement The FlowElement instance that has experienced a change in status. | StatusChangeEvent
|  | errorEvent : ErrorEvent The ErrorEvent object that was dispatched as a result of the status change. | StatusChangeEvent
|  | status : String The FlowElement's new status. | StatusChangeEvent

Public Methods

| Method | Defined By
--- | --- | ---
|  | StatusChangeEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, element:FlowElement = null, status:String = null, errorEvent:ErrorEvent = null) Creates an event object that contains information about a status change. | StatusChangeEvent

Public Constants

| Constant | Defined By
--- | --- | ---
|  | INLINE_GRAPHIC_STATUS_CHANGE : String = inlineGraphicStatusChange [static] Defines the value of the type property of a inlineGraphicStatusChanged event object. | StatusChangeEvent

Property Detail

element | property

`element:FlowElement`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

The FlowElement instance that has experienced a change in status.

Implementation
`public function get element():FlowElement`
`public function set element(value:FlowElement):void`

See also

flashx.textLayout.elements.FlowElement

errorEvent | property |

`errorEvent:ErrorEvent`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

The ErrorEvent object that was dispatched as a result of the status change.

Implementation
`public function get errorEvent():ErrorEvent`
`public function set errorEvent(value:ErrorEvent):void`

See also

flash.events.ErrorEvent

status | property |

`status:String`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

The FlowElement's new status. The possible values of this property are defined by the InlineGraphicElementStatus class. There are five static constants available in the InlineGraphicElementStatus class:

- ERROR : String = "error". An error occurred during loading of a referenced graphic.
- LOADING : String = "loading". Load has been initiated (but not completed) on a graphic element that is a URL.
- LOAD_PENDING : String = "loadPending". Graphic element is an URL that has not been loaded.
- READY : String = "ready". Graphic is completely loaded and properly sized.
- SIZE_PENDING : String = "sizePending". Graphic element with auto or percentage width/height has completed loading but has not been recomposed.

Implementation
`public function get status():String`
`public function set status(value:String):void`

See also

flashx.textLayout.elements.InlineGraphicElementStatus
Constructor Detail

StatusChangeEvent | () | Constructor

`public function StatusChangeEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, element:FlowElement = null, status:String = null, errorEvent:ErrorEvent = null)`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

Creates an event object that contains information about a status change.

Parameters

| `type:String` — The type of the event. Event listeners can access this information through the inherited `type` property. There is only one type of StatusChangeEvent: `StatusChangeEvent.INLINE_GRAPHIC_STATUS_CHANGE`;
| `bubbles:Boolean` (default = `false`)`` — Indicates whether an event is a bubbling event.This event does not bubble.
| `cancelable:Boolean` (default = `false`)`` — Indicates whether the behavior associated with the event can be prevented. This event cannot be cancelled.
| `element:FlowElement` (default = `null`)`` — The FlowElement instance that has experienced a change in status.
| `status:String` (default = `null`)`` — The FlowElement instance's new status.
| `errorEvent:ErrorEvent` (default = `null`)`` — The ErrorEvent object, if any, associated with the status.

Constant Detail

INLINE_GRAPHIC_STATUS_CHANGE | Constant

`public static const INLINE_GRAPHIC_STATUS_CHANGE:String = inlineGraphicStatusChange`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

Defines the value of the `type` property of a `inlineGraphicStatusChanged` event object.

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