Packagecom.adobe.indesign
Classpublic class TrapPreset
InheritanceTrapPreset Inheritance CSHostObject Inheritance flash.utils.Proxy



Public Properties
 PropertyDefined By
  blackColorThreshold : Number
The minimum amount (as a percentage) of black ink required before the black width setting is applied.
TrapPreset
  blackDensity : Number
The neutral density value at or above which an ink is considered black.
TrapPreset
  blackWidth : Object
The black width.
TrapPreset
  colorReduction : Number
The degree (as a percentage) to which components from abutting colors are used to reduce the trap color.
TrapPreset
  defaultTrapWidth : Object
The default width for trapping all colors except those involving solid black.
TrapPreset
  eventListeners : EventListeners
[read-only] A collection of event listeners.
TrapPreset
  events : Events
[read-only] A collection of events.
TrapPreset
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  id : Number
[read-only] The unique ID of the TrapPreset.
TrapPreset
  imagePlacement : TrapImagePlacementTypes
The trap placement between vector objects and bitmap images.
TrapPreset
  imagesToImages : Boolean
If true, turns on trapping along the boundary of overlapping or abutting bitmap images.
TrapPreset
  index : Number
[read-only] The index of the TrapPreset within its containing object.
TrapPreset
  internalImages : Boolean
If true, turns on trapping among colors within individual bitmap images.
TrapPreset
  isValid : Boolean
[read-only] Returns true if the object specifier resolves to valid objects.
TrapPreset
  label : String
A property that can be set to any string.
TrapPreset
  name : String
The name of the TrapPreset.
TrapPreset
  objectsToImages : Boolean
If true, ensures that vector objects overlap bitmap images.
TrapPreset
  oneBitImages : Boolean
If true, ensures that one-bit images trap to abutting objects.
TrapPreset
  parent : Object
[read-only] The parent of the TrapPreset (a Application or Document).
TrapPreset
  properties : Object
A property that allows setting of several properties at the same time.
TrapPreset
  slidingTrapThreshold : Number
The difference (as a percentage) between the neutral densities of abutting colors at which the trap is moved from the darker side of a color edge toward the centerline.
TrapPreset
  stepThreshold : Number
The amount (as a percentage) that components of abutting colors must vary before a trap is created.
TrapPreset
  trapEnd : TrapEndTypes
The shape to use at the intersection of three-way traps.
TrapPreset
  trapJoin : EndJoin
The join type of the trap preset.
TrapPreset
Public Methods
 MethodDefined By
  
addEventListenerTrapPreset(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
TrapPreset
  
Duplicates the TrapPreset.
TrapPreset
  
extractLabel(keyParam:String = null):String
Gets the label value associated with the specified key.
TrapPreset
 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
Resolves the object specifier, creating an array of object references.
TrapPreset
 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
  
insertLabel(keyParam:String = null, valueParam:String = null):void
Sets the label to the value associated with the specified key.
TrapPreset
 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
  
remove(replacingWithParam:TrapPreset = null):void
Deletes the trap preset.
TrapPreset
  
removeEventListenerTrapPreset(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
TrapPreset
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
toSpecifier():String
Retrieves the object specifier.
TrapPreset
 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
blackColorThresholdproperty
blackColorThreshold:Number

The minimum amount (as a percentage) of black ink required before the black width setting is applied. (Range: 0 to 100)


Implementation
    public function get blackColorThreshold():Number
    public function set blackColorThreshold(value:Number):void
blackDensityproperty 
blackDensity:Number

The neutral density value at or above which an ink is considered black. (Range: .001 to 10)


Implementation
    public function get blackDensity():Number
    public function set blackDensity(value:Number):void
blackWidthproperty 
blackWidth:Object

The black width. (Range depends on unit. For points: 0.0 to 8.0; picas: 0p0 to 0p8; inches: 0 to 0.1111; mm: 0 to 2.822; cm: 0 to .2822; ciceros: 0c0 to 0c7.507)


Implementation
    public function get blackWidth():Object
    public function set blackWidth(value:Object):void
colorReductionproperty 
colorReduction:Number

The degree (as a percentage) to which components from abutting colors are used to reduce the trap color. (Range: 0 to 100) Note: 0% makes a trap whose neutral density is equal to the neutral density of the darker color.


Implementation
    public function get colorReduction():Number
    public function set colorReduction(value:Number):void
defaultTrapWidthproperty 
defaultTrapWidth:Object

The default width for trapping all colors except those involving solid black. (Range depends on unit. For points: 0.0 to 8.0; picas: 0p0 to 0p8; inches: 0 to 0.1111; mm: 0 to 2.822; cm: 0 to .2822; ciceros: 0c0 to 0c7.507)


Implementation
    public function get defaultTrapWidth():Object
    public function set defaultTrapWidth(value:Object):void
eventListenersproperty 
eventListeners:EventListeners  [read-only]

A collection of event listeners.


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

A collection of events.


Implementation
    public function get events():Events
idproperty 
id:Number  [read-only]

The unique ID of the TrapPreset.


Implementation
    public function get id():Number
imagePlacementproperty 
imagePlacement:TrapImagePlacementTypes

The trap placement between vector objects and bitmap images.


Implementation
    public function get imagePlacement():TrapImagePlacementTypes
    public function set imagePlacement(value:TrapImagePlacementTypes):void
imagesToImagesproperty 
imagesToImages:Boolean

If true, turns on trapping along the boundary of overlapping or abutting bitmap images.


Implementation
    public function get imagesToImages():Boolean
    public function set imagesToImages(value:Boolean):void
indexproperty 
index:Number  [read-only]

The index of the TrapPreset within its containing object.


Implementation
    public function get index():Number
internalImagesproperty 
internalImages:Boolean

If true, turns on trapping among colors within individual bitmap images.


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

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
labelproperty 
label:String

A property that can be set to any string.


Implementation
    public function get label():String
    public function set label(value:String):void
nameproperty 
name:String

The name of the TrapPreset.


Implementation
    public function get name():String
    public function set name(value:String):void
objectsToImagesproperty 
objectsToImages:Boolean

If true, ensures that vector objects overlap bitmap images.


Implementation
    public function get objectsToImages():Boolean
    public function set objectsToImages(value:Boolean):void
oneBitImagesproperty 
oneBitImages:Boolean

If true, ensures that one-bit images trap to abutting objects.


Implementation
    public function get oneBitImages():Boolean
    public function set oneBitImages(value:Boolean):void
parentproperty 
parent:Object  [read-only]

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


Implementation
    public function get parent():Object
propertiesproperty 
properties:Object

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
slidingTrapThresholdproperty 
slidingTrapThreshold:Number

The difference (as a percentage) between the neutral densities of abutting colors at which the trap is moved from the darker side of a color edge toward the centerline. (Range: 0 to 100)


Implementation
    public function get slidingTrapThreshold():Number
    public function set slidingTrapThreshold(value:Number):void
stepThresholdproperty 
stepThreshold:Number

The amount (as a percentage) that components of abutting colors must vary before a trap is created. (Range: 1 to 100)


Implementation
    public function get stepThreshold():Number
    public function set stepThreshold(value:Number):void
trapEndproperty 
trapEnd:TrapEndTypes

The shape to use at the intersection of three-way traps.


Implementation
    public function get trapEnd():TrapEndTypes
    public function set trapEnd(value:TrapEndTypes):void
trapJoinproperty 
trapJoin:EndJoin

The join type of the trap preset.


Implementation
    public function get trapJoin():EndJoin
    public function set trapJoin(value:EndJoin):void
Method Detail
addEventListenerTrapPreset()method
public function addEventListenerTrapPreset(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
duplicate()method 
public function duplicate():TrapPreset

Duplicates the TrapPreset.

Returns
TrapPreset
extractLabel()method 
public function extractLabel(keyParam:String = null):String

Gets the label value associated with the specified key.

Parameters

keyParam:String (default = null) — (String) The key.

Returns
String
getElements()method 
public function getElements():Object

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

Returns
Object
insertLabel()method 
public function insertLabel(keyParam:String = null, valueParam:String = null):void

Sets the label to the value associated with the specified key.

Parameters

keyParam:String (default = null) — (String) The key.
 
valueParam:String (default = null) — (String) The value.

remove()method 
public function remove(replacingWithParam:TrapPreset = null):void

Deletes the trap preset.

Parameters

replacingWithParam:TrapPreset (default = null) — (TrapPreset) The trap preset to apply in place of the deleted preset.

removeEventListenerTrapPreset()method 
public function removeEventListenerTrapPreset(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 
public function toSpecifier():String

Retrieves the object specifier.

Returns
String