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

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

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

A TextFlow instance dispatches this event after any of its containers completes an update. Each text container has two states: composition and display. This event notifies you when the display phase has ended. This provides an opportunity to make any necessary changes to the container when it is ready to be displayed, but hasn't yet been painted to the screen.

See also

flashx.textLayout.elements.TextFlow

Public Properties

| Property | Defined By
--- | --- | ---
|  | controller : ContainerController The controller of the container being updated | UpdateCompleteEvent
|  | textFlow : TextFlow TextFlow which has been updated. | UpdateCompleteEvent

Public Methods

| Method | Defined By
--- | --- | ---
|  | UpdateCompleteEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, textFlow:TextFlow = null, controller:ContainerController = null) Constructor | UpdateCompleteEvent

Public Constants

| Constant | Defined By
--- | --- | ---
|  | UPDATE_COMPLETE : String = updateComplete [static] Defines the value of the type property of an UpdateCompleteEvent object | UpdateCompleteEvent

Property Detail

controller | property

`controller:ContainerController`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

The controller of the container being updated

Implementation
`public function get controller():ContainerController`
`public function set controller(value:ContainerController):void`

textFlow | property |

`textFlow:TextFlow`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

TextFlow which has been updated.

Implementation
`public function get textFlow():TextFlow`
`public function set textFlow(value:TextFlow):void`
Constructor Detail

UpdateCompleteEvent | () | Constructor

`public function UpdateCompleteEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, textFlow:TextFlow = null, controller:ContainerController = null)`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

Constructor

Parameters

| `type:String` — event type - use the static property UPDATE_COMPLETE.
| `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.
| `textFlow:TextFlow` (default = `null`)`` — The ContainerController whose container was updated
| `controller:ContainerController` (default = `null`)`` — The TextFlow which was updated

Constant Detail

UPDATE_COMPLETE | Constant

`public static const UPDATE_COMPLETE:String = updateComplete`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

Defines the value of the `type` property of an `UpdateCompleteEvent` object

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