Package | com.adobe.indesign |
Class | public class PagesPanel |
Inheritance | PagesPanel ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
eventListeners : EventListeners [override] [read-only]
A collection of event listeners. | PagesPanel | ||
events : Events [override] [read-only]
A collection of events. | PagesPanel | ||
![]() | hostObjectDelegate : 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 |
Method | Defined By | ||
---|---|---|---|
addEventListenerPagesPanel(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | PagesPanel | ||
![]() | addEventListenerPanel(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | Panel | |
![]() | filterArgsForHBAPI(args:Array):Array [static]
Function to clean up the argument list and put it into a format that
makes sense for HBAPI. | CSHostObject | |
![]() | filterSingleObjectForHBAPI(value:Object):Object [static]
| CSHostObject | |
![]() | 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 | ||
![]() | getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):* [static] | CSHostObject | |
![]() | hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
| CSHostObject | |
![]() | hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):* [static]
Implements a safe call of a static method on the host
| CSHostObject | |
![]() | hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
| CSHostObject | |
![]() | hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
| CSHostObject | |
![]() | 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 | |
![]() | hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
| CSHostObject | |
![]() | hostSetStatic(className:String, propertyName:String, rawvalue:*):* [static]
Implements a safe set of a static property on the host
| CSHostObject | |
![]() | 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 | ||
![]() | removeEventListenerPanel(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | Panel | |
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
toSpecifier():String [override]
Retrieves the object specifier. | PagesPanel | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
eventListeners | property |
eventListeners:EventListeners
[read-only] [override] Since : | CS5 |
A collection of event listeners.
public function get eventListeners():EventListeners
events | property |
events:Events
[read-only] [override] Since : | CS5 |
A collection of events.
public function get events():Events
iconSize | property |
iconSize:IconSizes
Since : | CS5 |
Page icon size.
public function get iconSize():IconSizes
public function set iconSize(value:IconSizes):void
index | property |
index:Number
[read-only] [override] Since : | CS5 |
The index of the PagesPanel within its containing object.
public function get index():Number
isValid | property |
isValid:Boolean
[read-only] [override] Since : | CS5 |
Returns true if the object specifier resolves to valid objects.
public function get isValid():Boolean
masterIconSize | property |
masterIconSize:IconSizes
Since : | CS5 |
Master page icon size.
public function get masterIconSize():IconSizes
public function set masterIconSize(value:IconSizes):void
mastersThumbnails | property |
mastersThumbnails:Boolean
Since : | CS5 |
If true, display thumbnails of the pages in the master pages area of the panel.
public function get mastersThumbnails():Boolean
public function set mastersThumbnails(value:Boolean):void
masterVerticalView | property |
masterVerticalView:Boolean
Since : | CS5 |
If true, master page icons will be arranged vertically around the binding spine. If false, master page icons will be arranged horizontally.
public function get masterVerticalView():Boolean
public function set masterVerticalView(value:Boolean):void
name | property |
name:String
[read-only] [override] Since : | CS5 |
The name of the PagesPanel.
public function get name():String
pagesOnTop | property |
pagesOnTop:Boolean
Since : | CS5 |
If true, the pages area of the panel will be drawn above the master pages area.
public function get pagesOnTop():Boolean
public function set pagesOnTop(value:Boolean):void
pagesThumbnails | property |
pagesThumbnails:Boolean
Since : | CS5 |
If true, display thumbnails of the pages in the pages area of the panel.
public function get pagesThumbnails():Boolean
public function set pagesThumbnails(value:Boolean):void
parent | property |
parent:Application
[read-only] [override] Since : | CS5 |
The parent of the PagesPanel (a Application).
public function get parent():Application
properties | property |
properties:Object
[override] Since : | CS5 |
A property that allows setting of several properties at the same time.
public function get properties():Object
public function set properties(value:Object):void
resizeBehavior | property |
resizeBehavior:PanelLayoutResize
Since : | CS5 |
Specifies the behavior of the document and master page areas of the panel when the panel is resized.
public function get resizeBehavior():PanelLayoutResize
public function set resizeBehavior(value:PanelLayoutResize):void
rotationIcons | property |
rotationIcons:Boolean
Since : | CS5 |
If true, a rotation icon will display next to spreads with non-zero rotation applied.
public function get rotationIcons():Boolean
public function set rotationIcons(value:Boolean):void
transitionsIcons | property |
transitionsIcons:Boolean
Since : | CS5 |
If true, a page transitions icon will display next to spreads with page transitions applied.
public function get transitionsIcons():Boolean
public function set transitionsIcons(value:Boolean):void
transparencyIcons | property |
transparencyIcons:Boolean
Since : | CS5 |
If true, a transparency icon will display next to spreads with elements having transparency applied.
public function get transparencyIcons():Boolean
public function set transparencyIcons(value:Boolean):void
verticalView | property |
verticalView:Boolean
Since : | CS5 |
If true, document page icons will be arranged vertically around the binding spine. If false, page icons will be arranged horizontally.
public function get verticalView():Boolean
public function set verticalView(value:Boolean):void
visible | property |
visible:Boolean
[override] Since : | CS5 |
If true, the panel is visible.
public function get visible():Boolean
public function set visible(value:Boolean):void
addEventListenerPagesPanel | () | method |
public function addEventListenerPagesPanel(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Since : | CS5 |
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)
|
EventListener |
getElements | () | method |
override public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
removeEventListenerPagesPanel | () | method |
public function removeEventListenerPagesPanel(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Since : | CS5 |
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)
|
Boolean |
toSpecifier | () | method |
override public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |