Adobe Flex 2 Language Reference - collected by Jimbob | Back to MY RESOURCES


Packagemx.events
Classpublic class StyleEvent
InheritanceStyleEvent Inheritance ProgressEvent Inheritance Event Inheritance Object

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

See also

mx.styles.StyleManager


Public Properties
 PropertyDefined by
 Inheritedbubbles : Boolean
Indicates whether an event is a bubbling event.
Event
 InheritedbytesLoaded : Number
The number of items or bytes loaded when the listener processes the event.
ProgressEvent
 InheritedbytesTotal : Number
The total number of items or bytes that will be loaded if the loading process succeeds.
ProgressEvent
 Inheritedcancelable : Boolean
Indicates whether the behavior associated with the event can be prevented.
Event
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcurrentTarget : Object
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
 InheritedeventPhase : uint
The current phase in the event flow.
Event
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 Inheritedtarget : Object
The event target.
Event
 Inheritedtype : String
The type of event.
Event
Public Methods
 MethodDefined by
  
StyleEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, bytesLoaded:uint = 0, bytesTotal:uint = 0, errorText:String = null)
Constructor.
StyleEvent
 Inherited
Creates a copy of the ProgressEvent object and sets each property's value to match that of the original.
ProgressEvent
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in your custom Event class.
Event
 Inherited
Checks whether preventDefault() has been called on the event.
Event
 Inherited
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
Returns a string that contains all the properties of the ProgressEvent object.
ProgressEvent
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] Defines the value of the type property of an activate event object.
Event
 InheritedADDED : String = "added"
[static] Defines the value of the type property of an added event object.
Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] Defines the value of the type property of an addedToStage event object.
Event
 InheritedCANCEL : String = "cancel"
[static] Defines the value of the type property of a cancel event object.
Event
 InheritedCHANGE : String = "change"
[static] Defines the value of the type property of a change event object.
Event
 InheritedCLOSE : String = "close"
[static] Defines the value of the type property of a close event object.
Event
 InheritedCLOSING : String = "closing"
[static] Defines the value of the type property of a closing event object.
Event
  COMPLETE : String = "complete"
[static] Dispatched when the style SWF has finished downloading.
StyleEvent
 InheritedCONNECT : String = "connect"
[static] Defines the value of the type property of a connect event object.
Event
 InheritedDEACTIVATE : String = "deactivate"
[static] Defines the value of the type property of a deactivate event object.
Event
 InheritedDOM_INITIALIZE : String = "domInitialize"
[static] Defines the value of the type property of a domInitialize event object.
Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] Defines the value of the type property of an enterFrame event object.
Event
  ERROR : String = "error"
[static] Dispatched when there is an error downloading the style SWF.
StyleEvent
 InheritedFULLSCREEN : String = "fullScreen"
[static] Defines the value of the type property of a fullScreen event object.
Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] Defines the value of the type property of an htmlBoundsChange event object.
Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] Defines the value of the type property of an htmlRender event object.
Event
 InheritedID3 : String = "id3"
[static] Defines the value of the type property of an id3 event object.
Event
 InheritedINIT : String = "init"
[static] Defines the value of the type property of an init event object.
Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] Defines the value of the type property of a locationChange event object.
Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] Defines the value of the type property of a mouseLeave event object.
Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] Defines the value of the type property of a networkChange event object.
Event
 InheritedOPEN : String = "open"
[static] Defines the value of the type property of an open event object.
Event
  PROGRESS : String = "progress"
[static] Dispatched when the style SWF is downloading.
StyleEvent
 InheritedREMOVED : String = "removed"
[static] Defines the value of the type property of a removed event object.
Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] Defines the value of the type property of a removedFromStage event object.
Event
 InheritedRENDER : String = "render"
[static] Defines the value of the type property of a render event object.
Event
 InheritedRESIZE : String = "resize"
[static] Defines the value of the type property of a resize event object.
Event
 InheritedSCROLL : String = "scroll"
[static] Defines the value of the type property of a scroll event object.
Event
 InheritedSELECT : String = "select"
[static] Defines the value of the type property of a select event object.
Event
 InheritedSOCKET_DATA : String = "socketData"
[static] Defines the value of the type property of a socketData event object.
ProgressEvent
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] Defines the value of the type property of a soundComplete event object.
Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] Defines the value of the type property of a tabChildrenChange event object.
Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] Defines the value of the type property of a tabEnabledChange event object.
Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] Defines the value of the type property of a tabIndexChange event object.
Event
 InheritedUNLOAD : String = "unload"
[static] Defines the value of the type property of an unload event object.
Event
Property detail
errorTextproperty
public var errorText:String

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)

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
COMPLETEconstant
public static const COMPLETE:String = "complete"

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:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe 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.
errorTextEmpty
targetThe 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.
ERRORconstant 
public static const ERROR:String = "error"

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:

An error message.
PropertyValue
bubblesfalse
bytesLoadedEmpty
bytesTotalEmpty
cancelablefalse
currentTargetThe 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
targetThe 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.
PROGRESSconstant 
public static const PROGRESS:String = "progress"

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:

Empty
PropertyValue
bubblesfalse
bytesLoadedThe number of bytes loaded.
bytesTotalThe total number of bytes to load.
cancelablefalse
currentTargetThe 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
targetThe 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.





collected by Jimbob 2007.05