qnx.events.TextCaretChangedEvent

TextCaretChangedEvent

Properties | Methods | Constants


Packageqnx.events
Classpublic class TextCaretChangedEvent
InheritanceTextCaretChangedEvent Inheritance flash.events.Event

A QNXStageWebView object dispatches a TextCaretChangedEvent object when the text input position (caret) on the web page changes position.

There is only one type of TextCaretChangedEvent:

  • TextCaretChangedEvent.TEXT_CARET_CHANGED: dispatched after caret changes. Cannot be cancelled.


Class information:
BlackBerry 10 Version:   10.0.0

See also

QNXStageWebView



Public Properties

 PropertyDefined By
  caretRect : Rectangle
The rectangle that indicates the new caret position
TextCaretChangedEvent
  userTouch : Boolean
A boolean indicating whether the change was due to user touch input
TextCaretChangedEvent

Public Methods

 MethodDefined By
  
TextCaretChangedEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, caretRect:Rectangle = null, userTouch:Boolean = false)
Creates a TextCaretChangedEvent object.
TextCaretChangedEvent
  
clone():Event
[override] Duplicates an instance of an Event subclass.
TextCaretChangedEvent
  
toString():String
[override] Returns a string that contains all the properties of the TextCaretChangedEvent object.
TextCaretChangedEvent

Public Constants

 ConstantDefined By
  TEXT_CARET_CHANGED : String = textCaretChanged
[static] Dispatched when the text input position (caret) changes.
TextCaretChangedEvent

Property Detail

caretRect


caretRect:Rectangle

The rectangle that indicates the new caret position


Implementation

public function get caretRect():Rectangle
public function set caretRect(value:Rectangle):void

userTouch


userTouch:Boolean

A boolean indicating whether the change was due to user touch input


Implementation

public function get userTouch():Boolean
public function set userTouch(value:Boolean):void

Constructor Detail

TextCaretChangedEvent()


public function TextCaretChangedEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, caretRect:Rectangle = null, userTouch:Boolean = false)

Creates a TextCaretChangedEvent object.

Parameters

type:String
bubbles:Boolean (default = false)
cancelable:Boolean (default = false)
caretRect:Rectangle (default = null)
userTouch:Boolean (default = false)

Method Detail

clone()


override public function clone():Event

Duplicates an instance of an Event subclass.

Returns a new Event object that is a copy of the original instance of the Event object. You do not normally call clone(); the EventDispatcher class calls it automatically when you redispatch an event—that is, when you call dispatchEvent(event) from a handler that is handling event.

The new Event object includes all the properties of the original.

When creating your own custom Event class, you must override the inherited Event.clone() method in order for it to duplicate the properties of your custom class. If you do not set all the properties that you add in your event subclass, those properties will not have the correct values when listeners handle the redispatched event.

Returns

Event

toString()


override public function toString():String

Returns a string that contains all the properties of the TextCaretChangedEvent object. The string is in the following format:

[TextCaretChangedEvent type=value bubbles=value cancelable=value eventPhase=value caretRect=value userTouch=value

Returns

String

Constant Detail

TEXT_CARET_CHANGED


public static const TEXT_CARET_CHANGED:String = textCaretChanged

Dispatched when the text input position (caret) changes. The caretRect property of the event indicates the caret position. The userTouch property indicates whether the change was due to user touch input.





comments powered by Disqus