////////////////////////////////////////////////////////////////////////////////
//
// Licensed to the Apache Software Foundation (ASF) under one or more
// contributor license agreements. See the NOTICE file distributed with
// this work for additional information regarding copyright ownership.
// The ASF licenses this file to You under the Apache License, Version 2.0
// (the "License"); you may not use this file except in compliance with
// the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
////////////////////////////////////////////////////////////////////////////////
package mx.events
{
import flash.events.Event;
/**
* 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 mx.olap.OLAPCube
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public class CubeEvent extends Event
{
//--------------------------------------------------------------------------
//
// Class constants
//
//--------------------------------------------------------------------------
/**
* 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 |
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 |
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 |