Package | com.adobe.incopy |
Class | public class TrapPreset |
Inheritance | TrapPreset ![]() ![]() |
Since : | CS5 |
Property | Defined 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 | ||
![]() | hostObjectDelegate : 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 |
Method | Defined 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 | ||
![]() | 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
Resolves the object specifier, creating an array of object references. | TrapPreset | ||
![]() | 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 | |
insertLabel(keyParam:String = null, valueParam:String = null):void
Sets the label to the value associated with the specified key. | TrapPreset | ||
![]() | 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 | ||
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
toSpecifier():String
Retrieves the object specifier. | TrapPreset | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
blackColorThreshold | property |
blackColorThreshold:Number
Since : | CS5 |
The minimum amount (as a percentage) of black ink required before the black width setting is applied. (Range: 0 to 100)
public function get blackColorThreshold():Number
public function set blackColorThreshold(value:Number):void
blackDensity | property |
blackDensity:Number
Since : | CS5 |
The neutral density value at or above which an ink is considered black. (Range: .001 to 10)
public function get blackDensity():Number
public function set blackDensity(value:Number):void
blackWidth | property |
blackWidth:Object
Since : | CS5 |
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)
public function get blackWidth():Object
public function set blackWidth(value:Object):void
colorReduction | property |
colorReduction:Number
Since : | CS5 |
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.
public function get colorReduction():Number
public function set colorReduction(value:Number):void
defaultTrapWidth | property |
defaultTrapWidth:Object
Since : | CS5 |
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)
public function get defaultTrapWidth():Object
public function set defaultTrapWidth(value:Object):void
eventListeners | property |
eventListeners:EventListeners
[read-only] Since : | CS5 |
A collection of event listeners.
public function get eventListeners():EventListeners
events | property |
events:Events
[read-only] Since : | CS5 |
A collection of events.
public function get events():Events
id | property |
id:Number
[read-only] Since : | CS5 |
The unique ID of the TrapPreset.
public function get id():Number
imagePlacement | property |
imagePlacement:TrapImagePlacementTypes
Since : | CS5 |
The trap placement between vector objects and bitmap images.
public function get imagePlacement():TrapImagePlacementTypes
public function set imagePlacement(value:TrapImagePlacementTypes):void
imagesToImages | property |
imagesToImages:Boolean
Since : | CS5 |
If true, turns on trapping along the boundary of overlapping or abutting bitmap images.
public function get imagesToImages():Boolean
public function set imagesToImages(value:Boolean):void
index | property |
index:Number
[read-only] Since : | CS5 |
The index of the TrapPreset within its containing object.
public function get index():Number
internalImages | property |
internalImages:Boolean
Since : | CS5 |
If true, turns on trapping among colors within individual bitmap images.
public function get internalImages():Boolean
public function set internalImages(value:Boolean):void
isValid | property |
isValid:Boolean
[read-only] Since : | CS5 |
Returns true if the object specifier resolves to valid objects.
public function get isValid():Boolean
label | property |
label:String
Since : | CS5 |
A property that can be set to any string.
public function get label():String
public function set label(value:String):void
name | property |
name:String
Since : | CS5 |
The name of the TrapPreset.
public function get name():String
public function set name(value:String):void
objectsToImages | property |
objectsToImages:Boolean
Since : | CS5 |
If true, ensures that vector objects overlap bitmap images.
public function get objectsToImages():Boolean
public function set objectsToImages(value:Boolean):void
oneBitImages | property |
oneBitImages:Boolean
Since : | CS5 |
If true, ensures that one-bit images trap to abutting objects.
public function get oneBitImages():Boolean
public function set oneBitImages(value:Boolean):void
parent | property |
parent:Object
[read-only] Since : | CS5 |
The parent of the TrapPreset (a Application or Document).
public function get parent():Object
properties | property |
properties:Object
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
slidingTrapThreshold | property |
slidingTrapThreshold:Number
Since : | CS5 |
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)
public function get slidingTrapThreshold():Number
public function set slidingTrapThreshold(value:Number):void
stepThreshold | property |
stepThreshold:Number
Since : | CS5 |
The amount (as a percentage) that components of abutting colors must vary before a trap is created. (Range: 1 to 100)
public function get stepThreshold():Number
public function set stepThreshold(value:Number):void
trapEnd | property |
trapEnd:TrapEndTypes
Since : | CS5 |
The shape to use at the intersection of three-way traps.
public function get trapEnd():TrapEndTypes
public function set trapEnd(value:TrapEndTypes):void
trapJoin | property |
trapJoin:EndJoin
Since : | CS5 |
The join type of the trap preset.
public function get trapJoin():EndJoin
public function set trapJoin(value:EndJoin):void
addEventListenerTrapPreset | () | method |
public function addEventListenerTrapPreset(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 |
duplicate | () | method |
extractLabel | () | method |
public function extractLabel(keyParam:String = null):String
Since : | CS5 |
Gets the label value associated with the specified key.
Parameters
keyParam:String (default = null ) — (String) The key.
|
String |
getElements | () | method |
public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
insertLabel | () | method |
public function insertLabel(keyParam:String = null, valueParam:String = null):void
Since : | CS5 |
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
Since : | CS5 |
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
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 |
public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |