openfl/lib/openfl/events/FocusEvent.d.ts

A fast, productive library for 2D cross-platform development.

import Event from "./Event";
import InteractiveObject from "./../display/InteractiveObject";


declare namespace openfl.events {
	
	
	/**
	 * 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.FOCUS_IN`
	 *  * `FocusEvent.FOCUS_OUT`
	 *  * `FocusEvent.KEY_FOCUS_CHANGE`
	 *  * `FocusEvent.MOUSE_FOCUS_CHANGE`
	 * 
	 * 
	 */
	export class FocusEvent extends Event {
		
		
		/**
		 * Defines the value of the `type` property of a
		 * `focusIn` event object.
		 *
		 * This event has the following properties:
		 */
		public static FOCUS_IN:string;
		
		/**
		 * Defines the value of the `type` property of a
		 * `focusOut` event object.
		 *
		 * This event has the following properties:
		 */
		public static FOCUS_OUT:string;
		
		/**
		 * Defines the value of the `type` property of a
		 * `keyFocusChange` event object.
		 *
		 * This event has the following properties:
		 */
		public static KEY_FOCUS_CHANGE:string;
		
		/**
		 * Defines the value of the `type` property of a
		 * `mouseFocusChange` event object.
		 *
		 * This event has the following properties:
		 */
		public static MOUSE_FOCUS_CHANGE:string;
		
		
		// #if flash
		// @:noCompletion @:dox(hide) @:require(flash10) public var isRelatedObjectInaccessible:boolean;
		// #end
		
		/**
		 * The key code value of the key pressed to trigger a
		 * `keyFocusChange` event.
		 */
		public keyCode:number;
		
		/**
		 * 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.
		 */
		public relatedObject:InteractiveObject;
		
		/**
		 * 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`.
		 */
		public shiftKey:boolean;
		
		
		/**
		 * Creates an Event object with specific information relevant to focus
		 * events. Event objects are passed as parameters to event listeners.
		 * 
		 * @param type          The type of the event. Possible values are:
		 *                      `FocusEvent.FOCUS_IN`,
		 *                      `FocusEvent.FOCUS_OUT`,
		 *                      `FocusEvent.KEY_FOCUS_CHANGE`, and
		 *                      `FocusEvent.MOUSE_FOCUS_CHANGE`.
		 * @param bubbles       Determines whether the Event object participates in
		 *                      the bubbling stage of the event flow.
		 * @param cancelable    Determines whether the Event object can be canceled.
		 * @param 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.
		 * @param shiftKey      Indicates whether the Shift key modifier is
		 *                      activated.
		 * @param keyCode       Indicates the code of the key pressed to trigger a
		 *                      `keyFocusChange` event.
		 */
		public constructor (type:string, bubbles?:boolean, cancelable?:boolean, relatedObject?:InteractiveObject, shiftKey?:boolean, keyCode?:number);
		
		
	}
	
	
}


export default openfl.events.FocusEvent;