Packagemx.events
Classpublic class CubeEvent
InheritanceCubeEvent Inheritance flash.events.Event

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.

See also

mx.olap.OLAPCube

Public Properties
 PropertyDefined By
  message : String
A description of what is being processed.
CubeEvent
  progress : int
The number of elements in the cube that have been updated.
CubeEvent
  total : int
The total number of elements in the cube that need to be udpated.
CubeEvent
Public Methods
 MethodDefined By
  
CubeEvent(type:String)
Constructor.
CubeEvent
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
messageproperty
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.

progressproperty 
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.

totalproperty 
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_COMPLETEConstant
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_PROGRESSConstant 
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_PROGRESSConstant 
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





Mon Dec 24 2012, 01:18 PM +11:00