Main Page | Packages | Class Tree | Index | Help

xp.system

class Cursor

MovieClip
  |
  +--xp.system.Cursor


class Cursor
extends MovieClip

Cursor

A cursor is a small picture whose location on the screen is controlled by a pointing device, such as a mouse, pen, or trackball. When the user moves the pointing device, the operating system moves the cursor accordingly. Different cursor shapes are used to inform the user what operation the mouse will have. For example, when editing or selecting text, a Cursors.IBeam cursor is typically displayed. A wait cursor is commonly used to inform the user that a process is currently running. Examples of processes you might have the user wait for are opening a file, saving a file, or filling a control such as a DataGrid, ListBox or TreeView with a large amount of data. All controls that derive from the Control class have a Cursor property. To change the cursor displayed by the mouse pointer when it is within the bounds of the control, assign a Cursor to the Cursor property of the control. Alternatively, you can display cursors at the application level by assigning a Cursor to the Current property. For example, if the purpose of your application is to edit a text file, you might set the Current property to Cursors.WaitCursor to display a wait cursor over the application while the file loads or saves to prevent any mouse events from being processed. When the process is complete, set the Current property to Cursors.Default for the application to display the appropriate cursor over each control type. You can temporarily hide the cursor by calling the hide method, and restore it by calling the show method.


Author:
ProWin Computers Ltd. - Rob Edgar

Version:
3.0.0.000

See also:


Field Summary

public
active: Boolean


public static
cursor: Cursor
The current custom cursor

Property Summary

public static
current (read)
Gets or sets a cursor symbol that represents the mouse cursor. The default is a null reference. Setting the Current property changes the cursor currently displayed.

public static
current: String (write)


Constructor

public
Cursor ( )
Event handler to enable cursor to track mouse movement

Method Summary

public
__onMouseMove ( )
Event handler to enable cursor to track mouse movement

public static
attachBusyCursor ( loader: Object ): Void
attach the busy cursor to the progress event *

public static
hide ( )
Hides the current cursor.

public static
progressHandler ( e: Object ): Void
Callback from the progress event

public static
removeBusyCursor ( loader: Object ): Void
remove the busy cursor to the progress event *

public static
show ( )
Displays the current cursor.

public static
showBusyCursor ( state: Boolean )
Displays or hides the busy cursor dependent on the state param



Field Documentation

active

public var active: Boolean

cursor

public static var cursor: Cursor
The current custom cursor


Property Documentation

current

public static current (read)
Gets or sets a cursor symbol that represents the mouse cursor. The default is a null reference. Setting the Current property changes the cursor currently displayed.

current

public static current: String (write)

Constructor Documentation

Cursor

public function Cursor()
Event handler to enable cursor to track mouse movement


Method Documentation

__onMouseMove

public function __onMouseMove()
Event handler to enable cursor to track mouse movement

attachBusyCursor

public static function attachBusyCursor(loader: Object): Void
attach the busy cursor to the progress event *

hide

public static function hide()
Hides the current cursor.

progressHandler

public static function progressHandler(e: Object): Void
Callback from the progress event

updatet the busy cursor state as required

removeBusyCursor

public static function removeBusyCursor(loader: Object): Void
remove the busy cursor to the progress event *

show

public static function show()
Displays the current cursor.

showBusyCursor

public static function showBusyCursor(state: Boolean)
Displays or hides the busy cursor dependent on the state param

Parameters:
state
Boolean property true to show the bust cursor, false to hide it

The documentation was generated from the following file:


Generated on 10/30/2005 9:34:02 PM by AS2Doc