Packagecom.adobe.indesign
Classpublic class PagesPanel
InheritancePagesPanel Inheritance Panel Inheritance CSHostObject Inheritance flash.utils.Proxy

Panel



Public Properties
 PropertyDefined By
  eventListeners : EventListeners
[override] [read-only] A collection of event listeners.
PagesPanel
  events : Events
[override] [read-only] A collection of events.
PagesPanel
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  iconSize : IconSizes
Page icon size.
PagesPanel
  index : Number
[override] [read-only] The index of the PagesPanel within its containing object.
PagesPanel
  isValid : Boolean
[override] [read-only] Returns true if the object specifier resolves to valid objects.
PagesPanel
  masterIconSize : IconSizes
Master page icon size.
PagesPanel
  mastersThumbnails : Boolean
If true, display thumbnails of the pages in the master pages area of the panel.
PagesPanel
  masterVerticalView : Boolean
If true, master page icons will be arranged vertically around the binding spine.
PagesPanel
  name : String
[override] [read-only] The name of the PagesPanel.
PagesPanel
  pagesOnTop : Boolean
If true, the pages area of the panel will be drawn above the master pages area.
PagesPanel
  pagesThumbnails : Boolean
If true, display thumbnails of the pages in the pages area of the panel.
PagesPanel
  parent : Application
[override] [read-only] The parent of the PagesPanel (a Application).
PagesPanel
  properties : Object
[override] A property that allows setting of several properties at the same time.
PagesPanel
  resizeBehavior : PanelLayoutResize
Specifies the behavior of the document and master page areas of the panel when the panel is resized.
PagesPanel
  rotationIcons : Boolean
If true, a rotation icon will display next to spreads with non-zero rotation applied.
PagesPanel
  transitionsIcons : Boolean
If true, a page transitions icon will display next to spreads with page transitions applied.
PagesPanel
  transparencyIcons : Boolean
If true, a transparency icon will display next to spreads with elements having transparency applied.
PagesPanel
  verticalView : Boolean
If true, document page icons will be arranged vertically around the binding spine.
PagesPanel
  visible : Boolean
[override] If true, the panel is visible.
PagesPanel
Public Methods
 MethodDefined By
  
addEventListenerPagesPanel(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
PagesPanel
 Inherited
addEventListenerPanel(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
Panel
 Inherited
filterArgsForHBAPI(args:Array):Array
[static] Function to clean up the argument list and put it into a format that makes sense for HBAPI.
CSHostObject
 Inherited
filterSingleObjectForHBAPI(value:Object):Object
[static]
CSHostObject
 Inherited
getClassObjectForName(className:String):HostObject
[static] This returns a "Class" object, meaning, a HostObject that can be used to make static function calls or get static properties
CSHostObject
  
getElements():Object
[override] Resolves the object specifier, creating an array of object references.
PagesPanel
 Inherited
getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):*
[static]
CSHostObject
 Inherited
hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
CSHostObject
 Inherited
hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):*
[static] Implements a safe call of a static method on the host
CSHostObject
 Inherited
hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
CSHostObject
 Inherited
hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
CSHostObject
 Inherited
hostGetStatic(className:String, propertyName:String, expectedReturnType:Class):*
[static] Implements a safe get of a static property on the host Used by for instance, all the enum implementations.
CSHostObject
 Inherited
hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
CSHostObject
 Inherited
hostSetStatic(className:String, propertyName:String, rawvalue:*):*
[static] Implements a safe set of a static property on the host
CSHostObject
 Inherited
isDescendedFrom(clz:Class, ancClass:Class):Boolean
[static] Efficiently determines whether or not one class descends from another in inheritance hierarchy- class relationships are cached by the ClassUtils implementation- (uses org.as3commons lib to quickly discover class hierarchy.
CSHostObject
  
removeEventListenerPagesPanel(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
PagesPanel
 Inherited
removeEventListenerPanel(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
Panel
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
toSpecifier():String
[override] Retrieves the object specifier.
PagesPanel
 Inherited
wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):*
[static] Method used on static/normal get/ hostcalls
CSHostObject
Protected Methods
 MethodDefined By
 Inherited
createWithArgs(args:Array):void
CSHostObject
 Inherited
hostCreate(args:Array):void
CSHostObject
Property Detail
eventListenersproperty
eventListeners:EventListeners  [read-only] [override]

A collection of event listeners.


Implementation
    public function get eventListeners():EventListeners
eventsproperty 
events:Events  [read-only] [override]

A collection of events.


Implementation
    public function get events():Events
iconSizeproperty 
iconSize:IconSizes

Page icon size.


Implementation
    public function get iconSize():IconSizes
    public function set iconSize(value:IconSizes):void
indexproperty 
index:Number  [read-only] [override]

The index of the PagesPanel within its containing object.


Implementation
    public function get index():Number
isValidproperty 
isValid:Boolean  [read-only] [override]

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
masterIconSizeproperty 
masterIconSize:IconSizes

Master page icon size.


Implementation
    public function get masterIconSize():IconSizes
    public function set masterIconSize(value:IconSizes):void
mastersThumbnailsproperty 
mastersThumbnails:Boolean

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


Implementation
    public function get mastersThumbnails():Boolean
    public function set mastersThumbnails(value:Boolean):void
masterVerticalViewproperty 
masterVerticalView:Boolean

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


Implementation
    public function get masterVerticalView():Boolean
    public function set masterVerticalView(value:Boolean):void
nameproperty 
name:String  [read-only] [override]

The name of the PagesPanel.


Implementation
    public function get name():String
pagesOnTopproperty 
pagesOnTop:Boolean

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


Implementation
    public function get pagesOnTop():Boolean
    public function set pagesOnTop(value:Boolean):void
pagesThumbnailsproperty 
pagesThumbnails:Boolean

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


Implementation
    public function get pagesThumbnails():Boolean
    public function set pagesThumbnails(value:Boolean):void
parentproperty 
parent:Application  [read-only] [override]

The parent of the PagesPanel (a Application).


Implementation
    public function get parent():Application
propertiesproperty 
properties:Object[override]

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


Implementation
    public function get properties():Object
    public function set properties(value:Object):void
resizeBehaviorproperty 
resizeBehavior:PanelLayoutResize

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


Implementation
    public function get resizeBehavior():PanelLayoutResize
    public function set resizeBehavior(value:PanelLayoutResize):void
rotationIconsproperty 
rotationIcons:Boolean

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


Implementation
    public function get rotationIcons():Boolean
    public function set rotationIcons(value:Boolean):void
transitionsIconsproperty 
transitionsIcons:Boolean

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


Implementation
    public function get transitionsIcons():Boolean
    public function set transitionsIcons(value:Boolean):void
transparencyIconsproperty 
transparencyIcons:Boolean

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


Implementation
    public function get transparencyIcons():Boolean
    public function set transparencyIcons(value:Boolean):void
verticalViewproperty 
verticalView:Boolean

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


Implementation
    public function get verticalView():Boolean
    public function set verticalView(value:Boolean):void
visibleproperty 
visible:Boolean[override]

If true, the panel is visible.


Implementation
    public function get visible():Boolean
    public function set visible(value:Boolean):void
Method Detail
addEventListenerPagesPanel()method
public function addEventListenerPagesPanel(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener

Adds an event listener.

Parameters

eventTypeParam:String (default = null) — (String) The event type.
 
handlerParam:Object (default = null) — (Object) The event handler. Can accept: File or JavaScript Function.
 
capturesParam:Boolean (default = false) — (Boolean) This parameter is obsolete. (Optional)

Returns
EventListener
getElements()method 
override public function getElements():Object

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

Returns
Object
removeEventListenerPagesPanel()method 
public function removeEventListenerPagesPanel(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean

Removes the event listener.

Parameters

eventTypeParam:String (default = null) — (String) The registered event type.
 
handlerParam:Object (default = null) — (Object) The registered event handler. Can accept: File or JavaScript Function.
 
capturesParam:Boolean (default = false) — (Boolean) This parameter is obsolete. (Optional)

Returns
Boolean
toSpecifier()method 
override public function toSpecifier():String

Retrieves the object specifier.

Returns
String