Adobe InCopy CS5 (7.0) Object Model JS: Tint

InCopy CS5

previous page next page

Class

Tint

A tint swatch. Base Class: Color

QuickLinks

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

Hierarchy

Application | Document

Color

Tint

Event | EventListener | MutationEvent

Properties

Property	Type	Access	Description
baseColor	Color	readonly	The color that the tint is based on.
colorValue	Array of number	readonly	The ink values that create the color, specified as a percentage for each ink. Note: The number of values required and the range depends on the color space. For RGB, specify three values, with each value in the range 0 to 255; for CMYK, specify four values representing C, M, Y, and K, with each value in the range 0 to 100; for LAB, specify three values representing L (Range: 0 to 100), A (Range: -128 to 127), and B (Range: -128 to 127); for mixed ink, specify values for each ink in the ink list, with each value in the range 0 to 100.
eventListeners	EventListeners	readonly	A collection of event listeners.
events	Events	readonly	A collection of events.
id	number	readonly	The unique ID of the Tint.
index	number	readonly	The index of the Tint within its containing object.
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.
model	ColorModel: ColorModel.PROCESS ColorModel.REGISTRATION	readonly	The color model.
name	string	readonly	The name of the Tint.
parent	Application Document	readonly	The parent of the Tint (a Application or Document).
properties	Object	r/w	A property that allows setting of several properties at the same time.
space	ColorSpace: ColorSpace.RGB ColorSpace.CMYK ColorSpace.LAB ColorSpace.MIXEDINK	readonly	The color space.
tintValue	number (range: 0 - 100)	r/w	The percent of the base color. (Range: 0 to 100)

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)

Tint duplicate ()
Duplicates the Tint.

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

Parameter	Type	Description
key	string	The key.

Array of Tint 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.

Swatch merge (with: varies)
Merges the specified swatches with the swatch.

Parameter	Type	Description
with	Array of Swatches String Swatch	The swatches to merge. Can accept: Array of Swatches, Swatch or String.

void remove ([replacingWith: Swatch])
Deletes the swatch.

Parameter	Type	Description
replacingWith	Swatch	The swatch to apply in place of the deleted swatch. (Optional)

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)