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

Preference



Public Properties
 PropertyDefined By
  appliedGraphicObjectStyle : ObjectStyle
The default graphic object style applied to the PageItemDefault.
PageItemDefault
  appliedGridObjectStyle : ObjectStyle
The default frame grid object style applied to the PageItemDefault.
PageItemDefault
  appliedTextObjectStyle : ObjectStyle
The default text object style applied to the PageItemDefault.
PageItemDefault
  bottomLeftCornerOption : CornerOptions
The shape to apply to the bottom left corner of rectangular shapes.
PageItemDefault
  bottomLeftCornerRadius : Object
The radius in measurement units of the corner effect applied to the bottom left corner of rectangular shapes
PageItemDefault
  bottomRightCornerOption : CornerOptions
The shape to apply to the bottom right corner of rectangular shapes.
PageItemDefault
  bottomRightCornerRadius : Object
The radius in measurement units of the corner effect applied to the bottom right corner of rectangular shapes
PageItemDefault
  contentTransparencySettings : ContentTransparencySetting
[read-only] Transparency settings for the content of the PageItemDefault.
PageItemDefault
  endCap : EndCap
The end shape of an open path.
PageItemDefault
  endJoin : EndJoin
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
The swatch (color, gradient, tint, or mixed ink) applied to the fill of the PageItemDefault.
PageItemDefault
  fillTint : Number
The percent of tint to use in the PageItemDefault's fill color.
PageItemDefault
  fillTransparencySettings : FillTransparencySetting
[read-only] Transparency settings for the fill applied to the PageItemDefault.
PageItemDefault
  gapColor : Swatch
The swatch (color, gradient, tint, or mixed ink) applied to the gap of a dashed, dotted, or striped stroke.
PageItemDefault
  gapTint : Number
The tint as a percentage of the gap color.
PageItemDefault
  gradientFillAngle : Number
The angle of a linear gradient applied to the fill of the PageItemDefault.
PageItemDefault
  gradientStrokeAngle : Number
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
The arrowhead applied to the start of the path.
PageItemDefault
  miterLimit : Number
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
If true, the PageItemDefault does not print.
PageItemDefault
  overprintFill : Boolean
If true, the PageItemDefault's fill color overprints any underlying objects.
PageItemDefault
  overprintGap : Boolean
If true, the gap color overprints any underlying colors.
PageItemDefault
  overprintStroke : Boolean
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
  preferences : Preferences
[read-only] A collection of preferences objects.
PageItemDefault
  properties : Object
[override] A property that allows setting of several properties at the same time.
PageItemDefault
  rightLineEnd : ArrowHead
The arrowhead applied to the end of the path.
PageItemDefault
  strokeAlignment : StrokeAlignment
The stroke alignment applied to the PageItemDefault.
PageItemDefault
  strokeColor : Swatch
The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the PageItemDefault.
PageItemDefault
  strokeTint : Number
The percent of tint to use in object's stroke color.
PageItemDefault
  strokeTransparencySettings : StrokeTransparencySetting
[read-only] Transparency settings for the stroke.
PageItemDefault
  strokeType : StrokeStyle
The name of the stroke style to apply.
PageItemDefault
  strokeWeight : Object
The weight (in points) to apply to the PageItemDefault's stroke.
PageItemDefault
  topLeftCornerOption : CornerOptions
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
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
The shape to apply to the top right corner of rectangular shapes
PageItemDefault
  topRightCornerRadius : Object
The radius in measurement units of the corner effect applied to the top right corner of rectangular shapes
PageItemDefault
  transparencySettings : TransparencySetting
[read-only] Transparency settings.
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
  
applyObjectStyle(usingParam:ObjectStyle = null, clearingOverridesParam:Boolean = true, clearingOverridesThroughRootObjectStyleParam:Boolean = false):void
Applies the specified object style.
PageItemDefault
  
Clear overrides for object style
PageItemDefault
 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
appliedGraphicObjectStyleproperty
appliedGraphicObjectStyle:ObjectStyle

The default graphic object style applied to the PageItemDefault. Can also accept: String.


Implementation
    public function get appliedGraphicObjectStyle():ObjectStyle
    public function set appliedGraphicObjectStyle(value:ObjectStyle):void
appliedGridObjectStyleproperty 
appliedGridObjectStyle:ObjectStyle

The default frame grid object style applied to the PageItemDefault. Can also accept: String.


Implementation
    public function get appliedGridObjectStyle():ObjectStyle
    public function set appliedGridObjectStyle(value:ObjectStyle):void
appliedTextObjectStyleproperty 
appliedTextObjectStyle:ObjectStyle

The default text object style applied to the PageItemDefault. Can also accept: String.


Implementation
    public function get appliedTextObjectStyle():ObjectStyle
    public function set appliedTextObjectStyle(value:ObjectStyle):void
bottomLeftCornerOptionproperty 
bottomLeftCornerOption:CornerOptions

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


Implementation
    public function get bottomLeftCornerOption():CornerOptions
    public function set bottomLeftCornerOption(value:CornerOptions):void
bottomLeftCornerRadiusproperty 
bottomLeftCornerRadius:Object

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


Implementation
    public function get bottomLeftCornerRadius():Object
    public function set bottomLeftCornerRadius(value:Object):void
bottomRightCornerOptionproperty 
bottomRightCornerOption:CornerOptions

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


Implementation
    public function get bottomRightCornerOption():CornerOptions
    public function set bottomRightCornerOption(value:CornerOptions):void
bottomRightCornerRadiusproperty 
bottomRightCornerRadius:Object

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


Implementation
    public function get bottomRightCornerRadius():Object
    public function set bottomRightCornerRadius(value:Object):void
contentTransparencySettingsproperty 
contentTransparencySettings:ContentTransparencySetting  [read-only]

Transparency settings for the content of the PageItemDefault.


Implementation
    public function get contentTransparencySettings():ContentTransparencySetting
endCapproperty 
endCap:EndCap

The end shape of an open path.


Implementation
    public function get endCap():EndCap
    public function set endCap(value:EndCap):void
endJoinproperty 
endJoin:EndJoin

The corner join applied to the PageItemDefault.


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

A collection of event listeners.


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

A collection of events.


Implementation
    public function get events():Events
fillColorproperty 
fillColor:Swatch

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
    public function set fillColor(value:Swatch):void
fillTintproperty 
fillTint:Number

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
    public function set fillTint(value:Number):void
fillTransparencySettingsproperty 
fillTransparencySettings:FillTransparencySetting  [read-only]

Transparency settings for the fill applied to the PageItemDefault.


Implementation
    public function get fillTransparencySettings():FillTransparencySetting
gapColorproperty 
gapColor:Swatch

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
    public function set gapColor(value:Swatch):void
gapTintproperty 
gapTint:Number

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
    public function set gapTint(value:Number):void
gradientFillAngleproperty 
gradientFillAngle:Number

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


Implementation
    public function get gradientFillAngle():Number
    public function set gradientFillAngle(value:Number):void
gradientStrokeAngleproperty 
gradientStrokeAngle:Number

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


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

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
leftLineEndproperty 
leftLineEnd:ArrowHead

The arrowhead applied to the start of the path.


Implementation
    public function get leftLineEnd():ArrowHead
    public function set leftLineEnd(value:ArrowHead):void
miterLimitproperty 
miterLimit:Number

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
    public function set miterLimit(value:Number):void
nonprintingproperty 
nonprinting:Boolean

If true, the PageItemDefault does not print.


Implementation
    public function get nonprinting():Boolean
    public function set nonprinting(value:Boolean):void
overprintFillproperty 
overprintFill:Boolean

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
    public function set overprintFill(value:Boolean):void
overprintGapproperty 
overprintGap:Boolean

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
    public function set overprintGap(value:Boolean):void
overprintStrokeproperty 
overprintStroke:Boolean

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
    public function set overprintStroke(value:Boolean):void
parentproperty 
parent:Object  [read-only] [override]

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


Implementation
    public function get parent():Object
preferencesproperty 
preferences:Preferences  [read-only]

A collection of preferences objects.


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

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

The arrowhead applied to the end of the path.


Implementation
    public function get rightLineEnd():ArrowHead
    public function set rightLineEnd(value:ArrowHead):void
strokeAlignmentproperty 
strokeAlignment:StrokeAlignment

The stroke alignment applied to the PageItemDefault.


Implementation
    public function get strokeAlignment():StrokeAlignment
    public function set strokeAlignment(value:StrokeAlignment):void
strokeColorproperty 
strokeColor:Swatch

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
    public function set strokeColor(value:Swatch):void
strokeTintproperty 
strokeTint:Number

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
    public function set strokeTint(value:Number):void
strokeTransparencySettingsproperty 
strokeTransparencySettings:StrokeTransparencySetting  [read-only]

Transparency settings for the stroke.


Implementation
    public function get strokeTransparencySettings():StrokeTransparencySetting
strokeTypeproperty 
strokeType:StrokeStyle

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


Implementation
    public function get strokeType():StrokeStyle
    public function set strokeType(value:StrokeStyle):void
strokeWeightproperty 
strokeWeight:Object

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


Implementation
    public function get strokeWeight():Object
    public function set strokeWeight(value:Object):void
topLeftCornerOptionproperty 
topLeftCornerOption:CornerOptions

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
    public function set topLeftCornerOption(value:CornerOptions):void
topLeftCornerRadiusproperty 
topLeftCornerRadius:Object

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
    public function set topLeftCornerRadius(value:Object):void
topRightCornerOptionproperty 
topRightCornerOption:CornerOptions

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


Implementation
    public function get topRightCornerOption():CornerOptions
    public function set topRightCornerOption(value:CornerOptions):void
topRightCornerRadiusproperty 
topRightCornerRadius:Object

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


Implementation
    public function get topRightCornerRadius():Object
    public function set topRightCornerRadius(value:Object):void
transparencySettingsproperty 
transparencySettings:TransparencySetting  [read-only]

Transparency settings.


Implementation
    public function get transparencySettings():TransparencySetting
Method Detail
addEventListenerPageItemDefault()method
public function addEventListenerPageItemDefault(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener

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
applyObjectStyle()method 
public function applyObjectStyle(usingParam:ObjectStyle = null, clearingOverridesParam:Boolean = true, clearingOverridesThroughRootObjectStyleParam:Boolean = false):void

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 PageItemDefault's existing attributes before applying the style. (Optional)
 
clearingOverridesThroughRootObjectStyleParam:Boolean (default = false) — (Boolean) If true, clears attributes and formatting applied to the PageItemDefault that are not defined in the object style. (Optional)

clearObjectStyleOverrides()method 
public function clearObjectStyleOverrides():void

Clear overrides for object style

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

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

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

Retrieves the object specifier.

Returns
String