Paquete | mx.managers |
Clase | public class ToolTipManager |
Herencia | ToolTipManager EventDispatcher Object |
Versión del lenguaje: | ActionScript 3.0 |
Versión de producto: | Flex 3 |
Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
Más ejemplos
ToolTip objects in multi-versioned applications
Using the ToolTip Manager
Creating custom ToolTips
Elementos de API relacionados
Propiedad | Definido por | ||
---|---|---|---|
constructor : Object
Una referencia a la clase de objeto o función constructora para una instancia de objeto determinada. | Object | ||
currentTarget : DisplayObject [estática]
The UIComponent that is currently displaying a ToolTip,
or null if none is. | ToolTipManager | ||
currentToolTip : mx.core:IToolTip [estática]
The ToolTip object that is currently visible,
or null if none is shown. | ToolTipManager | ||
enabled : Boolean [estática]
If true, the ToolTipManager will automatically show
ToolTips when the user moves the mouse pointer over components. | ToolTipManager | ||
hideDelay : Number [estática]
The amount of time, in milliseconds, that Flex waits
to hide the ToolTip after it appears. | ToolTipManager | ||
hideEffect : IAbstractEffect [estática]
The effect that plays when a ToolTip is hidden,
or null if the ToolTip should disappear with no effect. | ToolTipManager | ||
scrubDelay : Number [estática]
The amount of time, in milliseconds, that a user can take
when moving the mouse between controls before Flex again waits
for the duration of showDelay to display a ToolTip. | ToolTipManager | ||
showDelay : Number [estática]
The amount of time, in milliseconds, that Flex waits
before displaying the ToolTip box once a user
moves the mouse over a component that has a ToolTip. | ToolTipManager | ||
showEffect : IAbstractEffect [estática]
The effect that plays when a ToolTip is shown,
or null if the ToolTip should appear with no effect. | ToolTipManager | ||
toolTipClass : Class [estática]
The class to use for creating ToolTips. | ToolTipManager |
Método | Definido por | ||
---|---|---|---|
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registra un objeto de detector de eventos con un objeto EventDispatcher, de modo que el detector reciba la notificación de un evento. | EventDispatcher | ||
createToolTip(text:String, x:Number, y:Number, errorTipBorderStyle:String = null, context:IUIComponent = null):mx.core:IToolTip [estática]
Creates an instance of the ToolTip class with the specified text
and displays it at the specified location in stage coordinates. | ToolTipManager | ||
[estática]
Destroys a specified ToolTip that was created by the createToolTip() method. | ToolTipManager | ||
Distribuye un evento en el flujo del evento. | EventDispatcher | ||
Comprueba si el objeto EventDispatcher tiene detectores registrados para un tipo concreto de evento. | EventDispatcher | ||
Indica si un objeto tiene definida una propiedad especificada. | Object | ||
Indica si hay una instancia de la clase Object en la cadena de prototipo del objeto especificado como parámetro. | Object | ||
Indica si existe la propiedad especificada y si es enumerable. | Object | ||
Elimina un detector del objeto EventDispatcher. | EventDispatcher | ||
Establece la disponibilidad de una propiedad dinámica para operaciones de bucle. | Object | ||
Devuelve la representación de cadena de este objeto, con formato según las convenciones específicas de configuración regional. | Object | ||
Devuelve la representación de cadena del objeto especificado. | Object | ||
Devuelve el valor simple del objeto especificado. | Object | ||
Comprueba si hay registrado un detector de eventos con este objeto EventDispatcher o con cualquiera de sus ascendientes para el tipo de evento concreto. | EventDispatcher |
currentTarget | propiedad |
currentTarget:DisplayObject
Versión del lenguaje: | ActionScript 3.0 |
Versión de producto: | Flex 3 |
Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
The UIComponent that is currently displaying a ToolTip,
or null
if none is.
Implementación
public static function get currentTarget():DisplayObject
public static function set currentTarget(value:DisplayObject):void
currentToolTip | propiedad |
currentToolTip:mx.core:IToolTip
Versión del lenguaje: | ActionScript 3.0 |
Versión de producto: | Flex 3 |
Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
The ToolTip object that is currently visible,
or null
if none is shown.
Implementación
public static function get currentToolTip():mx.core:IToolTip
public static function set currentToolTip(value:mx.core:IToolTip):void
enabled | propiedad |
enabled:Boolean
Versión del lenguaje: | ActionScript 3.0 |
Versión de producto: | Flex 3 |
Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
If true
, the ToolTipManager will automatically show
ToolTips when the user moves the mouse pointer over components.
If false
, no ToolTips will be shown.
El valor predeterminado es true.
Implementación
public static function get enabled():Boolean
public static function set enabled(value:Boolean):void
hideDelay | propiedad |
hideDelay:Number
Versión del lenguaje: | ActionScript 3.0 |
Versión de producto: | Flex 3 |
Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
The amount of time, in milliseconds, that Flex waits
to hide the ToolTip after it appears.
Once Flex hides a ToolTip, the user must move the mouse
off the component and then back onto it to see the ToolTip again.
If you set hideDelay
to Infinity
,
Flex does not hide the ToolTip until the user triggers an event,
such as moving the mouse off of the component.
El valor predeterminado es 10000.
Implementación
public static function get hideDelay():Number
public static function set hideDelay(value:Number):void
hideEffect | propiedad |
hideEffect:IAbstractEffect
Versión del lenguaje: | ActionScript 3.0 |
Versión de producto: | Flex 3 |
Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
The effect that plays when a ToolTip is hidden,
or null
if the ToolTip should disappear with no effect.
El valor predeterminado es null.
Implementación
public static function get hideEffect():IAbstractEffect
public static function set hideEffect(value:IAbstractEffect):void
scrubDelay | propiedad |
scrubDelay:Number
Versión del lenguaje: | ActionScript 3.0 |
Versión de producto: | Flex 3 |
Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
The amount of time, in milliseconds, that a user can take
when moving the mouse between controls before Flex again waits
for the duration of showDelay
to display a ToolTip.
This setting is useful if the user moves quickly from one control
to another; after displaying the first ToolTip, Flex will display
the others immediately rather than waiting.
The shorter the setting for scrubDelay
, the more
likely that the user must wait for an amount of time specified
by showDelay
in order to see the next ToolTip.
A good use of this property is if you have several buttons on a
toolbar, and the user will quickly scan across them to see brief
descriptions of their functionality.
El valor predeterminado es 100.
Implementación
public static function get scrubDelay():Number
public static function set scrubDelay(value:Number):void
showDelay | propiedad |
showDelay:Number
Versión del lenguaje: | ActionScript 3.0 |
Versión de producto: | Flex 3 |
Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
The amount of time, in milliseconds, that Flex waits
before displaying the ToolTip box once a user
moves the mouse over a component that has a ToolTip.
To make the ToolTip appear instantly, set showDelay
to 0.
El valor predeterminado es 500.
Implementación
public static function get showDelay():Number
public static function set showDelay(value:Number):void
showEffect | propiedad |
showEffect:IAbstractEffect
Versión del lenguaje: | ActionScript 3.0 |
Versión de producto: | Flex 3 |
Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
The effect that plays when a ToolTip is shown,
or null
if the ToolTip should appear with no effect.
El valor predeterminado es null.
Implementación
public static function get showEffect():IAbstractEffect
public static function set showEffect(value:IAbstractEffect):void
toolTipClass | propiedad |
toolTipClass:Class
Versión del lenguaje: | ActionScript 3.0 |
Versión de producto: | Flex 3 |
Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
The class to use for creating ToolTips.
El valor predeterminado es mx.controls.ToolTip.
Implementación
public static function get toolTipClass():Class
public static function set toolTipClass(value:Class):void
createToolTip | () | método |
public static function createToolTip(text:String, x:Number, y:Number, errorTipBorderStyle:String = null, context:IUIComponent = null):mx.core:IToolTip
Versión del lenguaje: | ActionScript 3.0 |
Versión de producto: | Flex 3 |
Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
Creates an instance of the ToolTip class with the specified text and displays it at the specified location in stage coordinates.
ToolTips appear in their own layer, on top of everything except cursors.
The standard way of using ToolTips is to let the ToolTipManager
automatically show and hide them as the user moves the mouse over
the objects that have the toolTip
property set.
You can turn off this automatic ToolTip management by setting
the ToolTipManager's enabled
property to
false
.
By contrast, this method—along with destroyToolTip()
—gives
you programmatic control over ToolTips.
You can show them when and where you choose,
and you can even show more than one at once if you need to.
(The ToolTipManager never does this, because it is generally
confusing to the user).
This method first creates a new instance of ToolTip and calls the
addChild()
method to put it into the SystemManager's
toolTips layer.
If you are showing an error tip, it sets the appropriate styles.
Then it sets the text for the ToolTip, sizes the ToolTip based on
its text, and positions it where you specified.
You must save the reference to the ToolTip that this method
returns so that you can pass it to the destroyToolTip()
method.
Parámetros
text:String — The text to display in the ToolTip instance.
| |
x:Number — The horizontal coordinate of the ToolTip in stage coordinates.
In case of multiple stages, the relevant stage is determined
from the context argument.
| |
y:Number — The vertical coordinate of the ToolTip in stage coordinates.
In case of multiple stages, the relevant stage is determined
from the context argument.
| |
errorTipBorderStyle:String (default = null ) — The border style of an error tip. This method
argument can be null, "errorTipRight", "errorTipAbove", or "errorTipBelow".
If it is null, then the createToolTip() method creates a normal ToolTip. If it is
"errorTipRight", "errorTipAbove", or "errorTipBelow", then the createToolTip()
method creates an error tip, and this parameter determines where the arrow
of the error tip points to (the error's target). For example, if you pass "errorTipRight", Flex
positions the error tip (via the x and y arguments) to the
right of the error target; the arrow is on the left edge of the error tip.
| |
context:IUIComponent (default = null ) — Determines which StyleManager is used. Typically, you pass the object on
which the ToolTip appears, so that the ToolTip's StyleManager is the same one that is used by that object.
|
mx.core:IToolTip — The newly created ToolTip.
|
destroyToolTip | () | método |
public static function destroyToolTip(toolTip:mx.core:IToolTip):void
Versión del lenguaje: | ActionScript 3.0 |
Versión de producto: | Flex 3 |
Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
Destroys a specified ToolTip that was created by the createToolTip()
method.
This method calls the removeChild()
method to remove the specified
ToolTip from the SystemManager's ToolTips layer.
It will then be garbage-collected unless you keep a
reference to it.
You should not call this method on the ToolTipManager's
currentToolTip
.
Parámetros
toolTip:mx.core:IToolTip — The ToolTip instance to destroy.
|
Tue Jun 12 2018, 02:12 PM Z