Package | com.adobe.illustrator |
Class | public class PageItem |
Inheritance | PageItem ![]() ![]() ![]() |
Subclasses | CompoundPathItem, GraphItem, GroupItem, LegacyTextItem, MeshItem, NonNativeItem, PathItem, PlacedItem, PluginItem, RasterItem, SymbolItem, TextFrame |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
artworkKnockout : KnockoutState
Is the artwork used to create a knockout. | PageItem | ||
blendingMode : BlendModes
The mode used when compositing an object. | PageItem | ||
controlBounds : Array [read-only]
The bounds of the artwork including stroke width and controls. | PageItem | ||
editable : Boolean [read-only]
Can the art item be modified. | PageItem | ||
geometricBounds : Array [read-only]
The bounds of the artwork excluding stroke width. | PageItem | ||
height : Number
The height of the art item. | PageItem | ||
hidden : Boolean
Is this artwork item hidden?
| PageItem | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
isIsolated : Boolean
Is the artwork isolated. | PageItem | ||
layer : Layer [read-only]
The layer to which this artwork belongs. | PageItem | ||
left : Number
The left position of the art item. | PageItem | ||
locked : Boolean
Is this artwork item locked?
| PageItem | ||
name : String
The item's name. | PageItem | ||
note : String
The note assigned to this artwork item. | PageItem | ||
opacity : Number
The object's opacity (between 0.0 and 100.0) ( 0.0 - 100.0 )
| PageItem | ||
![]() | parent : * [read-only] | IllustratorHostObject | |
pixelAligned : Boolean
is this artwork item aligned to Pixel Grid?
| PageItem | ||
position : Array
The position of the top left corner of the art item. | PageItem | ||
selected : Boolean
Is this artwork item selected?
| PageItem | ||
sliced : Boolean
Is the art item sliced (default: false)
| PageItem | ||
tags : Tags [read-only]
The collection of tags associated with this page item. | PageItem | ||
top : Number
The top position of the art item. | PageItem | ||
uRL : String
The value of the Adobe URL tag assigned to this artwork item. | PageItem | ||
visibilityVariable : Object
The visibility variable bound to this page item. | PageItem | ||
visibleBounds : Array [read-only]
The visible bounds of the artwork including stroke width. | PageItem | ||
width : Number
The width of the art item. | PageItem | ||
wrapInside : Boolean
Should the text frame object be wrapped inside this object?
| PageItem | ||
wrapOffset : Number
Use this offset when wrapping text around this object. | PageItem | ||
wrapped : Boolean
Wrap text frame objects around this object (text frame must be above the object)
| PageItem | ||
zOrderPosition : Number [read-only]
The drawing order of the art within it's group or layer. | PageItem |
Method | Defined By | ||
---|---|---|---|
bringInPerspective(positionX:Number, positionY:Number, perspectiveGridPlane:PerspectiveGridPlaneType = null):void
Place art object(s)in perspective grid at spedified perspective plane and coordinate
| PageItem | ||
create a duplicate of the object
| 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 | |
![]() | 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 | |
![]() | 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 | |
![]() | isDescendedFrom(clz:Class, ancClass:Class):Boolean [static] Efficiently determines whether or not one class descends from
another in inheritance hierarchy- class relationships are cached
by the ClassUtils implementation-
(uses org.as3commons lib to quickly discover class hierarchy. | CSHostObject | |
move(relativeObject:Object, insertionLocation:ElementPlacement):void
move the object
| PageItem | ||
remove():void
delete the object
| PageItem | ||
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
resize(scaleX:Number, scaleY:Number, changePositions:Boolean = true, changeFillPatterns:Boolean = true, changeFillGradients:Boolean = true, changeStrokePattern:Boolean = true, changeLineWidths:Number = 100.0, scaleAbout:Transformation = null):void
Scale art object(s)
| PageItem | ||
rotate(angle:Number, changePositions:Boolean = true, changeFillPatterns:Boolean = true, changeFillGradients:Boolean = true, changeStrokePattern:Boolean = true, rotateAbout:Transformation = null):void
Rotate art object(s)
| PageItem | ||
transform(transformationMatrix:Matrix, changePositions:Boolean = true, changeFillPatterns:Boolean = true, changeFillGradients:Boolean = true, changeStrokePattern:Boolean = true, changeLineWidths:Number = 100.0, transformAbout:Transformation = null):void
Transform art object(s) using a transformation matrix. | PageItem | ||
translate(deltaX:Number = 0.0, deltaY:Number = 0.0, transformObjects:Boolean = true, transformFillPatterns:Boolean = true, transformFillGradients:Boolean = true, transformStrokePattern:Boolean = true):void
Reposition art object(s)
| PageItem | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject | |
zOrder(zOrderCmd:ZOrderMethod):void
Arranges the art relative to other art in the group or layer. | PageItem |
artworkKnockout | property |
artworkKnockout:KnockoutState
Since : | CS5 |
Is the artwork used to create a knockout.
public function get artworkKnockout():KnockoutState
public function set artworkKnockout(value:KnockoutState):void
blendingMode | property |
blendingMode:BlendModes
Since : | CS5 |
The mode used when compositing an object.
public function get blendingMode():BlendModes
public function set blendingMode(value:BlendModes):void
controlBounds | property |
controlBounds:Array
[read-only] Since : | CS5 |
The bounds of the artwork including stroke width and controls.
public function get controlBounds():Array
editable | property |
editable:Boolean
[read-only] Since : | CS5 |
Can the art item be modified.
public function get editable():Boolean
geometricBounds | property |
geometricBounds:Array
[read-only] Since : | CS5 |
The bounds of the artwork excluding stroke width.
public function get geometricBounds():Array
height | property |
height:Number
Since : | CS5 |
The height of the art item. ( 0.0 - 16348.0 )
public function get height():Number
public function set height(value:Number):void
hidden | property |
hidden:Boolean
Since : | CS5 |
Is this artwork item hidden?
public function get hidden():Boolean
public function set hidden(value:Boolean):void
isIsolated | property |
isIsolated:Boolean
Since : | CS5 |
Is the artwork isolated.
public function get isIsolated():Boolean
public function set isIsolated(value:Boolean):void
layer | property |
layer:Layer
[read-only] Since : | CS5 |
The layer to which this artwork belongs.
public function get layer():Layer
left | property |
left:Number
Since : | CS5 |
The left position of the art item.
public function get left():Number
public function set left(value:Number):void
locked | property |
locked:Boolean
Since : | CS5 |
Is this artwork item locked?
public function get locked():Boolean
public function set locked(value:Boolean):void
name | property |
name:String
Since : | CS5 |
The item's name.
public function get name():String
public function set name(value:String):void
note | property |
note:String
Since : | CS5 |
The note assigned to this artwork item.
public function get note():String
public function set note(value:String):void
opacity | property |
opacity:Number
Since : | CS5 |
The object's opacity (between 0.0 and 100.0) ( 0.0 - 100.0 )
public function get opacity():Number
public function set opacity(value:Number):void
pixelAligned | property |
pixelAligned:Boolean
Since : | CS5.5 |
is this artwork item aligned to Pixel Grid?
public function get pixelAligned():Boolean
public function set pixelAligned(value:Boolean):void
position | property |
position:Array
Since : | CS5 |
The position of the top left corner of the art item.
public function get position():Array
public function set position(value:Array):void
selected | property |
selected:Boolean
Since : | CS5 |
Is this artwork item selected?
public function get selected():Boolean
public function set selected(value:Boolean):void
sliced | property |
sliced:Boolean
Since : | CS5 |
Is the art item sliced (default: false)
public function get sliced():Boolean
public function set sliced(value:Boolean):void
tags | property |
tags:Tags
[read-only] Since : | CS5 |
The collection of tags associated with this page item.
public function get tags():Tags
top | property |
top:Number
Since : | CS5 |
The top position of the art item.
public function get top():Number
public function set top(value:Number):void
uRL | property |
uRL:String
Since : | CS5 |
The value of the Adobe URL tag assigned to this artwork item.
public function get uRL():String
public function set uRL(value:String):void
visibilityVariable | property |
visibilityVariable:Object
Since : | CS5 |
The visibility variable bound to this page item.
public function get visibilityVariable():Object
public function set visibilityVariable(value:Object):void
visibleBounds | property |
visibleBounds:Array
[read-only] Since : | CS5 |
The visible bounds of the artwork including stroke width.
public function get visibleBounds():Array
width | property |
width:Number
Since : | CS5 |
The width of the art item. ( 0.0 - 16348.0 )
public function get width():Number
public function set width(value:Number):void
wrapInside | property |
wrapInside:Boolean
Since : | CS5 |
Should the text frame object be wrapped inside this object?
public function get wrapInside():Boolean
public function set wrapInside(value:Boolean):void
wrapOffset | property |
wrapOffset:Number
Since : | CS5 |
Use this offset when wrapping text around this object.
public function get wrapOffset():Number
public function set wrapOffset(value:Number):void
wrapped | property |
wrapped:Boolean
Since : | CS5 |
Wrap text frame objects around this object (text frame must be above the object)
public function get wrapped():Boolean
public function set wrapped(value:Boolean):void
zOrderPosition | property |
zOrderPosition:Number
[read-only] Since : | CS5 |
The drawing order of the art within it's group or layer.
public function get zOrderPosition():Number
bringInPerspective | () | method |
public function bringInPerspective(positionX:Number, positionY:Number, perspectiveGridPlane:PerspectiveGridPlaneType = null):void
Since : | CS5 |
Place art object(s)in perspective grid at spedified perspective plane and coordinate
Parameters
positionX:Number — (Number) position towards X direction of specified or active perspective grid plane
| |
positionY:Number — (Number) position towards Y direction of specified or active perspective grid plane
| |
perspectiveGridPlane:PerspectiveGridPlaneType (default = null ) — (com.adobe.illustrator.PerspectiveGridPlaneType) Type of perspective grid plane. ( default: PerspectiveGridPlaneType.NOPLANE )
|
duplicate | () | method |
public function duplicate(relativeObject:Object = null, insertionLocation:ElementPlacement = null):PageItem
Since : | CS5 |
create a duplicate of the object
Parameters
relativeObject:Object (default = null ) — (Object)
| |
insertionLocation:ElementPlacement (default = null ) — (com.adobe.illustrator.ElementPlacement) ( default: ElementPlacement.INSIDE )
|
PageItem |
move | () | method |
public function move(relativeObject:Object, insertionLocation:ElementPlacement):void
Since : | CS5 |
move the object
Parameters
relativeObject:Object — (Object)
| |
insertionLocation:ElementPlacement — (com.adobe.illustrator.ElementPlacement)
|
remove | () | method |
public function remove():void
Since : | CS5 |
delete the object
resize | () | method |
public function resize(scaleX:Number, scaleY:Number, changePositions:Boolean = true, changeFillPatterns:Boolean = true, changeFillGradients:Boolean = true, changeStrokePattern:Boolean = true, changeLineWidths:Number = 100.0, scaleAbout:Transformation = null):void
Since : | CS5 |
Scale art object(s)
Parameters
scaleX:Number — (Number) Horizontal scaling factor expressed as a percentage (100 = 100%)
| |
scaleY:Number — (Number) Vertical scaling factor expressed as a percentage (100 = 100%)
| |
changePositions:Boolean (default = true ) — (Boolean) Are art object positions and orientations effected? ( default: true )
| |
changeFillPatterns:Boolean (default = true ) — (Boolean) Are the fill patterns assigned to paths to be transformed? ( default: true )
| |
changeFillGradients:Boolean (default = true ) — (Boolean) Are the fill gradients assigned to paths to be transformed? ( default: true )
| |
changeStrokePattern:Boolean (default = true ) — (Boolean) Are the stroke patterns assigned to paths to be transformed? ( default: true )
| |
changeLineWidths:Number (default = 100.0 ) — (Number) The amount line widths are to be scaled (expressed as a percentage) ( default: 100.0 )
| |
scaleAbout:Transformation (default = null ) — (com.adobe.illustrator.Transformation) The point on the art item's bounding box to which the scale is applied. ( default: Transformation.CENTER )
|
rotate | () | method |
public function rotate(angle:Number, changePositions:Boolean = true, changeFillPatterns:Boolean = true, changeFillGradients:Boolean = true, changeStrokePattern:Boolean = true, rotateAbout:Transformation = null):void
Since : | CS5 |
Rotate art object(s)
Parameters
angle:Number — (Number) Angle of rotation (in degrees). Rotation is performed counter-clock wise.
| |
changePositions:Boolean (default = true ) — (Boolean) Are art object positions and orientations effected? ( default: true )
| |
changeFillPatterns:Boolean (default = true ) — (Boolean) Are the fill patterns assigned to paths to be transformed? ( default: true )
| |
changeFillGradients:Boolean (default = true ) — (Boolean) Are the fill gradients assigned to paths to be transformed? ( default: true )
| |
changeStrokePattern:Boolean (default = true ) — (Boolean) Are the stroke patterns assigned to paths to be transformed? ( default: true )
| |
rotateAbout:Transformation (default = null ) — (com.adobe.illustrator.Transformation) The point on the art item's bounding box to which the rotation is applied. ( default: Transformation.CENTER )
|
transform | () | method |
public function transform(transformationMatrix:Matrix, changePositions:Boolean = true, changeFillPatterns:Boolean = true, changeFillGradients:Boolean = true, changeStrokePattern:Boolean = true, changeLineWidths:Number = 100.0, transformAbout:Transformation = null):void
Since : | CS5 |
Transform art object(s) using a transformation matrix.
Parameters
transformationMatrix:Matrix — (com.adobe.illustrator.Matrix) The transformation matrix to be applied to the objects.
| |
changePositions:Boolean (default = true ) — (Boolean) Are art object positions and orientations effected? ( default: true )
| |
changeFillPatterns:Boolean (default = true ) — (Boolean) Are the fill patterns assigned to paths to be transformed? ( default: true )
| |
changeFillGradients:Boolean (default = true ) — (Boolean) Are the fill gradients assigned to paths to be transformed? ( default: true )
| |
changeStrokePattern:Boolean (default = true ) — (Boolean) Are the stroke patterns assigned to paths to be transformed? ( default: true )
| |
changeLineWidths:Number (default = 100.0 ) — (Number) The amount line widths are to be scaled (expressed as a percentage) ( default: 100.0 )
| |
transformAbout:Transformation (default = null ) — (com.adobe.illustrator.Transformation) The point on the art item's bounding box to which scale and rotation operations apply. ( default: Transformation.CENTER )
|
translate | () | method |
public function translate(deltaX:Number = 0.0, deltaY:Number = 0.0, transformObjects:Boolean = true, transformFillPatterns:Boolean = true, transformFillGradients:Boolean = true, transformStrokePattern:Boolean = true):void
Since : | CS5 |
Reposition art object(s)
Parameters
deltaX:Number (default = 0.0 ) — (Number) Horizontal transformation. ( default: 0.0 )
| |
deltaY:Number (default = 0.0 ) — (Number) Vertical transformation. ( default: 0.0 )
| |
transformObjects:Boolean (default = true ) — (Boolean) Are art object positions and orientations affected? ( default: true )
| |
transformFillPatterns:Boolean (default = true ) — (Boolean) Are the fill patterns assigned to paths to be transformed? ( default: true )
| |
transformFillGradients:Boolean (default = true ) — (Boolean) Are the fill gradients assigned to paths to be transformed? ( default: true )
| |
transformStrokePattern:Boolean (default = true ) — (Boolean) Are the stroke patterns assigned to paths to be transformed? ( default: true )
|
zOrder | () | method |
public function zOrder(zOrderCmd:ZOrderMethod):void
Since : | CS5 |
Arranges the art relative to other art in the group or layer.
Parameters
zOrderCmd:ZOrderMethod — (com.adobe.illustrator.ZOrderMethod) How to arrange the art.
|