////////////////////////////////////////////////////////////////////////////////
//
// 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;
import mx.core.IToolTip;
/**
* The ToolTipEvent class represents ToolTip events, which are generated by the ToolTipManager
* class. The ToolTipManager class calls the dispatchEvent()
method
* of the object to which the tip applies to dispatch the event.
*
* @see mx.managers.ToolTipManager
* @see mx.core.UIComponent
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public class ToolTipEvent extends Event
{
include "../core/Version.as";
//--------------------------------------------------------------------------
//
// Class constants
//
//--------------------------------------------------------------------------
/**
* The ToolTipEvent.TOOL_TIP_CREATE
constant defines the value of the
* type
property of the event object for a toolTipCreate
event.
*
*
The properties of the event object have the following values:
*Property | Value |
---|---|
bubbles | false |
cancelable | false |
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 . |
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. |
tooltip | The ToolTip object to * which this event applies. |
ToolTipEvent.TOOL_TIP_END
constant defines the value of the
* type
property of the event object for a toolTipEnd
event.
*
* The properties of the event object have the following values:
*Property | Value |
---|---|
bubbles | false |
cancelable | false |
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 . |
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. |
tooltip | The ToolTip object to * which this event applies. |
ToolTipEvent.TOOL_TIP_HIDE
constant defines the value of the
* type
property of the event object for a toolTipHide
event.
*
* The properties of the event object have the following values:
*Property | Value |
---|---|
bubbles | false |
cancelable | false |
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 . |
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. |
tooltip | The ToolTip object to * which this event applies. |
ToolTipEvent.TOOL_TIP_SHOW
constant defines the value of the
* type
property of the event object for a toolTipShow
event.
*
* The properties of the event object have the following values:
*Property | Value |
---|---|
bubbles | false |
cancelable | false |
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 . |
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. |
tooltip | The ToolTip object to * which this event applies. |
ToolTipEvent.TOOL_TIP_SHOWN
constant defines the value of the
* type
property of the event object for a toolTipShown
event.
*
* The properties of the event object have the following values:
*Property | Value |
---|---|
bubbles | false |
cancelable | false |
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 . |
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. |
tooltip | The ToolTip object to * which this event applies. |
ToolTipEvent.TOOL_TIP_START
constant defines the value of the
* type
property of the event object for a toolTipStart
event.
*
* The properties of the event object have the following values:
*Property | Value |
---|---|
bubbles | false |
cancelable | false |
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 . |
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. |
tooltip | The ToolTip object to * which this event applies. |