Adobe InCopy CS5 (7.0) Object Model JS: TrapPreset

InCopy CS5

previous page next page

Class

TrapPreset

A trap preset.

QuickLinks

addEventListener, duplicate, extractLabel, getElements, insertLabel, remove, removeEventListener, toSource, toSpecifier

Hierarchy

Application | Document

TrapPreset

Event | EventListener | MutationEvent

Properties

Property	Type	Access	Description
blackColorThreshold	number (range: 0 - 100)	r/w	The minimum amount (as a percentage) of black ink required before the black width setting is applied. (Range: 0 to 100)
blackDensity	number (range: 0 - 10)	r/w	The neutral density value at or above which an ink is considered black. (Range: .001 to 10)
blackWidth	Measurement Unit (Number or String) (range: 0 - 8)	r/w	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)
colorReduction	number (range: 0 - 100)	r/w	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.
defaultTrapWidth	Measurement Unit (Number or String) (range: 0 - 8)	r/w	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)
eventListeners	EventListeners	readonly	A collection of event listeners.
events	Events	readonly	A collection of events.
id	number	readonly	The unique ID of the TrapPreset.
imagePlacement	TrapImagePlacementTypes: TrapImagePlacementTypes.CENTER_EDGES TrapImagePlacementTypes.CHOKE TrapImagePlacementTypes.IMAGE_NEUTRAL_DENSITY TrapImagePlacementTypes.IMAGES_OVER_SPREAD	r/w	The trap placement between vector objects and bitmap images.
imagesToImages	bool	r/w	If true, turns on trapping along the boundary of overlapping or abutting bitmap images.
index	number	readonly	The index of the TrapPreset within its containing object.
internalImages	bool	r/w	If true, turns on trapping among colors within individual bitmap images.
isValid	bool	readonly	Returns true if the object specifier resolves to valid objects.
label	string	r/w	A property that can be set to any string.
name	string	r/w	The name of the TrapPreset.
objectsToImages	bool	r/w	If true, ensures that vector objects overlap bitmap images.
oneBitImages	bool	r/w	If true, ensures that one-bit images trap to abutting objects.
parent	Application Document	readonly	The parent of the TrapPreset (a Application or Document).
properties	Object	r/w	A property that allows setting of several properties at the same time.
slidingTrapThreshold	number (range: 0 - 100)	r/w	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)
stepThreshold	number (range: 1 - 100)	r/w	The amount (as a percentage) that components of abutting colors must vary before a trap is created. (Range: 1 to 100)
trapEnd	TrapEndTypes: TrapEndTypes.MITER_TRAP_ENDS TrapEndTypes.OVERLAP_TRAP_ENDS	r/w	The shape to use at the intersection of three-way traps.
trapJoin	EndJoin: EndJoin.MITER_END_JOIN EndJoin.ROUND_END_JOIN EndJoin.BEVEL_END_JOIN	r/w	The join type of the trap preset.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

Parameter	Type	Description
eventType	string	The event type.
handler	File JavaScript Function	The event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)

TrapPreset duplicate ()
Duplicates the TrapPreset.

string extractLabel (key: string)
Gets the label value associated with the specified key.

Parameter	Type	Description
key	string	The key.

Array of TrapPreset getElements ()
Resolves the object specifier, creating an array of object references.

void insertLabel (key: string, value: string)
Sets the label to the value associated with the specified key.

Parameter	Type	Description
key	string	The key.
value	string	The value.

void remove (replacingWith: TrapPreset)
Deletes the trap preset.

Parameter	Type	Description
replacingWith	TrapPreset	The trap preset to apply in place of the deleted preset.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

Parameter	Type	Description
eventType	string	The registered event type.
handler	File JavaScript Function	The registered event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)