topical media & game development
student-ar-fl-managers-FocusManager.ax
student-ar-fl-managers-FocusManager.ax
[swf]
flex
// Copyright 2007. Adobe Systems Incorporated. All Rights Reserved.
package fl.managers {
import flash.display.Sprite;
import flash.display.MovieClip;
import flash.display.Stage;
import flash.display.SimpleButton;
import flash.display.DisplayObject;
import flash.display.DisplayObjectContainer;
import flash.display.InteractiveObject;
import flash.text.TextField;
import flash.text.TextFieldType;
import flash.ui.Keyboard;
import flash.events.Event;
import flash.events.FocusEvent;
import flash.events.MouseEvent;
import flash.events.KeyboardEvent;
import fl.controls.Button;
import fl.controls.TextInput;
import fl.core.UIComponent;
import flash.system.Capabilities;
import flash.utils.*;
The @ax-student-ar-fl-managers-FocusManager class manages focus for a set of components that are navigated by mouse
or keyboard as a <em>tab loop</em>.
<p>A tab loop is typically navigated by using the Tab key; focus moves between the components
in the tab loop in a circular pattern from the first component that has focus, to the last,
and then back again to the first. A tab loop includes all the components and tab-enabled
components in a container. An application can contain numerous tab loops.</p>
<p>A @ax-student-ar-fl-managers-FocusManager instance is responsible for a single tab loop; an application uses
a different @ax-student-ar-fl-managers-FocusManager instance to manage each tab loop that it contains, although
a main application is always associated with at least one @ax-student-ar-fl-managers-FocusManager instance. An
application may require additional @ax-student-ar-fl-managers-FocusManager instances if it includes a popup window,
for example, that separately contains one or more tab loops of components.</p>
<p>All components that can be managed by a @ax-student-ar-fl-managers-FocusManager instance must implement the
fl.managers.I@fileComponent interface. Objects for which Flash Player
manages focus are not required to implement the I@fileComponent interface.</p>
<p>The @ax-student-ar-fl-managers-FocusManager class also manages how the default button is implemented. A default button
dispatches a <code>click</code> event when the Enter key is pressed on a form,
depending on where focus is at the time. The default button does not dispatch the
<code>click</code> event if a text area has focus or if a value is being edited in
a component, for example, in a ComboBox or NumericStepper component.</p>
see: I@ax-student-ar-fl-managers-FocusManager
see: I@fileComponent
@includeExample examples/@fileExample.as
@langversion 3.0
@playerversion Flash 9.0.28.0
public class @ax-student-ar-fl-managers-FocusManager implements I@ax-student-ar-fl-managers-FocusManager {
@private
@langversion 3.0
@playerversion Flash 9.0.28.0
private var _form:DisplayObjectContainer;
@private
@langversion 3.0
@playerversion Flash 9.0.28.0
private var focusableObjects:Dictionary;
@private
@langversion 3.0
@playerversion Flash 9.0.28.0
private var focusableCandidates:Array;
@private
@langversion 3.0
@playerversion Flash 9.0.28.0
private var activated:Boolean = false;
@private
@langversion 3.0
@playerversion Flash 9.0.28.0
private var calculateCandidates:Boolean = true;
@private
@langversion 3.0
@playerversion Flash 9.0.28.0
private var lastFocus:InteractiveObject;
@private
@langversion 3.0
@playerversion Flash 9.0.28.0
private var _showFocusIndicator:Boolean = true;
@private
@langversion 3.0
@playerversion Flash 9.0.28.0
private var lastAction:String;
@private
@langversion 3.0
@playerversion Flash 9.0.28.0
private var defButton:Button;
@private
@langversion 3.0
@playerversion Flash 9.0.28.0
private var _defaultButton:Button;
@private
@langversion 3.0
@playerversion Flash 9.0.28.0
private var _defaultButtonEnabled:Boolean = true;
Creates a new @ax-student-ar-fl-managers-FocusManager instance.
<p>A focus manager manages focus within the children of a
DisplayObjectContainer object.</p>
parameter: container A DisplayObjectContainer that hosts the focus manager,
or <code>stage</code>.
@langversion 3.0
@playerversion Flash 9.0.28.0
public function @ax-student-ar-fl-managers-FocusManager(container:DisplayObjectContainer) {
focusableObjects = new Dictionary(true);
if(container != null) {
_form = container;
addFocusables(DisplayObject(container));
container.addEventListener(Event.ADDED, addedHandler);
container.addEventListener(Event.REMOVED, removedHandler);
activate();
}
}
@private
Listen for children being added and see if they are focus candidates.
@langversion 3.0
@playerversion Flash 9.0.28.0
private function addedHandler(event:Event):void {
var target:DisplayObject = DisplayObject(event.target);
// if it is truly parented, add it, otherwise it will get added
// when the top of the tree gets parented
if (target.stage) {
addFocusables(DisplayObject(event.target));
}
}
@private
Listen for children being removed.
@langversion 3.0
@playerversion Flash 9.0.28.0
private function removedHandler(event:Event):void {
var i:int;
var o:DisplayObject = DisplayObject(event.target);
if (o is I@fileComponent && focusableObjects[o] == true) {
if (o == lastFocus) {
I@fileComponent(lastFocus).drawFocus(false);
lastFocus = null;
}
o.removeEventListener(Event.TAB_ENABLED_CHANGE, tabEnabledChangeHandler);
delete focusableObjects[o];
calculateCandidates = true;
} else if(o is InteractiveObject && focusableObjects[o] == true) {
var io:InteractiveObject = o as InteractiveObject;
if(io) {
if (io == lastFocus) {
lastFocus = null;
}
delete focusableObjects[io];
calculateCandidates = true;
}
o.addEventListener(Event.TAB_ENABLED_CHANGE, tabEnabledChangeHandler);
}
removeFocusables(o);
}
@private
Do a tree walk and add all children you can find.
@langversion 3.0
@playerversion Flash 9.0.28.0
private function addFocusables(o:DisplayObject, skipTopLevel:Boolean = false):void {
if(!skipTopLevel) {
if (o is I@fileComponent) {
var focusable:I@fileComponent = I@fileComponent(o);
if (focusable.focusEnabled) {
if (focusable.tabEnabled && isTabVisible(o)) {
focusableObjects[o] = true;
calculateCandidates = true;
}
o.addEventListener(Event.TAB_ENABLED_CHANGE, tabEnabledChangeHandler);
o.addEventListener(Event.TAB_INDEX_CHANGE, tabIndexChangeHandler);
}
} else if(o is InteractiveObject) {
var io:InteractiveObject = o as InteractiveObject;
if(io && io.tabEnabled && find@fileComponent(io) == io) {
focusableObjects[io] = true;
calculateCandidates = true;
}
io.addEventListener(Event.TAB_ENABLED_CHANGE, tabEnabledChangeHandler);
io.addEventListener(Event.TAB_INDEX_CHANGE, tabIndexChangeHandler);
}
}
if (o is DisplayObjectContainer) {
var doc:DisplayObjectContainer = DisplayObjectContainer(o);
o.addEventListener(Event.TAB_CHILDREN_CHANGE, tabChildrenChangeHandler);
if (doc is Stage || doc.parent is Stage || doc.tabChildren) {
var i:int;
for (i = 0; i < doc.numChildren; i++) {
try {
var child:DisplayObject = doc.getChildAt(i);
if(child != null) {
addFocusables(doc.getChildAt(i));
}
} catch(error:SecurityError) {
// Ignore this child if we can't access it
}
}
}
}
}
@private
Removes the DisplayObject and all its children.
@langversion 3.0
@playerversion Flash 9.0.28.0
private function removeFocusables(o:DisplayObject):void {
if (o is DisplayObjectContainer) {
o.removeEventListener(Event.TAB_CHILDREN_CHANGE, tabChildrenChangeHandler);
o.removeEventListener(Event.TAB_INDEX_CHANGE, tabIndexChangeHandler);
for (var p:Object in focusableObjects) {
var dob:DisplayObject = DisplayObject(p);
if (DisplayObjectContainer(o).contains(dob)) {
if (dob == lastFocus) {
lastFocus = null;
}
dob.removeEventListener(Event.TAB_ENABLED_CHANGE, tabEnabledChangeHandler);
delete focusableObjects[p];
calculateCandidates = true;
}
}
}
}
@private
Checks if the DisplayObject is visible for the tab loop.
@langversion 3.0
@playerversion Flash 9.0.28.0
private function isTabVisible(o:DisplayObject):Boolean {
var p:DisplayObjectContainer = o.parent;
while (p && !(p is Stage) && !(p.parent && p.parent is Stage)) {
if (!p.tabChildren) {
return false;
}
p = p.parent;
}
return true;
}
@private
Checks if the DisplayObject is a valid candidate for the tab loop.
@langversion 3.0
@playerversion Flash 9.0.28.0
private function isValidFocusCandidate(o:DisplayObject, groupName:String):Boolean {
if (!isEnabledAndVisible(o)) {
return false;
}
if (o is I@fileGroup) {
var tg:I@fileGroup = I@fileGroup(o);
if (groupName == tg.groupName) {
return false;
}
}
return true;
}
@private
Checks if the DisplayObject is enabled and visible, or
a selectable or input TextField
@langversion 3.0
@playerversion Flash 9.0.28.0
private function isEnabledAndVisible(o:DisplayObject):Boolean {
var formParent:DisplayObjectContainer = DisplayObject(form).parent;
while (o != formParent) {
if (o is UIComponent) {
if (!UIComponent(o).enabled) {
// The DO is a disabled UIComponent
return false;
}
} else if(o is TextField) {
var tf:TextField = TextField(o);
if(tf.type == TextFieldType.DYNAMIC || !tf.selectable) {
// The DO is a dynamic or non-selectable TextField
return false;
}
} else if(o is SimpleButton) {
var sb:SimpleButton = SimpleButton(o);
if(!sb.enabled) {
// The DO is a disabled SimpleButton
return false;
}
}
if (!o.visible) {
// The DO is not visible
return false;
}
o = o.parent;
}
return true;
}
@private
Add or remove object if tabbing properties change.
@langversion 3.0
@playerversion Flash 9.0.28.0
private function tabEnabledChangeHandler(event:Event):void {
calculateCandidates = true;
var o:InteractiveObject = InteractiveObject(event.target);
var registeredFocusableObject:Boolean = (focusableObjects[o] == true);
if (o.tabEnabled) {
if (!registeredFocusableObject && isTabVisible(o)) {
if(!(o is I@fileComponent)) {
o.focusRect = false;
}
focusableObjects[o] = true;
}
} else {
if (registeredFocusableObject) {
delete focusableObjects[o];
}
}
}
@private
Called when a focusable object's <code>tabIndex</code> property changes.
@langversion 3.0
@playerversion Flash 9.0.28.0
private function tabIndexChangeHandler(event:Event):void {
calculateCandidates = true;
}
@private
Add or remove object if tabbing properties change.
@langversion 3.0
@playerversion Flash 9.0.28.0
private function tabChildrenChangeHandler(event:Event):void {
if (event.target != event.currentTarget) {
return;
}
calculateCandidates = true;
var o:DisplayObjectContainer = DisplayObjectContainer(event.target);
if (o.tabChildren) {
addFocusables(o, true);
} else {
removeFocusables(o);
}
}
Activates the @ax-student-ar-fl-managers-FocusManager instance.
<p>The @ax-student-ar-fl-managers-FocusManager instance adds event handlers that allow it to monitor
focus-related keyboard and mouse activity.</p>
@langversion 3.0
@playerversion Flash 9.0.28.0
public function activate():void {
if (activated) {
return;
}
// Listen for focus changes, use weak references for the stage.
form.stage.addEventListener(FocusEvent.MOUSE_FOCUS_CHANGE, mouseFocusChangeHandler, false, 0, true);
form.stage.addEventListener(FocusEvent.KEY_FOCUS_CHANGE, keyFocusChangeHandler, false, 0, true);
form.addEventListener(FocusEvent.FOCUS_IN, focusInHandler, true);
form.addEventListener(FocusEvent.FOCUS_OUT, focusOutHandler, true);
form.stage.addEventListener(Event.ACTIVATE, activateHandler, false, 0, true);
form.stage.addEventListener(Event.DEACTIVATE, deactivateHandler, false, 0, true);
form.addEventListener(MouseEvent.MOUSE_DOWN, mouseDownHandler);
form.addEventListener(KeyboardEvent.KEY_DOWN, keyDownHandler, true);
activated = true;
// Restore focus to the last component that had it if there was one.
if (lastFocus) {
setFocus(lastFocus);
}
}
Deactivates the @ax-student-ar-fl-managers-FocusManager.
<p>The @ax-student-ar-fl-managers-FocusManager removes the event handlers that allow it to monitor
focus-related keyboard and mouse activity.</p>
@langversion 3.0
@playerversion Flash 9.0.28.0
public function deactivate():void {
form.stage.removeEventListener(FocusEvent.MOUSE_FOCUS_CHANGE, mouseFocusChangeHandler);
form.stage.removeEventListener(FocusEvent.KEY_FOCUS_CHANGE, keyFocusChangeHandler);
form.removeEventListener(FocusEvent.FOCUS_IN, focusInHandler, true);
form.removeEventListener(FocusEvent.FOCUS_OUT, focusOutHandler, true);
form.stage.removeEventListener(Event.ACTIVATE, activateHandler);
form.stage.removeEventListener(Event.DEACTIVATE, deactivateHandler);
form.removeEventListener(MouseEvent.MOUSE_DOWN, mouseDownHandler);
form.removeEventListener(KeyboardEvent.KEY_DOWN, keyDownHandler, true);
activated = false;
}
@private
@langversion 3.0
@playerversion Flash 9.0.28.0
private function focusInHandler(event:FocusEvent):void {
var target:InteractiveObject = InteractiveObject(event.target);
if (form.contains(target)) {
lastFocus = find@fileComponent(InteractiveObject(target));
// handle default button here
if (lastFocus is Button) {
var x:Button = Button(lastFocus);
// if we have marked some other button as a default button
if (defButton) {
// change it to be this button
defButton.emphasized = false;
defButton = x;
x.emphasized = true;
}
} else {
// restore the default button to be the original one
if (defButton && defButton != _defaultButton) {
defButton.emphasized = false;
defButton = _defaultButton;
_defaultButton.emphasized = true;
}
}
}
}
@private
Useful for debugging.
@langversion 3.0
@playerversion Flash 9.0.28.0
private function focusOutHandler(event:FocusEvent):void {
var target:InteractiveObject = event.target as InteractiveObject;
}
@private
Restore focus to the element that had it last.
@langversion 3.0
@playerversion Flash 9.0.28.0
private function activateHandler(event:Event):void {
var target:InteractiveObject = InteractiveObject(event.target);
if (lastFocus) {
if(lastFocus is I@fileComponent) {
I@fileComponent(lastFocus).setFocus();
} else {
form.stage.focus = lastFocus;
}
}
lastAction = "ACTIVATE";
}
@private
Useful for debugging.
@langversion 3.0
@playerversion Flash 9.0.28.0
private function deactivateHandler(event:Event):void {
var target:InteractiveObject = InteractiveObject(event.target);
}
@private
This gets called when mouse clicks on a focusable object.
We block Flash Player behavior.
@langversion 3.0
@playerversion Flash 9.0.28.0
private function mouseFocusChangeHandler(event:FocusEvent):void {
if (event.relatedObject is TextField) {
return; // pass it on
}
event.preventDefault();
}
@private
This function is called when the tab key is hit.
@langversion 3.0
@playerversion Flash 9.0.28.0
private function keyFocusChangeHandler(event:FocusEvent):void {
showFocusIndicator = true;
if ((event.keyCode == Keyboard.TAB || event.keyCode == 0) && !event.isDefaultPrevented()) {
setFocusToNextObject(event);
event.preventDefault();
}
}
@private
Watch for the Enter key.
@langversion 3.0
@playerversion Flash 9.0.28.0
private function keyDownHandler(event:KeyboardEvent):void {
if (event.keyCode == Keyboard.TAB) {
lastAction = "KEY";
// this makes and orders the focusableCandidates array
if (calculateCandidates) {
sortFocusableObjects();
calculateCandidates = false;
}
}
if (defaultButtonEnabled && event.keyCode == Keyboard.ENTER && defaultButton && defButton.enabled) {
sendDefaultButtonEvent();
}
}
@private
This gets called when the focus changes due to a mouse click.
<p><strong>Note:</strong> If focus is moving to a TextField, it is not
necessary to call <code>setFocus()</code> on it because the player handles it;
calling <code>setFocus()</code> on a TextField that has scrollable text
causes the text to auto-scroll to the end, making the
mouse click set the insertion point in the wrong place.</p>
@langversion 3.0
@playerversion Flash 9.0.28.0
private function mouseDownHandler(event:MouseEvent):void {
if (event.isDefaultPrevented()) {
return;
}
var o:InteractiveObject = getTopLevelFocusTarget(InteractiveObject(event.target));
if (!o) {
return;
}
showFocusIndicator = false;
// Make sure the containing component gets notified.
// As the note above says, we don't set focus to a TextField ever
// because the player already did and took care of where
// the insertion point is, and we also don't call setfocus
// on a component that last the last object with focus unless
// the last action was just to activate the player and didn't
// involve tabbing or clicking on a component
if ((o != lastFocus || lastAction == "ACTIVATE") && !(o is TextField)) {
setFocus(o);
}
lastAction = "MOUSEDOWN";
}
Gets or sets the current default button.
<p>The default button is the button on a form that dispatches a
<code>click</code> event when the Enter key is pressed,
depending on where focus is at the time.</p>
@langversion 3.0
@playerversion Flash 9.0.28.0
public function get defaultButton():Button {
return _defaultButton;
}
@private (setter)
@langversion 3.0
@playerversion Flash 9.0.28.0
public function set defaultButton(value:Button):void {
var button:Button = value ? Button(value) : null;
if (button != _defaultButton) {
if (_defaultButton) {
_defaultButton.emphasized = false;
}
if (defButton) {
defButton.emphasized = false;
}
_defaultButton = button;
defButton = button;
if (button) {
button.emphasized = true;
}
}
}
@private
Call this method to make the system
think the Enter key was pressed and the default button was clicked.
@langversion 3.0
@playerversion Flash 9.0.28.0
public function sendDefaultButtonEvent():void {
defButton.dispatchEvent(new MouseEvent(MouseEvent.CLICK));
}
@private
@langversion 3.0
@playerversion Flash 9.0.28.0
private function setFocusToNextObject(event:FocusEvent):void {
if (!hasFocusableObjects()) { return; }
var o:InteractiveObject = getNext@fileComponent(event.shiftKey);
if (o) {
setFocus(o);
}
}
@private
@langversion 3.0
@playerversion Flash 9.0.28.0
private function hasFocusableObjects():Boolean {
for(var o:Object in focusableObjects) {
return true;
}
return false;
}
Retrieves the interactive object that would receive focus
if the user pressed the Tab key to navigate to the next object.
This method retrieves the object that currently has focus
if there are no other valid objects in the application.
parameter: backward If this parameter is set to true,
focus moves in a backward direction, causing this method to retrieve
the object that would receive focus next if the Shift+Tab key combination
were pressed.
returns: The next component to receive focus.
@langversion 3.0
@playerversion Flash 9.0.28.0
public function getNext@fileComponent(backward:Boolean = false):InteractiveObject {
if (!hasFocusableObjects()) { return null; }
if (calculateCandidates) {
sortFocusableObjects();
calculateCandidates = false;
}
// get the object that has the focus
var o:DisplayObject = form.stage.focus;
o = DisplayObject(find@fileComponent(InteractiveObject(o)));
var g:String = "";
if (o is I@fileGroup) {
var tg:I@fileGroup = I@fileGroup(o);
g = tg.groupName;
}
var i:int = getIndexOfFocusedObject(o);
var bSearchAll:Boolean = false;
var start:int = i;
if (i == -1) {
// we didn't find it
if (backward) {
i = focusableCandidates.length;
}
bSearchAll = true;
}
var j:int = getIndexOfNextObject(i, backward, bSearchAll, g);
return find@fileComponent(focusableCandidates[j]);
}
@private
@langversion 3.0
@playerversion Flash 9.0.28.0
private function getIndexOfFocusedObject(o:DisplayObject):int {
var n:int = focusableCandidates.length;
var i:int = 0;
for (i = 0; i < n; i++) {
if (focusableCandidates[i] == o) {
return i;
}
}
return -1;
}
@private
@langversion 3.0
@playerversion Flash 9.0.28.0
private function getIndexOfNextObject(i:int, shiftKey:Boolean, bSearchAll:Boolean, groupName:String):int {
var n:int = focusableCandidates.length;
var start:int = i;
while (true) {
if (shiftKey) {
i--;
} else {
i++;
}
if (bSearchAll) {
if (shiftKey && i < 0) {
break;
}
if (!shiftKey && i == n) {
break;
}
} else {
i = (i + n) % n;
// came around and found the original
if (start == i) {
break;
}
}
if (isValidFocusCandidate(focusableCandidates[i], groupName)) {
var o:DisplayObject = DisplayObject(find@fileComponent(focusableCandidates[i]));
if (o is I@fileGroup) {
// look around to see if there's a selected member in the tabgroup
// otherwise use the first one we found.
var tg1:I@fileGroup = I@fileGroup(o);
for (var j:int = 0; j < focusableCandidates.length; j++) {
var obj:DisplayObject = focusableCandidates[j];
if (obj is I@fileGroup) {
var tg2:I@fileGroup = I@fileGroup(obj);
if (tg2.groupName == tg1.groupName && tg2.selected) {
i = j;
break;
}
}
}
}
return i;
}
}
return i;
}
@private
@langversion 3.0
@playerversion Flash 9.0.28.0
private function sortFocusableObjects():void {
focusableCandidates = [];
for (var o:Object in focusableObjects) {
var c:InteractiveObject = InteractiveObject(o);
if (c.tabIndex && !isNaN(Number(c.tabIndex)) && c.tabIndex > 0) {
sortFocusableObjectsTabIndex();
return;
}
focusableCandidates.push(c);
}
focusableCandidates.sort(sortByDepth);
}
@private
@langversion 3.0
@playerversion Flash 9.0.28.0
private function sortFocusableObjectsTabIndex():void {
focusableCandidates = [];
for (var o:Object in focusableObjects) {
var c:InteractiveObject = InteractiveObject(o);
if (c.tabIndex && !isNaN(Number(c.tabIndex))) {
// if we get here, it is a candidate
focusableCandidates.push(c);
}
}
focusableCandidates.sort(sortByTabIndex);
}
@private
@langversion 3.0
@playerversion Flash 9.0.28.0
private function sortByDepth(aa:InteractiveObject, bb:InteractiveObject):Number {
var val1:String = "";
var val2:String = "";
var index:int;
var tmp:String;
var tmp2:String;
var zeros:String = "0000";
var a:DisplayObject = DisplayObject(aa);
var b:DisplayObject = DisplayObject(bb);
while (a != DisplayObject(form) && a.parent) {
index = getChildIndex(a.parent, a);
tmp = index.toString(16);
if (tmp.length < 4) {
tmp2 = zeros.substring(0, 4 - tmp.length) + tmp;
}
val1 = tmp2 + val1;
a = a.parent;
}
while (b != DisplayObject(form) && b.parent) {
index = getChildIndex(b.parent, b);
tmp = index.toString(16);
if (tmp.length < 4) {
tmp2 = zeros.substring(0, 4 - tmp.length) + tmp;
}
val2 = tmp2 + val2;
b = b.parent;
}
return val1 > val2 ? 1 : val1 < val2 ? -1 : 0;
}
@private
@langversion 3.0
@playerversion Flash 9.0.28.0
private function getChildIndex(parent:DisplayObjectContainer, child:DisplayObject):int {
return parent.getChildIndex(child);
}
@private
@langversion 3.0
@playerversion Flash 9.0.28.0
private function sortByTabIndex(a:InteractiveObject, b:InteractiveObject):int {
return (a.tabIndex > b.tabIndex ? 1 : a.tabIndex < b.tabIndex ? -1 : sortByDepth(a, b));
}
@copy fl.managers.I@ax-student-ar-fl-managers-FocusManager#defaultButtonEnabled
@langversion 3.0
@playerversion Flash 9.0.28.0
public function get defaultButtonEnabled():Boolean {
return _defaultButtonEnabled;
}
@private
@langversion 3.0
@playerversion Flash 9.0.28.0
public function set defaultButtonEnabled(value:Boolean):void {
_defaultButtonEnabled = value;
}
Gets the next unique tab index to use in this tab loop.
@langversion 3.0
@playerversion Flash 9.0.28.0
public function get nextTabIndex():int {
return 0;
}
Gets or sets a value that indicates whether a component that has focus should be marked with a visual indicator of focus.
@langversion 3.0
@playerversion Flash 9.0.28.0
public function get showFocusIndicator():Boolean {
return _showFocusIndicator;
}
@private
@langversion 3.0
@playerversion Flash 9.0.28.0
public function set showFocusIndicator(value:Boolean):void {
_showFocusIndicator = value;
}
@private
@langversion 3.0
@playerversion Flash 9.0.28.0
public function get form():DisplayObjectContainer {
return _form;
}
@private
@langversion 3.0
@playerversion Flash 9.0.28.0
public function set form(value:DisplayObjectContainer):void {
_form = value;
}
Gets the interactive object that currently has focus.
Adobe recommends calling this method instead of using the Stage object
because this method indicates which component has focus.
The Stage might return a subcomponent in that component.
returns: The interactive object that currently has focus.
@langversion 3.0
@playerversion Flash 9.0.28.0
public function getFocus():InteractiveObject {
var o:InteractiveObject = form.stage.focus;
return find@fileComponent(o);
}
Sets focus on an I@fileComponent component. This method does
not check for component visibility, enabled state, or other conditions.
parameter: component An object that can receive focus.
@internal Do you guys have a code snippet/test case/sample you could give us for this? (rberry(at)adobe.com)
Adobe: [LM] {StyleManager.setFocus(myBtn);}
@langversion 3.0
@playerversion Flash 9.0.28.0
public function setFocus(component:InteractiveObject):void {
if(component is I@fileComponent) {
I@fileComponent(component).setFocus();
} else {
form.stage.focus = component;
}
}
Sets the <code>showFocusIndicator</code> value to <code>true</code>
and draws the visual focus indicator on the object with focus, if any.
@langversion 3.0
@playerversion Flash 9.0.28.0
public function showFocus():void {
}
Sets the <code>showFocusIndicator</code> value to <code>false</code>
and removes the visual focus indicator from the object that has focus, if any.
@langversion 3.0
@playerversion Flash 9.0.28.0
public function hideFocus():void {
}
Retrieves the interactive object that contains the given object, if any.
The player can set focus to a subcomponent of a Flash component;
this method determines which interactive object has focus from
the component perspective.
parameter: component An object that can have player-level focus.
returns: The object containing the component or, if one is
not found, the <code>component</code> itself.
@internal Description needs explanation of relationship between interactive object (param and return type) and
@fileComponent, which the function claims to be finding. Do you guys have a code snippet/test
case/sample you could give us for this? (rberry(at)adobe.com)
Metaliq: Anybody?
Adobe: [LM] Changed description to InteractiveObject. This was changed to InteractiveObject because the @ax-student-ar-fl-managers-FocusManager supports native flash objects too.
@langversion 3.0
@playerversion Flash 9.0.28.0
public function find@fileComponent(component:InteractiveObject):InteractiveObject {
var p:InteractiveObject = component;
while (component) {
if (component is I@fileComponent && I@fileComponent(component).focusEnabled) {
return component;
}
component = component.parent;
}
// tab was set somewhere else
return p;
}
@private
@langversion 3.0
@playerversion Flash 9.0.28.0
private function getTopLevelFocusTarget(o:InteractiveObject):InteractiveObject {
while (o != InteractiveObject(form)) {
if (o is I@fileComponent &&
I@fileComponent(o).focusEnabled &&
I@fileComponent(o).mouseFocusEnabled &&
UIComponent(o).enabled) {
return o;
}
o = o.parent;
if (o == null) {
break;
}
}
return null;
}
}
}
(C) Æliens
27/08/2009
You may not copy or print any of this material without explicit permission of the author or the publisher.
In case of other copyright issues, contact the author.
