Package | com.yworks.resources |
Class | public class Cursor |
Inheritance | Cursor Object |
Property | Defined By | ||
---|---|---|---|
activated : Boolean [read-only]
Returns whether this cursor is activated, i.e. | Cursor | ||
iconClass : Class [read-only]
Returns the class object that represents the icon image. | Cursor | ||
offsetX : Number [read-only]
Returns the x offset of the click point of a cursor image relative to its center. | Cursor | ||
offsetY : Number [read-only]
Returns the y offset of the click point of a cursor image relative to its center
| Cursor | ||
priority : int
Gets or sets the priority that determines which cursor is shown when multiple cursors are active. | Cursor |
Method | Defined By | ||
---|---|---|---|
Cursor(iconClass:Class, offsetX:Number = 0, offsetY:Number = 0, priority:int = 2)
Creates a cursor instance. | Cursor | ||
activate():void
Activates this cursor using CursorManager.setCursor. | Cursor | ||
deactivate():void
Removes the activated instance of this cursor. | Cursor |
activated | property |
activated:Boolean
[read-only]
Returns whether this cursor is activated, i.e. activate
had been called
at least once after deactivate(true)
was called.
public function get activated():Boolean
iconClass | property |
iconClass:Class
[read-only] Returns the class object that represents the icon image.
public function get iconClass():Class
offsetX | property |
offsetX:Number
[read-only] Returns the x offset of the click point of a cursor image relative to its center.
public function get offsetX():Number
offsetY | property |
offsetY:Number
[read-only] Returns the y offset of the click point of a cursor image relative to its center
public function get offsetY():Number
priority | property |
priority:int
Gets or sets the priority that determines which cursor is shown when multiple cursors are active.
public function get priority():int
public function set priority(value:int):void
Cursor | () | Constructor |
public function Cursor(iconClass:Class, offsetX:Number = 0, offsetY:Number = 0, priority:int = 2)
Creates a cursor instance.
ParametersiconClass:Class — The class object that represents the image icon of this cursor.
| |
offsetX:Number (default = 0 ) — The relative offset of the click point of this cursor in x direction.
| |
offsetY:Number (default = 0 ) — The relative offset of the click point of this cursor in y direction.
| |
priority:int (default = 2 ) — The priority that determines which cursor is shown when multiple cursors are active.
|
activate | () | method |
public function activate():void
Activates this cursor using CursorManager.setCursor
.
Note that if iconClass
is null
, CursorManager.removeAllCursors()
will be called.
deactivate | () | method |
public function deactivate():void
Removes the activated instance of this cursor.