PagesPanel

Pages panel.

Methods:

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Objects:

Boolean, EventListeners, Events, IconSizes, Number, Object, PageViewOptions, PanelLayoutResize, String

Hierarchy:

Superclass: Panel

Class: PagesPanel

Property Listing

Property

Type

Access

Description

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

iconSize

IconSizes

IconSizes.EXTRA_LARGE_ICON

IconSizes.EXTRA_SMALL_ICON

IconSizes.JUMBO_ICON

IconSizes.LARGE_ICON

IconSizes.MEDIUM_ICON

IconSizes.SMALL_ICON

read/write

Page icon size.

index

Number

readonly

The index of the PagesPanel within its containing object.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

masterIconSize

IconSizes

IconSizes.EXTRA_LARGE_ICON

IconSizes.EXTRA_SMALL_ICON

IconSizes.JUMBO_ICON

IconSizes.LARGE_ICON

IconSizes.MEDIUM_ICON

IconSizes.SMALL_ICON

read/write

Master page icon size.

masterVerticalView

Boolean

read/write

If true, master page icons will be arranged vertically around the binding spine. If false, master page icons will be arranged horizontally.

mastersThumbnails

Boolean

read/write

If true, display thumbnails of the pages in the master pages area of the panel.

name

String

readonly

The name of the PagesPanel.

pagesOnTop

Boolean

read/write

If true, the pages area of the panel will be drawn above the master pages area.

pagesThumbnails

Boolean

read/write

If true, display thumbnails of the pages in the pages area of the panel.

pagesViewSetting

PageViewOptions

PageViewOptions.BY_ALTERNATE_LAYOUT

PageViewOptions.HORIZONTALLY

PageViewOptions.VERTICALLY

read/write

View setting for how to arrange the pages in the page section of the panel.

parent

Application

readonly

The parent of the PagesPanel (a Application).

properties

Object

read/write

A property that allows setting of several properties at the same time.

resizeBehavior

PanelLayoutResize

PanelLayoutResize.MASTERS_FIXED

PanelLayoutResize.PAGES_FIXED

PanelLayoutResize.PROPORTIONAL_RESIZE

read/write

Specifies the behavior of the document and master page areas of the panel when the panel is resized.

rotationIcons

Boolean

read/write

If true, a rotation icon will display next to spreads with non-zero rotation applied.

transitionsIcons

Boolean

read/write

If true, a page transitions icon will display next to spreads with page transitions applied.

transparencyIcons

Boolean

read/write

If true, a transparency icon will display next to spreads with elements having transparency applied.

visible

Boolean

read/write

If true, the panel is visible.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

PagesPanel getElements ()

Resolves the object specifier, creating an array of object references.

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter

Type

Description

eventType

String

The registered event type.

handler

File

JavaScriptFunction

The registered event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

String toSource ()

Generates a string which, if executed, will return the PagesPanel.

String toSpecifier ()

Retrieves the object specifier.

Object of

Event.parent

EventListener.parent

MutationEvent.parent

Return

PagesPanel.getElements()