class openfl.events.TextEvent extends Event

Available on all platforms

An object dispatches a TextEvent object when a user enters text in a text field or clicks a hyperlink in an HTML-enabled text field. There are two types of text events: TextEvent.LINK and TextEvent.TEXT_INPUT.

Class Fields

static var LINK:String

Defines the value of the type property of a link event object.

This event has the following properties:

static var TEXT_INPUT:String

Defines the value of the type property of a textInput event object.

Note: This event is not dispatched for the Delete or Backspace keys.

This event has the following properties:

Instance Fields

var text:String

For a textInput event, the character or sequence of characters entered by the user. For a link event, the text of the event attribute of the href attribute of the tag.

function new(type:String, ?bubbles:Bool = false, ?cancelable:Bool = false, ?text:String = ''):Void

Creates an Event object that contains information about text events. Event objects are passed as parameters to event listeners.

type

The type of the event. Event listeners can access this information through the inherited type property. Possible values are: TextEvent.LINK and TextEvent.TEXT_INPUT.

bubbles

Determines whether the Event object participates in the bubbling phase of the event flow. Event listeners can access this information through the inherited bubbles property.

cancelable

Determines whether the Event object can be canceled. Event listeners can access this information through the inherited cancelable property.

text

One or more characters of text entered by the user. Event listeners can access this information through the text property.

function clone():Event

function toString():String