ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
mx.events 

CubeEvent  - AS3 Flex
Packagemx.events
Classpublic class CubeEvent
InheritanceCubeEvent Inheritance Event Inheritance Object

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Event class used by OLAPCube to indicate its status. The CubeEvent class represents event objects that are specific to the OLAPCube class, such as the event that is dispatched when an cube is ready to be queried.

More examples

Manually dispatching events

Learn more

About Flex events

Related API Elements

mx.olap.OLAPCube

Public Properties
 PropertyDefined By
 Inheritedbubbles : Boolean
[read-only] Indicates whether an event is a bubbling event.
Event
 Inheritedcancelable : Boolean
[read-only] 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
[read-only] The object that is actively processing the Event object with an event listener.
Event
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
  message : String
A description of what is being processed.
CubeEvent
  progress : int
The number of elements in the cube that have been updated.
CubeEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
  total : int
The total number of elements in the cube that need to be udpated.
CubeEvent
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
CubeEvent(type:String)
Constructor.
CubeEvent
 Inherited
clone():Event
Duplicates an instance of an Event subclass.
Event
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isDefaultPrevented():Boolean
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
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
 Inherited
preventDefault():void
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
stopImmediatePropagation():void
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
stopPropagation():void
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns a string containing all the properties of the Event object.
Event
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  CUBE_COMPLETE : String = "complete"
[static] The CubeEvent.CUBE_COMPLETE constant defines the value of the type property of the event object for a complete event.
CubeEvent
  CUBE_PROGRESS : String = "progress"
[static] The CubeEvent.CUBE_PROGRESS constant defines the value of the type property of the event object for a progress event.
CubeEvent
  QUERY_PROGRESS : String = "queryProgress"
[static] The CubeEvent.QUERY_PROGRESS constant defines the value of the type property of the event object for a queryProgress event.
CubeEvent
Property Detail

message

property
public var message:String

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

A description of what is being processed.

progress

property 
public var progress:int

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The number of elements in the cube that have been updated.

total

property 
public var total:int

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The total number of elements in the cube that need to be udpated.

Constructor Detail

CubeEvent

()Constructor
public function CubeEvent(type:String)

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Constructor.

Parameters
type:String — The event type; indicates the action that caused the event.
Constant Detail

CUBE_COMPLETE

Constant
public static const CUBE_COMPLETE:String = "complete"

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The CubeEvent.CUBE_COMPLETE constant defines the value of the type property of the event object for a complete event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelabletrue
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.
descriptionDescription of what is being processed.
progressThe number of elements in the cube that have been updated.
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.
totalThe total number of elements in the cube that need to be udpated.
typeCubeEvent.CUBE_COMPLETE

CUBE_PROGRESS

Constant 
public static const CUBE_PROGRESS:String = "progress"

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The CubeEvent.CUBE_PROGRESS constant defines the value of the type property of the event object for a progress event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelabletrue
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.
descriptionDescription of what is being processed.
progressThe number of elements in the cube that have been updated.
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.
totalThe total number of elements in the cube that need to be udpated.
typeCubeEvent.CUBE_PROGRESS

QUERY_PROGRESS

Constant 
public static const QUERY_PROGRESS:String = "queryProgress"

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The CubeEvent.QUERY_PROGRESS constant defines the value of the type property of the event object for a queryProgress event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelabletrue
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.
descriptionDescription of what is being processed.
progressThe number of elements in the cube that have been updated.
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.
totalThe total number of elements in the cube that need to be udpated.
typeCubeEvent.QUERY_PROGRESS



© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy