Adobe Extending Flash Professional CS5 - Manual (Page 519)

497
Last updated 5/2/2011
Chapter 46: ToolObj object
Availability
Flash MX 2004.
Description
A ToolObj object represents an individual tool in the Tools panel. To access a ToolObj object, use properties of the
Tools object : either the tools.toolObjs array or tools.activeTool .
Method summary
The following methods are available for the ToolObj object.
Note: The following methods are used only when creating extensible tools.
Property summary
The following properties are available for the ToolObj object:
toolObj.depth
Availability
Flash MX 2004.
Method Description
toolObj.enablePIControl() Enables or disables the specified control in a Property inspector. Used only
when creating extensible tools.
toolObj.setIcon() Identifies a PNG file to use as a tool icon in the Flash Tools panel.
toolObj.setMenuString() Sets the string that appears in the pop-up menu as the name for the tool.
toolObj.setOptionsFile() Associates an XML file with the tool.
toolObj.setPI() Sets a particular Property inspector to be used when the tool is activated.
toolObj.setToolName() Assigns a name to the tool for the configuration of the Tools panel.
toolObj.setToolTip() Sets the tooltip that appears when the mouse is held over the tool icon.
toolObj.showPIControl() Shows or hides a control in the Property inspector.
toolObj.showTransformHandles() Called in the configureTool() method of an extensible tool’s JavaScript
file to indicate that the free transform handles should appear when the tool
is active.
Property Description
toolObj.depth An integer that specifies the depth of the tool in the pop-up menu in the Tools panel.
toolObj.iconID An integer that specifies the resource ID of the tool.
toolObj.position Read-only; an integer specifying the position of the tool in the Tools panel.