Package | com.adobe.indesign |
Class | public class PageItem |
Inheritance | PageItem ![]() ![]() |
Subclasses | EPSText, FormField, Graphic, Group, MediaItem, SplineItem, TextFrame |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
absoluteFlip : Flip
Indicates whether the PageItem has been flipped independently of its parent object and, if yes, the direction in which the PageItem was flipped. | PageItem | ||
absoluteHorizontalScale : Number
The horizontal scale of the PageItem relative to its containing object. | PageItem | ||
absoluteRotationAngle : Number
The rotation angle of the PageItem relative to its containing object. | PageItem | ||
absoluteShearAngle : Number
The skewing angle of the PageItem relative to its containing object. | PageItem | ||
absoluteVerticalScale : Number
The vertical scale of the PageItem relative to its containing object. | PageItem | ||
AFTER_PLACE : String [static] [read-only]
Dispatched after a PageItem is placed. | PageItem | ||
allArticles : Object [read-only]
The list of all articles this page item is part of
| PageItem | ||
allGraphics : Object [read-only]
Lists all graphics contained by the PageItem. | PageItem | ||
allowOverrides : Boolean
If true, the master page item can be overridden. | PageItem | ||
allPageItems : Object [read-only]
Lists all page items contained by the PageItem. | PageItem | ||
animationSettings : AnimationSetting [read-only]
The page item animation settings. | PageItem | ||
appliedObjectStyle : ObjectStyle
The object style applied to the PageItem. | PageItem | ||
associatedXMLElement : XMLItem [read-only]
The XML element associated with the PageItem. | PageItem | ||
BEFORE_PLACE : String [static] [read-only]
Dispatched before a PageItem is placed. | PageItem | ||
bottomLeftCornerOption : CornerOptions
The shape to apply to the bottom left corner of rectangular shapes. | PageItem | ||
bottomLeftCornerRadius : Object
The radius in measurement units of the corner effect applied to the bottom left corner of rectangular shapes
| PageItem | ||
bottomRightCornerOption : CornerOptions
The shape to apply to the bottom right corner of rectangular shapes. | PageItem | ||
bottomRightCornerRadius : Object
The radius in measurement units of the corner effect applied to the bottom right corner of rectangular shapes
| PageItem | ||
contentTransparencySettings : ContentTransparencySetting [read-only]
Transparency settings for the content of the PageItem. | PageItem | ||
endCap : EndCap
The end shape of an open path. | PageItem | ||
endJoin : EndJoin
The corner join applied to the PageItem. | PageItem | ||
eventListeners : EventListeners [read-only]
A collection of event listeners. | PageItem | ||
events : Events [read-only]
A collection of events. | PageItem | ||
fillColor : Swatch
The swatch (color, gradient, tint, or mixed ink) applied to the fill of the PageItem. | PageItem | ||
fillTint : Number
The percent of tint to use in the PageItem's fill color. | PageItem | ||
fillTransparencySettings : FillTransparencySetting [read-only]
Transparency settings for the fill applied to the PageItem. | PageItem | ||
flip : Flip
The direction in which to flip the printed image. | PageItem | ||
gapColor : Swatch
The swatch (color, gradient, tint, or mixed ink) applied to the gap of a dashed, dotted, or striped stroke. | PageItem | ||
gapTint : Number
The tint as a percentage of the gap color. | PageItem | ||
geometricBounds : Object
The bounds of the PageItem excluding the stroke width, in the format [y1, x1, y2, x2], which give the coordinates of the top-left and bottom-right corners of the bounding box. | PageItem | ||
gradientFillAngle : Number
The angle of a linear gradient applied to the fill of the PageItem. | PageItem | ||
gradientFillLength : Object
The length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the PageItem. | PageItem | ||
gradientFillStart : Object
The starting point (in page coordinates) of a gradient applied to the fill of the PageItem, in the format [x, y]. | PageItem | ||
gradientStrokeAngle : Number
The angle of a linear gradient applied to the stroke of the PageItem. | PageItem | ||
gradientStrokeLength : Object
The length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the PageItem. | PageItem | ||
gradientStrokeStart : Object
The starting point (in page coordinates) of a gradient applied to the stroke of the PageItem, in the format [x, y]. | PageItem | ||
horizontalScale : Number
The horizontal scaling applied to the PageItem. | PageItem | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
id : Number [read-only]
The unique ID of the PageItem. | PageItem | ||
index : Number [read-only]
The index of the PageItem within its containing object. | PageItem | ||
isValid : Boolean [read-only]
Returns true if the object specifier resolves to valid objects. | PageItem | ||
itemLayer : Layer
The layer that the PageItem is on. | PageItem | ||
label : String
A property that can be set to any string. | PageItem | ||
leftLineEnd : ArrowHead
The arrowhead applied to the start of the path. | PageItem | ||
localDisplaySetting : DisplaySettingOptions
Display performance options for the PageItem. | PageItem | ||
locked : Boolean
If true, the PageItem is locked. | PageItem | ||
miterLimit : Number
The limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join. | PageItem | ||
name : String
The name of the PageItem. | PageItem | ||
nonprinting : Boolean
If true, the PageItem does not print. | PageItem | ||
overprintFill : Boolean
If true, the PageItem's fill color overprints any underlying objects. | PageItem | ||
overprintGap : Boolean
If true, the gap color overprints any underlying colors. | PageItem | ||
overprintStroke : Boolean
If true, the PageItem's stroke color overprints any underlying objects. | PageItem | ||
overridden : Boolean [read-only]
If true, the object originated on a master spread and was overridden. | PageItem | ||
overriddenMasterPageItem : Object [read-only]
An object that originated on a master page and has been overridden. | PageItem | ||
parent : Object [read-only]
The parent of the PageItem (a XMLElement, Spread, MasterSpread, Polygon, GraphicLine, Rectangle, Oval, SplineItem, Group, State, Character, Sound, PlaceGun, Movie or Snippet). | PageItem | ||
parentPage : Page [read-only]
The page on which this page item appears. | PageItem | ||
preferences : Preferences [read-only]
A collection of preferences objects. | PageItem | ||
properties : Object
A property that allows setting of several properties at the same time. | PageItem | ||
rightLineEnd : ArrowHead
The arrowhead applied to the end of the path. | PageItem | ||
rotationAngle : Number
The rotatation angle of the PageItem. | PageItem | ||
shearAngle : Number
The skewing angle applied to the PageItem. | PageItem | ||
strokeAlignment : StrokeAlignment
The stroke alignment applied to the PageItem. | PageItem | ||
strokeColor : Swatch
The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the PageItem. | PageItem | ||
strokeCornerAdjustment : StrokeCornerAdjustment
The corner adjustment applied to the PageItem. | PageItem | ||
strokeDashAndGap : Object
The dash and gap measurements that define the pattern of a custom dashed line. | PageItem | ||
strokeTint : Number
The percent of tint to use in object's stroke color. | PageItem | ||
strokeTransparencySettings : StrokeTransparencySetting [read-only]
Transparency settings for the stroke. | PageItem | ||
strokeType : StrokeStyle
The name of the stroke style to apply. | PageItem | ||
strokeWeight : Object
The weight (in points) to apply to the PageItem's stroke. | PageItem | ||
textWrapPreferences : TextWrapPreference [read-only]
The text wrap preference properties that define the default formatting for wrapping text around objects. | PageItem | ||
timingSettings : TimingSetting [read-only]
The object timing settings. | PageItem | ||
topLeftCornerOption : CornerOptions
The shape to be applied to the top left corner of rectangular shapes and all corners of non-rectangular shapes.Note: corner option differs from end join in which you can set a radius for a corner option, whereas the rounded or beveled effect of an end join depends on the stroke weight. | PageItem | ||
topLeftCornerRadius : Object
The radius in measurement units of the corner effect applied to the top left corner of rectangular shapes and all corners of non-rectangular shapes
| PageItem | ||
topRightCornerOption : CornerOptions
The shape to apply to the top right corner of rectangular shapes
| PageItem | ||
topRightCornerRadius : Object
The radius in measurement units of the corner effect applied to the top right corner of rectangular shapes
| PageItem | ||
transparencySettings : TransparencySetting [read-only]
Transparency settings. | PageItem | ||
verticalScale : Number
The vertical scaling applied to the PageItem. | PageItem | ||
visible : Boolean
If true, the PageItem is visible. | PageItem | ||
visibleBounds : Object
The bounds of the PageItem including the stroke width, in the format [y1, x1, y2, x2], which give the coordinates of the top-left and bottom-right corners of the bounding box. | PageItem |
Method | Defined By | ||
---|---|---|---|
addEventListenerPageItem(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | PageItem | ||
applyObjectStyle(usingParam:ObjectStyle = null, clearingOverridesParam:Boolean = true, clearingOverridesThroughRootObjectStyleParam:Boolean = false):void
Applies the specified object style. | PageItem | ||
asynchronousExportFile(formatParam:Object = null, toParam:File = null, showingOptionsParam:Boolean = false, usingParam:PDFExportPreset = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):BackgroundTask
asynchronously exports the object(s) to a file. | PageItem | ||
autoTag():void
Tag the object or the parent story using default tags defined in XML preference. | PageItem | ||
changeObject(reverseOrderParam:Boolean):Object
Finds objects that match the find what value and replace the objects with the change to value. | PageItem | ||
clearObjectStyleOverrides():void
Clear overrides for object style
| PageItem | ||
clearTransformations():void
Clears transformations from the PageItem. | PageItem | ||
convertShape(givenParam:ConvertShapeOptions = null, numberOfSidesParam:Number, insetPercentageParam:Number, cornerRadiusParam:Object = null):void
Converts the PageItem to a different shape. | PageItem | ||
detach():void
Detaches an overridden master page item from the master page. | PageItem | ||
Duplicates the PageItem at the specified location or offset. | PageItem | ||
exportFile(formatParam:Object = null, toParam:File = null, showingOptionsParam:Boolean = false, usingParam:PDFExportPreset = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):void
Exports the object(s) to a file. | PageItem | ||
extractLabel(keyParam:String = null):String
Gets the label value associated with the specified key. | PageItem | ||
![]() | 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 | |
findObject(reverseOrderParam:Boolean):Object
Finds objects that match the find what value. | PageItem | ||
fit(givenParam:FitOptions = null):void
Applies the specified fit option to content in a frame. | PageItem | ||
Flips the PageItem. | PageItem | ||
![]() | 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. | PageItem | ||
![]() | 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. | PageItem | ||
![]() | 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 | |
markup(usingParam:XMLElement = null):void
Associates the page item with the specified XML element while preserving existing content. | PageItem | ||
move(toParam:Object = null, byParam:Array = null):void
Moves the PageItem to a new location. | PageItem | ||
Overrides a master page item and places the item on the document page as a new object. | PageItem | ||
place(fileNameParam:File = null, showingOptionsParam:Boolean = false, withPropertiesParam:Object = null):Object
Places the file. | PageItem | ||
placeXML(usingParam:XMLElement = null):void
Places XML content into the specified object. | PageItem | ||
redefineScaling(toParam:Array = null):void
Apply an item's scaling to its content if possible. | PageItem | ||
reframe(inParam:Object = null, opposingCornersParam:Array = null):void
Move the bounding box of the page item
| PageItem | ||
remove():void
Deletes the PageItem. | PageItem | ||
removeEventListenerPageItem(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | PageItem | ||
removeOverride():void
Removes the override from a previously overridden master page item. | PageItem | ||
![]() | 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. | PageItem | ||
resolve(locationParam:Object = null, inParam:CoordinateSpaces = null, consideringRulerUnitsParam:Boolean = false):Object
Get the coordinates of the given location in the specified coordinate system. | PageItem | ||
select(existingSelectionParam:SelectionOptions = null):void
Selects the object. | PageItem | ||
Stores the object in the specified library. | PageItem | ||
toSpecifier():String
Retrieves the object specifier. | PageItem | ||
transform(inParam:CoordinateSpaces = null, fromParam:Object = null, withMatrixParam:Object = null, replacingCurrentParam:Object = null, consideringRulerUnitsParam:Boolean = false):void
Transform the page item. | PageItem | ||
transformAgain():Object
Transforms the PageItem using the last transformation performed on any object. | PageItem | ||
transformAgainIndividually():Object
Transforms the PageItem using the last transformation performed on any PageItem. | PageItem | ||
transformSequenceAgain():Object
Transforms the PageItem using the last sequence of transform operations performed on any single object or performed at the same time on any group of objects. | PageItem | ||
transformSequenceAgainIndividually():Object
Transforms the PageItem using the last sequence of transformations performed on any single object or performed at the same time on any group of objects. | PageItem | ||
transformValuesOf(inParam:CoordinateSpaces = null):Object
Get the transformation values of the page item. | PageItem | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
absoluteFlip | property |
absoluteFlip:Flip
Since : | CS5 |
Indicates whether the PageItem has been flipped independently of its parent object and, if yes, the direction in which the PageItem was flipped.
public function get absoluteFlip():Flip
public function set absoluteFlip(value:Flip):void
absoluteHorizontalScale | property |
absoluteHorizontalScale:Number
Since : | CS5 |
The horizontal scale of the PageItem relative to its containing object.
public function get absoluteHorizontalScale():Number
public function set absoluteHorizontalScale(value:Number):void
absoluteRotationAngle | property |
absoluteRotationAngle:Number
Since : | CS5 |
The rotation angle of the PageItem relative to its containing object. (Range: -360 to 360)
public function get absoluteRotationAngle():Number
public function set absoluteRotationAngle(value:Number):void
absoluteShearAngle | property |
absoluteShearAngle:Number
Since : | CS5 |
The skewing angle of the PageItem relative to its containing object. (Range: -360 to 360)
public function get absoluteShearAngle():Number
public function set absoluteShearAngle(value:Number):void
absoluteVerticalScale | property |
absoluteVerticalScale:Number
Since : | CS5 |
The vertical scale of the PageItem relative to its containing object.
public function get absoluteVerticalScale():Number
public function set absoluteVerticalScale(value:Number):void
AFTER_PLACE | property |
AFTER_PLACE:String
[read-only] Since : | CS5 |
Dispatched after a PageItem is placed. This event bubbles. This event is not cancelable.
public static function get AFTER_PLACE():String
allArticles | property |
allArticles:Object
[read-only] Since : | CS5.5 |
The list of all articles this page item is part of
public function get allArticles():Object
allGraphics | property |
allGraphics:Object
[read-only] Since : | CS5 |
Lists all graphics contained by the PageItem.
public function get allGraphics():Object
allowOverrides | property |
allowOverrides:Boolean
Since : | CS5 |
If true, the master page item can be overridden.
public function get allowOverrides():Boolean
public function set allowOverrides(value:Boolean):void
allPageItems | property |
allPageItems:Object
[read-only] Since : | CS5 |
Lists all page items contained by the PageItem.
public function get allPageItems():Object
animationSettings | property |
animationSettings:AnimationSetting
[read-only] Since : | CS5 |
The page item animation settings.
public function get animationSettings():AnimationSetting
appliedObjectStyle | property |
appliedObjectStyle:ObjectStyle
Since : | CS5 |
The object style applied to the PageItem.
public function get appliedObjectStyle():ObjectStyle
public function set appliedObjectStyle(value:ObjectStyle):void
associatedXMLElement | property |
associatedXMLElement:XMLItem
[read-only] Since : | CS5 |
The XML element associated with the PageItem.
public function get associatedXMLElement():XMLItem
BEFORE_PLACE | property |
BEFORE_PLACE:String
[read-only] Since : | CS5 |
Dispatched before a PageItem is placed. This event bubbles. This event is cancelable.
public static function get BEFORE_PLACE():String
bottomLeftCornerOption | property |
bottomLeftCornerOption:CornerOptions
Since : | CS5 |
The shape to apply to the bottom left corner of rectangular shapes.
public function get bottomLeftCornerOption():CornerOptions
public function set bottomLeftCornerOption(value:CornerOptions):void
bottomLeftCornerRadius | property |
bottomLeftCornerRadius:Object
Since : | CS5 |
The radius in measurement units of the corner effect applied to the bottom left corner of rectangular shapes
public function get bottomLeftCornerRadius():Object
public function set bottomLeftCornerRadius(value:Object):void
bottomRightCornerOption | property |
bottomRightCornerOption:CornerOptions
Since : | CS5 |
The shape to apply to the bottom right corner of rectangular shapes.
public function get bottomRightCornerOption():CornerOptions
public function set bottomRightCornerOption(value:CornerOptions):void
bottomRightCornerRadius | property |
bottomRightCornerRadius:Object
Since : | CS5 |
The radius in measurement units of the corner effect applied to the bottom right corner of rectangular shapes
public function get bottomRightCornerRadius():Object
public function set bottomRightCornerRadius(value:Object):void
contentTransparencySettings | property |
contentTransparencySettings:ContentTransparencySetting
[read-only] Since : | CS5 |
Transparency settings for the content of the PageItem.
public function get contentTransparencySettings():ContentTransparencySetting
endCap | property |
endCap:EndCap
Since : | CS5 |
The end shape of an open path.
public function get endCap():EndCap
public function set endCap(value:EndCap):void
endJoin | property |
endJoin:EndJoin
Since : | CS5 |
The corner join applied to the PageItem.
public function get endJoin():EndJoin
public function set endJoin(value:EndJoin):void
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
fillColor | property |
fillColor:Swatch
Since : | CS5 |
The swatch (color, gradient, tint, or mixed ink) applied to the fill of the PageItem. . Can also accept: String.
public function get fillColor():Swatch
public function set fillColor(value:Swatch):void
fillTint | property |
fillTint:Number
Since : | CS5 |
The percent of tint to use in the PageItem's fill color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.)
public function get fillTint():Number
public function set fillTint(value:Number):void
fillTransparencySettings | property |
fillTransparencySettings:FillTransparencySetting
[read-only] Since : | CS5 |
Transparency settings for the fill applied to the PageItem.
public function get fillTransparencySettings():FillTransparencySetting
flip | property |
flip:Flip
Since : | CS5 |
The direction in which to flip the printed image.
public function get flip():Flip
public function set flip(value:Flip):void
gapColor | property |
gapColor:Swatch
Since : | CS5 |
The swatch (color, gradient, tint, or mixed ink) applied to the gap of a dashed, dotted, or striped stroke. For information, see stroke type.
public function get gapColor():Swatch
public function set gapColor(value:Swatch):void
gapTint | property |
gapTint:Number
Since : | CS5 |
The tint as a percentage of the gap color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.)
public function get gapTint():Number
public function set gapTint(value:Number):void
geometricBounds | property |
geometricBounds:Object
Since : | CS5 |
The bounds of the PageItem excluding the stroke width, in the format [y1, x1, y2, x2], which give the coordinates of the top-left and bottom-right corners of the bounding box.
public function get geometricBounds():Object
public function set geometricBounds(value:Object):void
gradientFillAngle | property |
gradientFillAngle:Number
Since : | CS5 |
The angle of a linear gradient applied to the fill of the PageItem. (Range: -180 to 180)
public function get gradientFillAngle():Number
public function set gradientFillAngle(value:Number):void
gradientFillLength | property |
gradientFillLength:Object
Since : | CS5 |
The length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the PageItem.
public function get gradientFillLength():Object
public function set gradientFillLength(value:Object):void
gradientFillStart | property |
gradientFillStart:Object
Since : | CS5 |
The starting point (in page coordinates) of a gradient applied to the fill of the PageItem, in the format [x, y].
public function get gradientFillStart():Object
public function set gradientFillStart(value:Object):void
gradientStrokeAngle | property |
gradientStrokeAngle:Number
Since : | CS5 |
The angle of a linear gradient applied to the stroke of the PageItem. (Range: -180 to 180)
public function get gradientStrokeAngle():Number
public function set gradientStrokeAngle(value:Number):void
gradientStrokeLength | property |
gradientStrokeLength:Object
Since : | CS5 |
The length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the PageItem.
public function get gradientStrokeLength():Object
public function set gradientStrokeLength(value:Object):void
gradientStrokeStart | property |
gradientStrokeStart:Object
Since : | CS5 |
The starting point (in page coordinates) of a gradient applied to the stroke of the PageItem, in the format [x, y].
public function get gradientStrokeStart():Object
public function set gradientStrokeStart(value:Object):void
horizontalScale | property |
horizontalScale:Number
Since : | CS5 |
The horizontal scaling applied to the PageItem.
public function get horizontalScale():Number
public function set horizontalScale(value:Number):void
id | property |
id:Number
[read-only] Since : | CS5 |
The unique ID of the PageItem.
public function get id():Number
index | property |
index:Number
[read-only] Since : | CS5 |
The index of the PageItem 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
itemLayer | property |
itemLayer:Layer
Since : | CS5 |
The layer that the PageItem is on.
public function get itemLayer():Layer
public function set itemLayer(value:Layer):void
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
leftLineEnd | property |
leftLineEnd:ArrowHead
Since : | CS5 |
The arrowhead applied to the start of the path.
public function get leftLineEnd():ArrowHead
public function set leftLineEnd(value:ArrowHead):void
localDisplaySetting | property |
localDisplaySetting:DisplaySettingOptions
Since : | CS5 |
Display performance options for the PageItem.
public function get localDisplaySetting():DisplaySettingOptions
public function set localDisplaySetting(value:DisplaySettingOptions):void
locked | property |
locked:Boolean
Since : | CS5 |
If true, the PageItem is locked.
public function get locked():Boolean
public function set locked(value:Boolean):void
miterLimit | property |
miterLimit:Number
Since : | CS5 |
The limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join.
public function get miterLimit():Number
public function set miterLimit(value:Number):void
name | property |
name:String
Since : | CS5 |
The name of the PageItem.
public function get name():String
public function set name(value:String):void
nonprinting | property |
nonprinting:Boolean
Since : | CS5 |
If true, the PageItem does not print.
public function get nonprinting():Boolean
public function set nonprinting(value:Boolean):void
overprintFill | property |
overprintFill:Boolean
Since : | CS5 |
If true, the PageItem's fill color overprints any underlying objects. If false, the fill color knocks out the underlying colors.
public function get overprintFill():Boolean
public function set overprintFill(value:Boolean):void
overprintGap | property |
overprintGap:Boolean
Since : | CS5 |
If true, the gap color overprints any underlying colors. If false, the gap color knocks out the underlying colors.
public function get overprintGap():Boolean
public function set overprintGap(value:Boolean):void
overprintStroke | property |
overprintStroke:Boolean
Since : | CS5 |
If true, the PageItem's stroke color overprints any underlying objects. If false, the stroke color knocks out the underlying colors.
public function get overprintStroke():Boolean
public function set overprintStroke(value:Boolean):void
overridden | property |
overridden:Boolean
[read-only] Since : | CS5 |
If true, the object originated on a master spread and was overridden. If false, the object either originated on a master spread and was not overridden, or the object did not originate on a master page.
public function get overridden():Boolean
overriddenMasterPageItem | property |
overriddenMasterPageItem:Object
[read-only] Since : | CS5 |
An object that originated on a master page and has been overridden. Can return: PageItem, Guide, Graphic, Movie or Sound.
public function get overriddenMasterPageItem():Object
parent | property |
parent:Object
[read-only] Since : | CS5 |
The parent of the PageItem (a XMLElement, Spread, MasterSpread, Polygon, GraphicLine, Rectangle, Oval, SplineItem, Group, State, Character, Sound, PlaceGun, Movie or Snippet).
public function get parent():Object
parentPage | property |
parentPage:Page
[read-only] Since : | CS5 |
The page on which this page item appears.
public function get parentPage():Page
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
rightLineEnd | property |
rightLineEnd:ArrowHead
Since : | CS5 |
The arrowhead applied to the end of the path.
public function get rightLineEnd():ArrowHead
public function set rightLineEnd(value:ArrowHead):void
rotationAngle | property |
rotationAngle:Number
Since : | CS5 |
The rotatation angle of the PageItem. (Range: -360 to 360)
public function get rotationAngle():Number
public function set rotationAngle(value:Number):void
shearAngle | property |
shearAngle:Number
Since : | CS5 |
The skewing angle applied to the PageItem. (Range: -360 to 360)
public function get shearAngle():Number
public function set shearAngle(value:Number):void
strokeAlignment | property |
strokeAlignment:StrokeAlignment
Since : | CS5 |
The stroke alignment applied to the PageItem.
public function get strokeAlignment():StrokeAlignment
public function set strokeAlignment(value:StrokeAlignment):void
strokeColor | property |
strokeColor:Swatch
Since : | CS5 |
The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the PageItem. Can also accept: String.
public function get strokeColor():Swatch
public function set strokeColor(value:Swatch):void
strokeCornerAdjustment | property |
strokeCornerAdjustment:StrokeCornerAdjustment
Since : | CS5 |
The corner adjustment applied to the PageItem.
public function get strokeCornerAdjustment():StrokeCornerAdjustment
public function set strokeCornerAdjustment(value:StrokeCornerAdjustment):void
strokeDashAndGap | property |
strokeDashAndGap:Object
Since : | CS5 |
The dash and gap measurements that define the pattern of a custom dashed line. Define up to six values (in points) in the format [dash1, gap1, dash2, gap2, dash3, gap3].
public function get strokeDashAndGap():Object
public function set strokeDashAndGap(value:Object):void
strokeTint | property |
strokeTint:Number
Since : | CS5 |
The percent of tint to use in object's stroke color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.)
public function get strokeTint():Number
public function set strokeTint(value:Number):void
strokeTransparencySettings | property |
strokeTransparencySettings:StrokeTransparencySetting
[read-only] Since : | CS5 |
Transparency settings for the stroke.
public function get strokeTransparencySettings():StrokeTransparencySetting
strokeType | property |
strokeType:StrokeStyle
Since : | CS5 |
The name of the stroke style to apply. Can also accept: String.
public function get strokeType():StrokeStyle
public function set strokeType(value:StrokeStyle):void
strokeWeight | property |
strokeWeight:Object
Since : | CS5 |
The weight (in points) to apply to the PageItem's stroke.
public function get strokeWeight():Object
public function set strokeWeight(value:Object):void
textWrapPreferences | property |
textWrapPreferences:TextWrapPreference
[read-only] Since : | CS5 |
The text wrap preference properties that define the default formatting for wrapping text around objects.
public function get textWrapPreferences():TextWrapPreference
timingSettings | property |
timingSettings:TimingSetting
[read-only] Since : | CS5 |
The object timing settings.
public function get timingSettings():TimingSetting
topLeftCornerOption | property |
topLeftCornerOption:CornerOptions
Since : | CS5 |
The shape to be applied to the top left corner of rectangular shapes and all corners of non-rectangular shapes.Note: corner option differs from end join in which you can set a radius for a corner option, whereas the rounded or beveled effect of an end join depends on the stroke weight.
public function get topLeftCornerOption():CornerOptions
public function set topLeftCornerOption(value:CornerOptions):void
topLeftCornerRadius | property |
topLeftCornerRadius:Object
Since : | CS5 |
The radius in measurement units of the corner effect applied to the top left corner of rectangular shapes and all corners of non-rectangular shapes
public function get topLeftCornerRadius():Object
public function set topLeftCornerRadius(value:Object):void
topRightCornerOption | property |
topRightCornerOption:CornerOptions
Since : | CS5 |
The shape to apply to the top right corner of rectangular shapes
public function get topRightCornerOption():CornerOptions
public function set topRightCornerOption(value:CornerOptions):void
topRightCornerRadius | property |
topRightCornerRadius:Object
Since : | CS5 |
The radius in measurement units of the corner effect applied to the top right corner of rectangular shapes
public function get topRightCornerRadius():Object
public function set topRightCornerRadius(value:Object):void
transparencySettings | property |
transparencySettings:TransparencySetting
[read-only] Since : | CS5 |
Transparency settings.
public function get transparencySettings():TransparencySetting
verticalScale | property |
verticalScale:Number
Since : | CS5 |
The vertical scaling applied to the PageItem.
public function get verticalScale():Number
public function set verticalScale(value:Number):void
visible | property |
visible:Boolean
Since : | CS5 |
If true, the PageItem is visible.
public function get visible():Boolean
public function set visible(value:Boolean):void
visibleBounds | property |
visibleBounds:Object
Since : | CS5 |
The bounds of the PageItem including the stroke width, in the format [y1, x1, y2, x2], which give the coordinates of the top-left and bottom-right corners of the bounding box.
public function get visibleBounds():Object
public function set visibleBounds(value:Object):void
addEventListenerPageItem | () | method |
public function addEventListenerPageItem(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 |
applyObjectStyle | () | method |
public function applyObjectStyle(usingParam:ObjectStyle = null, clearingOverridesParam:Boolean = true, clearingOverridesThroughRootObjectStyleParam:Boolean = false):void
Since : | CS5 |
Applies the specified object style.
Parameters
usingParam:ObjectStyle (default = null ) — (ObjectStyle) The object style to apply.
| |
clearingOverridesParam:Boolean (default = true ) — (Boolean) If true, clears the PageItem's existing attributes before applying the style. (Optional)
| |
clearingOverridesThroughRootObjectStyleParam:Boolean (default = false ) — (Boolean) If true, clears attributes and formatting applied to the PageItem that are not defined in the object style. (Optional)
|
asynchronousExportFile | () | method |
public function asynchronousExportFile(formatParam:Object = null, toParam:File = null, showingOptionsParam:Boolean = false, usingParam:PDFExportPreset = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):BackgroundTask
Since : | CS5 |
asynchronously exports the object(s) to a file.
Parameters
formatParam:Object (default = null ) — (Object) The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String.
| |
toParam:File (default = null ) — (File) The path to the export file.
| |
showingOptionsParam:Boolean (default = false ) — (Boolean) If true, displays the export options dialog. (Optional)
| |
usingParam:PDFExportPreset (default = null ) — (PDFExportPreset) The export style. (Optional)
| |
versionCommentsParam:String (default = null ) — (String) The comment for this version. (Optional)
| |
forceSaveParam:Boolean (default = false ) — (Boolean) If true, forcibly saves a version. (Optional)
|
BackgroundTask |
autoTag | () | method |
public function autoTag():void
Since : | CS5 |
Tag the object or the parent story using default tags defined in XML preference.
changeObject | () | method |
public function changeObject(reverseOrderParam:Boolean):Object
Since : | CS5 |
Finds objects that match the find what value and replace the objects with the change to value.
Parameters
reverseOrderParam:Boolean (default = NaN ) — (Boolean) If true, returns the results in reverse order. (Optional)
|
Object |
clearObjectStyleOverrides | () | method |
public function clearObjectStyleOverrides():void
Since : | CS5 |
Clear overrides for object style
clearTransformations | () | method |
public function clearTransformations():void
Since : | CS5 |
Clears transformations from the PageItem. Transformations include rotation, scaling, flipping, fitting, and shearing.
convertShape | () | method |
public function convertShape(givenParam:ConvertShapeOptions = null, numberOfSidesParam:Number, insetPercentageParam:Number, cornerRadiusParam:Object = null):void
Since : | CS5 |
Converts the PageItem to a different shape.
Parameters
givenParam:ConvertShapeOptions (default = null ) — (ConvertShapeOptions) The PageItem's new shape.
| |
numberOfSidesParam:Number (default = NaN ) — (Number) The number of sides for the resulting polygon. (Range: 3 to 100) (Optional)
| |
insetPercentageParam:Number (default = NaN ) — (Number) The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional)
| |
cornerRadiusParam:Object (default = null ) — (Object) The corner radius of the resulting rectangle. (Optional)
|
detach | () | method |
public function detach():void
Since : | CS5 |
Detaches an overridden master page item from the master page.
duplicate | () | method |
public function duplicate(toParam:Object = null, byParam:Array = null):PageItem
Since : | CS5 |
Duplicates the PageItem at the specified location or offset.
Parameters
toParam:Object (default = null ) — (Object) The location of the new PageItem, specified in coordinates in the format [x, y]. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional)
| |
byParam:Array (default = null ) — (Array) Amount by which to offset the new PageItem from the original PageItem's position. (Optional)
|
PageItem |
exportFile | () | method |
public function exportFile(formatParam:Object = null, toParam:File = null, showingOptionsParam:Boolean = false, usingParam:PDFExportPreset = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):void
Since : | CS5 |
Exports the object(s) to a file.
Parameters
formatParam:Object (default = null ) — (Object) The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String.
| |
toParam:File (default = null ) — (File) The path to the export file.
| |
showingOptionsParam:Boolean (default = false ) — (Boolean) If true, displays the export options dialog. (Optional)
| |
usingParam:PDFExportPreset (default = null ) — (PDFExportPreset) The export style. (Optional)
| |
versionCommentsParam:String (default = null ) — (String) The comment for this version. (Optional)
| |
forceSaveParam:Boolean (default = false ) — (Boolean) If true, forcibly saves a version. (Optional)
|
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 |
findObject | () | method |
public function findObject(reverseOrderParam:Boolean):Object
Since : | CS5 |
Finds objects that match the find what value.
Parameters
reverseOrderParam:Boolean (default = NaN ) — (Boolean) If true, returns the results in reverse order. (Optional)
|
Object |
fit | () | method |
public function fit(givenParam:FitOptions = null):void
Since : | CS5 |
Applies the specified fit option to content in a frame.
Parameters
givenParam:FitOptions (default = null ) — (FitOptions) The fit option to use.
|
flipItem | () | method |
public function flipItem(givenParam:Flip = null, aroundParam:Object = null):void
Since : | CS5 |
Flips the PageItem.
Parameters
givenParam:Flip (default = null ) — (Flip) The axis around which to flip the PageItem.
| |
aroundParam:Object (default = null ) — (Object) The point around which to flip the PageItem. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional)
|
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.
|
markup | () | method |
public function markup(usingParam:XMLElement = null):void
Since : | CS5 |
Associates the page item with the specified XML element while preserving existing content.
Parameters
usingParam:XMLElement (default = null ) — (XMLElement) The XML element.
|
move | () | method |
public function move(toParam:Object = null, byParam:Array = null):void
Since : | CS5 |
Moves the PageItem to a new location. Note: Either the 'to' or 'by' parameter is required; if both parameters are defined, only the to value is used.
Parameters
toParam:Object (default = null ) — (Object) The new location of the PageItem,in the format (x, y). Can accept: Array of 2 Units, Spread, Page or Layer. (Optional)
| |
byParam:Array (default = null ) — (Array) The amount (in measurement units) to move the PageItem relative to its current position, in the format (x, y). (Optional)
|
override | () | method |
public function override(destinationPageParam:Page = null):Object
Since : | CS5 |
Overrides a master page item and places the item on the document page as a new object.
Parameters
destinationPageParam:Page (default = null ) — (Page) The document page that contains the master page item to override.
|
Object |
place | () | method |
public function place(fileNameParam:File = null, showingOptionsParam:Boolean = false, withPropertiesParam:Object = null):Object
Since : | CS5 |
Places the file.
Parameters
fileNameParam:File (default = null ) — (File) The file to place
| |
showingOptionsParam:Boolean (default = false ) — (Boolean) Whether to display the import options dialog (Optional)
| |
withPropertiesParam:Object (default = null ) — (Object) Initial values for properties of the placed object(s) (Optional)
|
Object |
placeXML | () | method |
public function placeXML(usingParam:XMLElement = null):void
Since : | CS5 |
Places XML content into the specified object. Note: Replaces any existing content.
Parameters
usingParam:XMLElement (default = null ) — (XMLElement) The XML element whose content you want to place.
|
redefineScaling | () | method |
public function redefineScaling(toParam:Array = null):void
Since : | CS5 |
Apply an item's scaling to its content if possible.
Parameters
toParam:Array (default = null ) — (Array) The scale factors to be left on the item. The default is {1.0, 1.0}. (Optional)
|
reframe | () | method |
public function reframe(inParam:Object = null, opposingCornersParam:Array = null):void
Since : | CS5 |
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
Since : | CS5 |
Deletes the PageItem.
removeEventListenerPageItem | () | method |
public function removeEventListenerPageItem(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 |
removeOverride | () | method |
public function removeOverride():void
Since : | CS5 |
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
Since : | CS5 |
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
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 |
select | () | method |
public function select(existingSelectionParam:SelectionOptions = null):void
Since : | CS5 |
Selects the object.
Parameters
existingSelectionParam:SelectionOptions (default = null ) — (SelectionOptions) The selection status of the PageItem in relation to previously selected objects. (Optional)
|
store | () | method |
public function store(usingParam:Library = null, withPropertiesParam:Object = null):Asset
Since : | CS5 |
Stores the object in the specified library.
Parameters
usingParam:Library (default = null ) — (Library) The library in which to store the object.
| |
withPropertiesParam:Object (default = null ) — (Object) Initial values for properties of the new PageItem (Optional)
|
Asset |
toSpecifier | () | method |
public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |
transform | () | method |
public function transform(inParam:CoordinateSpaces = null, fromParam:Object = null, withMatrixParam:Object = null, replacingCurrentParam:Object = null, consideringRulerUnitsParam:Boolean = false):void
Since : | CS5 |
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)
|
transformAgain | () | method |
public function transformAgain():Object
Since : | CS5 |
Transforms the PageItem using the last transformation performed on any object. Transformations include moving, rotating, shearing, scaling, and flipping.
ReturnsObject |
transformAgainIndividually | () | method |
public function transformAgainIndividually():Object
Since : | CS5 |
Transforms the PageItem using the last transformation performed on any PageItem. Transformations include moving, rotating, shearing, scaling, and flipping.
ReturnsObject |
transformSequenceAgain | () | method |
public function transformSequenceAgain():Object
Since : | CS5 |
Transforms the PageItem using the last sequence of transform operations performed on any single object or performed at the same time on any group of objects. Transformations include moving, rotating, shearing, scaling, and flipping.
ReturnsObject |
transformSequenceAgainIndividually | () | method |
public function transformSequenceAgainIndividually():Object
Since : | CS5 |
Transforms the PageItem using the last sequence of transformations performed on any single object or performed at the same time on any group of objects. Transformations include moving, rotating, shearing, scaling, and flipping.
ReturnsObject |
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 |