fl.events.ComponentEvent (ActionScript 3.0)

	Property	Defined By
		bubbles : Boolean [read-only] Indicates whether an event is a bubbling event.	Event
		cancelable : Boolean [read-only] 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 [read-only] The object that is actively processing the Event object with an event listener.	Event
		eventPhase : uint [read-only] The current phase in the event flow.	Event
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		target : Object [read-only] The event target.	Event
		type : String [read-only] The type of event.	Event

	Method	Defined By
		ComponentEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false) Creates a new ComponentEvent object that contains information about a component event.	ComponentEvent
		clone():Event Creates a copy of the ComponentEvent object and sets the value of each parameter to match the original.	ComponentEvent
		formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.	Event
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isDefaultPrevented():Boolean Checks whether the preventDefault() method has been called on the event.	Event
		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
		preventDefault():void Cancels an event's default behavior if that behavior can be canceled.	Event
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void 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
		toString():String Returns a string that contains all the properties of the ComponentEvent object.	ComponentEvent
		valueOf():Object Returns the primitive value of the specified object.	Object

Public Constants

	Constant		Defined By
		ACTIVATE : String = "activate" [static] The Event.ACTIVATE constant defines the value of the type property of an activate event object.	Event
		ADDED : String = "added" [static] The Event.ADDED constant defines the value of the type property of an added event object.	Event
		ADDED_TO_STAGE : String = "addedToStage" [static] The Event.ADDED_TO_STAGE constant defines the value of the type property of an addedToStage event object.	Event
		BUTTON_DOWN : String = "buttonDown" [static] Defines the value of the type property of a buttonDown event object.	ComponentEvent
		CANCEL : String = "cancel" [static] The Event.CANCEL constant defines the value of the type property of a cancel event object.	Event
		CHANGE : String = "change" [static] The Event.CHANGE constant defines the value of the type property of a change event object.	Event
		CLOSE : String = "close" [static] The Event.CLOSE constant defines the value of the type property of a close event object.	Event
		CLOSING : String = "closing" [static] The Event.CLOSING constant defines the value of the type property of a closing event object.	Event
		COMPLETE : String = "complete" [static] The Event.COMPLETE constant defines the value of the type property of a complete event object.	Event
		CONNECT : String = "connect" [static] The Event.CONNECT constant defines the value of the type property of a connect event object.	Event
		DEACTIVATE : String = "deactivate" [static] The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.	Event
		DISPLAYING : String = "displaying" [static] Defines the value of the type property of a displaying event object.	Event
		ENTER : String = "enter" [static] Defines the value of the type property of an enter event object.	ComponentEvent
		ENTER_FRAME : String = "enterFrame" [static] The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.	Event
		EXITING : String = "exiting" [static] The Event.EXITING constant defines the value of the type property of an exiting event object.	Event
		FULLSCREEN : String = "fullScreen" [static] The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.	Event
		HIDE : String = "hide" [static] Defines the value of the type property of a hide event object.	ComponentEvent
		HTML_BOUNDS_CHANGE : String = "htmlBoundsChange" [static] The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.	Event
		HTML_DOM_INITIALIZE : String = "htmlDOMInitialize" [static] The Event.HTML_DOM_INITIALIZE constant defines the value of the type property of an htmlDOMInitialize event object.	Event
		HTML_RENDER : String = "htmlRender" [static] The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.	Event
		ID3 : String = "id3" [static] The Event.ID3 constant defines the value of the type property of an id3 event object.	Event
		INIT : String = "init" [static] The Event.INIT constant defines the value of the type property of an init event object.	Event
		LABEL_CHANGE : String = "labelChange" [static] Defines the value of the type property of a labelChange event object.	ComponentEvent
		LOCATION_CHANGE : String = "locationChange" [static] The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.	Event
		MOUSE_LEAVE : String = "mouseLeave" [static] The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.	Event
		MOVE : String = "move" [static] Defines the value of the type property of a move event object.	ComponentEvent
		NETWORK_CHANGE : String = "networkChange" [static] The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.	Event
		OPEN : String = "open" [static] The Event.OPEN constant defines the value of the type property of an open event object.	Event
		REMOVED : String = "removed" [static] The Event.REMOVED constant defines the value of the type property of a removed event object.	Event
		REMOVED_FROM_STAGE : String = "removedFromStage" [static] The Event.REMOVED_FROM_STAGE constant defines the value of the type property of a removedFromStage event object.	Event
		RENDER : String = "render" [static] The Event.RENDER constant 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.	ComponentEvent
		SCROLL : String = "scroll" [static] The Event.SCROLL constant defines the value of the type property of a scroll event object.	Event
		SELECT : String = "select" [static] The Event.SELECT constant defines the value of the type property of a select event object.	Event
		SHOW : String = "show" [static] Defines the value of the type property of a show event object.	ComponentEvent
		SOUND_COMPLETE : String = "soundComplete" [static] The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.	Event
		TAB_CHILDREN_CHANGE : String = "tabChildrenChange" [static] The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.	Event
		TAB_ENABLED_CHANGE : String = "tabEnabledChange" [static] The Event.TAB_ENABLED_CHANGE constant defines the value of the type property of a tabEnabledChange event object.	Event
		TAB_INDEX_CHANGE : String = "tabIndexChange" [static] The Event.TAB_INDEX_CHANGE constant defines the value of the type property of a tabIndexChange event object.	Event
		UNLOAD : String = "unload" [static] The Event.UNLOAD constant defines the value of the type property of an unload event object.	Event
		USER_IDLE : String = "userIdle" [static] The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.	Event
		USER_PRESENT : String = "userPresent" [static] The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.	Event

Constructor Detail

ComponentEvent

()

Constructor

public function ComponentEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false)

Language Version :

ActionScript 3.0

Runtime Versions :

AIR 1.0, Flash Player 9.0.28.0

Creates a new ComponentEvent object that contains information about a component event. A ComponentEvent object is passed as a parameter to an event listener.

Parameters

	`type:String` — The type of the event. Event listeners can access this information through the `type` property of the event object. A component can have the following types of events: `ComponentEvent.BUTTON_DOWN`, `ComponentEvent.ENTER`, `ComponentEvent.HIDE`, `ComponentEvent.LABEL_CHANGE`, `ComponentEvent.MOVE`, `ComponentEvent.RESIZE`, `ComponentEvent.SHOW`.

	`bubbles:Boolean` (default = `false`) — Determines whether the ComponentEvent object participates in the bubbling phase of the event flow. Event listeners can access this information through the `bubbles` property of the event object.

	`cancelable:Boolean` (default = `false`) — Determines whether the ComponentEvent object can be canceled. Event listeners can access this information through the `cancelable` property of the event object.

Method Detail

clone

()

method

override public function clone():Event

Language Version :

ActionScript 3.0

Runtime Versions :

AIR 1.0, Flash Player 9.0.28.0

Creates a copy of the ComponentEvent object and sets the value of each parameter to match the original.

Returns

Event — A new ComponentEvent object with property values that match those of the original.

toString

()

method

override public function toString():String

Language Version :

ActionScript 3.0

Runtime Versions :

AIR 1.0, Flash Player 9.0.28.0

Returns a string that contains all the properties of the ComponentEvent object. The string is in the following format:

[ComponentEvent type=value bubbles=value cancelable=value]

Returns

String — A string representation of the ComponentEvent object.

Constant Detail

BUTTON_DOWN

Constant

public static const BUTTON_DOWN:String = "buttonDown"

Language Version :

ActionScript 3.0

Runtime Versions :

AIR 1.0, Flash Player 9.0.28.0

Defines the value of the type property of a buttonDown event object.

This event has the following properties:

Property	Value
`bubbles`	`false`
`cancelable`	`false`; there is no default behavior to cancel.
`currentTarget`	The object that is actively processing the event object with an event listener.
`target`	The object that dispatched the event. The target is not always the object listening for the event. Use the `currentTarget` property to access the object that is listening for the event.

ENTER

Constant

public static const ENTER:String = "enter"

Language Version :

ActionScript 3.0

Runtime Versions :

AIR 1.0, Flash Player 9.0.28.0

Defines the value of the type property of an enter event object.

This event has the following properties:

Property	Value
`bubbles`	`false`
`cancelable`	`false`; there is no default behavior to cancel.
`currentTarget`	The object that is actively processing the event object with an event listener.
`target`	The object that dispatched the event. The target is not always the object listening for the event. Use the `currentTarget` property to access the object that is listening for the event.

HIDE

Constant

public static const HIDE:String = "hide"

Language Version :

ActionScript 3.0

Runtime Versions :

AIR 1.0, Flash Player 9.0.28.0

Defines the value of the type property of a hide event object.

This event has the following properties:

Property	Value
`bubbles`	`false`
`cancelable`	`false`; there is no default behavior to cancel.
`currentTarget`	The object that is actively processing the event object with an event listener.
`target`	The object that dispatched the event. The target is not always the object listening for the event. Use the `currentTarget` property to access the object that is listening for the event.

See also

SHOW

Example

The following example creates a Button component that toggles a List component's visibility:


import fl.controls.Button;
import fl.controls.List;
import fl.events.ComponentEvent;
import fl.events.ListEvent;

var toggleButton:Button = new Button();
toggleButton.label = "toggle visibility";
toggleButton.toggle = true;
toggleButton.selected = true;
toggleButton.emphasized = toggleButton.selected;
toggleButton.addEventListener(Event.CHANGE, changeHandler);
toggleButton.width = 150;
toggleButton.move(10, 10);
addChild(toggleButton);

var myList:List = new List();
myList.addItem({label:"Item 1"});
myList.addItem({label:"Item 2"});
myList.addItem({label:"Item 3"});
myList.addItem({label:"Item 4"});
myList.addItem({label:"Item 5"});
myList.move(10, 40);
myList.addEventListener(ComponentEvent.HIDE, hideHandler);
myList.addEventListener(ComponentEvent.SHOW, showHandler);
myList.addEventListener(ListEvent.ITEM_ROLL_OVER, itemRollOverHandler);
myList.addEventListener(ListEvent.ITEM_ROLL_OUT, itemRollOverHandler);
addChild(myList);


function changeHandler(event:Event):void {
    toggleButton.emphasized = toggleButton.selected;
    myList.visible = toggleButton.selected;
}

function hideHandler(event:ComponentEvent):void {
    trace("hiding list");
    myList.removeEventListener(ListEvent.ITEM_ROLL_OVER, itemRollOverHandler);
    myList.removeEventListener(ListEvent.ITEM_ROLL_OUT, itemRollOverHandler);
}

function showHandler(event:ComponentEvent):void {
    trace("showing list");
    myList.addEventListener(ListEvent.ITEM_ROLL_OVER, itemRollOverHandler);
    myList.addEventListener(ListEvent.ITEM_ROLL_OUT, itemRollOverHandler);
}

function itemRollOverHandler(event:ListEvent):void {
    trace(event.type + ":", event.item.label);
}

function itemRollOutHandler(event:ListEvent):void {
    trace(event.type + ":", event.item.label);
}

LABEL_CHANGE

Constant

public static const LABEL_CHANGE:String = "labelChange"

Language Version :

ActionScript 3.0

Runtime Versions :

AIR 1.0, Flash Player 9.0.28.0

Defines the value of the type property of a labelChange event object.

This event has the following properties:

Property	Value
`bubbles`	`false`
`cancelable`	`false`; there is no default behavior to cancel.
`currentTarget`	The object that is actively processing the event object with an event listener.
`target`	The object that dispatched the event. The target is not always the object listening for the event. Use the `currentTarget` property to access the object that is listening for the event.

MOVE

Constant

public static const MOVE:String = "move"

Language Version :

ActionScript 3.0

Runtime Versions :

AIR 1.0, Flash Player 9.0.28.0

Defines the value of the type property of a move event object.

This event has the following properties:

Property	Value
`bubbles`	`false`
`cancelable`	`false`; there is no default behavior to cancel.
`currentTarget`	The object that is actively processing the event object with an event listener.
`target`	The object that dispatched the event. The target is not always the object listening for the event. Use the `currentTarget` property to access the object that is listening for the event.

Example

The following example repositions a UILoader component instance on the Stage based on the value of a Slider component:


import fl.controls.Slider;
import fl.containers.UILoader;
import fl.events.ComponentEvent;
import fl.events.SliderEvent;

var myUILoader:UILoader = new UILoader();
myUILoader.source = "http://www.helpexamples.com/flash/images/image3.jpg";
myUILoader.move(10, 20); 
myUILoader.addEventListener(ComponentEvent.MOVE, moveHandler);
addChild(myUILoader);

var mySlider:Slider = new Slider();
mySlider.liveDragging = true;
mySlider.minimum = myUILoader.x;
mySlider.maximum = myUILoader.x + 200;
mySlider.snapInterval = 1;
mySlider.tickInterval = 10;
mySlider.move(10, 10);
mySlider.addEventListener(SliderEvent.CHANGE, changeHandler);
addChild(mySlider);

function changeHandler(event:SliderEvent):void {
    myUILoader.x = event.value;
}

function moveHandler(event:ComponentEvent):void {
    trace("[move] x:" + event.currentTarget.x + ", y:" + event.currentTarget.y);
}

RESIZE

Constant

public static const RESIZE:String = "resize"

Language Version :

ActionScript 3.0

Runtime Versions :

AIR 1.0, Flash Player 9.0.28.0

Defines the value of the type property of a resize event object.

This event has the following properties:

Property	Value
`bubbles`	`false`
`cancelable`	`false`; there is no default behavior to cancel.
`currentTarget`	The object that is actively processing the event object with an event listener.
`target`	The object that dispatched the event. The target is not always the object listening for the event. Use the `currentTarget` property to access the object that is listening for the event.

Example

The following example loads an external image into a UILoader component instance and centers it on the Stage using the resize event and move() method:


import fl.containers.UILoader;
import fl.events.ComponentEvent;

var myUILoader:UILoader = new UILoader();
myUILoader.scaleContent = false;
myUILoader.addEventListener(ComponentEvent.RESIZE, resizeHandler);
myUILoader.source = "http://www.helpexamples.com/flash/images/image3.jpg";
addChild(myUILoader);

function resizeHandler(event:ComponentEvent):void {
    var myImg:UILoader = event.currentTarget as UILoader;
    var newX:uint = (stage.stageWidth - myImg.width) / 2;
    var newY:uint = (stage.stageHeight - myImg.height) / 2;
    myImg.move(newX, newY);
}

SHOW

Constant

public static const SHOW:String = "show"

Language Version :

ActionScript 3.0

Runtime Versions :

AIR 1.0, Flash Player 9.0.28.0

Defines the value of the type property of a show event object.

This event has the following properties:

Property	Value
`bubbles`	`false`
`cancelable`	`false`; there is no default behavior to cancel.
`currentTarget`	The object that is actively processing the event object with an event listener.
`target`	The object that dispatched the event. The target is not always the object listening for the event. Use the `currentTarget` property to access the object that is listening for the event.

Comments

capheen said on Aug 8, 2007 at 1:53 PM :

Copying and pasting these examples into the actions panel of frame 1 produces the following errors:

1172: Definition fl.controls:Button could not be found.
1172: Definition fl.controls:List could not be found.
1172: Definition fl.events:ComponentEvent could not be found.
1172: Definition fl.events:ListEvent could not be found.

I have found this is true with all packages in the fl. prefex.

tderich said on Sep 25, 2007 at 4:11 PM :

Please read this page before working with AS3 samples. You have to do more than copy/paste:
http://livedocs.adobe.com/flash/9.0/ActionScriptLangRefV3/ExampleInstruct.html

Spuds202 said on Oct 5, 2007 at 8:36 AM :

For most of the simple examples (including those above) that do not define a class structure you need to take the extra step of dragging any referenced user interface components to the library. To be honest, I hope Adobe corrects this in the future. The runtime should recognize what it needs to do when it sees the proper import statement.

No screen name said on Apr 9, 2008 at 8:18 PM :

yes, this is very troublesome to drag the components to the library every time. for common components, these should be done by the software, as we has done the "import " in the script.

Package	fl.events
Class	public class ComponentEvent
Inheritance	ComponentEvent Event Object