Package | flashx.textLayout.events |
Class | public class DamageEvent |
Inheritance | DamageEvent ![]() ![]() |
Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
See also
Property | Defined By | ||
---|---|---|---|
![]() | bubbles : Boolean [read-only]
Indicates whether an event is a bubbling event. | Event | |
![]() | cancelable : Boolean [read-only]
Indicates whether the behavior associated with the event can be prevented. | Event | |
![]() | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
![]() | currentTarget : Object [read-only]
The object that is actively processing the Event object with an event listener. | Event | |
damageAbsoluteStart : int [read-only]
Absolute start of the damage
| DamageEvent | ||
damageLength : int [read-only]
Length of the damage
| DamageEvent | ||
![]() | eventPhase : uint [read-only]
The current phase in the event flow. | Event | |
![]() | prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | |
![]() | target : Object [read-only]
The event target. | Event | |
textFlow : flashx.textLayout.elements:TextFlow [read-only]
TextFlow owning the damage
| DamageEvent | ||
![]() | type : String [read-only]
The type of event. | Event |
Method | Defined By | ||
---|---|---|---|
DamageEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, textFlow:flashx.textLayout.elements:TextFlow = null, damageAbsoluteStart:int = 0, damageLength:int = 0) Constructor
| DamageEvent | ||
![]() |
Duplicates an instance of an Event subclass. | Event | |
![]() |
A utility function for implementing the toString() method in custom
ActionScript 3.0 Event classes. | Event | |
![]() |
Indicates whether an object has a specified property defined. | Object | |
![]() |
Checks whether the preventDefault() method has been called on the event. | Event | |
![]() |
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
![]() |
Cancels an event's default behavior if that behavior can be canceled. | Event | |
![]() |
Indicates whether the specified property exists and is enumerable. | Object | |
![]() |
Sets the availability of a dynamic property for loop operations. | Object | |
![]() |
Prevents processing of any event listeners in the current node and any subsequent nodes in
the event flow. | Event | |
![]() |
Prevents processing of any event listeners in nodes subsequent to the current node in the
event flow. | Event | |
![]() |
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
![]() |
Returns a string containing all the properties of the Event object. | Event | |
![]() |
Returns the primitive value of the specified object. | Object |
Constant | Defined By | ||
---|---|---|---|
![]() | ACTIVATE : String = "activate" [static]
The ACTIVATE constant defines the value of the type property of an activate event object. | Event | |
![]() | ADDED : String = "added" [static]
The Event.ADDED constant defines the value of the type property of
an added event object. | Event | |
![]() | ADDED_TO_STAGE : String = "addedToStage" [static]
The Event.ADDED_TO_STAGE constant defines the value of the type
property of an addedToStage event object. | Event | |
![]() | CANCEL : String = "cancel" [static]
The Event.CANCEL constant defines the value of the type property of a cancel event object. | Event | |
![]() | CHANGE : String = "change" [static]
The Event.CHANGE constant defines the value of the type property of a change event object. | Event | |
![]() | CLEAR : String = "clear" [static]
The Event.CLEAR constant efines the value of the type property
of a clear event object. | Event | |
![]() | CLOSE : String = "close" [static]
The Event.CLOSE constant defines the value of the type property of a close event object. | Event | |
![]() | ![]() [static]
The Event.CLOSING constant defines the value of the
type property of a closing event object. | Event | |
![]() | COMPLETE : String = "complete" [static]
The Event.COMPLETE constant defines the value of the type property of a complete event object. | Event | |
![]() | CONNECT : String = "connect" [static]
The Event.CONNECT constant defines the value of the type property of a connect event object. | Event | |
![]() | COPY : String = "copy" [static]
Defines the value of the type property of a copy event object. | Event | |
![]() | CUT : String = "cut" [static]
Defines the value of the type property of a cut event object. | Event | |
DAMAGE : String = "damage" [static] Event type for DamageEvent | DamageEvent | ||
![]() | DEACTIVATE : String = "deactivate" [static]
The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object. | Event | |
![]() | DISPLAYING : String = "displaying" [static]
The Event.DISPLAYING constant defines the value of the type property of a displaying event object. | Event | |
![]() | ENTER_FRAME : String = "enterFrame" [static]
The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object. | Event | |
![]() | EXIT_FRAME : String = "exitFrame" [static]
The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object. | Event | |
![]() | ![]() [static]
The Event.EXITING constant defines the value of the type property of an exiting event object. | Event | |
![]() | FRAME_CONSTRUCTED : String = "frameConstructed" [static]
The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object. | Event | |
![]() | FULLSCREEN : String = "fullScreen" [static]
The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object. | Event | |
![]() | ![]() [static]
The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object. | Event | |
![]() | ![]() [static]
The Event.HTML_DOM_INITIALIZE constant defines the value of the type property
of an htmlDOMInitialize event object. | Event | |
![]() | ![]() [static]
The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object. | Event | |
![]() | ID3 : String = "id3" [static]
The Event.ID3 constant defines the value of the type property of an id3 event object. | Event | |
![]() | INIT : String = "init" [static]
The Event.INIT constant defines the value of the type property of an init event object. | Event | |
![]() | ![]() [static]
The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object. | Event | |
![]() | MOUSE_LEAVE : String = "mouseLeave" [static]
The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object. | Event | |
![]() | ![]() [static]
The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object. | Event | |
![]() | OPEN : String = "open" [static]
The Event.OPEN constant defines the value of the type property of an open event object. | Event | |
![]() | PASTE : String = "paste" [static]
The Event.PASTE constant defines the value of the type property of a paste event object. | Event | |
![]() | REMOVED : String = "removed" [static]
The Event.REMOVED constant defines the value of the type property of
a removed event object. | Event | |
![]() | REMOVED_FROM_STAGE : String = "removedFromStage" [static]
The Event.REMOVED_FROM_STAGE constant defines the value of the type
property of a removedFromStage event object. | Event | |
![]() | RENDER : String = "render" [static]
The Event.RENDER constant defines the value of the type property of a render event object. | Event | |
![]() | RESIZE : String = "resize" [static]
The Event.RESIZE constant defines the value of the type property of a resize event object. | Event | |
![]() | SCROLL : String = "scroll" [static]
The Event.SCROLL constant defines the value of the type property of a scroll event object. | Event | |
![]() | SELECT : String = "select" [static]
The Event.SELECT constant defines the value of the type property of a select event object. | Event | |
![]() | SELECT_ALL : String = "selectAll" [static]
The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object. | Event | |
![]() | SOUND_COMPLETE : String = "soundComplete" [static]
The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object. | Event | |
![]() | TAB_CHILDREN_CHANGE : String = "tabChildrenChange" [static]
The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object. | Event | |
![]() | TAB_ENABLED_CHANGE : String = "tabEnabledChange" [static]
The Event.TAB_ENABLED_CHANGE constant defines the value of the type
property of a tabEnabledChange event object. | Event | |
![]() | TAB_INDEX_CHANGE : String = "tabIndexChange" [static]
The Event.TAB_INDEX_CHANGE constant defines the value of the
type property of a tabIndexChange event object. | Event | |
![]() | UNLOAD : String = "unload" [static]
The Event.UNLOAD constant defines the value of the type property of an unload event object. | Event | |
![]() | ![]() [static]
The Event.USER_IDLE constant defines the value of the type property of a userIdle event object. | Event | |
![]() | ![]() [static]
The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object. | Event |
damageAbsoluteStart | property |
damageAbsoluteStart:int
[read-only] Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
Absolute start of the damage
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
public function get damageLength():int
textFlow | property |
textFlow:flashx.textLayout.elements:TextFlow
[read-only] Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
TextFlow owning the damage
public function get textFlow():flashx.textLayout.elements:TextFlow
DamageEvent | () | Constructor |
public function DamageEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, textFlow:flashx.textLayout.elements:TextFlow = null, damageAbsoluteStart:int = 0, damageLength:int = 0)
Language Version: | ActionScript 3.0 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
Constructor
Parameterstype:String — text index of the start of the damage
| |
bubbles:Boolean (default = false ) — length of text that was damaged
| |
cancelable:Boolean (default = false )
| |
textFlow:flashx.textLayout.elements:TextFlow (default = null )
| |
damageAbsoluteStart:int (default = 0 )
| |
damageLength:int (default = 0 )
|
DAMAGE | Constant |
public static const DAMAGE:String = "damage"
Event type for DamageEvent
The call to addEventListener()
is made to the TextFlow instance.
You can use simple strings, such as "damage"
and "updateComplete"
,
but it is safer to use static constants, such as DamageEvent.DAMAGE
and UpdateCompleteEvent.UPDATE_COMPLETE
.
package { import flash.display.Sprite; import flashx.textLayout.container.ContainerController; import flashx.textLayout.conversion.ConversionType; import flashx.textLayout.conversion.TextConverter; import flashx.textLayout.edit.EditManager; import flashx.textLayout.elements.TextFlow; import flashx.textLayout.events.DamageEvent; import flashx.textLayout.events.UpdateCompleteEvent; public class DamageEvent_example extends Sprite { private var textFlow:TextFlow; private var text:String = "Text example"; // In this example, the DamageEvent is used to mark when the text in the TextFlow has been changed, // so that a simple binding can be implemented that is optimized so that the binding is only updated // when the text is updated. public function DamageEvent_example() { textFlow = TextConverter.importToFlow(text, TextConverter.PLAIN_TEXT_FORMAT); textFlow.flowComposer.addController(new ContainerController(this, 200, 200)); textFlow.interactionManager = new EditManager(); textFlow.flowComposer.updateAllControllers(); textFlow.addEventListener(DamageEvent.DAMAGE, damageHandler); textFlow.addEventListener(UpdateCompleteEvent.UPDATE_COMPLETE, updateHandler); // ... user clicks on the TextFlow and starts typing ... } private function updateHandler(event:UpdateCompleteEvent):void { if (text == null) text = TextConverter.export(textFlow, TextConverter.PLAIN_TEXT_FORMAT, ConversionType.STRING_TYPE) as String; trace(text); // result: same as what's in the TextFlow } private function damageHandler(event:DamageEvent):void { text = null; } } }