XPComponents: class xp.system.ToolTip

Main Page | Packages | Class Tree | Index | Help

Previous \| Next	Frames \| No Frames
Summary: Field \| Property \| Contructor \| Method	Detail: Field \| Property \| Contructor \| Method

xp.system

class ToolTip

Object
  |
  +--xp.system.ToolTip

class ToolTip
extends Object

Tooltip
Represents a small rectangular pop-up window that displays a brief description of a control's purpose when the mouse hovers over the control. Displays a custom Tooltip in the application window The tooltip consist of a message box below an arrow pointer The ToolTip class allows you to provide help to users when they place the mouse cursor over a control. The ToolTip class is typically used to alert users to the intended use of a control. For example, you could specify ToolTip text for a TextInput control that accepts a name, specifying the format of the name to typed into the control. In addition to providing help, you can also use the ToolTip class to provide run time status information. For example, you could use the ToolTip class to display field data when the user moves the mouse cursor over a list control. The ToolTipService class provides properties that enable you to modify how long and how quickly a ToolTip window is displayed. The AutoPopDelay determines how long a ToolTip window is displayed; the InitialDelay and ReshowDelay properties determine the delay before a ToolTip window is displayed.

Author:: ProWin Computers Ltd. - Rob Edgar

Version:: 3.0.0.000

See also:: support@epresenterplus.com

Field Summary
public	maxWidth: Number
	The maximum width of the tooltip, if the message is longer it will wrap.

public	textField
	the tooltip display textField

public	trackCursor: Boolean
	Determines if the tooltip should track the mouse wil on displayed

Constructor
public	ToolTip ( )
	Constructor

Method Summary
public static	getToolTip ( ): ToolTip
	An application tooltip

public	showToolTip ( state: Boolean, tgt: MovieClip, text: String, track: Boolean, maxWidth: Number )
	Shows or Hides the tooltip

Field Documentation

maxWidth

public var maxWidth: Number

The maximum width of the tooltip, if the message is longer it will wrap.

textField

public var textField

the tooltip display textField

trackCursor

public var trackCursor: Boolean

Determines if the tooltip should track the mouse wil on displayed

Constructor Documentation

ToolTip

public function ToolTip

()

Constructor

Method Documentation

getToolTip

public static function getToolTip

(): ToolTip

An application tooltip

showToolTip

public function showToolTip

(state: Boolean,
tgt: MovieClip,
text: String,
track: Boolean,
maxWidth: Number)

Shows or Hides the tooltip

Parameters:

state		true to show false to hide
tgt		the clip to attach the tooltip to
text		the display message
track		controls whether the tooltip tracks the cursor whilst it is displayed, defaults to the trackCursor property if not set
maxWidth		the maxWidth of the tooltip, defaults to the maxWidth property if not set

The documentation was generated from the following file:

ToolTip.as, Last Modified: 10/15/2005 5:25:08 AM

Previous \| Next	Frames \| No Frames
Summary: Field \| Property \| Contructor \| Method	Detail: Field \| Property \| Contructor \| Method