ToolTipManager - Adobe ActionScript® 3 (AS3 Flex) API-Referenz

Paket	mx.managers
Klasse	public class ToolTipManager
Vererbung	ToolTipManager EventDispatcher Object

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Mit dem ToolTipManager können Sie grundlegende QuickInfo- und Fehlerinfo-Funktionen wie die Anzeigeverzögerung und die Deaktivierung von QuickInfos einstellen.

Verwandte API-Elemente

mx.controls.ToolTip
mx.validators.Validator

Öffentliche Eigenschaften

Vererbte öffentliche Eigenschaften ausblenden

Vererbte öffentliche Eigenschaften anzeigen

	Eigenschaft		Definiert von
		constructor : Object Ein Verweis auf das Klassenobjekt oder die Konstruktorfunktion für eine angegebene Objektinstanz.	Object
		currentTarget : DisplayObject [statisch] Die UIComponent, die derzeit eine QuickInfo anzeigt, oder null, wenn keine QuickInfo angezeigt wird.	ToolTipManager
		currentToolTip : mx.core:IToolTip [statisch] Das ToolTip-Objekt, das derzeit sichtbar ist, oder null, wenn keines angezeigt wird.	ToolTipManager
		enabled : Boolean [statisch] Bei „true“ zeigt der ToolTipManager automatisch QuickInfos an, wenn der Benutzer den Mauszeiger über Komponenten führt.	ToolTipManager
		hideDelay : Number [statisch] Der Zeitraum in Millisekunden, bis Flex eine angezeigte QuickInfo wieder ausblendet.	ToolTipManager
		hideEffect : IAbstractEffect [statisch] Der Effekt, der beim Ausblenden einer QuickInfo angezeigt wird, oder null, wenn die QuickInfo ohne Effekt ausgeblendet werden soll.	ToolTipManager
		scrubDelay : Number [statisch] Der Zeitraum in Millisekunden, innerhalb dessen der Benutzer den Mauszeiger zwischen den Steuerelementen bewegen kann, bevor Flex erneut die in showDelay definierte Zeit abwartet, um eine QuickInfo anzuzeigen.	ToolTipManager
		showDelay : Number [statisch] Der Zeitraum in Millisekunden, den Flex vor dem Einblenden eines QuickInfo-Felds abwartet, sobald ein Benutzer die Maus über eine Komponente mit einer QuickInfo geführt hat.	ToolTipManager
		showEffect : IAbstractEffect [statisch] Der Effekt, der beim Einblenden einer QuickInfo angezeigt wird, oder null, wenn die QuickInfo ohne Effekt eingeblendet werden soll.	ToolTipManager
		toolTipClass : Class [statisch] Die zum Erstellen von QuickInfos zu verwendende Klasse.	ToolTipManager

Öffentliche Methoden

Vererbte öffentliche Methoden ausblenden

Vererbte öffentliche Methoden anzeigen

	Methode		Definiert von
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registriert ein Ereignis-Listener-Objekt bei einem EventDispatcher-Objekt, sodass der Listener über ein Ereignis benachrichtigt wird.	EventDispatcher
		createToolTip(text:String, x:Number, y:Number, errorTipBorderStyle:String = null, context:IUIComponent = null):mx.core:IToolTip [statisch] Erstellt eine Instanz der ToolTip-Klasse mit dem angegebenen Text und zeigt sie an der in Bühnenkoordinaten angegebenen Position an.	ToolTipManager
		destroyToolTip(toolTip:mx.core:IToolTip):void [statisch] Löscht eine angegebene QuickInfo, die durch die createToolTip()-Methode erstellt wurde.	ToolTipManager
		dispatchEvent(event:Event):Boolean Sendet ein Ereignis in den Ereignisablauf.	EventDispatcher
		hasEventListener(type:String):Boolean Überprüft, ob das EventDispatcher-Objekt Listener für einen bestimmten Ereignistyp registriert hat.	EventDispatcher
		hasOwnProperty(name:String):Boolean Gibt an, ob für ein Objekt eine bestimmte Eigenschaft definiert wurde.	Object
		isPrototypeOf(theClass:Object):Boolean Gibt an, ob eine Instanz der Object-Klasse in der Prototypkette des Objekts vorhanden ist, das als Parameter angegeben wurde.	Object
		propertyIsEnumerable(name:String):Boolean Gibt an, ob die angegebene Eigenschaft vorhanden ist und durchlaufen werden kann.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Entfernt einen Listener aus dem EventDispatcher-Objekt.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Legt die Verfügbarkeit einer dynamischen Eigenschaft für Schleifenoperationen fest.	Object
		toLocaleString():String Gibt die Stringdarstellung dieses Objekts zurück, formatiert entsprechend den Konventionen des Gebietsschemas.	Object
		toString():String Gibt das angegebene Objekt als String zurück.	Object
		valueOf():Object Gibt den Grundwert des angegebenen Objekts zurück.	Object
		willTrigger(type:String):Boolean Überprüft, ob bei diesem EventDispatcher-Objekt oder bei einem seiner Vorgänger ein Ereignis-Listener für einen bestimmten Ereignistyp registriert ist.	EventDispatcher

Ereignisse

Klicken Sie, um weitere Informationen zu Ereignissen zu erhalten.

Vererbte Ereignisse ausblenden

Vererbte Ereignisse anzeigen

	Ereignis		Übersicht	Definiert von
		activate	[broadcast event] Wird ausgelöst, wenn Flash Player oder eine AIR-Anwendung den Betriebssystemfokus erhält und aktiv wird.	EventDispatcher
		deactivate	[broadcast event] Wird ausgelöst, wenn Flash Player- oder die AIR-Anwendung den Fokus verliert und inaktiv wird.	EventDispatcher

Eigenschaftendetails

currentTarget

Eigenschaft

currentTarget:DisplayObject

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Die UIComponent, die derzeit eine QuickInfo anzeigt, oder null, wenn keine QuickInfo angezeigt wird.

Implementierung
public static function get currentTarget():DisplayObject
public static function set currentTarget(value:DisplayObject):void

currentToolTip

Eigenschaft

currentToolTip:mx.core:IToolTip

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Das ToolTip-Objekt, das derzeit sichtbar ist, oder null, wenn keines angezeigt wird.

Implementierung
public static function get currentToolTip():mx.core:IToolTip
public static function set currentToolTip(value:mx.core:IToolTip):void

enabled

Eigenschaft

enabled:Boolean

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Bei true zeigt der ToolTipManager automatisch QuickInfos an, wenn der Benutzer den Mauszeiger über Komponenten führt. Bei false werden keine QuickInfos angezeigt.

Der Standardwert ist true.

Implementierung
public static function get enabled():Boolean
public static function set enabled(value:Boolean):void

hideDelay

Eigenschaft

hideDelay:Number

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Der Zeitraum in Millisekunden, bis Flex eine angezeigte QuickInfo wieder ausblendet. Nach dem Ausblenden einer QuickInfo muss der Benutzer den Mauszeiger von der Komponente entfernen und erneut über die Komponente führen, damit die QuickInfo wieder angezeigt wird. Setzen Sie hideDelay auf Infinity, dann blendet Flex die QuickInfo erst aus, wenn der Benutzer ein Ereignis auslöst, beispielsweise den Mauszeiger von der Komponente entfernt.

Der Standardwert ist 10000.

Implementierung
public static function get hideDelay():Number
public static function set hideDelay(value:Number):void

hideEffect

Eigenschaft

hideEffect:IAbstractEffect

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Der Effekt, der beim Ausblenden einer QuickInfo angezeigt wird, oder null, wenn die QuickInfo ohne Effekt ausgeblendet werden soll.

Der Standardwert ist null.

Implementierung
public static function get hideEffect():IAbstractEffect
public static function set hideEffect(value:IAbstractEffect):void

scrubDelay

Eigenschaft

scrubDelay:Number

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Der Zeitraum in Millisekunden, innerhalb dessen der Benutzer den Mauszeiger zwischen den Steuerelementen bewegen kann, bevor Flex erneut die in showDelay definierte Zeit abwartet, um eine QuickInfo anzuzeigen.

Diese Einstellung ist nützlich, wenn der Benutzer schnell von einem Steuerelement zum nächsten wechselt. Nach der ersten QuickInfo werden alle folgenden QuickInfos sofort angezeigt, statt abzuwarten. Je kürzer der für scrubDelay eingestellte Zeitraum, umso wahrscheinlicher muss der Benutzer die in showDelay eingestellte Zeit abwarten, um die nächste QuickInfo zu sehen. Mit dieser Eigenschaft können Sie beispielsweise Benutzern ermöglichen, die QuickInfos mehrerer Schaltflächen in einer Symbolleiste schnell hintereinander anzuzeigen.

Der Standardwert ist 100.

Implementierung
public static function get scrubDelay():Number
public static function set scrubDelay(value:Number):void

showDelay

Eigenschaft

showDelay:Number

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Der Zeitraum in Millisekunden, den Flex vor dem Einblenden eines QuickInfo-Felds abwartet, sobald ein Benutzer die Maus über eine Komponente mit einer QuickInfo geführt hat. Damit die QuickInfo sofort angezeigt wird, müssen Sie showDelay auf 0 setzen.

Der Standardwert ist 500.

Implementierung
public static function get showDelay():Number
public static function set showDelay(value:Number):void

showEffect

Eigenschaft

showEffect:IAbstractEffect

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Der Effekt, der beim Einblenden einer QuickInfo angezeigt wird, oder null, wenn die QuickInfo ohne Effekt eingeblendet werden soll.

Der Standardwert ist null.

Implementierung
public static function get showEffect():IAbstractEffect
public static function set showEffect(value:IAbstractEffect):void

toolTipClass

Eigenschaft

toolTipClass:Class

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Die zum Erstellen von QuickInfos zu verwendende Klasse.

Der Standardwert ist mx.controls.ToolTip.

Implementierung
public static function get toolTipClass():Class
public static function set toolTipClass(value:Class):void

Methodendetails

createToolTip

()

Methode

 public static function createToolTip(text:String, x:Number, y:Number, errorTipBorderStyle:String = null, context:IUIComponent = null):mx.core:IToolTip

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Erstellt eine Instanz der ToolTip-Klasse mit dem angegebenen Text und zeigt sie an der in Bühnenkoordinaten angegebenen Position an.

QuickInfos werden auf einer eigenen Ebene über allen anderen Elementen mit Ausnahme des Cursors angezeigt.

Normalerweise werden QuickInfos vom ToolTipManager automatisch ein- und ausgeblendet, wenn der Benutzer die Maus über die Objekte führt, für die die Eigenschaft toolTip eingestellt ist. Sie können die automatische Verwaltung von QuickInfos deaktivieren, indem Sie die Eigenschaft enabled des ToolTipManagers auf false setzen.

Dadurch und durch destroyToolTip() können Sie QuickInfos steuern. Sie können die QuickInfos zum gewünschten Zeitpunkt an der gewünschten Position einblenden – sogar mehrere QuickInfos gleichzeitig. (Der ToolTipManager blendet nie mehrere QuickInfos gleichzeitig ein, da dies Benutzer normalerweise verwirrt.)

Diese Methode erstellt eine neue QuickInfo-Instanz und ruft die addChild()-Methode auf, um sie auf der toolTips-Ebene des SystemManagers zu platzieren. Wenn Sie eine Fehlerinfo anzeigen, stellt sie die entsprechenden Stile ein. Dann stellt sie den Text der QuickInfo ein, passt deren Größe anhand des Texts an und platziert die QuickInfo an der angegebenen Position.

Sie müssen den von dieser Methode zurückgegebenen Verweis auf die QuickInfo speichern, um ihn an die destroyToolTip()-Methode übergeben zu können.

Parameter

	`text:String` — Der in der QuickInfo-Instanz anzuzeigende Text.

	`x:Number` — Die horizontale Koordinate der QuickInfo in Bühnenkoordinaten. Bei mehreren Bühnen wird die relevante Bühne durch das `context`-Argument bestimmt.

	`y:Number` — Die vertikale Koordinate der QuickInfo in Bühnenkoordinaten. Bei mehreren Bühnen wird die relevante Bühne durch das `context`-Argument bestimmt.

	`errorTipBorderStyle:String` (default = `null`) — Der Rahmenstil einer Fehlerinfo. Das Argument dieser Methode kann null, „errorTipRight“, „errorTipAbove“ oder „errorTipBelow“ entsprechen. Bei null erstellt die `createToolTip()`-Methode eine normale QuickInfo. Bei „errorTipRight“, „errorTipAbove“, oder „errorTipBelow“ erstellt die `createToolTip()`-Methode eine Fehlerinfo und dieser Parameter bestimmt, wohin der Pfeil der Fehlerinfo weist (Ziel des Fehlers). Wird beispielsweise „errorTipRight“ übergeben, platziert Flex die Fehlerinfo (über die x- und y-Argumente) rechts neben das Fehlerziel; der Pfeil befindet sich auf der linken Seite der Fehlerinfo.

	`context:IUIComponent` (default = `null`) — Bestimmt, welcher StyleManager verwendet wird. In der Regel übergeben Sie das Objekt, bei dem die QuickInfo angezeigt wird, sodass der StyleManager von QuickInfo und Objekt übereinstimmt.

Rückgabewerte

mx.core:IToolTip — Die neu erstellte QuickInfo.

destroyToolTip

()

Methode

public static function destroyToolTip(toolTip:mx.core:IToolTip):void

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Löscht eine angegebene QuickInfo, die durch die createToolTip()-Methode erstellt wurde.

Diese Methode ruft die removeChild()-Methode auf, um die angegebene QuickInfo aus der ToolTip-Ebene des SystemManagers zu entfernen. Danach wird sie von einem Garbagekollektor entfernt, es sei denn es ist noch ein Verweis darauf vorhanden.

Sie sollten diese Methode nicht vom currentToolTip des ToolTipManagers aus aufrufen.

Parameter

toolTip:mx.core:IToolTip — Die zu löschende QuickInfo-Instanz.

Rechtliche Hinweise | Onlinedatenschutzerklärung

ToolTipManager - AS3 Flex

Klassen x

currentTarget

currentToolTip

enabled

hideDelay

hideEffect

scrubDelay

showDelay

showEffect

toolTipClass

createToolTip

destroyToolTip