Packagecom.adobe.indesign
Classpublic class Page
InheritancePage Inheritance CSHostObject Inheritance flash.utils.Proxy



Public Properties
 PropertyDefined By
  allGraphics : Object
[read-only] Lists all graphics contained by the Page.
Page
  allPageItems : Object
[read-only] Lists all page items contained by the Page.
Page
  appliedMaster : MasterSpread
The master spread applied to the Page.
Page
  appliedSection : Section
[read-only] The section to which the page belongs.
Page
  appliedTrapPreset : TrapPreset
The trap preset applied to the page.
Page
  bounds : Object
[read-only] The bounds of the Page, in the format [y1, x1, y2, x2].
Page
  buttons : Buttons
[read-only] A collection of buttons.
Page
  documentOffset : Number
[read-only] The sequential number of the page within the document.
Page
  epstexts : EPSTexts
[read-only] EPSTexts
Page
  eventListeners : EventListeners
[read-only] A collection of event listeners.
Page
  events : Events
[read-only] A collection of events.
Page
  formFields : FormFields
[read-only] A collection of form fields.
Page
  graphicLines : GraphicLines
[read-only] A collection of graphic lines.
Page
  gridData : GridDataInformation
[read-only] Default grid properties.
Page
  groups : Groups
[read-only] A collection of groups.
Page
  guides : Guides
[read-only] A collection of guides.
Page
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  id : Number
[read-only] The unique ID of the Page.
Page
  index : Number
[read-only] The index of the Page within its containing object.
Page
  isValid : Boolean
[read-only] Returns true if the object specifier resolves to valid objects.
Page
  label : String
A property that can be set to any string.
Page
  marginPreferences : MarginPreference
[read-only] Margin preference settings.
Page
  masterPageItems : Object
[read-only] The items on a specified document page that originated on the applied master page and have not been overridden or detached.
Page
  masterPageTransform : TransformationMatrix
The transform applied to the master page before it is applied to Page.
Page
  multiStateObjects : MultiStateObjects
[read-only] A collection of multi-state objects.
Page
  name : String
[read-only] The name of the Page.
Page
  ovals : Ovals
[read-only] A collection of ellipses.
Page
  pageColor : Object
The color label of the Page, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values, or as a UI color.
Page
  pageItems : PageItems
[read-only] The page items collection, which can be used to process all page items in a container (such as a document, page, or group), regardless of type.
Page
  parent : Object
[read-only] The parent of the Page (a Spread or MasterSpread).
Page
  polygons : Polygons
[read-only] A collection of polygons.
Page
  preferences : Preferences
[read-only] A collection of preferences objects.
Page
  properties : Object
A property that allows setting of several properties at the same time.
Page
  rectangles : Rectangles
[read-only] A collection of rectangles.
Page
  side : PageSideOptions
[read-only] The side of the binding spine on which to place the page within the spread.
Page
  splineItems : SplineItems
[read-only] The spline items collection.
Page
  tabOrder : Object
The order in which the focus moves to different buttons in the PDF when the tab key is pressed.
Page
  textFrames : TextFrames
[read-only] A collection of text frames.
Page
Public Methods
 MethodDefined By
  
addEventListenerPage(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
Page
  
detach():void
Detaches an overridden master page item from the master page.
Page
  
duplicate(toParam:LocationOptions = null, referenceParam:Object = null):Page
Duplicates the page.
Page
  
extractLabel(keyParam:String = null):String
Gets the label value associated with the specified key.
Page
 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
Resolves the object specifier, creating an array of object references.
Page
 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
  
insertLabel(keyParam:String = null, valueParam:String = null):void
Sets the label to the value associated with the specified key.
Page
 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
  
move(toParam:LocationOptions = null, referenceParam:Object = null, bindingParam:BindingOptions = null):Page
Moves the page.
Page
  
place(fileNameParam:File = null, placePointParam:Array = null, destinationLayerParam:Layer = null, showingOptionsParam:Boolean = false, autoflowingParam:Boolean = false, withPropertiesParam:Object = null):Object
Places the file.
Page
  
placeXML(usingParam:XMLElement = null, placePointParam:Array = null, autoflowingParam:Boolean = false):PageItem
Places the XML element onto a page.
Page
  
reframe(inParam:Object = null, opposingCornersParam:Array = null):void
Move the bounding box of the page item
Page
  
remove():void
Deletes the Page.
Page
  
removeEventListenerPage(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
Page
  
Removes the override from a previously overridden master page item.
Page
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
resize(inParam:Object = null, fromParam:Object = null, byParam:ResizeMethods = null, valuesParam:Array = null, resizeIndividuallyParam:Boolean = true, consideringRulerUnitsParam:Boolean = false):void
Resize the page item.
Page
  
resolve(locationParam:Object = null, inParam:CoordinateSpaces = null, consideringRulerUnitsParam:Boolean = false):Object
Get the coordinates of the given location in the specified coordinate system.
Page
  
select(existingSelectionParam:SelectionOptions = null):void
Selects the object.
Page
  
setContent(usingParam:String = null, relativeBasePathParam:String = null):PageItem
Replaces the content of XML element with content imported from a file.
Page
  
toSpecifier():String
Retrieves the object specifier.
Page
  
transform(inParam:CoordinateSpaces = null, fromParam:Object = null, withMatrixParam:Object = null, replacingCurrentParam:Object = null, consideringRulerUnitsParam:Boolean = false):void
Transform the page item.
Page
  
transformValuesOf(inParam:CoordinateSpaces = null):Object
Get the transformation values of the page item.
Page
 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
allGraphicsproperty
allGraphics:Object  [read-only]

Lists all graphics contained by the Page.


Implementation
    public function get allGraphics():Object
allPageItemsproperty 
allPageItems:Object  [read-only]

Lists all page items contained by the Page.


Implementation
    public function get allPageItems():Object
appliedMasterproperty 
appliedMaster:MasterSpread

The master spread applied to the Page. Can also accept: NothingEnum enumerator.


Implementation
    public function get appliedMaster():MasterSpread
    public function set appliedMaster(value:MasterSpread):void
appliedSectionproperty 
appliedSection:Section  [read-only]

The section to which the page belongs.


Implementation
    public function get appliedSection():Section
appliedTrapPresetproperty 
appliedTrapPreset:TrapPreset

The trap preset applied to the page. Can also accept: String.


Implementation
    public function get appliedTrapPreset():TrapPreset
    public function set appliedTrapPreset(value:TrapPreset):void
boundsproperty 
bounds:Object  [read-only]

The bounds of the Page, in the format [y1, x1, y2, x2].


Implementation
    public function get bounds():Object
buttonsproperty 
buttons:Buttons  [read-only]

A collection of buttons.


Implementation
    public function get buttons():Buttons
documentOffsetproperty 
documentOffset:Number  [read-only]

The sequential number of the page within the document.


Implementation
    public function get documentOffset():Number
epstextsproperty 
epstexts:EPSTexts  [read-only]

EPSTexts


Implementation
    public function get epstexts():EPSTexts
eventListenersproperty 
eventListeners:EventListeners  [read-only]

A collection of event listeners.


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

A collection of events.


Implementation
    public function get events():Events
formFieldsproperty 
formFields:FormFields  [read-only]

A collection of form fields.


Implementation
    public function get formFields():FormFields
graphicLinesproperty 
graphicLines:GraphicLines  [read-only]

A collection of graphic lines.


Implementation
    public function get graphicLines():GraphicLines
gridDataproperty 
gridData:GridDataInformation  [read-only]

Default grid properties. Note: Applies to named, layout, and frame (story) grids.


Implementation
    public function get gridData():GridDataInformation
groupsproperty 
groups:Groups  [read-only]

A collection of groups.


Implementation
    public function get groups():Groups
guidesproperty 
guides:Guides  [read-only]

A collection of guides.


Implementation
    public function get guides():Guides
idproperty 
id:Number  [read-only]

The unique ID of the Page.


Implementation
    public function get id():Number
indexproperty 
index:Number  [read-only]

The index of the Page within its containing object.


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

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
labelproperty 
label:String

A property that can be set to any string.


Implementation
    public function get label():String
    public function set label(value:String):void
marginPreferencesproperty 
marginPreferences:MarginPreference  [read-only]

Margin preference settings.


Implementation
    public function get marginPreferences():MarginPreference
masterPageItemsproperty 
masterPageItems:Object  [read-only]

The items on a specified document page that originated on the applied master page and have not been overridden or detached. Can return: Array of PageItems, Guides, Graphics, Movies or Sounds.


Implementation
    public function get masterPageItems():Object
masterPageTransformproperty 
masterPageTransform:TransformationMatrix

The transform applied to the master page before it is applied to Page.


Implementation
    public function get masterPageTransform():TransformationMatrix
    public function set masterPageTransform(value:TransformationMatrix):void
multiStateObjectsproperty 
multiStateObjects:MultiStateObjects  [read-only]

A collection of multi-state objects.


Implementation
    public function get multiStateObjects():MultiStateObjects
nameproperty 
name:String  [read-only]

The name of the Page.


Implementation
    public function get name():String
ovalsproperty 
ovals:Ovals  [read-only]

A collection of ellipses.


Implementation
    public function get ovals():Ovals
pageColorproperty 
pageColor:Object

The color label of the Page, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values, or as a UI color. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator or PageColorOptions enumerator.


Implementation
    public function get pageColor():Object
    public function set pageColor(value:Object):void
pageItemsproperty 
pageItems:PageItems  [read-only]

The page items collection, which can be used to process all page items in a container (such as a document, page, or group), regardless of type.


Implementation
    public function get pageItems():PageItems
parentproperty 
parent:Object  [read-only]

The parent of the Page (a Spread or MasterSpread).


Implementation
    public function get parent():Object
polygonsproperty 
polygons:Polygons  [read-only]

A collection of polygons.


Implementation
    public function get polygons():Polygons
preferencesproperty 
preferences:Preferences  [read-only]

A collection of preferences objects.


Implementation
    public function get preferences():Preferences
propertiesproperty 
properties:Object

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
rectanglesproperty 
rectangles:Rectangles  [read-only]

A collection of rectangles.


Implementation
    public function get rectangles():Rectangles
sideproperty 
side:PageSideOptions  [read-only]

The side of the binding spine on which to place the page within the spread.


Implementation
    public function get side():PageSideOptions
splineItemsproperty 
splineItems:SplineItems  [read-only]

The spline items collection.


Implementation
    public function get splineItems():SplineItems
tabOrderproperty 
tabOrder:Object

The order in which the focus moves to different buttons in the PDF when the tab key is pressed.


Implementation
    public function get tabOrder():Object
    public function set tabOrder(value:Object):void
textFramesproperty 
textFrames:TextFrames  [read-only]

A collection of text frames.


Implementation
    public function get textFrames():TextFrames
Method Detail
addEventListenerPage()method
public function addEventListenerPage(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
detach()method 
public function detach():void

Detaches an overridden master page item from the master page.

duplicate()method 
public function duplicate(toParam:LocationOptions = null, referenceParam:Object = null):Page

Duplicates the page.

Parameters

toParam:LocationOptions (default = null) — (LocationOptions) The location at which to place the duplicate page relative to the reference object or within the document or spread. (Optional)
 
referenceParam:Object (default = null) — (Object) The reference object. Note: Required when the to value specifies before or after. Can accept: Page or Spread. (Optional)

Returns
Page
extractLabel()method 
public function extractLabel(keyParam:String = null):String

Gets the label value associated with the specified key.

Parameters

keyParam:String (default = null) — (String) The key.

Returns
String
getElements()method 
public function getElements():Object

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

Returns
Object
insertLabel()method 
public function insertLabel(keyParam:String = null, valueParam:String = null):void

Sets the label to the value associated with the specified key.

Parameters

keyParam:String (default = null) — (String) The key.
 
valueParam:String (default = null) — (String) The value.

move()method 
public function move(toParam:LocationOptions = null, referenceParam:Object = null, bindingParam:BindingOptions = null):Page

Moves the page.

Parameters

toParam:LocationOptions (default = null) — (LocationOptions) The new location of the page relative to the reference object or within the document or spread. (Optional)
 
referenceParam:Object (default = null) — (Object) The reference object. Note: Required when the to parameter value specifies before or after. Can accept: Page or Spread. (Optional)
 
bindingParam:BindingOptions (default = null) — (BindingOptions) The location of the binding spine in spreads. (Optional)

Returns
Page
place()method 
public function place(fileNameParam:File = null, placePointParam:Array = null, destinationLayerParam:Layer = null, showingOptionsParam:Boolean = false, autoflowingParam:Boolean = false, withPropertiesParam:Object = null):Object

Places the file.

Parameters

fileNameParam:File (default = null) — (File) The file to place
 
placePointParam:Array (default = null) — (Array) The point at which to place (Optional)
 
destinationLayerParam:Layer (default = null) — (Layer) The layer on which to place (Optional)
 
showingOptionsParam:Boolean (default = false) — (Boolean) Whether to display the import options dialog (Optional)
 
autoflowingParam:Boolean (default = false) — (Boolean) Whether to autoflow placed text (Optional)
 
withPropertiesParam:Object (default = null) — (Object) Initial values for properties of the placed object(s) (Optional)

Returns
Object
placeXML()method 
public function placeXML(usingParam:XMLElement = null, placePointParam:Array = null, autoflowingParam:Boolean = false):PageItem

Places the XML element onto a page. If the place point is above an existing page item, place the XML element into the page item.

Parameters

usingParam:XMLElement (default = null) — (XMLElement) The XML element to place.
 
placePointParam:Array (default = null) — (Array) The point at which to place the object, specified in the format [x, y].
 
autoflowingParam:Boolean (default = false) — (Boolean) If true, autoflows placed text. (Optional)

Returns
PageItem
reframe()method 
public function reframe(inParam:Object = null, opposingCornersParam:Array = null):void

Move the bounding box of the page item

Parameters

inParam:Object (default = null) — (Object) The bounding box to resize. Can accept: CoordinateSpaces enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator.
 
opposingCornersParam:Array (default = null) — (Array) Opposing corners of new bounding box in the given coordinate space

remove()method 
public function remove():void

Deletes the Page.

removeEventListenerPage()method 
public function removeEventListenerPage(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
removeOverride()method 
public function removeOverride():void

Removes the override from a previously overridden master page item.

resize()method 
public function resize(inParam:Object = null, fromParam:Object = null, byParam:ResizeMethods = null, valuesParam:Array = null, resizeIndividuallyParam:Boolean = true, consideringRulerUnitsParam:Boolean = false):void

Resize the page item.

Parameters

inParam:Object (default = null) — (Object) The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator.
 
fromParam:Object (default = null) — (Object) The transform origin. Legal specifications: relative to bounding box: anchor | {anchor | {x,y}, bounds kind [, coordinate space]}; relative to coordinate space: {x,y} | {{x,y}[, coordinate space]}; relative to layout window ruler: {{x,y}, page index | bounds kind}. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers.
 
byParam:ResizeMethods (default = null) — (ResizeMethods) How the current dimensions are affected by the given values
 
valuesParam:Array (default = null) — (Array) The width and height values. Legal dimensions specifications: {x, y [, coordinate space]}, {x, resize constraint [, coordinate space]}, or {resize constraint, y [, coordinate space]}; where x and y are real numbers and coordinate space is used to determine _only_ the unit of length for x and y; coordinate space is ignored for the 'current dimensions times' resize method). Can accept: Array of Reals, ResizeConstraints enumerators or CoordinateSpaces enumerators.
 
resizeIndividuallyParam:Boolean (default = true) — (Boolean) If false and multiple page items are targeted, the new dimensions are attained only by moving the individual items rather than resizing them. (Optional)
 
consideringRulerUnitsParam:Boolean (default = false) — (Boolean) If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional)

resolve()method 
public function resolve(locationParam:Object = null, inParam:CoordinateSpaces = null, consideringRulerUnitsParam:Boolean = false):Object

Get the coordinates of the given location in the specified coordinate system.

Parameters

locationParam:Object (default = null) — (Object) The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers.
 
inParam:CoordinateSpaces (default = null) — (CoordinateSpaces) The coordinate space to use.
 
consideringRulerUnitsParam:Boolean (default = false) — (Boolean) If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional)

Returns
Object
select()method 
public function select(existingSelectionParam:SelectionOptions = null):void

Selects the object.

Parameters

existingSelectionParam:SelectionOptions (default = null) — (SelectionOptions) The selection status of the Page in relation to previously selected objects. (Optional)

setContent()method 
public function setContent(usingParam:String = null, relativeBasePathParam:String = null):PageItem

Replaces the content of XML element with content imported from a file.

Parameters

usingParam:String (default = null) — (String) The file path to the import file.
 
relativeBasePathParam:String (default = null) — (String) Base path used to resolve relative paths. (Optional)

Returns
PageItem
toSpecifier()method 
public function toSpecifier():String

Retrieves the object specifier.

Returns
String
transform()method 
public function transform(inParam:CoordinateSpaces = null, fromParam:Object = null, withMatrixParam:Object = null, replacingCurrentParam:Object = null, consideringRulerUnitsParam:Boolean = false):void

Transform the page item.

Parameters

inParam:CoordinateSpaces (default = null) — (CoordinateSpaces) The coordinate space to use
 
fromParam:Object (default = null) — (Object) The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers.
 
withMatrixParam:Object (default = null) — (Object) Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix.
 
replacingCurrentParam:Object (default = null) — (Object) Transform components to consider; providing this optional parameter causes the target's existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target's existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional)
 
consideringRulerUnitsParam:Boolean (default = false) — (Boolean) If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional)

transformValuesOf()method 
public function transformValuesOf(inParam:CoordinateSpaces = null):Object

Get the transformation values of the page item.

Parameters

inParam:CoordinateSpaces (default = null) — (CoordinateSpaces) The coordinate space to use

Returns
Object