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

Since : CS5



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
[read-only] 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
  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
  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
  
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
  
removeEventListenerPage(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
Page
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
resolve(locationParam:Object = null, inParam:CoordinateSpaces = null, consideringRulerUnitsParam:Boolean = false):Object
Get the coordinates of the given location in the specified coordinate system.
Page
  
toSpecifier():String
Retrieves the object specifier.
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]

Since : CS5

Lists all graphics contained by the Page.


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

Since : CS5

Lists all page items contained by the Page.


Implementation
    public function get allPageItems():Object
appliedMasterproperty 
appliedMaster:MasterSpread  [read-only]

Since : CS5

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


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

Since : CS5

The section to which the page belongs.


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

Since : CS5

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]

Since : CS5

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


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

Since : CS5

A collection of buttons.


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

Since : CS5

The sequential number of the page within the document.


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

Since : CS5

EPSTexts


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

Since : CS5

A collection of event listeners.


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

Since : CS5

A collection of events.


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

Since : CS5

A collection of form fields.


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

Since : CS5

A collection of graphic lines.


Implementation
    public function get graphicLines():GraphicLines
groupsproperty 
groups:Groups  [read-only]

Since : CS5

A collection of groups.


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

Since : CS5

A collection of guides.


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

Since : CS5

The unique ID of the Page.


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

Since : CS5

The index of the Page within its containing object.


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

Since : CS5

Returns true if the object specifier resolves to valid objects.


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

Since : CS5

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]

Since : CS5

Margin preference settings.


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

Since : CS5

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

Since : CS5

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]

Since : CS5

A collection of multi-state objects.


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

Since : CS5

The name of the Page.


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

Since : CS5

A collection of ellipses.


Implementation
    public function get ovals():Ovals
pageItemsproperty 
pageItems:PageItems  [read-only]

Since : CS5

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]

Since : CS5

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


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

Since : CS5

A collection of polygons.


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

Since : CS5

A collection of preferences objects.


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

Since : CS5

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]

Since : CS5

A collection of rectangles.


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

Since : CS5

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]

Since : CS5

The spline items collection.


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

Since : CS5

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]

Since : CS5

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

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)

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

Since : CS5

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

Since : CS5

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

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

Since : CS5

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.

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

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

Since : CS5

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
toSpecifier()method 
public function toSpecifier():String

Since : CS5

Retrieves the object specifier.

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

Since : CS5

Get the transformation values of the page item.

Parameters

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

Returns
Object