Packagecom.adobe.incopy
Classpublic class PageItem
InheritancePageItem Inheritance CSHostObject Inheritance flash.utils.Proxy
Subclasses EPSText, FormField, Graphic, Group, MediaItem, SplineItem, TextFrame

Since : CS5



Public Properties
 PropertyDefined 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
[read-only] The horizontal scale of the PageItem relative to its containing object.
PageItem
  absoluteRotationAngle : Number
[read-only] The rotation angle of the PageItem relative to its containing object.
PageItem
  absoluteShearAngle : Number
[read-only] The skewing angle of the PageItem relative to its containing object.
PageItem
  absoluteVerticalScale : Number
[read-only] 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
  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
  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
[read-only] The shape to apply to the bottom left corner of rectangular shapes.
PageItem
  bottomLeftCornerRadius : Object
[read-only] The radius in measurement units of the corner effect applied to the bottom left corner of rectangular shapes
PageItem
  bottomRightCornerOption : CornerOptions
[read-only] The shape to apply to the bottom right corner of rectangular shapes.
PageItem
  bottomRightCornerRadius : Object
[read-only] The radius in measurement units of the corner effect applied to the bottom right corner of rectangular shapes
PageItem
  endCap : EndCap
[read-only] The end shape of an open path.
PageItem
  endJoin : EndJoin
[read-only] 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
[read-only] The swatch (color, gradient, tint, or mixed ink) applied to the fill of the PageItem.
PageItem
  fillTint : Number
[read-only] The percent of tint to use in the PageItem's fill color.
PageItem
  flip : Flip
The direction in which to flip the printed image.
PageItem
  gapColor : Swatch
[read-only] The swatch (color, gradient, tint, or mixed ink) applied to the gap of a dashed, dotted, or striped stroke.
PageItem
  gapTint : Number
[read-only] The tint as a percentage of the gap color.
PageItem
  geometricBounds : Object
[read-only] 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
[read-only] The angle of a linear gradient applied to the fill of the PageItem.
PageItem
  gradientFillLength : Object
[read-only] The length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the PageItem.
PageItem
  gradientFillStart : Object
[read-only] The starting point (in page coordinates) of a gradient applied to the fill of the PageItem, in the format [x, y].
PageItem
  gradientStrokeAngle : Number
[read-only] The angle of a linear gradient applied to the stroke of the PageItem.
PageItem
  gradientStrokeLength : Object
[read-only] The length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the PageItem.
PageItem
  gradientStrokeStart : Object
[read-only] The starting point (in page coordinates) of a gradient applied to the stroke of the PageItem, in the format [x, y].
PageItem
  horizontalScale : Number
[read-only] The horizontal scaling applied to the PageItem.
PageItem
 InheritedhostObjectDelegate : 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
[read-only] The layer that the PageItem is on.
PageItem
  label : String
A property that can be set to any string.
PageItem
  leftLineEnd : ArrowHead
[read-only] The arrowhead applied to the start of the path.
PageItem
  localDisplaySetting : DisplaySettingOptions
[read-only] Display performance options for the PageItem.
PageItem
  locked : Boolean
[read-only] If true, the PageItem is locked.
PageItem
  miterLimit : Number
[read-only] 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
[read-only] If true, the PageItem does not print.
PageItem
  overprintFill : Boolean
[read-only] If true, the PageItem's fill color overprints any underlying objects.
PageItem
  overprintGap : Boolean
[read-only] If true, the gap color overprints any underlying colors.
PageItem
  overprintStroke : Boolean
[read-only] 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, Page, Sound, PlaceGun or Movie).
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
[read-only] The arrowhead applied to the end of the path.
PageItem
  rotationAngle : Number
[read-only] The rotatation angle of the PageItem.
PageItem
  shearAngle : Number
[read-only] The skewing angle applied to the PageItem.
PageItem
  strokeAlignment : StrokeAlignment
[read-only] The stroke alignment applied to the PageItem.
PageItem
  strokeColor : Swatch
[read-only] The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the PageItem.
PageItem
  strokeCornerAdjustment : StrokeCornerAdjustment
[read-only] The corner adjustment applied to the PageItem.
PageItem
  strokeDashAndGap : Object
[read-only] The dash and gap measurements that define the pattern of a custom dashed line.
PageItem
  strokeTint : Number
[read-only] The percent of tint to use in object's stroke color.
PageItem
  strokeType : StrokeStyle
[read-only] The name of the stroke style to apply.
PageItem
  strokeWeight : Object
[read-only] 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
  topLeftCornerOption : CornerOptions
[read-only] 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
[read-only] 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
[read-only] The shape to apply to the top right corner of rectangular shapes
PageItem
  topRightCornerRadius : Object
[read-only] The radius in measurement units of the corner effect applied to the top right corner of rectangular shapes
PageItem
  verticalScale : Number
[read-only] The vertical scaling applied to the PageItem.
PageItem
  visible : Boolean
If true, the PageItem is visible.
PageItem
  visibleBounds : Object
[read-only] 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
Public Methods
 MethodDefined By
  
addEventListenerPageItem(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
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
  
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
  
extractLabel(keyParam:String = null):String
Gets the label value associated with the specified key.
PageItem
 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
  
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
 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.
PageItem
 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.
PageItem
 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
  
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
  
removeEventListenerPageItem(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
PageItem
 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.
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
  
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
  
transformValuesOf(inParam:CoordinateSpaces = null):Object
Get the transformation values of the page item.
PageItem
 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
absoluteFlipproperty
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.


Implementation
    public function get absoluteFlip():Flip
    public function set absoluteFlip(value:Flip):void
absoluteHorizontalScaleproperty 
absoluteHorizontalScale:Number  [read-only]

Since : CS5

The horizontal scale of the PageItem relative to its containing object.


Implementation
    public function get absoluteHorizontalScale():Number
absoluteRotationAngleproperty 
absoluteRotationAngle:Number  [read-only]

Since : CS5

The rotation angle of the PageItem relative to its containing object. (Range: -360 to 360)


Implementation
    public function get absoluteRotationAngle():Number
absoluteShearAngleproperty 
absoluteShearAngle:Number  [read-only]

Since : CS5

The skewing angle of the PageItem relative to its containing object. (Range: -360 to 360)


Implementation
    public function get absoluteShearAngle():Number
absoluteVerticalScaleproperty 
absoluteVerticalScale:Number  [read-only]

Since : CS5

The vertical scale of the PageItem relative to its containing object.


Implementation
    public function get absoluteVerticalScale():Number
AFTER_PLACEproperty 
AFTER_PLACE:String  [read-only]

Since : CS5

Dispatched after a PageItem is placed. This event bubbles. This event is not cancelable.


Implementation
    public static function get AFTER_PLACE():String
allGraphicsproperty 
allGraphics:Object  [read-only]

Since : CS5

Lists all graphics contained by the PageItem.


Implementation
    public function get allGraphics():Object
allowOverridesproperty 
allowOverrides:Boolean

Since : CS5

If true, the master page item can be overridden.


Implementation
    public function get allowOverrides():Boolean
    public function set allowOverrides(value:Boolean):void
allPageItemsproperty 
allPageItems:Object  [read-only]

Since : CS5

Lists all page items contained by the PageItem.


Implementation
    public function get allPageItems():Object
associatedXMLElementproperty 
associatedXMLElement:XMLItem  [read-only]

Since : CS5

The XML element associated with the PageItem.


Implementation
    public function get associatedXMLElement():XMLItem
BEFORE_PLACEproperty 
BEFORE_PLACE:String  [read-only]

Since : CS5

Dispatched before a PageItem is placed. This event bubbles. This event is cancelable.


Implementation
    public static function get BEFORE_PLACE():String
bottomLeftCornerOptionproperty 
bottomLeftCornerOption:CornerOptions  [read-only]

Since : CS5

The shape to apply to the bottom left corner of rectangular shapes.


Implementation
    public function get bottomLeftCornerOption():CornerOptions
bottomLeftCornerRadiusproperty 
bottomLeftCornerRadius:Object  [read-only]

Since : CS5

The radius in measurement units of the corner effect applied to the bottom left corner of rectangular shapes


Implementation
    public function get bottomLeftCornerRadius():Object
bottomRightCornerOptionproperty 
bottomRightCornerOption:CornerOptions  [read-only]

Since : CS5

The shape to apply to the bottom right corner of rectangular shapes.


Implementation
    public function get bottomRightCornerOption():CornerOptions
bottomRightCornerRadiusproperty 
bottomRightCornerRadius:Object  [read-only]

Since : CS5

The radius in measurement units of the corner effect applied to the bottom right corner of rectangular shapes


Implementation
    public function get bottomRightCornerRadius():Object
endCapproperty 
endCap:EndCap  [read-only]

Since : CS5

The end shape of an open path.


Implementation
    public function get endCap():EndCap
endJoinproperty 
endJoin:EndJoin  [read-only]

Since : CS5

The corner join applied to the PageItem.


Implementation
    public function get endJoin():EndJoin
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
fillColorproperty 
fillColor:Swatch  [read-only]

Since : CS5

The swatch (color, gradient, tint, or mixed ink) applied to the fill of the PageItem. . Can also accept: String.


Implementation
    public function get fillColor():Swatch
fillTintproperty 
fillTint:Number  [read-only]

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.)


Implementation
    public function get fillTint():Number
flipproperty 
flip:Flip

Since : CS5

The direction in which to flip the printed image.


Implementation
    public function get flip():Flip
    public function set flip(value:Flip):void
gapColorproperty 
gapColor:Swatch  [read-only]

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.


Implementation
    public function get gapColor():Swatch
gapTintproperty 
gapTint:Number  [read-only]

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.)


Implementation
    public function get gapTint():Number
geometricBoundsproperty 
geometricBounds:Object  [read-only]

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.


Implementation
    public function get geometricBounds():Object
gradientFillAngleproperty 
gradientFillAngle:Number  [read-only]

Since : CS5

The angle of a linear gradient applied to the fill of the PageItem. (Range: -180 to 180)


Implementation
    public function get gradientFillAngle():Number
gradientFillLengthproperty 
gradientFillLength:Object  [read-only]

Since : CS5

The length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the PageItem.


Implementation
    public function get gradientFillLength():Object
gradientFillStartproperty 
gradientFillStart:Object  [read-only]

Since : CS5

The starting point (in page coordinates) of a gradient applied to the fill of the PageItem, in the format [x, y].


Implementation
    public function get gradientFillStart():Object
gradientStrokeAngleproperty 
gradientStrokeAngle:Number  [read-only]

Since : CS5

The angle of a linear gradient applied to the stroke of the PageItem. (Range: -180 to 180)


Implementation
    public function get gradientStrokeAngle():Number
gradientStrokeLengthproperty 
gradientStrokeLength:Object  [read-only]

Since : CS5

The length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the PageItem.


Implementation
    public function get gradientStrokeLength():Object
gradientStrokeStartproperty 
gradientStrokeStart:Object  [read-only]

Since : CS5

The starting point (in page coordinates) of a gradient applied to the stroke of the PageItem, in the format [x, y].


Implementation
    public function get gradientStrokeStart():Object
horizontalScaleproperty 
horizontalScale:Number  [read-only]

Since : CS5

The horizontal scaling applied to the PageItem.


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

Since : CS5

The unique ID of the PageItem.


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

Since : CS5

The index of the PageItem 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
itemLayerproperty 
itemLayer:Layer  [read-only]

Since : CS5

The layer that the PageItem is on.


Implementation
    public function get itemLayer():Layer
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
leftLineEndproperty 
leftLineEnd:ArrowHead  [read-only]

Since : CS5

The arrowhead applied to the start of the path.


Implementation
    public function get leftLineEnd():ArrowHead
localDisplaySettingproperty 
localDisplaySetting:DisplaySettingOptions  [read-only]

Since : CS5

Display performance options for the PageItem.


Implementation
    public function get localDisplaySetting():DisplaySettingOptions
lockedproperty 
locked:Boolean  [read-only]

Since : CS5

If true, the PageItem is locked.


Implementation
    public function get locked():Boolean
miterLimitproperty 
miterLimit:Number  [read-only]

Since : CS5

The limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join.


Implementation
    public function get miterLimit():Number
nameproperty 
name:String

Since : CS5

The name of the PageItem.


Implementation
    public function get name():String
    public function set name(value:String):void
nonprintingproperty 
nonprinting:Boolean  [read-only]

Since : CS5

If true, the PageItem does not print.


Implementation
    public function get nonprinting():Boolean
overprintFillproperty 
overprintFill:Boolean  [read-only]

Since : CS5

If true, the PageItem's fill color overprints any underlying objects. If false, the fill color knocks out the underlying colors.


Implementation
    public function get overprintFill():Boolean
overprintGapproperty 
overprintGap:Boolean  [read-only]

Since : CS5

If true, the gap color overprints any underlying colors. If false, the gap color knocks out the underlying colors.


Implementation
    public function get overprintGap():Boolean
overprintStrokeproperty 
overprintStroke:Boolean  [read-only]

Since : CS5

If true, the PageItem's stroke color overprints any underlying objects. If false, the stroke color knocks out the underlying colors.


Implementation
    public function get overprintStroke():Boolean
overriddenproperty 
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.


Implementation
    public function get overridden():Boolean
overriddenMasterPageItemproperty 
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.


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

Since : CS5

The parent of the PageItem (a XMLElement, Spread, MasterSpread, Polygon, GraphicLine, Rectangle, Oval, SplineItem, Group, State, Character, Page, Sound, PlaceGun or Movie).


Implementation
    public function get parent():Object
parentPageproperty 
parentPage:Page  [read-only]

Since : CS5

The page on which this page item appears.


Implementation
    public function get parentPage():Page
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
rightLineEndproperty 
rightLineEnd:ArrowHead  [read-only]

Since : CS5

The arrowhead applied to the end of the path.


Implementation
    public function get rightLineEnd():ArrowHead
rotationAngleproperty 
rotationAngle:Number  [read-only]

Since : CS5

The rotatation angle of the PageItem. (Range: -360 to 360)


Implementation
    public function get rotationAngle():Number
shearAngleproperty 
shearAngle:Number  [read-only]

Since : CS5

The skewing angle applied to the PageItem. (Range: -360 to 360)


Implementation
    public function get shearAngle():Number
strokeAlignmentproperty 
strokeAlignment:StrokeAlignment  [read-only]

Since : CS5

The stroke alignment applied to the PageItem.


Implementation
    public function get strokeAlignment():StrokeAlignment
strokeColorproperty 
strokeColor:Swatch  [read-only]

Since : CS5

The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the PageItem. Can also accept: String.


Implementation
    public function get strokeColor():Swatch
strokeCornerAdjustmentproperty 
strokeCornerAdjustment:StrokeCornerAdjustment  [read-only]

Since : CS5

The corner adjustment applied to the PageItem.


Implementation
    public function get strokeCornerAdjustment():StrokeCornerAdjustment
strokeDashAndGapproperty 
strokeDashAndGap:Object  [read-only]

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].


Implementation
    public function get strokeDashAndGap():Object
strokeTintproperty 
strokeTint:Number  [read-only]

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.)


Implementation
    public function get strokeTint():Number
strokeTypeproperty 
strokeType:StrokeStyle  [read-only]

Since : CS5

The name of the stroke style to apply. Can also accept: String.


Implementation
    public function get strokeType():StrokeStyle
strokeWeightproperty 
strokeWeight:Object  [read-only]

Since : CS5

The weight (in points) to apply to the PageItem's stroke.


Implementation
    public function get strokeWeight():Object
textWrapPreferencesproperty 
textWrapPreferences:TextWrapPreference  [read-only]

Since : CS5

The text wrap preference properties that define the default formatting for wrapping text around objects.


Implementation
    public function get textWrapPreferences():TextWrapPreference
topLeftCornerOptionproperty 
topLeftCornerOption:CornerOptions  [read-only]

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.


Implementation
    public function get topLeftCornerOption():CornerOptions
topLeftCornerRadiusproperty 
topLeftCornerRadius:Object  [read-only]

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


Implementation
    public function get topLeftCornerRadius():Object
topRightCornerOptionproperty 
topRightCornerOption:CornerOptions  [read-only]

Since : CS5

The shape to apply to the top right corner of rectangular shapes


Implementation
    public function get topRightCornerOption():CornerOptions
topRightCornerRadiusproperty 
topRightCornerRadius:Object  [read-only]

Since : CS5

The radius in measurement units of the corner effect applied to the top right corner of rectangular shapes


Implementation
    public function get topRightCornerRadius():Object
verticalScaleproperty 
verticalScale:Number  [read-only]

Since : CS5

The vertical scaling applied to the PageItem.


Implementation
    public function get verticalScale():Number
visibleproperty 
visible:Boolean

Since : CS5

If true, the PageItem is visible.


Implementation
    public function get visible():Boolean
    public function set visible(value:Boolean):void
visibleBoundsproperty 
visibleBounds:Object  [read-only]

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.


Implementation
    public function get visibleBounds():Object
Method Detail
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)

Returns
EventListener
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)

Returns
Object
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)

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
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)

Returns
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.

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.

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)

Returns
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

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)

Returns
Boolean
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)

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

Since : CS5

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

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)

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