Adobe InCopy CS6 (8.0) Object Model JS: ToolBox

InCopy 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.TYPE_TOOL
UITools.POSITION_TOOL
UITools.NOTE_TOOL
UITools.EYE_DROPPER_TOOL
UITools.HAND_TOOL
UITools.ZOOM_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 EventListener readonlyA collection of event listeners.
eventsEvents Event 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, 29-Apr-2012 v3.0.3iContents :: Index