Packagecom.adobe.indesign
Classpublic class ClippingPathSettings
InheritanceClippingPathSettings Inheritance Preference Inheritance CSHostObject Inheritance flash.utils.Proxy

Preference



Public Properties
 PropertyDefined By
  alphaChannelPathNames : Object
[read-only] A list of the alpha channels stored in the graphic.
ClippingPathSettings
  appliedPathName : String
The name of the Photoshop path or alpha channel to use as a clipping path.
ClippingPathSettings
  clippingType : ClippingPathType
The clipping path type.
ClippingPathSettings
  eventListeners : EventListeners
[override] [read-only] A collection of event listeners.
ClippingPathSettings
  events : Events
[override] [read-only] A collection of events.
ClippingPathSettings
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  includeInsideEdges : Boolean
If true, creates interior clipping paths within the surrounding clipping path.
ClippingPathSettings
  insetFrame : Object
Shrinks the area enclosed by the clipping path by the specified amount.
ClippingPathSettings
  invertPath : Boolean
If true, inverts the clipping path.
ClippingPathSettings
  isValid : Boolean
[override] [read-only] Returns true if the object specifier resolves to valid objects.
ClippingPathSettings
  parent : Object
[override] [read-only] The parent of the ClippingPathSettings (a Image, EPS, WMF, PICT, PDF or ImportedPage).
ClippingPathSettings
  paths : Paths
[read-only] A collection of paths.
ClippingPathSettings
  photoshopPathNames : Object
[read-only] A list of the clipping paths stored in the graphic.
ClippingPathSettings
  properties : Object
[override] A property that allows setting of several properties at the same time.
ClippingPathSettings
  restrictToFrame : Boolean
If true, truncates the clipping path at the edge of the frame containing the graphic.
ClippingPathSettings
  threshold : Number
The lowest value (darkest) pixel to allow in the image.
ClippingPathSettings
  tolerance : Number
Specifies how similar a pixel's intensity value can be to the threshold value before the pixel is obscured by the clipping path.
ClippingPathSettings
  useHighResolutionImage : Boolean
If true, uses the high-resolution version of the graphic to create the clipping path.
ClippingPathSettings
Public Methods
 MethodDefined By
  
addEventListenerClippingPathSettings(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
ClippingPathSettings
 Inherited
addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
Preference
  
Converts the clipping path to a frame.
ClippingPathSettings
 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.
ClippingPathSettings
 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
  
removeEventListenerClippingPathSettings(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
ClippingPathSettings
 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.
ClippingPathSettings
 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
alphaChannelPathNamesproperty
alphaChannelPathNames:Object  [read-only]

A list of the alpha channels stored in the graphic.


Implementation
    public function get alphaChannelPathNames():Object
appliedPathNameproperty 
appliedPathName:String

The name of the Photoshop path or alpha channel to use as a clipping path.


Implementation
    public function get appliedPathName():String
    public function set appliedPathName(value:String):void
clippingTypeproperty 
clippingType:ClippingPathType

The clipping path type.


Implementation
    public function get clippingType():ClippingPathType
    public function set clippingType(value:ClippingPathType):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
includeInsideEdgesproperty 
includeInsideEdges:Boolean

If true, creates interior clipping paths within the surrounding clipping path. Note: Valid only when clipping type is alpha channel or detect edges.


Implementation
    public function get includeInsideEdges():Boolean
    public function set includeInsideEdges(value:Boolean):void
insetFrameproperty 
insetFrame:Object

Shrinks the area enclosed by the clipping path by the specified amount. (Range depends on the unit. For points: -10000 to 10000; picas: -833p4 to 833p4; inches: -138.8889 to 138.8889; mm: -3527.778 to 3527.778; cm: -352.7778 to 352.7778; ciceros: -781c11.889 to 781c11.889)


Implementation
    public function get insetFrame():Object
    public function set insetFrame(value:Object):void
invertPathproperty 
invertPath:Boolean

If true, inverts the clipping path.


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

Returns true if the object specifier resolves to valid objects.


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

The parent of the ClippingPathSettings (a Image, EPS, WMF, PICT, PDF or ImportedPage).


Implementation
    public function get parent():Object
pathsproperty 
paths:Paths  [read-only]

A collection of paths.


Implementation
    public function get paths():Paths
photoshopPathNamesproperty 
photoshopPathNames:Object  [read-only]

A list of the clipping paths stored in the graphic.


Implementation
    public function get photoshopPathNames():Object
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
restrictToFrameproperty 
restrictToFrame:Boolean

If true, truncates the clipping path at the edge of the frame containing the graphic. Note: Valid only when clipping type is alpha channel or detect edges.


Implementation
    public function get restrictToFrame():Boolean
    public function set restrictToFrame(value:Boolean):void
thresholdproperty 
threshold:Number

The lowest value (darkest) pixel to allow in the image. All pixels in the image whose values are greater than (lighter than) the threshold value are clipped (obscured). (Range: 0 to 255) Note: Valid only when clipping type is detect edges or alpha channel.


Implementation
    public function get threshold():Number
    public function set threshold(value:Number):void
toleranceproperty 
tolerance:Number

Specifies how similar a pixel's intensity value can be to the threshold value before the pixel is obscured by the clipping path. (Range: 0 to 10) Note: Valid only when clipping type is detect edges or alpha channel.


Implementation
    public function get tolerance():Number
    public function set tolerance(value:Number):void
useHighResolutionImageproperty 
useHighResolutionImage:Boolean

If true, uses the high-resolution version of the graphic to create the clipping path. If false, calculates the clipping path based on screen-display resolution. Note: Valid only when clipping type is detect edges.


Implementation
    public function get useHighResolutionImage():Boolean
    public function set useHighResolutionImage(value:Boolean):void
Method Detail
addEventListenerClippingPathSettings()method
public function addEventListenerClippingPathSettings(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
convertToFrame()method 
public function convertToFrame():PageItem

Converts the clipping path to a frame.

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

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

Returns
Object
removeEventListenerClippingPathSettings()method 
public function removeEventListenerClippingPathSettings(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