Adobe InDesign CS5 (7.0) Object Model JS: PagesPanel

InDesign CS5

Class

PagesPanel

 Pages panel. Base Class: Panel

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Application
Panel
PagesPanel
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
iconSizeIconSizes:
IconSizes.EXTRA_SMALL_ICON
IconSizes.SMALL_ICON
IconSizes.MEDIUM_ICON
IconSizes.LARGE_ICON
IconSizes.EXTRA_LARGE_ICON
IconSizes.JUMBO_ICON
r/wPage icon size.
indexnumber readonlyThe index of the PagesPanel within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
masterIconSizeIconSizes:
IconSizes.EXTRA_SMALL_ICON
IconSizes.SMALL_ICON
IconSizes.MEDIUM_ICON
IconSizes.LARGE_ICON
IconSizes.EXTRA_LARGE_ICON
IconSizes.JUMBO_ICON
r/wMaster page icon size.
masterVerticalViewbool r/wIf true, master page icons will be arranged vertically around the binding spine. If false, master page icons will be arranged horizontally.
mastersThumbnailsbool r/wIf true, display thumbnails of the pages in the master pages area of the panel.
namestring readonlyThe name of the PagesPanel.
pagesOnTopbool r/wIf true, the pages area of the panel will be drawn above the master pages area.
pagesThumbnailsbool r/wIf true, display thumbnails of the pages in the pages area of the panel.
parentApplication readonlyThe parent of the PagesPanel (a Application).
propertiesObject r/wA property that allows setting of several properties at the same time.
resizeBehaviorPanelLayoutResize:
PanelLayoutResize.PROPORTIONAL_RESIZE
PanelLayoutResize.PAGES_FIXED
PanelLayoutResize.MASTERS_FIXED
r/wSpecifies the behavior of the document and master page areas of the panel when the panel is resized.
rotationIconsbool r/wIf true, a rotation icon will display next to spreads with non-zero rotation applied.
transitionsIconsbool r/wIf true, a page transitions icon will display next to spreads with page transitions applied.
transparencyIconsbool r/wIf true, a transparency icon will display next to spreads with elements having transparency applied.
verticalViewbool r/wIf true, document page icons will be arranged vertically around the binding spine. If false, page icons will be arranged horizontally.
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 PagesPanel 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 PagesPanel.

string toSpecifier ()
Retrieves the object specifier.

Return

Array of PagesPanel PagesPanel.getElements ()

Jongware, 20-Jun-2010 v3.0.3dContents :: Index