| Package | flash.events |
| Class | public class FocusEvent |
| Inheritance | FocusEvent Event Object |
FocusEvent.FOCUS_INFocusEvent.FOCUS_OUTFocusEvent.KEY_FOCUS_CHANGEFocusEvent.MOUSE_FOCUS_CHANGE| Property | Defined by | ||
|---|---|---|---|
![]() | bubbles : Boolean
Indicates whether an event is a bubbling event.
| Event | |
![]() | cancelable : Boolean
Indicates whether the behavior associated with the event can be prevented.
| Event | |
![]() | constructor : Object
A reference to the class object or constructor function for a given object instance.
| Object | |
![]() | currentTarget : Object
The object that is actively processing the Event object with an event listener.
| Event | |
![]() | eventPhase : uint
The current phase in the event flow.
| Event | |
| keyCode : uint
The key code value of the key pressed to trigger a
keyFocusChange event. | FocusEvent | ||
![]() | prototype : Object
[static]
A reference to the prototype object of a class or function object.
| Object | |
| relatedObject : InteractiveObject
A reference to the complementary InteractiveObject instance that is affected by the
change in focus.
| FocusEvent | ||
| shiftKey : Boolean
Indicates whether the Shift key modifier is activated, in which case the value is
true. | FocusEvent | ||
![]() | target : Object
The event target.
| Event | |
![]() | type : String
The type of event.
| Event | |
| Method | Defined by | ||
|---|---|---|---|
|
FocusEvent(type:String, bubbles:Boolean = true, cancelable:Boolean = false, relatedObject:InteractiveObject = null, shiftKey:Boolean = false, keyCode:uint = 0)
Creates an Event object with specific information relevant to focus events.
| FocusEvent | ||
|
Creates a copy of the FocusEvent object and sets the value of each property to match that of the original.
| FocusEvent | ||
![]() |
A utility function for implementing the
toString() method in your custom Event class. | Event | |
![]() |
Checks whether
preventDefault() has been called on the event. | Event | |
![]() |
preventDefault():void
Cancels an event's default behavior if that behavior can be canceled.
| Event | |
![]() |
Sets the availability of a dynamic property for loop operations.
| Object | |
![]() |
stopImmediatePropagation():void
Prevents processing of any event listeners in the current node and any subsequent nodes in
the event flow.
| Event | |
![]() |
stopPropagation():void
Prevents processing of any event listeners in nodes subsequent to the current node in the
event flow.
| Event | |
|
Returns a string that contains all the properties of the FocusEvent object.
| FocusEvent | ||
![]() |
Returns the primitive value of the specified object.
| Object | |
| Constant | Defined by | ||
|---|---|---|---|
![]() | ACTIVATE : String = "activate" [static]
Defines the value of the
type property of an activate event object. | Event | |
![]() | ADDED : String = "added" [static]
Defines the value of the
type property of an added event object. | Event | |
![]() | ADDED_TO_STAGE : String = "addedToStage" [static]
Defines the value of the
type property of an addedToStage event object. | Event | |
![]() | CANCEL : String = "cancel" [static]
Defines the value of the
type property of a cancel event object. | Event | |
![]() | CHANGE : String = "change" [static]
Defines the value of the
type property of a change event object. | Event | |
![]() | CLOSE : String = "close" [static]
Defines the value of the
type property of a close event object. | Event | |
![]() | CLOSING : String = "closing" [static]
Defines the value of the
type property of a closing event object. | Event | |
![]() | COMPLETE : String = "complete" [static]
Defines the value of the
type property of a complete event object. | Event | |
![]() | CONNECT : String = "connect" [static]
Defines the value of the
type property of a connect event object. | Event | |
![]() | DEACTIVATE : String = "deactivate" [static]
Defines the value of the
type property of a deactivate event object. | Event | |
![]() | DOM_INITIALIZE : String = "domInitialize" [static]
Defines the value of the
type property of a domInitialize event object. | Event | |
![]() | ENTER_FRAME : String = "enterFrame" [static]
Defines the value of the
type property of an enterFrame event object. | Event | |
| FOCUS_IN : String = "focusIn" [static]
Defines the value of the
type property of a focusIn event object. | FocusEvent | ||
| FOCUS_OUT : String = "focusOut" [static]
Defines the value of the
type property of a focusOut event object. | FocusEvent | ||
![]() | FULLSCREEN : String = "fullScreen" [static]
Defines the value of the
type property of a fullScreen event object. | Event | |
![]() | HTML_BOUNDS_CHANGE : String = "htmlBoundsChange" [static]
Defines the value of the
type property of an htmlBoundsChange event object. | Event | |
![]() | HTML_RENDER : String = "htmlRender" [static]
Defines the value of the
type property of an htmlRender event object. | Event | |
![]() | ID3 : String = "id3" [static]
Defines the value of the
type property of an id3 event object. | Event | |
![]() | INIT : String = "init" [static]
Defines the value of the
type property of an init event object. | Event | |
| KEY_FOCUS_CHANGE : String = "keyFocusChange" [static]
Defines the value of the
type property of a keyFocusChange event object. | FocusEvent | ||
![]() | LOCATION_CHANGE : String = "locationChange" [static]
Defines the value of the
type property of a locationChange event object. | Event | |
| MOUSE_FOCUS_CHANGE : String = "mouseFocusChange" [static]
Defines the value of the
type property of a mouseFocusChange event object. | FocusEvent | ||
![]() | MOUSE_LEAVE : String = "mouseLeave" [static]
Defines the value of the
type property of a mouseLeave event object. | Event | |
![]() | NETWORK_CHANGE : String = "networkChange" [static]
Defines the value of the
type property of a networkChange event object. | Event | |
![]() | OPEN : String = "open" [static]
Defines the value of the
type property of an open event object. | Event | |
![]() | REMOVED : String = "removed" [static]
Defines the value of the
type property of a removed event object. | Event | |
![]() | REMOVED_FROM_STAGE : String = "removedFromStage" [static]
Defines the value of the
type property of a removedFromStage event object. | Event | |
![]() | RENDER : String = "render" [static]
Defines the value of the
type property of a render event object. | Event | |
![]() | RESIZE : String = "resize" [static]
Defines the value of the
type property of a resize event object. | Event | |
![]() | SCROLL : String = "scroll" [static]
Defines the value of the
type property of a scroll event object. | Event | |
![]() | SELECT : String = "select" [static]
Defines the value of the
type property of a select event object. | Event | |
![]() | SOUND_COMPLETE : String = "soundComplete" [static]
Defines the value of the
type property of a soundComplete event object. | Event | |
![]() | TAB_CHILDREN_CHANGE : String = "tabChildrenChange" [static]
Defines the value of the
type property of a tabChildrenChange event object. | Event | |
![]() | TAB_ENABLED_CHANGE : String = "tabEnabledChange" [static]
Defines the value of the
type property of a tabEnabledChange event object. | Event | |
![]() | TAB_INDEX_CHANGE : String = "tabIndexChange" [static]
Defines the value of the
type property of a tabIndexChange event object. | Event | |
![]() | UNLOAD : String = "unload" [static]
Defines the value of the
type property of an unload event object. | Event | |
| keyCode | property |
keyCode:uint [read-write]
The key code value of the key pressed to trigger a keyFocusChange event.
public function get keyCode():uint
public function set keyCode(value:uint):void
| relatedObject | property |
relatedObject:InteractiveObject [read-write]
A reference to the complementary InteractiveObject instance that is affected by the
change in focus. For example, when a focusOut event occurs, the
relatedObject represents the InteractiveObject instance that has gained focus.
public function get relatedObject():InteractiveObject
public function set relatedObject(value:InteractiveObject):void
| shiftKey | property |
shiftKey:Boolean [read-write]
Indicates whether the Shift key modifier is activated, in which case the value is
true. Otherwise, the value is false. This property is
used only if the FocusEvent is of type keyFocusChange.
public function get shiftKey():Boolean
public function set shiftKey(value:Boolean):void
| FocusEvent | () | constructor |
public function FocusEvent(type:String, bubbles:Boolean = true, cancelable:Boolean = false, relatedObject:InteractiveObject = null, shiftKey:Boolean = false, keyCode:uint = 0)Creates an Event object with specific information relevant to focus events. Event objects are passed as parameters to event listeners.
Parameterstype:String — The type of the event. Possible values are:
FocusEvent.FOCUS_IN, FocusEvent.FOCUS_OUT, FocusEvent.KEY_FOCUS_CHANGE, and FocusEvent.MOUSE_FOCUS_CHANGE.
|
|
bubbles:Boolean (default = true) — Determines whether the Event object participates in the bubbling stage of the event flow.
|
|
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled.
|
|
relatedObject:InteractiveObject (default = null) — Indicates the complementary InteractiveObject instance that is affected by the change in focus. For example, when a focusIn event occurs, relatedObject represents the InteractiveObject that has lost focus.
|
|
shiftKey:Boolean (default = false) — Indicates whether the Shift key modifier is activated.
|
|
keyCode:uint (default = 0) — Indicates the code of the key pressed to trigger a keyFocusChange
event.
|
See also
| clone | () | method |
public override function clone():EventCreates a copy of the FocusEvent object and sets the value of each property to match that of the original.
ReturnsEvent —
A new FocusEvent object with property values that match those of the original.
|
| toString | () | method |
public override function toString():String
Returns a string that contains all the properties of the FocusEvent object. The string is in the following format:
[FocusEvent type=value bubbles=value cancelable=value relatedObject=value shiftKey=value]
ReturnsString —
A string that contains all the properties of the FocusEvent object.
|
| FOCUS_IN | constant |
public static const FOCUS_IN:String = "focusIn"
Defines the value of the type property of a focusIn event object.
This event has the following properties:
| Property | Value |
|---|---|
bubbles | true |
cancelable | false; there is no default behavior to cancel. |
currentTarget | The object that is actively processing the Event object with an event listener. |
keyCode | 0; applies only to keyFocusChange events. |
relatedObject | The complementary InteractiveObject instance that is affected by the change in focus. |
shiftKey | false; applies only to keyFocusChange events. |
target | The InteractiveObject instance that has just received focus.
The target is not always the object in the display list
that registered the event listener. Use the currentTarget
property to access the object in the display list that is currently processing the event.
|
See also
| FOCUS_OUT | constant |
public static const FOCUS_OUT:String = "focusOut"
Defines the value of the type property of a focusOut event object.
This event has the following properties:
| Property | Value |
|---|---|
bubbles | true |
cancelable | false; there is no default behavior to cancel. |
currentTarget | The object that is actively processing the Event object with an event listener. |
keyCode | 0; applies only to keyFocusChange events. |
relatedObject | The complementary InteractiveObject instance that is affected by the change in focus. |
shiftKey | false; applies only to keyFocusChange events. |
target | The InteractiveObject instance that has just lost focus.
The target is not always the object in the display list
that registered the event listener. Use the currentTarget
property to access the object in the display list that is currently processing the event.
|
See also
| KEY_FOCUS_CHANGE | constant |
public static const KEY_FOCUS_CHANGE:String = "keyFocusChange"
Defines the value of the type property of a keyFocusChange event object.
This event has the following properties:
| Property | Value |
|---|---|
bubbles | true |
cancelable | true; call the preventDefault() method
to cancel default behavior. |
currentTarget | The object that is actively processing the Event object with an event listener. |
keyCode | The key code value of the key pressed to trigger a keyFocusChange event. |
relatedObject | The complementary InteractiveObject instance that is affected by the change in focus. |
shiftKey | true if the Shift key modifier is activated; false otherwise. |
target | The InteractiveObject instance that currently has focus.
The target is not always the object in the display list
that registered the event listener. Use the currentTarget
property to access the object in the display list that is currently processing the event.
|
See also
| MOUSE_FOCUS_CHANGE | constant |
public static const MOUSE_FOCUS_CHANGE:String = "mouseFocusChange"
Defines the value of the type property of a mouseFocusChange event object.
This event has the following properties:
| Property | Value |
|---|---|
bubbles | true |
cancelable | true; call the preventDefault() method
to cancel default behavior. |
currentTarget | The object that is actively processing the Event object with an event listener. |
keyCode | 0; applies only to keyFocusChange events. |
relatedObject | The complementary InteractiveObject instance that is affected by the change in focus. |
shiftKey | false; applies only to keyFocusChange events. |
target | The InteractiveObject instance that currently has focus.
The target is not always the object in the display list
that registered the event listener. Use the currentTarget
property to access the object in the display list that is currently processing the event.
|
See also
FocusEventExample and
CustomSprite classes to show how focus can be used in conjunction with items drawn on the Stage to capture events and print information.
This example carries out the following tasks:
child (of type Sprite) and childCount (of type uint).for loop creates five light blue squares at (0,0). It begins by
assigning child to a new CustomSprite instance. Each time a CustomSprite
object is created, the following happens:size property of type uint is set to 50 pixels and bgColor is set
to light blue. buttonMode and useHandCursor properties of the
Sprite class are set to true within the constructor.click is instantiated, along with the associated subscriber
clickHandler(). The subscriber method creates a local variable target of
type Sprite and assigns it whichever box was clicked. The Stage's focus is then assigned to
target.draw() method is called, which creates a 50 x 50 pixel square by
calling the beginFill(), drawRect(), and endFill() methods of
the Graphics class and the instance properties.configureListeners() method is called, which instantiates three event
listeners/subscribers:focusIn/focusInHandler() is dispatched after the click event
for whichever display list object (box) is clicked.focusOut/focusOutHandler() is dispatched when another box is clicked or
if the focus leaves the Stage (for example, by clicking outside Flash Player).keyFocusChange/keyFocusChangeHandler() is dispatched if you use the Tab key
or the left-arrow or right-arrow keys to select a display list object. The keyFocusChangeHandler()
method traps the left-arrow and right-arrow keys, however, and calls the preventDefault() method
to disable them.for loop, each square is added to the display list and displayed (all in
the same area) by means of addChild().refreshLayout(), which distributes the orange
squares across the top (y = 0) of the display with 5 pixels separating each square.
package {
import flash.display.Sprite;
import flash.display.DisplayObject;
import flash.events.FocusEvent;
import flash.events.IEventDispatcher;
public class FocusEventExample extends Sprite {
private var gutter:uint = 5;
private var childCount:uint = 5;
public function FocusEventExample() {
var child:Sprite;
for(var i:uint; i < childCount; i++) {
child = new CustomSprite();
configureListeners(child);
addChild(child);
}
refreshLayout();
}
private function configureListeners(dispatcher:IEventDispatcher):void {
dispatcher.addEventListener(FocusEvent.FOCUS_IN, focusInHandler);
dispatcher.addEventListener(FocusEvent.FOCUS_OUT, focusOutHandler);
dispatcher.addEventListener(FocusEvent.KEY_FOCUS_CHANGE, keyFocusChangeHandler);
dispatcher.addEventListener(FocusEvent.MOUSE_FOCUS_CHANGE, mouseFocusChangeHandler);
}
private function refreshLayout():void {
var ln:uint = numChildren;
var child:DisplayObject = getChildAt(0);
var lastChild:DisplayObject = child;
for(var i:uint = 1; i < ln; i++) {
child = getChildAt(i);
child.x = lastChild.x + lastChild.width + gutter;
lastChild = child;
}
}
private function focusInHandler(event:FocusEvent):void {
var target:CustomSprite = CustomSprite(event.target);
trace("focusInHandler: " + target.name);
}
private function focusOutHandler(event:FocusEvent):void {
var target:CustomSprite = CustomSprite(event.target);
trace("focusOutHandler: " + target.name);
}
private function keyFocusChangeHandler(event:FocusEvent):void {
if(event.keyCode == 39 || event.keyCode == 37){
event.preventDefault()
}
var target:CustomSprite = CustomSprite(event.target);
trace("keyFocusChangeHandler: " + target.name);
}
private function mouseFocusChangeHandler(event:FocusEvent):void {
var target:CustomSprite = CustomSprite(event.target);
trace("mouseFocusChangeHandler: " + target.name);
}
}
}
import flash.display.Sprite;
import flash.events.MouseEvent;
class CustomSprite extends Sprite {
private var size:uint = 50;
private var bgColor:uint = 0x00CCFF;
public function CustomSprite() {
buttonMode = true;
useHandCursor = true;
addEventListener(MouseEvent.CLICK, clickHandler);
draw(size, size);
}
private function draw(w:uint, h:uint):void {
graphics.beginFill(bgColor);
graphics.drawRect(0, 0, w, h);
graphics.endFill();
}
private function clickHandler(event:MouseEvent):void {
var target:Sprite = Sprite(event.target);
trace("clickHandler: " + target.name);
stage.focus = target;
}
}
Send me an e-mail when comments are added to this page | Comment Report
Current page: http://livedocs.adobe.com/apollo/1.0/aslr/flash/events/FocusEvent.html