StyleEvent

Package	mx.events
Class	public class StyleEvent
Inheritance	StyleEvent ProgressEvent Event Object

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The StyleEvent class represents an event object used by the StyleManager class when a style SWF is being downloaded.

More examples

Manually dispatching events

Learn more

About Flex events

Related API Elements

mx.styles.StyleManager

Public Properties

	Property		Defined By
		bubbles : Boolean [read-only] Indicates whether an event is a bubbling event.	Event
		bytesLoaded : Number The number of items or bytes loaded when the listener processes the event.	ProgressEvent
		bytesTotal : Number The total number of items or bytes that will be loaded if the loading process succeeds.	ProgressEvent
		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
		errorText : String The error message if the type is ERROR; otherwise, it is null.	StyleEvent
		eventPhase : uint [read-only] The current phase in the event flow.	Event
		target : Object [read-only] The event target.	Event
		type : String [read-only] The type of event.	Event

Public Methods

	Method		Defined By
		StyleEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, bytesLoaded:uint = 0, bytesTotal:uint = 0, errorText:String = null) Constructor.	StyleEvent
		clone():Event [override] Creates a copy of the ProgressEvent object and sets each property's value to match that of the original.	ProgressEvent
		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
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String [override] Returns a string that contains all the properties of the ProgressEvent object.	ProgressEvent
		valueOf():Object Returns the primitive value of the specified object.	Object

Public Constants

	Constant		Defined By
		COMPLETE : String = "complete" [static] Dispatched when the style SWF has finished downloading.	StyleEvent
		ERROR : String = "error" [static] Dispatched when there is an error downloading the style SWF.	StyleEvent
		PROGRESS : String = "progress" [static] Dispatched when the style SWF is downloading.	StyleEvent

Property Detail

errorText

property

public var errorText:String

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The error message if the type is ERROR; otherwise, it is null.

Constructor Detail

StyleEvent

()

Constructor

public function StyleEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, bytesLoaded:uint = 0, bytesTotal:uint = 0, errorText:String = null)

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Constructor.

Parameters

	`type:String` — The type of the event. Possible values are: "progress" (`StyleEvent.PROGRESS`); "complete" (`StyleEvent.COMPLETE`); "error" (`StyleEvent.ERROR`);

	`bubbles:Boolean` (default = `false`) — 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 cancelled.

	`bytesLoaded:uint` (default = `0`) — The number of bytes loaded at the time the listener processes the event.

	`bytesTotal:uint` (default = `0`) — The total number of bytes that will ultimately be loaded if the loading process succeeds.

	`errorText:String` (default = `null`) — The error message of the error when type is StyleEvent.ERROR.

Constant Detail

COMPLETE

Constant

public static const COMPLETE:String = "complete"

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Dispatched when the style SWF has finished downloading. The StyleEvent.COMPLETE constant defines the value of the type property of the event object for a styleComplete event.

The properties of the event object have the following values:

Property	Value
`bubbles`	false
`cancelable`	false
`currentTarget`	The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`errorText`	Empty
`target`	The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.

ERROR

Constant

public static const ERROR:String = "error"

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Dispatched when there is an error downloading the style SWF. The StyleEvent.ERROR constant defines the value of the type property of the event object for a styleError event.

The properties of the event object have the following values:

Property	Value
`bubbles`	false
`bytesLoaded`	Empty
`bytesTotal`	Empty
`cancelable`	false
`currentTarget`	The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`errorText`
`target`	The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.

PROGRESS

Constant

public static const PROGRESS:String = "progress"

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Dispatched when the style SWF is downloading. The StyleEvent.PROGRESS constant defines the value of the type property of the event object for a styleProgress event.

The properties of the event object have the following values:

Property	Value
`bubbles`	false
`bytesLoaded`	The number of bytes loaded.
`bytesTotal`	The total number of bytes to load.
`cancelable`	false
`currentTarget`	The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`errorText`
`target`	The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.

Legal Notices | Online Privacy Policy

StyleEvent - AS3 Flex

Classes x

errorText

StyleEvent

COMPLETE

ERROR

PROGRESS