Adobe InCopy CS5.5 (7.5) Object Model JS: Tint

InCopy CS5.5

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

PropertyTypeAccessDescription
baseColorColor readonlyThe color that the tint is based on.
colorValue Array of number readonlyThe 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.
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
idnumber readonlyThe unique ID of the Tint.
indexnumber readonlyThe index of the Tint within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
labelstring r/wA property that can be set to any string.
modelColorModel:
ColorModel.PROCESS
ColorModel.REGISTRATION
readonlyThe color model.
namestring readonlyThe name of the Tint.
parentApplication
Document
readonlyThe parent of the Tint (a Application or Document).
propertiesObject r/wA property that allows setting of several properties at the same time.
spaceColorSpace:
ColorSpace.RGB
ColorSpace.CMYK
ColorSpace.LAB
ColorSpace.MIXEDINK
readonlyThe color space.
tintValuenumber (range: 0 - 100) r/wThe percent of the base color. (Range: 0 to 100)

Methods

Instances

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

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

Tint duplicate ()
Duplicates the Tint.

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

ParameterTypeDescription
keystringThe 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.

ParameterTypeDescription
keystringThe key.
valuestringThe value.

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

ParameterTypeDescription
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.

ParameterTypeDescription
replacingWithSwatchThe swatch to apply in place of the deleted swatch. (Optional)

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

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

string toSource ()
Generates a string which, if executed, will return the Tint.

string toSpecifier ()
Retrieves the object specifier.

Used in:

Tint Tints.nextItem (obj: Tint)

Tint Tints.previousItem (obj: Tint)

Return

Tint Tint.duplicate ()

Array of Tint Tint.getElements ()

Tint Tints.[] (index: number)

Tint Tints.add (baseColor: Color[, withProperties: Object])

Tint Tints.anyItem ()

Array of Tint Tints.everyItem ()

Tint Tints.firstItem ()

Tint Tints.item (index: varies)

Tint Tints.itemByID (id: number)

Tint Tints.itemByName (name: string)

Array of Tint Tints.itemByRange (from: varies, to: varies)

Tint Tints.lastItem ()

Tint Tints.middleItem ()

Tint Tints.nextItem (obj: Tint)

Tint Tints.previousItem (obj: Tint)

Jongware, 29-Apr-2012 v3.0.3iContents :: Index