Adobe InCopy CS6 (8.0) Object Model JS: Panel

InCopy CS6

Class

Panel

 A panel (possibly within a panel group).

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Application
Panel
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
indexnumber readonlyThe index of the Panel within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
namestring readonlyThe name of the Panel.
parentApplication readonlyThe parent of the Panel (a Application).
propertiesObject r/wA property that allows setting of several properties at the same time.
visiblebool r/wIf true, the panel is visible.

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 Panel 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 Panel.

string toSpecifier ()
Retrieves the object specifier.

Used in:

Panel Panels.nextItem (obj: Panel)

Panel Panels.previousItem (obj: Panel)

Return

Array of Panel Panel.getElements ()

Panel Panels.[] (index: number)

Panel Panels.anyItem ()

Array of Panel Panels.everyItem ()

Panel Panels.firstItem ()

Panel Panels.item (index: varies)

Panel Panels.itemByName (name: string)

Array of Panel Panels.itemByRange (from: varies, to: varies)

Panel Panels.lastItem ()

Panel Panels.middleItem ()

Panel Panels.nextItem (obj: Panel)

Panel Panels.previousItem (obj: Panel)

Jongware, 29-Apr-2012 v3.0.3iContents :: Index