Packagecom.adobe.incopy
Classpublic class PageItemDefault
InheritancePageItemDefault Inheritance Preference Inheritance CSHostObject Inheritance flash.utils.Proxy

Since : CS5

Preference



Public Properties
 PropertyDefined 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
 InheritedhostObjectDelegate : 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
Public Methods
 MethodDefined By
  
addEventListenerPageItemDefault(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
PageItemDefault
 Inherited
addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
Preference
 Inherited
filterArgsForHBAPI(args:Array):Array
[static] Function to clean up the argument list and put it into a format that makes sense for HBAPI.
CSHostObject
 Inherited
filterSingleObjectForHBAPI(value:Object):Object
[static]
CSHostObject
 Inherited
getClassObjectForName(className:String):HostObject
[static] This returns a "Class" object, meaning, a HostObject that can be used to make static function calls or get static properties
CSHostObject
  
getElements():Object
[override] Resolves the object specifier, creating an array of object references.
PageItemDefault
 Inherited
getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):*
[static]
CSHostObject
 Inherited
hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
CSHostObject
 Inherited
hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):*
[static] Implements a safe call of a static method on the host
CSHostObject
 Inherited
hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
CSHostObject
 Inherited
hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
CSHostObject
 Inherited
hostGetStatic(className:String, propertyName:String, expectedReturnType:Class):*
[static] Implements a safe get of a static property on the host Used by for instance, all the enum implementations.
CSHostObject
 Inherited
hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
CSHostObject
 Inherited
hostSetStatic(className:String, propertyName:String, rawvalue:*):*
[static] Implements a safe set of a static property on the host
CSHostObject
 Inherited
isDescendedFrom(clz:Class, ancClass:Class):Boolean
[static] Efficiently determines whether or not one class descends from another in inheritance hierarchy- class relationships are cached by the ClassUtils implementation- (uses org.as3commons lib to quickly discover class hierarchy.
CSHostObject
  
removeEventListenerPageItemDefault(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
PageItemDefault
 Inherited
removeEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
Preference
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
toSpecifier():String
[override] Retrieves the object specifier.
PageItemDefault
 Inherited
wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):*
[static] Method used on static/normal get/ hostcalls
CSHostObject
Protected Methods
 MethodDefined By
 Inherited
createWithArgs(args:Array):void
CSHostObject
 Inherited
hostCreate(args:Array):void
CSHostObject
Property Detail
bottomLeftCornerOptionproperty
bottomLeftCornerOption:CornerOptions  [read-only]

Since : CS5

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


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

Since : CS5

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


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

Since : CS5

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


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

Since : CS5

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


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

Since : CS5

The end shape of an open path.


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

Since : CS5

The corner join applied to the PageItemDefault.


Implementation
    public function get endJoin():EndJoin
eventListenersproperty 
eventListeners:EventListeners  [read-only] [override]

Since : CS5

A collection of event listeners.


Implementation
    public function get eventListeners():EventListeners
eventsproperty 
events:Events  [read-only] [override]

Since : CS5

A collection of events.


Implementation
    public function get events():Events
fillColorproperty 
fillColor:Swatch  [read-only]

Since : CS5

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


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

Since : CS5

The percent of tint to use in the 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.)


Implementation
    public function get fillTint():Number
gapColorproperty 
gapColor:Swatch  [read-only]

Since : CS5

The swatch (color, gradient, tint, or mixed ink) applied to the gap of a dashed, dotted, or striped stroke. For information, see stroke type.


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

Since : CS5

The tint as a percentage of the gap color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.)


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

Since : CS5

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


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

Since : CS5

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


Implementation
    public function get gradientStrokeAngle():Number
isValidproperty 
isValid:Boolean  [read-only] [override]

Since : CS5

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
leftLineEndproperty 
leftLineEnd:ArrowHead  [read-only]

Since : CS5

The arrowhead applied to the start of the path.


Implementation
    public function get leftLineEnd():ArrowHead
miterLimitproperty 
miterLimit:Number  [read-only]

Since : CS5

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


Implementation
    public function get miterLimit():Number
nonprintingproperty 
nonprinting:Boolean  [read-only]

Since : CS5

If true, the PageItemDefault does not print.


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


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

Since : CS5

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


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

Since : CS5

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


Implementation
    public function get overprintStroke():Boolean
parentproperty 
parent:Object  [read-only] [override]

Since : CS5

The parent of the PageItemDefault (a Application or Document).


Implementation
    public function get parent():Object
propertiesproperty 
properties:Object[override]

Since : CS5

A property that allows setting of several properties at the same time.


Implementation
    public function get properties():Object
    public function set properties(value:Object):void
rightLineEndproperty 
rightLineEnd:ArrowHead  [read-only]

Since : CS5

The arrowhead applied to the end of the path.


Implementation
    public function get rightLineEnd():ArrowHead
strokeAlignmentproperty 
strokeAlignment:StrokeAlignment  [read-only]

Since : CS5

The stroke alignment applied to the PageItemDefault.


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

Since : CS5

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


Implementation
    public function get strokeColor():Swatch
strokeTintproperty 
strokeTint:Number  [read-only]

Since : CS5

The percent of tint to use in object's stroke color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.)


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

Since : CS5

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


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

Since : CS5

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


Implementation
    public function get strokeWeight():Object
topLeftCornerOptionproperty 
topLeftCornerOption:CornerOptions  [read-only]

Since : CS5

The shape to be applied to the top left corner of rectangular shapes and all corners of non-rectangular shapes.Note: corner option differs from end join in which you can set a radius for a corner option, whereas the rounded or beveled effect of an end join depends on the stroke weight.


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

Since : CS5

The radius in measurement units of the corner effect applied to the top left corner of rectangular shapes and all corners of non-rectangular shapes


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

Since : CS5

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


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

Since : CS5

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


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

Returns
EventListener
getElements()method 
override public function getElements():Object

Since : CS5

Resolves the object specifier, creating an array of object references.

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

Returns
Boolean
toSpecifier()method 
override public function toSpecifier():String

Since : CS5

Retrieves the object specifier.

Returns
String