| Package | mx.managers |
| Interface | public interface IFocusManager extends IEventDispatcher |
| Implementors | FocusManager |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Related API Elements
| Property | Defined By | ||
|---|---|---|---|
| defaultButton : IButton
A reference to the original default Button control. | IFocusManager | ||
| defaultButtonEnabled : Boolean
A flag that indicates whether the FocusManager should
check for the Enter key being pressed to activate the default button. | IFocusManager | ||
| focusPane : Sprite
A single Sprite that is moved from container to container
as the focus moves to those containers. | IFocusManager | ||
| nextTabIndex : int [read-only]
The next unique tab index to use in this tab loop. | IFocusManager | ||
| showFocusIndicator : Boolean
A flag that indicates whether to display an indicator that
a component has focus. | IFocusManager | ||
Hide Inherited Public Methods
Show Inherited Public Methods| Method | Defined By | ||
|---|---|---|---|
The SystemManager activates and deactivates a FocusManager
if more than one IFocusManagerContainer is visible at the same time. | IFocusManager | ||
 | addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | IEventDispatcher | |
The SystemManager activates and deactivates a FocusManager
if more than one IFocusManagerContainer is visible at the same time. | IFocusManager | ||
|
Dispatches an event into the event flow. | IEventDispatcher | |
Returns the IFocusManagerComponent that contains the given object, if any. | IFocusManager | ||
Gets the IFocusManagerComponent component that currently has the focus. | IFocusManager | ||
Returns the IFocusManagerComponent that would receive focus
if the user pressed the Tab key to navigate to another component. | IFocusManager | ||
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | IEventDispatcher | |
Sets showFocusIndicator to false
and removes the visual focus indicator from the focused object, if any. | IFocusManager | ||
|
Removes a listener from the EventDispatcher object. | IEventDispatcher | |
Sets focus to an IFocusManagerComponent component. | IFocusManager | ||
Sets showFocusIndicator to true
and draws the visual focus indicator on the focused object, if any. | IFocusManager | ||
|
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | IEventDispatcher | |
defaultButton | property |
defaultButton:IButton| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A reference to the original default Button control.
Pressing the Enter key while the focus is on any control
activates the Button control by dispatching a click event
on the Button control, just as if it was clicked with the mouse.
The actual default Button control changes if focus is given to another
Button control, but switches back to the original if focus is not
on a button.
This property is managed by Flex containers; do not set it directly to specify the default button.
The defaultButton must be of class
mx.controls.Button even though this property
is of type IUIComponent.
Implementation
public function get defaultButton():IButton public function set defaultButton(value:IButton):voiddefaultButtonEnabled | property |
defaultButtonEnabled:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A flag that indicates whether the FocusManager should
check for the Enter key being pressed to activate the default button.
TextArea and other components that want to recognize
the Enter key
set this property to false to disable the Enter
key from dispatching a click event on the
default button, if it exists.
Implementation
public function get defaultButtonEnabled():Boolean public function set defaultButtonEnabled(value:Boolean):voidfocusPane | property |
focusPane:Sprite| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A single Sprite that is moved from container to container as the focus moves to those containers. The Sprite is used as the parent of the visual indicator that a component has focus.
Implementation
public function get focusPane():Sprite public function set focusPane(value:Sprite):voidnextTabIndex | property |
showFocusIndicator | property |
showFocusIndicator:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A flag that indicates whether to display an indicator that
a component has focus.
If true a component receiving focus
draws a visible indicator that it has focus.
By default, this is false until the user uses
the Tab key, then it is set to true.
In general it is better to use
the showFocus() and hideFocus() methods
to change this property as those methods also update the
visual indicator that a component has focus.
Implementation
public function get showFocusIndicator():Boolean public function set showFocusIndicator(value:Boolean):voidactivate | () | method |
public function activate():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The SystemManager activates and deactivates a FocusManager
if more than one IFocusManagerContainer is visible at the same time.
If the mouse is clicked in an IFocusManagerContainer with a deactivated
FocusManager, the SystemManager will call
the activate() method on that FocusManager.
The FocusManager that was activated will have its deactivate() method
called prior to the activation of another FocusManager.
deactivate | () | method |
public function deactivate():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The SystemManager activates and deactivates a FocusManager
if more than one IFocusManagerContainer is visible at the same time.
If the mouse is clicked in an IFocusManagerContainer with a deactivated
FocusManager, the SystemManager will call
the activate() method on that FocusManager.
The FocusManager that was activated will have its deactivate() method
called prior to the activation of another FocusManager.
findFocusManagerComponent | () | method |
public function findFocusManagerComponent(o:InteractiveObject):IFocusManagerComponent| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns the IFocusManagerComponent that contains the given object, if any. Because the player can set focus to a subcomponent of a Flex component this method determines which IFocusManagerComponent has focus from the component perspective.
Parameters
o:InteractiveObject — An object that can have player-level focus.
|
IFocusManagerComponent — The IFOcusManagerComponent containing o or
null
|
getFocus | () | method |
public function getFocus():IFocusManagerComponent| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Gets the IFocusManagerComponent component that currently has the focus. Calling this method is recommended instead of using the Stage object because it indicates which component has focus. The Stage might return a subcomponent in that component.
ReturnsIFocusManagerComponent — IFocusManagerComponent object that has focus.
|
getNextFocusManagerComponent | () | method |
public function getNextFocusManagerComponent(backward:Boolean = false):IFocusManagerComponent| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns the IFocusManagerComponent that would receive focus if the user pressed the Tab key to navigate to another component. It will return the same component as the current focused component if there are no other valid components in the application.
Parameters
backward:Boolean (default = false)true, return the object
as if the Shift-Tab keys were pressed.
|
IFocusManagerComponent — The component that would receive focus.
|
hideFocus | () | method |
public function hideFocus():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Sets showFocusIndicator to false
and removes the visual focus indicator from the focused object, if any.
setFocus | () | method |
public function setFocus(o:IFocusManagerComponent):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Sets focus to an IFocusManagerComponent component. Does not check for the components visibility, enabled state, or any other conditions.
Parameters
o:IFocusManagerComponent — A component that can receive focus.
|
showFocus | () | method |
public function showFocus():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Sets showFocusIndicator to true
and draws the visual focus indicator on the focused object, if any.
Mon Nov 28 2011, 06:48 AM -08:00