Tools object

Availability

Flash MX 2004.

Description

The Tools object is accessible from the flash object (fl.tools). The tools.toolObjs property contains an array of ToolObj objects, and the tools.activeTool property returns the ToolObj object for the currently active tool. (See also ToolObj object and Extensible tools.)

NOTE

 

The following methods and properties are used only when creating extensible tools.

Method summary for the Tools object

The following methods are available for the Tools object:

Method

Description

tools.constrainPoint()

Takes two points and returns a new adjusted or constrained point.

tools.getKeyDown()

Returns the most recently pressed key.

tools.setCursor()

Sets the pointer to a specified appearance.

tools.snapPoint()

Takes a point as input and returns a new point that may be adjusted or snapped to the nearest geometric object.

Property summary for the Tools object

The following properties are available for the Tools object:

Property

Description

tools.activeTool

Read-only; returns the ToolObj object for the currently active tool.

tools.altIsDown

Read-only; a Boolean value that identifies if the Alt key is being pressed.

tools.ctlIsDown

Read-only; a Boolean value that identifies if the Control key is being pressed.

tools.mouseIsDown

Read-only; a Boolean value that identifies if the left mouse button is currently pressed.

tools.penDownLoc

Read-only; a point that represents the position of the last mouse-down event on the Stage.

tools.penLoc

Read-only; a point that represents the current location of the mouse.

tools.shiftIsDown

Read-only; a Boolean value that identifies if the Shift key is being pressed.

tools.toolObjs

Read-only; an array of ToolObj objects.


Flash CS3


 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/flash/9.0/main/00004568.html