Package | com.adobe.indesign |
Class | public class ClippingPathSettings |
Inheritance | ClippingPathSettings ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined 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 | ||
![]() | hostObjectDelegate : 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 |
Method | Defined By | ||
---|---|---|---|
addEventListenerClippingPathSettings(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | ClippingPathSettings | ||
![]() | addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | Preference | |
Converts the clipping path to a frame. | ClippingPathSettings | ||
![]() | 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. | ClippingPathSettings | ||
![]() | 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 | |
removeEventListenerClippingPathSettings(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | ClippingPathSettings | ||
![]() | 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. | ClippingPathSettings | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
alphaChannelPathNames | property |
alphaChannelPathNames:Object
[read-only] Since : | CS5 |
A list of the alpha channels stored in the graphic.
public function get alphaChannelPathNames():Object
appliedPathName | property |
appliedPathName:String
Since : | CS5 |
The name of the Photoshop path or alpha channel to use as a clipping path.
public function get appliedPathName():String
public function set appliedPathName(value:String):void
clippingType | property |
clippingType:ClippingPathType
Since : | CS5 |
The clipping path type.
public function get clippingType():ClippingPathType
public function set clippingType(value:ClippingPathType):void
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
includeInsideEdges | property |
includeInsideEdges:Boolean
Since : | CS5 |
If true, creates interior clipping paths within the surrounding clipping path. Note: Valid only when clipping type is alpha channel or detect edges.
public function get includeInsideEdges():Boolean
public function set includeInsideEdges(value:Boolean):void
insetFrame | property |
insetFrame:Object
Since : | CS5 |
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)
public function get insetFrame():Object
public function set insetFrame(value:Object):void
invertPath | property |
invertPath:Boolean
Since : | CS5 |
If true, inverts the clipping path.
public function get invertPath():Boolean
public function set invertPath(value:Boolean):void
isValid | property |
isValid:Boolean
[read-only] [override] Since : | CS5 |
Returns true if the object specifier resolves to valid objects.
public function get isValid():Boolean
parent | property |
parent:Object
[read-only] [override] Since : | CS5 |
The parent of the ClippingPathSettings (a Image, EPS, WMF, PICT, PDF or ImportedPage).
public function get parent():Object
paths | property |
paths:Paths
[read-only] Since : | CS5 |
A collection of paths.
public function get paths():Paths
photoshopPathNames | property |
photoshopPathNames:Object
[read-only] Since : | CS5 |
A list of the clipping paths stored in the graphic.
public function get photoshopPathNames():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
restrictToFrame | property |
restrictToFrame:Boolean
Since : | CS5 |
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.
public function get restrictToFrame():Boolean
public function set restrictToFrame(value:Boolean):void
threshold | property |
threshold:Number
Since : | CS5 |
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.
public function get threshold():Number
public function set threshold(value:Number):void
tolerance | property |
tolerance:Number
Since : | CS5 |
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.
public function get tolerance():Number
public function set tolerance(value:Number):void
useHighResolutionImage | property |
useHighResolutionImage:Boolean
Since : | CS5 |
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.
public function get useHighResolutionImage():Boolean
public function set useHighResolutionImage(value:Boolean):void
addEventListenerClippingPathSettings | () | method |
public function addEventListenerClippingPathSettings(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 |
convertToFrame | () | method |
public function convertToFrame():PageItem
Since : | CS5 |
Converts the clipping path to a frame.
ReturnsPageItem |
getElements | () | method |
override public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
removeEventListenerClippingPathSettings | () | method |
public function removeEventListenerClippingPathSettings(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 |