Class

ToolBox

 Tool box tools Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Application

Preference

ToolBox

Event | EventListener | MutationEvent

Properties

Property	Type	Access	Description
currentTool	UITools: UITools.NONE UITools.TYPE_TOOL UITools.POSITION_TOOL UITools.NOTE_TOOL UITools.EYE_DROPPER_TOOL UITools.HAND_TOOL UITools.ZOOM_TOOL	r/w	The currently active tool.
currentToolHint	string	readonly	The currently active tool's hint.
currentToolIconFile	File	readonly	The currently active tool's icon resource file.
currentToolName	string	readonly	The currently active tool's name.
eventListeners	EventListeners	readonly	A collection of event listeners.
events	Events	readonly	A collection of events.
isValid	bool	readonly	Returns true if the object specifier resolves to valid objects.
parent	Application	readonly	The parent of the ToolBox (a Application).
properties	Object	r/w	A property that allows setting of several properties at the same time.

Class

Property	Type	Access	Description
AFTER_ATTRIBUTE_CHANGED	string	readonly	Dispatched when the value of a property changes on this ToolBox. This event bubbles. This event is not cancelable. (default: afterAttributeChanged)

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

Parameter	Type	Description
eventType	string	The event type.
handler	File JavaScript Function	The event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)

Array of ToolBox getElements ()
Resolves the object specifier, creating an array of object references.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

Parameter	Type	Description
eventType	string	The registered event type.
handler	File JavaScript Function	The registered event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)

string toSource ()
Generates a string which, if executed, will return the ToolBox.

string toSpecifier ()
Retrieves the object specifier.

Element of

Application.toolBoxTools

Return

Array of ToolBox ToolBox.getElements ()

Jongware, 23-Mar-2011 v3.0.3d

Contents :: Index