scaffold.libs_as.feathers.core.IFocusDisplayObject.as Maven / Gradle / Ivy

Go to download

/*
Feathers
Copyright 2012-2015 Bowler Hat LLC. All Rights Reserved.

This program is free software. You can redistribute and/or modify it in
accordance with the terms of the accompanying license agreement.
*/
package feathers.core
{
	/**
	 * Dispatched when the display object receives focus.
	 *
	 * The properties of the event object have the following values:
	 * 
	 * 
	 * 
	 * 
	 * 
	 * 
	 * Property Value
bubbles false
currentTarget The Object that defines the
	 *   event listener that handles the event. For example, if you use
	 *   myButton.addEventListener() to register an event listener,
	 *   myButton is the value of the currentTarget.
data null
target The Object that dispatched the event;
	 *   it is not always the Object listening for the event. Use the
	 *   currentTarget property to always access the Object
	 *   listening for the event.
	 *
	 * @eventType feathers.events.FeathersEventType.FOCUS_IN
	 */
	[Event(name="focusIn",type="starling.events.Event")]

	/**
	 * Dispatched when the display object loses focus.
	 *
	 * The properties of the event object have the following values:
	 * 
	 * 
	 * 
	 * 
	 * 
	 * 
	 * Property Value
bubbles false
currentTarget The Object that defines the
	 *   event listener that handles the event. For example, if you use
	 *   myButton.addEventListener() to register an event listener,
	 *   myButton is the value of the currentTarget.
data null
target The Object that dispatched the event;
	 *   it is not always the Object listening for the event. Use the
	 *   currentTarget property to always access the Object
	 *   listening for the event.
	 *
	 * @eventType feathers.events.FeathersEventType.FOCUS_OUT
	 */
	[Event(name="focusOut",type="starling.events.Event")]

	/**
	 * A component that can receive focus if a focus manager is enabled.
	 *
	 * @see ../../../help/focus.html Keyboard focus management in Feathers
	 */
	public interface IFocusDisplayObject extends IFeathersDisplayObject
	{
		/**
		 * The current focus manager for this component. May be
		 * null if no focus manager is enabled.
		 */
		function get focusManager():IFocusManager;

		/**
		 * @private
		 */
		function set focusManager(value:IFocusManager):void;

		/**
		 * Determines if this component can receive focus.
		 *
		 * In the following example, the focus is disabled:
		 *
		 * 		 * object.isFocusEnabled = false;
		 */
		function get isFocusEnabled():Boolean;

		/**
		 * @private
		 */
		function set isFocusEnabled(value:Boolean):void;

		/**
		 * The next object that will receive focus when the tab key is pressed
		 * when a focus manager is enabled. If null, defaults to
		 * the next child on the display list.
		 *
		 * In the following example, the next tab focus is changed:
		 *
		 * 		 * object.nextTabFocus = otherObject;
		 */
		function get nextTabFocus():IFocusDisplayObject;

		/**
		 * @private
		 */
		function set nextTabFocus(value:IFocusDisplayObject):void;

		/**
		 * The previous object that will receive focus when the tab key is
		 * pressed while holding shift when a focus manager is enabled. If
		 * null, defaults to the previous child on the display
		 * list.
		 *
		 * In the following example, the previous tab focus is changed:
		 *
		 * 		 * object.previousTabFocus = otherObject;
		 */
		function get previousTabFocus():IFocusDisplayObject;

		/**
		 * @private
		 */
		function set previousTabFocus(value:IFocusDisplayObject):void;

		/**
		 * Used for associating focusable display objects that are not direct
		 * children with an "owner" focusable display object, such as pop-ups.
		 * A focus manager may use this property to influence the tab order.
		 *
		 * In the following example, the focus owner is changed:
		 *
		 * 		 * object.focusOwner = otherObject;
		 */
		function get focusOwner():IFocusDisplayObject;

		/**
		 * @private
		 */
		function set focusOwner(value:IFocusDisplayObject):void;

		/**
		 * If the object has focus, an additional visual indicator may
		 * optionally be displayed to highlight the object. Calling this
		 * function may have no effect. It's merely a suggestion to the object.
		 *
		 * Important: This function will not give focus to
		 * the display object if it doesn't have focus. To give focus to the
		 * display object, you should set the focus property on
		 * the focus manager.
		 *
		 * 		 * object.focusManager.focus = object;
		 *
		 * @see #hideFocus()
		 * @see feathers.core.IFocusManager#focus
		 */
		function showFocus():void;

		/**
		 * If the visual indicator of focus has been displayed by
		 * showFocus(), call this function to hide it.
		 *
		 * Important: This function will not clear focus
		 * from the display object if it has focus. To clear focus from the
		 * display object, you should set the focus property on
		 * the focus manager to null or another display object.
		 *
		 * @see #showFocus()
		 * @see feathers.core.IFocusManager#focus
		 */
		function hideFocus():void;
	}
}

Property	Value
`bubbles`	false
`currentTarget`	The Object that defines the * event listener that handles the event. For example, if you use * `myButton.addEventListener()` to register an event listener, * myButton is the value of the `currentTarget`.
`data`	null
`target`	The Object that dispatched the event; * it is not always the Object listening for the event. Use the * `currentTarget` property to always access the Object * listening for the event.

Property	Value
`bubbles`	false
`currentTarget`	The Object that defines the * event listener that handles the event. For example, if you use * `myButton.addEventListener()` to register an event listener, * myButton is the value of the `currentTarget`.
`data`	null
`target`	The Object that dispatched the event; * it is not always the Object listening for the event. Use the * `currentTarget` property to always access the Object * listening for the event.