Adobe InDesign CS6 (8.0) Object Model JS: ToolBox

InDesign CS6

Class

ToolBox

 Tool box tools Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Application
Preference
ToolBox
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
currentToolUITools:
UITools.NONE
UITools.SELECTION_TOOL
UITools.DIRECT_SELECTION_TOOL
UITools.GAP_TOOL
UITools.PEN_TOOL
UITools.ADD_ANCHOR_POINT
UITools.DELETE_ANCHOR_POINT
UITools.CONVERT_DIRECTION_POINT
UITools.LINE_TOOL
UITools.TYPE_TOOL
UITools.TYPE_ON_PATH_TOOL
UITools.PENCIL_TOOL
UITools.SMOOTH_TOOL
UITools.ERASE_TOOL
UITools.POLYGON_FRAME_TOOL
UITools.RECTANGLE_FRAME_TOOL
UITools.ELLIPSE_FRAME_TOOL
UITools.POLYGON_TOOL
UITools.RECTANGLE_TOOL
UITools.ELLIPSE_TOOL
UITools.ROTATE_TOOL
UITools.SCALE_TOOL
UITools.SHEAR_TOOL
UITools.SCISSORS_TOOL
UITools.FREE_TRANSFORM_TOOL
UITools.GRADIENT_SWATCH_TOOL
UITools.GRADIENT_FEATHER_TOOL
UITools.NOTE_TOOL
UITools.EYE_DROPPER_TOOL
UITools.MEASURE_TOOL
UITools.HAND_TOOL
UITools.ZOOM_TOOL
UITools.TABLE_TOOL
UITools.PLACE_CURSOR_TOOL
UITools.MOTION_PATH_TOOL
UITools.PAGE_TOOL
r/wThe currently active tool.
currentToolHintstring readonlyThe currently active tool's hint.
currentToolIconFileFile readonlyThe currently active tool's icon resource file.
currentToolNamestring readonlyThe currently active tool's name.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
parentApplication readonlyThe parent of the ToolBox (a Application).
propertiesObject r/wA property that allows setting of several properties at the same time.

Class

PropertyTypeAccessDescription
AFTER_ATTRIBUTE_CHANGEDstring readonlyDispatched 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.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis 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.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis 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, 28-Apr-2012 v3.0.3hContents :: Index