class openfl.events.FocusEvent extends Event

Available on all platforms

An object dispatches a FocusEvent object when the user changes the focus from one object in the display list to another. There are four types of focus events:

  • FocusEvent.FOCUSIN
  • FocusEvent.FOCUSOUT
  • FocusEvent.KEYFOCUSCHANGE
  • FocusEvent.MOUSEFOCUSCHANGE

Class Fields

static var FOCUS_IN:String

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

This event has the following properties:

static var FOCUS_OUT:String

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

This event has the following properties:

static var KEY_FOCUS_CHANGE:String

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

This event has the following properties:

static var MOUSE_FOCUS_CHANGE:String

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

This event has the following properties:

Instance Fields

var keyCode:Int

The key code value of the key pressed to trigger a keyFocusChange event.

var relatedObject:InteractiveObject

A reference to the complementary InteractiveObject instance that is affected by the change in focus. For example, when a focusOut event occurs, the relatedObject represents the InteractiveObject instance that has gained focus.

The value of this property can be null in two circumstances: if there no related object, or there is a related object, but it is in a security sandbox to which you don't have access. Use the isRelatedObjectInaccessible() property to determine which of these reasons applies.

var shiftKey:Bool

Indicates whether the Shift key modifier is activated, in which case the value is true. Otherwise, the value is false. This property is used only if the FocusEvent is of type keyFocusChange.

function new(type:String, ?bubbles:Bool = false, ?cancelable:Bool = false, ?relatedObject:InteractiveObject = null, ?shiftKey:Bool = false, ?keyCode:Int = 0):Void

Creates an Event object with specific information relevant to focus events. Event objects are passed as parameters to event listeners.

type

The type of the event. Possible values are: FocusEvent.FOCUSIN, FocusEvent.FOCUSOUT, FocusEvent.KEYFOCUSCHANGE, and FocusEvent.MOUSEFOCUSCHANGE.

bubbles

Determines whether the Event object participates in the bubbling stage of the event flow.

cancelable

Determines whether the Event object can be canceled.

relatedObject

Indicates the complementary InteractiveObject instance that is affected by the change in focus. For example, when a focusIn event occurs, relatedObject represents the InteractiveObject that has lost focus.

shiftKey

Indicates whether the Shift key modifier is activated.

keyCode

Indicates the code of the key pressed to trigger a keyFocusChange event.

function clone():Event

function toString():String