blob: c97756e9a559798db442a161be0048d425c0d16c [file] [log] [blame]
////////////////////////////////////////////////////////////////////////////////
//
// 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;
/**
* The AIREvent class represents the event object passed to
* the event listener for several AIR-specific events dispatched by the Window
* and WindowedApplication components.
*
* @see mx.core.Window
* @see mx.core.WindowedApplication
*
*
* @langversion 3.0
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public class AIREvent extends Event
{
include "../core/Version.as";
//--------------------------------------------------------------------------
//
// Class constants
//
//--------------------------------------------------------------------------
/**
* The AIREvent.APPLICATION_ACTIVATE constant defines the value of the
* <code>type</code> property of the event object for an
* <code>applicationActivate</code> event.
*
* <p>The properties of the event object have the following values:</p>
* <table class="innertable">
* <tr><th>Property</th><th>Value</th></tr>
* <tr><td><code>bubbles</code></td><td>false</td></tr>
* <tr><td><code>cancelable</code></td><td>false</td></tr>
* <tr><td><code>currentTarget</code></td><td>The Object that defines the
* event listener that handles the event. For example, if you use
* <code>myButton.addEventListener()</code> to register an event listener,
* myButton is the value of the <code>currentTarget</code>. </td></tr>
* <tr><td><code>file</code></td><td>The File object associated with this event.</td></tr>
* <tr><td><code>target</code></td><td>The Object that dispatched the event;
* it is not always the Object listening for the event.
* Use the <code>currentTarget</code> property to always access the
* Object listening for the event.</td></tr>
* <tr><td><code>type</code></td><td>AIREvent.APPLICATION_ACTIVATE</td></tr>
* </table>
*
* @eventType applicationActivate
*
* @langversion 3.0
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public static const APPLICATION_ACTIVATE:String = "applicationActivate";
/**
* The AIREvent.APPLICATION_DEACTIVATE constant defines the value of the
* <code>type</code> property of the event object for an
* <code>applicationDeactivate</code> event.
*
* <p>The properties of the event object have the following values:</p>
* <table class="innertable">
* <tr><th>Property</th><th>Value</th></tr>
* <tr><td><code>bubbles</code></td><td>false</td></tr>
* <tr><td><code>cancelable</code></td><td>false</td></tr>
* <tr><td><code>currentTarget</code></td><td>The Object that defines the
* event listener that handles the event. For example, if you use
* <code>myButton.addEventListener()</code> to register an event listener,
* myButton is the value of the <code>currentTarget</code>. </td></tr>
* <tr><td><code>file</code></td><td>The File object associated with this event.</td></tr>
* <tr><td><code>target</code></td><td>The Object that dispatched the event;
* it is not always the Object listening for the event.
* Use the <code>currentTarget</code> property to always access the
* Object listening for the event.</td></tr>
* <tr><td><code>type</code></td><td>AIREvent.APPLICATION_DEACTIVATE</td></tr>
* </table>
*
* @eventType applicationDeactivate
*
* @langversion 3.0
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public static const APPLICATION_DEACTIVATE:String = "applicationDeactivate";
/**
* The AIREvent.WINDOW_ACTIVATE constant defines the value of the
* <code>type</code> property of the event object for a
* <code>windowActivate</code> event.
*
* <p>The properties of the event object have the following values:</p>
* <table class="innertable">
* <tr><th>Property</th><th>Value</th></tr>
* <tr><td><code>bubbles</code></td><td>false</td></tr>
* <tr><td><code>cancelable</code></td><td>false</td></tr>
* <tr><td><code>currentTarget</code></td><td>The Object that defines the
* event listener that handles the event. For example, if you use
* <code>myButton.addEventListener()</code> to register an event listener,
* myButton is the value of the <code>currentTarget</code>. </td></tr>
* <tr><td><code>file</code></td><td>The File object associated with this event.</td></tr>
* <tr><td><code>target</code></td><td>The Object that dispatched the event;
* it is not always the Object listening for the event.
* Use the <code>currentTarget</code> property to always access the
* Object listening for the event.</td></tr>
* <tr><td><code>type</code></td><td>AIREvent.WINDOW_ACTIVATE</td></tr>
* </table>
*
* @eventType windowActivate
*
* @langversion 3.0
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public static const WINDOW_ACTIVATE:String = "windowActivate";
/**
* The AIREvent.WINDOW_DEACTIVATE constant defines the value of the
* <code>type</code> property of the event object for a
* <code>windowDeactivate</code> event.
*
* <p>The properties of the event object have the following values:</p>
* <table class="innertable">
* <tr><th>Property</th><th>Value</th></tr>
* <tr><td><code>bubbles</code></td><td>false</td></tr>
* <tr><td><code>cancelable</code></td><td>false</td></tr>
* <tr><td><code>currentTarget</code></td><td>The Object that defines the
* event listener that handles the event. For example, if you use
* <code>myButton.addEventListener()</code> to register an event listener,
* myButton is the value of the <code>currentTarget</code>. </td></tr>
* <tr><td><code>file</code></td><td>The File object associated with this event.</td></tr>
* <tr><td><code>target</code></td><td>The Object that dispatched the event;
* it is not always the Object listening for the event.
* Use the <code>currentTarget</code> property to always access the
* Object listening for the event.</td></tr>
* <tr><td><code>type</code></td><td>AIREvent.WINDOW_DEACTIVATE</td></tr>
* </table>
*
* @eventType windowDeactivate
*
* @langversion 3.0
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public static const WINDOW_DEACTIVATE:String = "windowDeactivate";
/**
* The AIREvent.WINDOW_COMPLETE constant defines the value of the
* <code>type</code> property of the event object for an
* <code>windowComplete</code> event.
*
* <p>The properties of the event object have the following values:</p>
* <table class="innertable">
* <tr><th>Property</th><th>Value</th></tr>
* <tr><td><code>bubbles</code></td><td>false</td></tr>
* <tr><td><code>cancelable</code></td><td>false</td></tr>
* <tr><td><code>currentTarget</code></td><td>The Object that defines the
* event listener that handles the event. For example, if you use
* <code>myButton.addEventListener()</code> to register an event listener,
* myButton is the value of the <code>currentTarget</code>. </td></tr>
* <tr><td><code>file</code></td><td>The File object associated with this event.</td></tr>
* <tr><td><code>target</code></td><td>The Object that dispatched the event;
* it is not always the Object listening for the event.
* Use the <code>currentTarget</code> property to always access the
* Object listening for the event.</td></tr>
* <tr><td><code>type</code></td><td>AIREvent.WINDOW_COMPLETE</td></tr>
* </table>
*
* @eventType windowComplete
*
* @langversion 3.0
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public static const WINDOW_COMPLETE:String = "windowComplete";
//--------------------------------------------------------------------------
//
// Constructor
//
//--------------------------------------------------------------------------
/**
* Constructor.
*
* @param type The event type; indicates the action that caused the event.
*
* @param bubbles Specifies whether the event can bubble up
* the display list hierarchy.
*
* @param cancelable Specifies whether the behavior
* associated with the event can be prevented.
*
* @langversion 3.0
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public function AIREvent(type:String, bubbles:Boolean = false,
cancelable:Boolean = false)
{
super(type, bubbles, cancelable);
}
//--------------------------------------------------------------------------
//
// Overridden methods: Event
//
//--------------------------------------------------------------------------
/**
* @private
*/
override public function clone():Event
{
return new AIREvent(type, bubbles, cancelable);
}
}
}