scaffold.libs_as.feathers.core.IFocusManager.as Maven / Gradle / Ivy
/*
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
{
import starling.display.DisplayObjectContainer;
/**
* Interface for focus management.
*
* @see ../../../help/focus.html Keyboard focus management in Feathers
* @see feathers.core.FocusManager
* @see feathers.core.IFocusDisplayObject
*/
public interface IFocusManager
{
/**
* Determines if this focus manager is enabled. A focus manager may be
* disabled when another focus manager has control, such as when a
* modal pop-up is displayed.
*/
function get isEnabled():Boolean;
/**
* @private
*/
function set isEnabled(value:Boolean):void;
/**
* The object that currently has focus. May return null if
* no object has focus.
*
* In the following example, the focus is changed:
*
*
* focusManager.focus = someObject;
*/
function get focus():IFocusDisplayObject;
/**
* @private
*/
function set focus(value:IFocusDisplayObject):void;
/**
* The top-level container of the focus manager. This isn't necessarily
* the root of the display list.
*/
function get root():DisplayObjectContainer;
}
}