Package | com.adobe.indesign |
Class | public class Oval |
Inheritance | Oval ![]() ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
absoluteFlip : Flip [override]
Indicates whether the Oval has been flipped independently of its parent object and, if yes, the direction in which the Oval was flipped. | Oval | ||
absoluteHorizontalScale : Number [override]
The horizontal scale of the Oval relative to its containing object. | Oval | ||
absoluteRotationAngle : Number [override]
The rotation angle of the Oval relative to its containing object. | Oval | ||
absoluteShearAngle : Number [override]
The skewing angle of the Oval relative to its containing object. | Oval | ||
absoluteVerticalScale : Number [override]
The vertical scale of the Oval relative to its containing object. | Oval | ||
AFTER_PLACE : String [static] [read-only]
Dispatched after a Oval is placed. | Oval | ||
allArticles : Object [override] [read-only]
The list of all articles this page item is part of
| Oval | ||
allGraphics : Object [override] [read-only]
Lists all graphics contained by the Oval. | Oval | ||
allowOverrides : Boolean [override]
If true, the master page item can be overridden. | Oval | ||
allPageItems : Object [override] [read-only]
Lists all page items contained by the Oval. | Oval | ||
anchoredObjectSettings : AnchoredObjectSetting [override] [read-only]
Anchored object settings. | Oval | ||
animationSettings : AnimationSetting [override] [read-only]
The page item animation settings. | Oval | ||
appliedObjectStyle : ObjectStyle [override]
The object style applied to the Oval. | Oval | ||
associatedXMLElement : XMLItem [override] [read-only]
The XML element associated with the Oval. | Oval | ||
BEFORE_PLACE : String [static] [read-only]
Dispatched before a Oval is placed. | Oval | ||
bottomLeftCornerOption : CornerOptions [override]
The shape to apply to the bottom left corner of rectangular shapes. | Oval | ||
bottomLeftCornerRadius : Object [override]
The radius in measurement units of the corner effect applied to the bottom left corner of rectangular shapes
| Oval | ||
bottomRightCornerOption : CornerOptions [override]
The shape to apply to the bottom right corner of rectangular shapes. | Oval | ||
bottomRightCornerRadius : Object [override]
The radius in measurement units of the corner effect applied to the bottom right corner of rectangular shapes
| Oval | ||
buttons : Buttons [override] [read-only]
A collection of buttons. | Oval | ||
contentTransparencySettings : ContentTransparencySetting [override] [read-only]
Transparency settings for the content of the Oval. | Oval | ||
contentType : ContentType [override]
The type of content that a frame can contain. | Oval | ||
endCap : EndCap [override]
The end shape of an open path. | Oval | ||
endJoin : EndJoin [override]
The corner join applied to the Oval. | Oval | ||
epss : EPSs [override] [read-only]
A collection of EPS files. | Oval | ||
epstexts : EPSTexts [override] [read-only]
EPSTexts
| Oval | ||
eventListeners : EventListeners [override] [read-only]
A collection of event listeners. | Oval | ||
events : Events [override] [read-only]
A collection of events. | Oval | ||
fillColor : Swatch [override]
The swatch (color, gradient, tint, or mixed ink) applied to the fill of the Oval. | Oval | ||
fillTint : Number [override]
The percent of tint to use in the Oval's fill color. | Oval | ||
fillTransparencySettings : FillTransparencySetting [override] [read-only]
Transparency settings for the fill applied to the Oval. | Oval | ||
flip : Flip [override]
The direction in which to flip the printed image. | Oval | ||
formFields : FormFields [override] [read-only]
A collection of form fields. | Oval | ||
frameFittingOptions : FrameFittingOption [read-only]
The frame fitting option to apply to placed or pasted content. | Oval | ||
gapColor : Swatch [override]
The swatch (color, gradient, tint, or mixed ink) applied to the gap of a dashed, dotted, or striped stroke. | Oval | ||
gapTint : Number [override]
The tint as a percentage of the gap color. | Oval | ||
geometricBounds : Object [override]
The bounds of the Oval 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. | Oval | ||
gradientFillAngle : Number [override]
The angle of a linear gradient applied to the fill of the Oval. | Oval | ||
gradientFillLength : Object [override]
The length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the Oval. | Oval | ||
gradientFillStart : Object [override]
The starting point (in page coordinates) of a gradient applied to the fill of the Oval, in the format [x, y]. | Oval | ||
gradientStrokeAngle : Number [override]
The angle of a linear gradient applied to the stroke of the Oval. | Oval | ||
gradientStrokeLength : Object [override]
The length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the Oval. | Oval | ||
gradientStrokeStart : Object [override]
The starting point (in page coordinates) of a gradient applied to the stroke of the Oval, in the format [x, y]. | Oval | ||
graphicLines : GraphicLines [override] [read-only]
A collection of graphic lines. | Oval | ||
graphics : Graphics [override] [read-only]
A collection of imported graphics in any graphic file format (vector, metafile, or bitmap). | Oval | ||
groups : Groups [override] [read-only]
A collection of groups. | Oval | ||
horizontalScale : Number [override]
The horizontal scaling applied to the Oval. | Oval | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
id : Number [override] [read-only]
The unique ID of the Oval. | Oval | ||
images : Images [override] [read-only]
A collection of bitmap images in any bitmap file format (including TIFF, JPEG, or GIF). | Oval | ||
importedPages : ImportedPages [override] [read-only]
Imported InDesign pages. | Oval | ||
incopyExportOptions : InCopyExportOption [read-only]
Export options for InCopy INCX document format. | Oval | ||
index : Number [override] [read-only]
The index of the Oval within its containing object. | Oval | ||
isValid : Boolean [override] [read-only]
Returns true if the object specifier resolves to valid objects. | Oval | ||
itemLayer : Layer [override]
The layer that the Oval is on. | Oval | ||
label : String [override]
A property that can be set to any string. | Oval | ||
leftLineEnd : ArrowHead [override]
The arrowhead applied to the start of the path. | Oval | ||
localDisplaySetting : DisplaySettingOptions [override]
Display performance options for the Oval. | Oval | ||
locked : Boolean [override]
If true, the Oval is locked. | Oval | ||
lockState : LockStateValues [override] [read-only]
The lock state. | Oval | ||
mediaItems : MediaItems [override] [read-only]
The media items collection. | Oval | ||
miterLimit : Number [override]
The limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join. | Oval | ||
movies : Movies [override] [read-only]
A collection of movies. | Oval | ||
multiStateObjects : MultiStateObjects [override] [read-only]
A collection of multi-state objects. | Oval | ||
name : String [override]
The name of the Oval. | Oval | ||
nonprinting : Boolean [override]
If true, the Oval does not print. | Oval | ||
objectExportOptions : ObjectExportOption [override] [read-only]
Export options for the object
| Oval | ||
ovals : Ovals [override] [read-only]
A collection of ellipses. | Oval | ||
overprintFill : Boolean [override]
If true, the Oval's fill color overprints any underlying objects. | Oval | ||
overprintGap : Boolean [override]
If true, the gap color overprints any underlying colors. | Oval | ||
overprintStroke : Boolean [override]
If true, the Oval's stroke color overprints any underlying objects. | Oval | ||
overridden : Boolean [override] [read-only]
If true, the object originated on a master spread and was overridden. | Oval | ||
overriddenMasterPageItem : Object [override] [read-only]
An object that originated on a master page and has been overridden. | Oval | ||
pageItems : PageItems [override] [read-only]
The page items collection, which can be used to process all page items in a container (such as a document, page, or group), regardless of type. | Oval | ||
parent : Object [override] [read-only]
The parent of the Oval (a Spread, MasterSpread, SplineItem, Polygon, GraphicLine, Rectangle, Oval, Group, State, Character, PlaceGun or Snippet). | Oval | ||
parentPage : Page [override] [read-only]
The page on which this page item appears. | Oval | ||
paths : Paths [override] [read-only]
A collection of paths. | Oval | ||
pdfs : PDFs [override] [read-only]
A collection of PDF files. | Oval | ||
picts : PICTs [override] [read-only]
A collection of PICT graphics. | Oval | ||
polygons : Polygons [override] [read-only]
A collection of polygons. | Oval | ||
preferences : Preferences [override] [read-only]
A collection of preferences objects. | Oval | ||
properties : Object [override]
A property that allows setting of several properties at the same time. | Oval | ||
rectangles : Rectangles [override] [read-only]
A collection of rectangles. | Oval | ||
rightLineEnd : ArrowHead [override]
The arrowhead applied to the end of the path. | Oval | ||
rotationAngle : Number [override]
The rotatation angle of the Oval. | Oval | ||
shearAngle : Number [override]
The skewing angle applied to the Oval. | Oval | ||
sounds : Sounds [override] [read-only]
A collection of sound clips. | Oval | ||
splineItems : SplineItems [override] [read-only]
The spline items collection. | Oval | ||
storyTitle : String
Title for this InCopy story. | Oval | ||
strokeAlignment : StrokeAlignment [override]
The stroke alignment applied to the Oval. | Oval | ||
strokeColor : Swatch [override]
The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the Oval. | Oval | ||
strokeCornerAdjustment : StrokeCornerAdjustment [override]
The corner adjustment applied to the Oval. | Oval | ||
strokeDashAndGap : Object [override]
The dash and gap measurements that define the pattern of a custom dashed line. | Oval | ||
strokeTint : Number [override]
The percent of tint to use in object's stroke color. | Oval | ||
strokeTransparencySettings : StrokeTransparencySetting [override] [read-only]
Transparency settings for the stroke. | Oval | ||
strokeType : StrokeStyle [override]
The name of the stroke style to apply. | Oval | ||
strokeWeight : Object [override]
The weight (in points) to apply to the Oval's stroke. | Oval | ||
textFrames : TextFrames [override] [read-only]
A collection of text frames. | Oval | ||
textPaths : TextPaths [override] [read-only]
A collection of text paths. | Oval | ||
textWrapPreferences : TextWrapPreference [override] [read-only]
The text wrap preference properties that define the default formatting for wrapping text around objects. | Oval | ||
timingSettings : TimingSetting [override] [read-only]
The object timing settings. | Oval | ||
topLeftCornerOption : CornerOptions [override]
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. | Oval | ||
topLeftCornerRadius : Object [override]
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
| Oval | ||
topRightCornerOption : CornerOptions [override]
The shape to apply to the top right corner of rectangular shapes
| Oval | ||
topRightCornerRadius : Object [override]
The radius in measurement units of the corner effect applied to the top right corner of rectangular shapes
| Oval | ||
transparencySettings : TransparencySetting [override] [read-only]
Transparency settings. | Oval | ||
verticalScale : Number [override]
The vertical scaling applied to the Oval. | Oval | ||
visible : Boolean [override]
If true, the Oval is visible. | Oval | ||
visibleBounds : Object [override]
The bounds of the Oval 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. | Oval | ||
wmfs : WMFs [override] [read-only]
A collection of WMF graphics. | Oval |
Method | Defined By | ||
---|---|---|---|
addEventListenerOval(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | Oval | ||
![]() | addEventListenerPageItem(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | PageItem | |
![]() | addEventListenerSplineItem(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | SplineItem | |
[override]
Creates a new page item by combining the Oval with other objects. | Oval | ||
applyObjectStyle(usingParam:ObjectStyle = null, clearingOverridesParam:Boolean = true, clearingOverridesThroughRootObjectStyleParam:Boolean = false):void [override]
Applies the specified object style. | Oval | ||
asynchronousExportFile(formatParam:Object = null, toParam:File = null, showingOptionsParam:Boolean = false, usingParam:PDFExportPreset = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):BackgroundTask [override]
asynchronously exports the object(s) to a file. | Oval | ||
autoTag():void [override]
Tag the object or the parent story using default tags defined in XML preference. | Oval | ||
bringForward():void [override]
Brings the Oval forward one level in its layer. | Oval | ||
bringToFront(referenceParam:PageItem = null):void [override]
Brings the Oval to the front of its layer or in front of a particular item. | Oval | ||
changeObject(reverseOrderParam:Boolean):Object [override]
Finds objects that match the find what value and replace the objects with the change to value. | Oval | ||
checkIn(versionCommentsParam:String = null, forceSaveParam:Boolean = false):Boolean [override]
Checks in the story or stories. | Oval | ||
checkOut():Boolean [override]
Checks out the story. | Oval | ||
clearFrameFittingOptions():void
Removes the frame fittings options and resets it to the initial state. | Oval | ||
clearObjectStyleOverrides():void [override]
Clear overrides for object style
| Oval | ||
clearTransformations():void [override]
Clears transformations from the Oval. | Oval | ||
convertShape(givenParam:ConvertShapeOptions = null, numberOfSidesParam:Number, insetPercentageParam:Number, cornerRadiusParam:Object = null):void [override]
Converts the Oval to a different shape. | Oval | ||
detach():void [override]
Detaches an overridden master page item from the master page. | Oval | ||
[override]
Duplicates the Oval at the specified location or offset. | Oval | ||
excludeOverlapPath(withParam:Array = null):PageItem [override]
Creates a new page item by excluding the overlapping areas of the Oval and other objects. | Oval | ||
exportFile(formatParam:Object = null, toParam:File = null, showingOptionsParam:Boolean = false, usingParam:PDFExportPreset = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):void [override]
Exports the object(s) to a file. | Oval | ||
extractLabel(keyParam:String = null):String [override]
Gets the label value associated with the specified key. | Oval | ||
![]() | 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 [override]
Finds objects that match the find what value. | Oval | ||
fit(givenParam:FitOptions = null):void [override]
Applies the specified fit option to content in a frame. | Oval | ||
[override]
Flips the Oval. | Oval | ||
![]() | 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 [override]
Resolves the object specifier, creating an array of object references. | Oval | ||
![]() | 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 [override]
Sets the label to the value associated with the specified key. | Oval | ||
intersectPath(withParam:Array = null):PageItem [override]
Creates a new page item by intersecting the Oval with other objects. | Oval | ||
![]() | 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 | |
makeCompoundPath(withParam:Array = null):PageItem [override]
Creates a compound path by combining the path(s) of the Oval with the paths of other objects. | Oval | ||
markup(usingParam:XMLElement = null):void [override]
Associates the page item with the specified XML element while preserving existing content. | Oval | ||
[override]
Creates a new page item by reverse subtracting the overlapping areas of the Oval and other objects. | Oval | ||
move(toParam:Object = null, byParam:Array = null):void [override]
Moves the Oval to a new location. | Oval | ||
[override]
Overrides a master page item and places the item on the document page as a new object. | Oval | ||
place(fileNameParam:File = null, showingOptionsParam:Boolean = false, withPropertiesParam:Object = null):Object [override]
Places the file. | Oval | ||
placeXML(usingParam:XMLElement = null):void [override]
Places XML content into the specified object. | Oval | ||
redefineScaling(toParam:Array = null):void [override]
Apply an item's scaling to its content if possible. | Oval | ||
reframe(inParam:Object = null, opposingCornersParam:Array = null):void [override]
Move the bounding box of the page item
| Oval | ||
releaseCompoundPath():Object [override]
Releases a compound path. | Oval | ||
remove():void [override]
Deletes the Oval. | Oval | ||
removeEventListenerOval(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | Oval | ||
![]() | removeEventListenerPageItem(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | PageItem | |
![]() | removeEventListenerSplineItem(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | SplineItem | |
removeOverride():void [override]
Removes the override from a previously overridden master page item. | Oval | ||
![]() | 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 [override]
Resize the page item. | Oval | ||
resolve(locationParam:Object = null, inParam:CoordinateSpaces = null, consideringRulerUnitsParam:Boolean = false):Object [override]
Get the coordinates of the given location in the specified coordinate system. | Oval | ||
revert():Boolean [override]
Reverts the document to its state at the last save operation. | Oval | ||
select(existingSelectionParam:SelectionOptions = null):void [override]
Selects the object. | Oval | ||
sendBackward():void [override]
Sends the Oval back one level in its layer. | Oval | ||
sendToBack(referenceParam:PageItem = null):void [override]
Sends the Oval to the back of its layer or behind a particular item (must have same parent). | Oval | ||
[override]
Stores the object in the specified library. | Oval | ||
subtractPath(withParam:Array = null):PageItem [override]
Creates a new page item by subtracting the overlapping areas of the Oval and other objects. | Oval | ||
toSpecifier():String [override]
Retrieves the object specifier. | Oval | ||
transform(inParam:CoordinateSpaces = null, fromParam:Object = null, withMatrixParam:Object = null, replacingCurrentParam:Object = null, consideringRulerUnitsParam:Boolean = false):void [override]
Transform the page item. | Oval | ||
transformAgain():Object [override]
Transforms the Oval using the last transformation performed on any object. | Oval | ||
transformAgainIndividually():Object [override]
Transforms the Oval using the last transformation performed on any Oval. | Oval | ||
transformSequenceAgain():Object [override]
Transforms the Oval using the last sequence of transform operations performed on any single object or performed at the same time on any group of objects. | Oval | ||
transformSequenceAgainIndividually():Object [override]
Transforms the Oval using the last sequence of transformations performed on any single object or performed at the same time on any group of objects. | Oval | ||
transformValuesOf(inParam:CoordinateSpaces = null):Object [override]
Get the transformation values of the page item. | Oval | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
absoluteFlip | property |
absoluteFlip:Flip
[override] Since : | CS5 |
Indicates whether the Oval has been flipped independently of its parent object and, if yes, the direction in which the Oval was flipped.
public function get absoluteFlip():Flip
public function set absoluteFlip(value:Flip):void
absoluteHorizontalScale | property |
absoluteHorizontalScale:Number
[override] Since : | CS5 |
The horizontal scale of the Oval relative to its containing object.
public function get absoluteHorizontalScale():Number
public function set absoluteHorizontalScale(value:Number):void
absoluteRotationAngle | property |
absoluteRotationAngle:Number
[override] Since : | CS5 |
The rotation angle of the Oval 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
[override] Since : | CS5 |
The skewing angle of the Oval 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
[override] Since : | CS5 |
The vertical scale of the Oval 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 Oval is placed. This event bubbles. This event is not cancelable.
public static function get AFTER_PLACE():String
allArticles | property |
allArticles:Object
[read-only] [override] 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] [override] Since : | CS5 |
Lists all graphics contained by the Oval.
public function get allGraphics():Object
allowOverrides | property |
allowOverrides:Boolean
[override] 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] [override] Since : | CS5 |
Lists all page items contained by the Oval.
public function get allPageItems():Object
anchoredObjectSettings | property |
anchoredObjectSettings:AnchoredObjectSetting
[read-only] [override] Since : | CS5 |
Anchored object settings.
public function get anchoredObjectSettings():AnchoredObjectSetting
animationSettings | property |
animationSettings:AnimationSetting
[read-only] [override] Since : | CS5 |
The page item animation settings.
public function get animationSettings():AnimationSetting
appliedObjectStyle | property |
appliedObjectStyle:ObjectStyle
[override] Since : | CS5 |
The object style applied to the Oval.
public function get appliedObjectStyle():ObjectStyle
public function set appliedObjectStyle(value:ObjectStyle):void
associatedXMLElement | property |
associatedXMLElement:XMLItem
[read-only] [override] Since : | CS5 |
The XML element associated with the Oval.
public function get associatedXMLElement():XMLItem
BEFORE_PLACE | property |
BEFORE_PLACE:String
[read-only] Since : | CS5 |
Dispatched before a Oval is placed. This event bubbles. This event is cancelable.
public static function get BEFORE_PLACE():String
bottomLeftCornerOption | property |
bottomLeftCornerOption:CornerOptions
[override] 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
[override] 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
[override] 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
[override] 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
buttons | property |
buttons:Buttons
[read-only] [override] Since : | CS5 |
A collection of buttons.
public function get buttons():Buttons
contentTransparencySettings | property |
contentTransparencySettings:ContentTransparencySetting
[read-only] [override] Since : | CS5 |
Transparency settings for the content of the Oval.
public function get contentTransparencySettings():ContentTransparencySetting
contentType | property |
contentType:ContentType
[override] Since : | CS5 |
The type of content that a frame can contain.
public function get contentType():ContentType
public function set contentType(value:ContentType):void
endCap | property |
endCap:EndCap
[override] 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
[override] Since : | CS5 |
The corner join applied to the Oval.
public function get endJoin():EndJoin
public function set endJoin(value:EndJoin):void
epss | property |
epss:EPSs
[read-only] [override] Since : | CS5 |
A collection of EPS files.
public function get epss():EPSs
epstexts | property |
epstexts:EPSTexts
[read-only] [override] Since : | CS5 |
EPSTexts
public function get epstexts():EPSTexts
eventListeners | property |
eventListeners:EventListeners
[read-only] [override] Since : | CS5 |
A collection of event listeners.
public function get eventListeners():EventListeners
events | property |
events:Events
[read-only] [override] Since : | CS5 |
A collection of events.
public function get events():Events
fillColor | property |
fillColor:Swatch
[override] Since : | CS5 |
The swatch (color, gradient, tint, or mixed ink) applied to the fill of the Oval. . Can also accept: String.
public function get fillColor():Swatch
public function set fillColor(value:Swatch):void
fillTint | property |
fillTint:Number
[override] Since : | CS5 |
The percent of tint to use in the Oval'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] [override] Since : | CS5 |
Transparency settings for the fill applied to the Oval.
public function get fillTransparencySettings():FillTransparencySetting
flip | property |
flip:Flip
[override] Since : | CS5 |
The direction in which to flip the printed image.
public function get flip():Flip
public function set flip(value:Flip):void
formFields | property |
formFields:FormFields
[read-only] [override] Since : | CS5 |
A collection of form fields.
public function get formFields():FormFields
frameFittingOptions | property |
frameFittingOptions:FrameFittingOption
[read-only] Since : | CS5 |
The frame fitting option to apply to placed or pasted content. Can be applied to a frame, object style, or document or to the application.
public function get frameFittingOptions():FrameFittingOption
gapColor | property |
gapColor:Swatch
[override] 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
[override] 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
[override] Since : | CS5 |
The bounds of the Oval 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
[override] Since : | CS5 |
The angle of a linear gradient applied to the fill of the Oval. (Range: -180 to 180)
public function get gradientFillAngle():Number
public function set gradientFillAngle(value:Number):void
gradientFillLength | property |
gradientFillLength:Object
[override] Since : | CS5 |
The length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the Oval.
public function get gradientFillLength():Object
public function set gradientFillLength(value:Object):void
gradientFillStart | property |
gradientFillStart:Object
[override] Since : | CS5 |
The starting point (in page coordinates) of a gradient applied to the fill of the Oval, in the format [x, y].
public function get gradientFillStart():Object
public function set gradientFillStart(value:Object):void
gradientStrokeAngle | property |
gradientStrokeAngle:Number
[override] Since : | CS5 |
The angle of a linear gradient applied to the stroke of the Oval. (Range: -180 to 180)
public function get gradientStrokeAngle():Number
public function set gradientStrokeAngle(value:Number):void
gradientStrokeLength | property |
gradientStrokeLength:Object
[override] Since : | CS5 |
The length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the Oval.
public function get gradientStrokeLength():Object
public function set gradientStrokeLength(value:Object):void
gradientStrokeStart | property |
gradientStrokeStart:Object
[override] Since : | CS5 |
The starting point (in page coordinates) of a gradient applied to the stroke of the Oval, in the format [x, y].
public function get gradientStrokeStart():Object
public function set gradientStrokeStart(value:Object):void
graphicLines | property |
graphicLines:GraphicLines
[read-only] [override] Since : | CS5 |
A collection of graphic lines.
public function get graphicLines():GraphicLines
graphics | property |
graphics:Graphics
[read-only] [override] Since : | CS5 |
A collection of imported graphics in any graphic file format (vector, metafile, or bitmap).
public function get graphics():Graphics
groups | property |
groups:Groups
[read-only] [override] Since : | CS5 |
A collection of groups.
public function get groups():Groups
horizontalScale | property |
horizontalScale:Number
[override] Since : | CS5 |
The horizontal scaling applied to the Oval.
public function get horizontalScale():Number
public function set horizontalScale(value:Number):void
id | property |
id:Number
[read-only] [override] Since : | CS5 |
The unique ID of the Oval.
public function get id():Number
images | property |
images:Images
[read-only] [override] Since : | CS5 |
A collection of bitmap images in any bitmap file format (including TIFF, JPEG, or GIF).
public function get images():Images
importedPages | property |
importedPages:ImportedPages
[read-only] [override] Since : | CS5 |
Imported InDesign pages.
public function get importedPages():ImportedPages
incopyExportOptions | property |
incopyExportOptions:InCopyExportOption
[read-only] Since : | CS5 |
Export options for InCopy INCX document format.
public function get incopyExportOptions():InCopyExportOption
index | property |
index:Number
[read-only] [override] Since : | CS5 |
The index of the Oval within its containing object.
public function get index():Number
isValid | property |
isValid:Boolean
[read-only] [override] Since : | CS5 |
Returns true if the object specifier resolves to valid objects.
public function get isValid():Boolean
itemLayer | property |
itemLayer:Layer
[override] Since : | CS5 |
The layer that the Oval is on.
public function get itemLayer():Layer
public function set itemLayer(value:Layer):void
label | property |
label:String
[override] 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
[override] 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
[override] Since : | CS5 |
Display performance options for the Oval.
public function get localDisplaySetting():DisplaySettingOptions
public function set localDisplaySetting(value:DisplaySettingOptions):void
locked | property |
locked:Boolean
[override] Since : | CS5 |
If true, the Oval is locked.
public function get locked():Boolean
public function set locked(value:Boolean):void
lockState | property |
lockState:LockStateValues
[read-only] [override] Since : | CS5 |
The lock state.
public function get lockState():LockStateValues
mediaItems | property |
mediaItems:MediaItems
[read-only] [override] Since : | CS5 |
The media items collection.
public function get mediaItems():MediaItems
miterLimit | property |
miterLimit:Number
[override] 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
movies | property |
movies:Movies
[read-only] [override] Since : | CS5 |
A collection of movies.
public function get movies():Movies
multiStateObjects | property |
multiStateObjects:MultiStateObjects
[read-only] [override] Since : | CS5 |
A collection of multi-state objects.
public function get multiStateObjects():MultiStateObjects
name | property |
name:String
[override] Since : | CS5 |
The name of the Oval.
public function get name():String
public function set name(value:String):void
nonprinting | property |
nonprinting:Boolean
[override] Since : | CS5 |
If true, the Oval does not print.
public function get nonprinting():Boolean
public function set nonprinting(value:Boolean):void
objectExportOptions | property |
objectExportOptions:ObjectExportOption
[read-only] [override] Since : | CS5.5 |
Export options for the object
public function get objectExportOptions():ObjectExportOption
ovals | property |
ovals:Ovals
[read-only] [override] Since : | CS5 |
A collection of ellipses.
public function get ovals():Ovals
overprintFill | property |
overprintFill:Boolean
[override] Since : | CS5 |
If true, the Oval'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
[override] 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
[override] Since : | CS5 |
If true, the Oval'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] [override] 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] [override] 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
pageItems | property |
pageItems:PageItems
[read-only] [override] Since : | CS5 |
The page items collection, which can be used to process all page items in a container (such as a document, page, or group), regardless of type.
public function get pageItems():PageItems
parent | property |
parent:Object
[read-only] [override] Since : | CS5 |
The parent of the Oval (a Spread, MasterSpread, SplineItem, Polygon, GraphicLine, Rectangle, Oval, Group, State, Character, PlaceGun or Snippet).
public function get parent():Object
parentPage | property |
parentPage:Page
[read-only] [override] Since : | CS5 |
The page on which this page item appears.
public function get parentPage():Page
paths | property |
paths:Paths
[read-only] [override] Since : | CS5 |
A collection of paths.
public function get paths():Paths
pdfs | property |
pdfs:PDFs
[read-only] [override] Since : | CS5 |
A collection of PDF files.
public function get pdfs():PDFs
picts | property |
picts:PICTs
[read-only] [override] Since : | CS5 |
A collection of PICT graphics.
public function get picts():PICTs
polygons | property |
polygons:Polygons
[read-only] [override] Since : | CS5 |
A collection of polygons.
public function get polygons():Polygons
preferences | property |
preferences:Preferences
[read-only] [override] Since : | CS5 |
A collection of preferences objects.
public function get preferences():Preferences
properties | property |
properties:Object
[override] Since : | CS5 |
A property that allows setting of several properties at the same time.
public function get properties():Object
public function set properties(value:Object):void
rectangles | property |
rectangles:Rectangles
[read-only] [override] Since : | CS5 |
A collection of rectangles.
public function get rectangles():Rectangles
rightLineEnd | property |
rightLineEnd:ArrowHead
[override] 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
[override] Since : | CS5 |
The rotatation angle of the Oval. (Range: -360 to 360)
public function get rotationAngle():Number
public function set rotationAngle(value:Number):void
shearAngle | property |
shearAngle:Number
[override] Since : | CS5 |
The skewing angle applied to the Oval. (Range: -360 to 360)
public function get shearAngle():Number
public function set shearAngle(value:Number):void
sounds | property |
sounds:Sounds
[read-only] [override] Since : | CS5 |
A collection of sound clips.
public function get sounds():Sounds
splineItems | property |
splineItems:SplineItems
[read-only] [override] Since : | CS5 |
The spline items collection.
public function get splineItems():SplineItems
storyTitle | property |
storyTitle:String
Since : | CS5 |
Title for this InCopy story.
public function get storyTitle():String
public function set storyTitle(value:String):void
strokeAlignment | property |
strokeAlignment:StrokeAlignment
[override] Since : | CS5 |
The stroke alignment applied to the Oval.
public function get strokeAlignment():StrokeAlignment
public function set strokeAlignment(value:StrokeAlignment):void
strokeColor | property |
strokeColor:Swatch
[override] Since : | CS5 |
The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the Oval. Can also accept: String.
public function get strokeColor():Swatch
public function set strokeColor(value:Swatch):void
strokeCornerAdjustment | property |
strokeCornerAdjustment:StrokeCornerAdjustment
[override] Since : | CS5 |
The corner adjustment applied to the Oval.
public function get strokeCornerAdjustment():StrokeCornerAdjustment
public function set strokeCornerAdjustment(value:StrokeCornerAdjustment):void
strokeDashAndGap | property |
strokeDashAndGap:Object
[override] 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
[override] 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] [override] Since : | CS5 |
Transparency settings for the stroke.
public function get strokeTransparencySettings():StrokeTransparencySetting
strokeType | property |
strokeType:StrokeStyle
[override] 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
[override] Since : | CS5 |
The weight (in points) to apply to the Oval's stroke.
public function get strokeWeight():Object
public function set strokeWeight(value:Object):void
textFrames | property |
textFrames:TextFrames
[read-only] [override] Since : | CS5 |
A collection of text frames.
public function get textFrames():TextFrames
textPaths | property |
textPaths:TextPaths
[read-only] [override] Since : | CS5 |
A collection of text paths.
public function get textPaths():TextPaths
textWrapPreferences | property |
textWrapPreferences:TextWrapPreference
[read-only] [override] 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] [override] Since : | CS5 |
The object timing settings.
public function get timingSettings():TimingSetting
topLeftCornerOption | property |
topLeftCornerOption:CornerOptions
[override] 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
[override] 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
[override] 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
[override] 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] [override] Since : | CS5 |
Transparency settings.
public function get transparencySettings():TransparencySetting
verticalScale | property |
verticalScale:Number
[override] Since : | CS5 |
The vertical scaling applied to the Oval.
public function get verticalScale():Number
public function set verticalScale(value:Number):void
visible | property |
visible:Boolean
[override] Since : | CS5 |
If true, the Oval is visible.
public function get visible():Boolean
public function set visible(value:Boolean):void
visibleBounds | property |
visibleBounds:Object
[override] Since : | CS5 |
The bounds of the Oval 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
wmfs | property |
wmfs:WMFs
[read-only] [override] Since : | CS5 |
A collection of WMF graphics.
public function get wmfs():WMFs
addEventListenerOval | () | method |
public function addEventListenerOval(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 |
addPath | () | method |
override public function addPath(withParam:Array = null):PageItem
Since : | CS5 |
Creates a new page item by combining the Oval with other objects. Deletes the objects if they do not intersect.
Parameters
withParam:Array (default = null ) — (Array) The object(s) to add.
|
PageItem |
applyObjectStyle | () | method |
override 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 Oval's existing attributes before applying the style. (Optional)
| |
clearingOverridesThroughRootObjectStyleParam:Boolean (default = false ) — (Boolean) If true, clears attributes and formatting applied to the Oval that are not defined in the object style. (Optional)
|
asynchronousExportFile | () | method |
override 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 |
override public function autoTag():void
Since : | CS5 |
Tag the object or the parent story using default tags defined in XML preference.
bringForward | () | method |
override public function bringForward():void
Since : | CS5 |
Brings the Oval forward one level in its layer.
bringToFront | () | method |
override public function bringToFront(referenceParam:PageItem = null):void
Since : | CS5 |
Brings the Oval to the front of its layer or in front of a particular item.
Parameters
referenceParam:PageItem (default = null ) — (PageItem) The reference object to bring the object in front of (must have same parent) (Optional)
|
changeObject | () | method |
override 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 |
checkIn | () | method |
override public function checkIn(versionCommentsParam:String = null, forceSaveParam:Boolean = false):Boolean
Since : | CS5 |
Checks in the story or stories.
Parameters
versionCommentsParam:String (default = null ) — (String) The comment for this version. (Optional)
| |
forceSaveParam:Boolean (default = false ) — (Boolean) If true, forcibly saves a version. (Optional)
|
Boolean |
checkOut | () | method |
override public function checkOut():Boolean
Since : | CS5 |
Checks out the story.
ReturnsBoolean |
clearFrameFittingOptions | () | method |
public function clearFrameFittingOptions():void
Since : | CS5 |
Removes the frame fittings options and resets it to the initial state.
clearObjectStyleOverrides | () | method |
override public function clearObjectStyleOverrides():void
Since : | CS5 |
Clear overrides for object style
clearTransformations | () | method |
override public function clearTransformations():void
Since : | CS5 |
Clears transformations from the Oval. Transformations include rotation, scaling, flipping, fitting, and shearing.
convertShape | () | method |
override public function convertShape(givenParam:ConvertShapeOptions = null, numberOfSidesParam:Number, insetPercentageParam:Number, cornerRadiusParam:Object = null):void
Since : | CS5 |
Converts the Oval to a different shape.
Parameters
givenParam:ConvertShapeOptions (default = null ) — (ConvertShapeOptions) The Oval'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 |
override public function detach():void
Since : | CS5 |
Detaches an overridden master page item from the master page.
duplicate | () | method |
override public function duplicate(toParam:Object = null, byParam:Array = null):PageItem
Since : | CS5 |
Duplicates the Oval at the specified location or offset.
Parameters
toParam:Object (default = null ) — (Object) The location of the new Oval, 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 Oval from the original Oval's position. (Optional)
|
PageItem |
excludeOverlapPath | () | method |
override public function excludeOverlapPath(withParam:Array = null):PageItem
Since : | CS5 |
Creates a new page item by excluding the overlapping areas of the Oval and other objects.
Parameters
withParam:Array (default = null ) — (Array) The object(s) to exclude.
|
PageItem |
exportFile | () | method |
override 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 |
override 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 |
override 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 |
override 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 |
override public function flipItem(givenParam:Flip = null, aroundParam:Object = null):void
Since : | CS5 |
Flips the Oval.
Parameters
givenParam:Flip (default = null ) — (Flip) The axis around which to flip the Oval.
| |
aroundParam:Object (default = null ) — (Object) The point around which to flip the Oval. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional)
|
getElements | () | method |
override public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
insertLabel | () | method |
override 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.
|
intersectPath | () | method |
override public function intersectPath(withParam:Array = null):PageItem
Since : | CS5 |
Creates a new page item by intersecting the Oval with other objects. Returns an error if the objects do not intersect.
Parameters
withParam:Array (default = null ) — (Array) The object(s) with which to intersect.
|
PageItem |
makeCompoundPath | () | method |
override public function makeCompoundPath(withParam:Array = null):PageItem
Since : | CS5 |
Creates a compound path by combining the path(s) of the Oval with the paths of other objects.
Parameters
withParam:Array (default = null ) — (Array) The other objects whose paths to include in the new compound path.
|
PageItem |
markup | () | method |
override 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.
|
minusBack | () | method |
override public function minusBack(withParam:Array = null):PageItem
Since : | CS5 |
Creates a new page item by reverse subtracting the overlapping areas of the Oval and other objects.
Parameters
withParam:Array (default = null ) — (Array) The object(s) to reverse subtract.
|
PageItem |
move | () | method |
override public function move(toParam:Object = null, byParam:Array = null):void
Since : | CS5 |
Moves the Oval 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 Oval,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 Oval relative to its current position, in the format (x, y). (Optional)
|
override | () | method |
override 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 |
override 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 |
override 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 |
override 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 |
override 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
|
releaseCompoundPath | () | method |
override public function releaseCompoundPath():Object
Since : | CS5 |
Releases a compound path.
ReturnsObject |
remove | () | method |
override public function remove():void
Since : | CS5 |
Deletes the Oval.
removeEventListenerOval | () | method |
public function removeEventListenerOval(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 |
override public function removeOverride():void
Since : | CS5 |
Removes the override from a previously overridden master page item.
resize | () | method |
override 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 |
override 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 |
revert | () | method |
override public function revert():Boolean
Since : | CS5 |
Reverts the document to its state at the last save operation.
ReturnsBoolean |
select | () | method |
override public function select(existingSelectionParam:SelectionOptions = null):void
Since : | CS5 |
Selects the object.
Parameters
existingSelectionParam:SelectionOptions (default = null ) — (SelectionOptions) The selection status of the Oval in relation to previously selected objects. (Optional)
|
sendBackward | () | method |
override public function sendBackward():void
Since : | CS5 |
Sends the Oval back one level in its layer.
sendToBack | () | method |
override public function sendToBack(referenceParam:PageItem = null):void
Since : | CS5 |
Sends the Oval to the back of its layer or behind a particular item (must have same parent).
Parameters
referenceParam:PageItem (default = null ) — (PageItem) The reference object to send the object behind (Optional)
|
store | () | method |
override 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 Oval (Optional)
|
Asset |
subtractPath | () | method |
override public function subtractPath(withParam:Array = null):PageItem
Since : | CS5 |
Creates a new page item by subtracting the overlapping areas of the Oval and other objects.
Parameters
withParam:Array (default = null ) — (Array) The object(s) to subtract.
|
PageItem |
toSpecifier | () | method |
override public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |
transform | () | method |
override 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 |
override public function transformAgain():Object
Since : | CS5 |
Transforms the Oval using the last transformation performed on any object. Transformations include moving, rotating, shearing, scaling, and flipping.
ReturnsObject |
transformAgainIndividually | () | method |
override public function transformAgainIndividually():Object
Since : | CS5 |
Transforms the Oval using the last transformation performed on any Oval. Transformations include moving, rotating, shearing, scaling, and flipping.
ReturnsObject |
transformSequenceAgain | () | method |
override public function transformSequenceAgain():Object
Since : | CS5 |
Transforms the Oval 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 |
override public function transformSequenceAgainIndividually():Object
Since : | CS5 |
Transforms the Oval 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 |
override 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 |