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

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

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

A TextFlow instance dispatches this each time it is marked as damaged. Damage can be caused by changes to the model or changes to the layout.

See also

flashx.textLayout.elements.TextFlow

Public Properties

| Property | Defined By
--- | --- | ---
|  | damageAbsoluteStart : int [read-only] Absolute start of the damage | DamageEvent
|  | damageLength : int [read-only] Length of the damage | DamageEvent
|  | textFlow : TextFlow [read-only] TextFlow owning the damage | DamageEvent

Public Methods

| Method | Defined By
--- | --- | ---
|  | DamageEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, textFlow:TextFlow = null, damageAbsoluteStart:int = 0, damageLength:int = 0) Constructor | DamageEvent

Public Constants

| Constant | Defined By
--- | --- | ---
|  | DAMAGE : String = damage [static] Event type for DamageEvent | DamageEvent

Property Detail

damageAbsoluteStart | property

`damageAbsoluteStart:int` [read-only]

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

Absolute start of the damage

Implementation
`public function get damageAbsoluteStart():int`

damageLength | property |

`damageLength:int` [read-only]

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

Length of the damage

Implementation
`public function get damageLength():int`

textFlow | property |

`textFlow:TextFlow` [read-only]

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

TextFlow owning the damage

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

DamageEvent | () | Constructor

`public function DamageEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, textFlow:TextFlow = null, damageAbsoluteStart:int = 0, damageLength:int = 0)`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

Constructor

Parameters

| `type:String` — text index of the start of the damage
| `bubbles:Boolean` (default = `false`)`` — length of text that was damaged
| `cancelable:Boolean` (default = `false`)``
| `textFlow:TextFlow` (default = `null`)``
| `damageAbsoluteStart:int` (default = `0`)``
| `damageLength:int` (default = `0`)``

Constant Detail

DAMAGE | Constant

`public static const DAMAGE:String = damage`

Event type for DamageEvent

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