FocusManager

(Preview)

Package	mx.managers
Class	public class FocusManager
Inheritance	FocusManager EventDispatcher Object
Implements	IFocusManager

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The FocusManager class manages the focus on components in response to mouse activity or keyboard activity (Tab key). There can be several FocusManager instances in an application. Each FocusManager instance is responsible for a set of components that comprise a "tab loop". If you hit Tab enough times, focus traverses through a set of components and eventually get back to the first component that had focus. That is a "tab loop" and a FocusManager instance manages that loop. If there are popup windows with their own set of components in a "tab loop" those popup windows will have their own FocusManager instances. The main application always has a FocusManager instance.

The FocusManager manages focus from the "component level". In Flex, a UITextField in a component is the only way to allow keyboard entry of text. To the Flash Player or AIR, that UITextField has focus. However, from the FocusManager's perspective the component that parents the UITextField has focus. Thus there is a distinction between component-level focus and player-level focus. Application developers generally only have to deal with component-level focus while component developers must understand player-level focus.

All components that can be managed by the FocusManager must implement mx.managers.IFocusManagerComponent, whereas objects managed by player-level focus do not.

The FocusManager also managers the concept of a defaultButton, which is the Button on a form that dispatches a click event when the Enter key is pressed depending on where focus is at that time.

More examples

Focus in sandboxed applications
Focus in multi-versioned applications

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		defaultButton : IButton A reference to the original default Button control.	FocusManager
		defaultButtonEnabled : Boolean A flag that indicates whether the FocusManager should check for the Enter key being pressed to activate the default button.	FocusManager
		focusPane : Sprite A single Sprite that is moved from container to container as the focus moves to those containers.	FocusManager
		nextTabIndex : int [read-only] The next unique tab index to use in this tab loop.	FocusManager
		showFocusIndicator : Boolean A flag that indicates whether to display an indicator that a component has focus.	FocusManager

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		FocusManager(container:IFocusManagerContainer, popup:Boolean = false) Constructor.	FocusManager
		activate():void The SystemManager activates and deactivates a FocusManager if more than one IFocusManagerContainer is visible at the same time.	FocusManager
		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.	EventDispatcher
		deactivate():void The SystemManager activates and deactivates a FocusManager if more than one IFocusManagerContainer is visible at the same time.	FocusManager
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		findFocusManagerComponent(o:InteractiveObject):IFocusManagerComponent Returns the IFocusManagerComponent that contains the given object, if any.	FocusManager
		getFocus():IFocusManagerComponent Gets the IFocusManagerComponent component that currently has the focus.	FocusManager
		getNextFocusManagerComponent(backward:Boolean = false):IFocusManagerComponent Returns the IFocusManagerComponent that would receive focus if the user pressed the Tab key to navigate to another component.	FocusManager
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		hideFocus():void Sets showFocusIndicator to false and removes the visual focus indicator from the focused object, if any.	FocusManager
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		setFocus(o:IFocusManagerComponent):void Sets focus to an IFocusManagerComponent component.	FocusManager
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		showFocus():void Sets showFocusIndicator to true and draws the visual focus indicator on the focused object, if any.	FocusManager
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String [override] Returns a String representation of the component hosting the FocusManager object, with the String ".focusManager" appended to the end of the String.	FocusManager
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventDispatcher

Events

Click for more information on events

Hide Inherited Events

Show Inherited Events

	Event		Summary	Defined By
		activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
		deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher

Property Detail

Constructor Detail

Method Detail

[an error occurred while processing this directive]

Legal Notices | Online Privacy Policy

FocusManager - AS3 Flex

Packagesx

Language Elements

Appendixes

Package mx.managers

defaultButton

defaultButtonEnabled

focusPane

nextTabIndex

showFocusIndicator

activate

deactivate

findFocusManagerComponent

getFocus

getNextFocusManagerComponent

hideFocus

setFocus

showFocus

toString

	`container:IFocusManagerContainer` — An IFocusManagerContainer that hosts the FocusManager.

	`popup:Boolean` (default = `false`) — If `true`, indicates that the container is a popup component and not the main application.