Package | com.adobe.incopy |
Class | public class PageItemDefault |
Inheritance | PageItemDefault ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
bottomLeftCornerOption : CornerOptions [read-only]
The shape to apply to the bottom left corner of rectangular shapes. | PageItemDefault | ||
bottomLeftCornerRadius : Object [read-only]
The radius in measurement units of the corner effect applied to the bottom left corner of rectangular shapes
| PageItemDefault | ||
bottomRightCornerOption : CornerOptions [read-only]
The shape to apply to the bottom right corner of rectangular shapes. | PageItemDefault | ||
bottomRightCornerRadius : Object [read-only]
The radius in measurement units of the corner effect applied to the bottom right corner of rectangular shapes
| PageItemDefault | ||
endCap : EndCap [read-only]
The end shape of an open path. | PageItemDefault | ||
endJoin : EndJoin [read-only]
The corner join applied to the PageItemDefault. | PageItemDefault | ||
eventListeners : EventListeners [override] [read-only]
A collection of event listeners. | PageItemDefault | ||
events : Events [override] [read-only]
A collection of events. | PageItemDefault | ||
fillColor : Swatch [read-only]
The swatch (color, gradient, tint, or mixed ink) applied to the fill of the PageItemDefault. | PageItemDefault | ||
fillTint : Number [read-only]
The percent of tint to use in the PageItemDefault's fill color. | PageItemDefault | ||
gapColor : Swatch [read-only]
The swatch (color, gradient, tint, or mixed ink) applied to the gap of a dashed, dotted, or striped stroke. | PageItemDefault | ||
gapTint : Number [read-only]
The tint as a percentage of the gap color. | PageItemDefault | ||
gradientFillAngle : Number [read-only]
The angle of a linear gradient applied to the fill of the PageItemDefault. | PageItemDefault | ||
gradientStrokeAngle : Number [read-only]
The angle of a linear gradient applied to the stroke of the PageItemDefault. | PageItemDefault | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
isValid : Boolean [override] [read-only]
Returns true if the object specifier resolves to valid objects. | PageItemDefault | ||
leftLineEnd : ArrowHead [read-only]
The arrowhead applied to the start of the path. | PageItemDefault | ||
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. | PageItemDefault | ||
nonprinting : Boolean [read-only]
If true, the PageItemDefault does not print. | PageItemDefault | ||
overprintFill : Boolean [read-only]
If true, the PageItemDefault's fill color overprints any underlying objects. | PageItemDefault | ||
overprintGap : Boolean [read-only]
If true, the gap color overprints any underlying colors. | PageItemDefault | ||
overprintStroke : Boolean [read-only]
If true, the PageItemDefault's stroke color overprints any underlying objects. | PageItemDefault | ||
parent : Object [override] [read-only]
The parent of the PageItemDefault (a Application or Document). | PageItemDefault | ||
properties : Object [override]
A property that allows setting of several properties at the same time. | PageItemDefault | ||
rightLineEnd : ArrowHead [read-only]
The arrowhead applied to the end of the path. | PageItemDefault | ||
strokeAlignment : StrokeAlignment [read-only]
The stroke alignment applied to the PageItemDefault. | PageItemDefault | ||
strokeColor : Swatch [read-only]
The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the PageItemDefault. | PageItemDefault | ||
strokeTint : Number [read-only]
The percent of tint to use in object's stroke color. | PageItemDefault | ||
strokeType : StrokeStyle [read-only]
The name of the stroke style to apply. | PageItemDefault | ||
strokeWeight : Object [read-only]
The weight (in points) to apply to the PageItemDefault's stroke. | PageItemDefault | ||
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. | PageItemDefault | ||
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
| PageItemDefault | ||
topRightCornerOption : CornerOptions [read-only]
The shape to apply to the top right corner of rectangular shapes
| PageItemDefault | ||
topRightCornerRadius : Object [read-only]
The radius in measurement units of the corner effect applied to the top right corner of rectangular shapes
| PageItemDefault |
Method | Defined By | ||
---|---|---|---|
addEventListenerPageItemDefault(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | PageItemDefault | ||
![]() | addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | Preference | |
![]() | filterArgsForHBAPI(args:Array):Array [static]
Function to clean up the argument list and put it into a format that
makes sense for HBAPI. | CSHostObject | |
![]() | filterSingleObjectForHBAPI(value:Object):Object [static]
| CSHostObject | |
![]() | getClassObjectForName(className:String):HostObject [static] This returns a "Class" object, meaning, a HostObject that can be used
to make static function calls or get static properties
| CSHostObject | |
getElements():Object [override]
Resolves the object specifier, creating an array of object references. | PageItemDefault | ||
![]() | 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 | |
removeEventListenerPageItemDefault(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | PageItemDefault | ||
![]() | removeEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | Preference | |
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
toSpecifier():String [override]
Retrieves the object specifier. | PageItemDefault | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
bottomLeftCornerOption | property |
bottomLeftCornerOption:CornerOptions
[read-only] Since : | CS5 |
The shape to apply to the bottom left corner of rectangular shapes.
public function get bottomLeftCornerOption():CornerOptions
bottomLeftCornerRadius | property |
bottomLeftCornerRadius:Object
[read-only] 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
bottomRightCornerOption | property |
bottomRightCornerOption:CornerOptions
[read-only] Since : | CS5 |
The shape to apply to the bottom right corner of rectangular shapes.
public function get bottomRightCornerOption():CornerOptions
bottomRightCornerRadius | property |
bottomRightCornerRadius:Object
[read-only] 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
endCap | property |
endCap:EndCap
[read-only] Since : | CS5 |
The end shape of an open path.
public function get endCap():EndCap
endJoin | property |
endJoin:EndJoin
[read-only] Since : | CS5 |
The corner join applied to the PageItemDefault.
public function get endJoin():EndJoin
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
[read-only] Since : | CS5 |
The swatch (color, gradient, tint, or mixed ink) applied to the fill of the PageItemDefault. . Can also accept: String.
public function get fillColor():Swatch
fillTint | property |
fillTint:Number
[read-only] Since : | CS5 |
The percent of tint to use in the PageItemDefault'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
gapColor | property |
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.
public function get gapColor():Swatch
gapTint | property |
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.)
public function get gapTint():Number
gradientFillAngle | property |
gradientFillAngle:Number
[read-only] Since : | CS5 |
The angle of a linear gradient applied to the fill of the PageItemDefault. (Range: -180 to 180)
public function get gradientFillAngle():Number
gradientStrokeAngle | property |
gradientStrokeAngle:Number
[read-only] Since : | CS5 |
The angle of a linear gradient applied to the stroke of the PageItemDefault. (Range: -180 to 180)
public function get gradientStrokeAngle():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
leftLineEnd | property |
leftLineEnd:ArrowHead
[read-only] Since : | CS5 |
The arrowhead applied to the start of the path.
public function get leftLineEnd():ArrowHead
miterLimit | property |
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.
public function get miterLimit():Number
nonprinting | property |
nonprinting:Boolean
[read-only] Since : | CS5 |
If true, the PageItemDefault does not print.
public function get nonprinting():Boolean
overprintFill | property |
overprintFill:Boolean
[read-only] Since : | CS5 |
If true, the PageItemDefault's fill color overprints any underlying objects. If false, the fill color knocks out the underlying colors.
public function get overprintFill():Boolean
overprintGap | property |
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.
public function get overprintGap():Boolean
overprintStroke | property |
overprintStroke:Boolean
[read-only] Since : | CS5 |
If true, the PageItemDefault's stroke color overprints any underlying objects. If false, the stroke color knocks out the underlying colors.
public function get overprintStroke():Boolean
parent | property |
parent:Object
[read-only] [override] Since : | CS5 |
The parent of the PageItemDefault (a Application or Document).
public function get parent():Object
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
rightLineEnd | property |
rightLineEnd:ArrowHead
[read-only] Since : | CS5 |
The arrowhead applied to the end of the path.
public function get rightLineEnd():ArrowHead
strokeAlignment | property |
strokeAlignment:StrokeAlignment
[read-only] Since : | CS5 |
The stroke alignment applied to the PageItemDefault.
public function get strokeAlignment():StrokeAlignment
strokeColor | property |
strokeColor:Swatch
[read-only] Since : | CS5 |
The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the PageItemDefault. Can also accept: String.
public function get strokeColor():Swatch
strokeTint | property |
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.)
public function get strokeTint():Number
strokeType | property |
strokeType:StrokeStyle
[read-only] Since : | CS5 |
The name of the stroke style to apply. Can also accept: String.
public function get strokeType():StrokeStyle
strokeWeight | property |
strokeWeight:Object
[read-only] Since : | CS5 |
The weight (in points) to apply to the PageItemDefault's stroke.
public function get strokeWeight():Object
topLeftCornerOption | property |
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.
public function get topLeftCornerOption():CornerOptions
topLeftCornerRadius | property |
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
public function get topLeftCornerRadius():Object
topRightCornerOption | property |
topRightCornerOption:CornerOptions
[read-only] Since : | CS5 |
The shape to apply to the top right corner of rectangular shapes
public function get topRightCornerOption():CornerOptions
topRightCornerRadius | property |
topRightCornerRadius:Object
[read-only] 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
addEventListenerPageItemDefault | () | method |
public function addEventListenerPageItemDefault(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 |
getElements | () | method |
override public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
removeEventListenerPageItemDefault | () | method |
public function removeEventListenerPageItemDefault(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 |
toSpecifier | () | method |
override public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |