Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
CubeEvent

Package | mx.events
Class | public class CubeEvent
Inheritance | CubeEvent 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

| Property | Defined 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

| Method | Defined By
--- | --- | ---
|  | CubeEvent(type:String) Constructor. | CubeEvent

Public Constants

| Constant | Defined 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:

Property | Value
--- | ---
`bubbles` | `false`
`cancelable` | `true`
`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`.
`description` | Description of what is being processed.
`progress` | The number of elements in the cube that have been updated.
`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.
`total` | The total number of elements in the cube that need to be udpated.
`type` | CubeEvent.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:

Property | Value
--- | ---
`bubbles` | `false`
`cancelable` | `true`
`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`.
`description` | Description of what is being processed.
`progress` | The number of elements in the cube that have been updated.
`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.
`total` | The total number of elements in the cube that need to be udpated.
`type` | CubeEvent.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:

Property | Value
--- | ---
`bubbles` | `false`
`cancelable` | `true`
`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`.
`description` | Description of what is being processed.
`progress` | The number of elements in the cube that have been updated.
`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.
`total` | The total number of elements in the cube that need to be udpated.
`type` | CubeEvent.QUERY_PROGRESS

Sun Mar 5 2017, 03:42 PM +11:00