Package | com.adobe.incopy |
Class | public class Page |
Inheritance | Page ![]() ![]() |
Since : | CS5 |
Property | Defined 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 | ||
![]() | hostObjectDelegate : 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 |
Method | Defined 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 | ||
![]() | 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
Resolves the object specifier, creating an array of object references. | Page | ||
![]() | 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 | |
insertLabel(keyParam:String = null, valueParam:String = null):void
Sets the label to the value associated with the specified key. | Page | ||
![]() | 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 | ||
![]() | 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 | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
allGraphics | property |
allGraphics:Object
[read-only] Since : | CS5 |
Lists all graphics contained by the Page.
public function get allGraphics():Object
allPageItems | property |
allPageItems:Object
[read-only] Since : | CS5 |
Lists all page items contained by the Page.
public function get allPageItems():Object
appliedMaster | property |
appliedMaster:MasterSpread
[read-only] Since : | CS5 |
The master spread applied to the Page. Can also accept: NothingEnum enumerator.
public function get appliedMaster():MasterSpread
appliedSection | property |
appliedSection:Section
[read-only] Since : | CS5 |
The section to which the page belongs.
public function get appliedSection():Section
appliedTrapPreset | property |
appliedTrapPreset:TrapPreset
Since : | CS5 |
The trap preset applied to the page. Can also accept: String.
public function get appliedTrapPreset():TrapPreset
public function set appliedTrapPreset(value:TrapPreset):void
bounds | property |
bounds:Object
[read-only] Since : | CS5 |
The bounds of the Page, in the format [y1, x1, y2, x2].
public function get bounds():Object
buttons | property |
buttons:Buttons
[read-only] Since : | CS5 |
A collection of buttons.
public function get buttons():Buttons
documentOffset | property |
documentOffset:Number
[read-only] Since : | CS5 |
The sequential number of the page within the document.
public function get documentOffset():Number
epstexts | property |
epstexts:EPSTexts
[read-only] Since : | CS5 |
EPSTexts
public function get epstexts():EPSTexts
eventListeners | property |
eventListeners:EventListeners
[read-only] Since : | CS5 |
A collection of event listeners.
public function get eventListeners():EventListeners
events | property |
events:Events
[read-only] Since : | CS5 |
A collection of events.
public function get events():Events
formFields | property |
formFields:FormFields
[read-only] Since : | CS5 |
A collection of form fields.
public function get formFields():FormFields
graphicLines | property |
graphicLines:GraphicLines
[read-only] Since : | CS5 |
A collection of graphic lines.
public function get graphicLines():GraphicLines
groups | property |
groups:Groups
[read-only] Since : | CS5 |
A collection of groups.
public function get groups():Groups
guides | property |
guides:Guides
[read-only] Since : | CS5 |
A collection of guides.
public function get guides():Guides
id | property |
id:Number
[read-only] Since : | CS5 |
The unique ID of the Page.
public function get id():Number
index | property |
index:Number
[read-only] Since : | CS5 |
The index of the Page within its containing object.
public function get index():Number
isValid | property |
isValid:Boolean
[read-only] Since : | CS5 |
Returns true if the object specifier resolves to valid objects.
public function get isValid():Boolean
label | property |
label:String
Since : | CS5 |
A property that can be set to any string.
public function get label():String
public function set label(value:String):void
marginPreferences | property |
marginPreferences:MarginPreference
[read-only] Since : | CS5 |
Margin preference settings.
public function get marginPreferences():MarginPreference
masterPageItems | property |
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.
public function get masterPageItems():Object
masterPageTransform | property |
masterPageTransform:TransformationMatrix
Since : | CS5 |
The transform applied to the master page before it is applied to Page.
public function get masterPageTransform():TransformationMatrix
public function set masterPageTransform(value:TransformationMatrix):void
multiStateObjects | property |
multiStateObjects:MultiStateObjects
[read-only] Since : | CS5 |
A collection of multi-state objects.
public function get multiStateObjects():MultiStateObjects
name | property |
name:String
[read-only] Since : | CS5 |
The name of the Page.
public function get name():String
ovals | property |
ovals:Ovals
[read-only] Since : | CS5 |
A collection of ellipses.
public function get ovals():Ovals
pageItems | property |
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.
public function get pageItems():PageItems
parent | property |
parent:Object
[read-only] Since : | CS5 |
The parent of the Page (a Spread or MasterSpread).
public function get parent():Object
polygons | property |
polygons:Polygons
[read-only] Since : | CS5 |
A collection of polygons.
public function get polygons():Polygons
preferences | property |
preferences:Preferences
[read-only] Since : | CS5 |
A collection of preferences objects.
public function get preferences():Preferences
properties | property |
properties:Object
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
rectangles | property |
rectangles:Rectangles
[read-only] Since : | CS5 |
A collection of rectangles.
public function get rectangles():Rectangles
side | property |
side:PageSideOptions
[read-only] Since : | CS5 |
The side of the binding spine on which to place the page within the spread.
public function get side():PageSideOptions
splineItems | property |
splineItems:SplineItems
[read-only] Since : | CS5 |
The spline items collection.
public function get splineItems():SplineItems
tabOrder | property |
tabOrder:Object
Since : | CS5 |
The order in which the focus moves to different buttons in the PDF when the tab key is pressed.
public function get tabOrder():Object
public function set tabOrder(value:Object):void
textFrames | property |
textFrames:TextFrames
[read-only] Since : | CS5 |
A collection of text frames.
public function get textFrames():TextFrames
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)
|
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.
|
String |
getElements | () | method |
public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
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)
|
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)
|
Object |
toSpecifier | () | method |
public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |
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
|
Object |