Adobe InDesign CS5 (7.0) Object Model JS: CompositeFontEntry

InDesign CS5

Class

CompositeFontEntry

 A composite font entry.

QuickLinks

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

Hierarchy

CompositeFont
CompositeFontEntry
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
appliedFontFontString r/wThe font applied to the CompositeFontEntry, specified as either a font object or the name of font family. Can return: Font or String.
baselineShiftnumber r/wThe amount of baseline shift.
customCharactersstring r/wThe characters that the set affects.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
fontStylestring r/wThe name of the font style.
horizontalScalenumber r/wThe horizontal scaling applied to the CompositeFontEntry.
idnumber readonlyThe unique ID of the CompositeFontEntry.
indexnumber readonlyThe index of the CompositeFontEntry 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.
lockedbool readonlyIf true, the CompositeFontEntry is locked.
namestring r/wThe name of the CompositeFontEntry.
parentCompositeFont readonlyThe parent of the CompositeFontEntry (a CompositeFont).
propertiesObject r/wA property that allows setting of several properties at the same time.
relativeSizenumber r/wThe size of the entry relative to the base entry. Note: The base entry cannot be modified.
scaleOptionbool r/wIf true, scales characters from the center.
verticalScalenumber r/wThe vertical scaling applied to the CompositeFontEntry.

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)

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

ParameterTypeDescription
keystringThe key.

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

void remove ()
Deletes the CompositeFontEntry.

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

CompositeFontEntry CompositeFontEntries.nextItem (obj: CompositeFontEntry)

CompositeFontEntry CompositeFontEntries.previousItem (obj: CompositeFontEntry)

Return

CompositeFontEntry CompositeFontEntries.[] (index: number)

CompositeFontEntry CompositeFontEntries.add ([withProperties: Object])

CompositeFontEntry CompositeFontEntries.anyItem ()

Array of CompositeFontEntry CompositeFontEntries.everyItem ()

CompositeFontEntry CompositeFontEntries.firstItem ()

CompositeFontEntry CompositeFontEntries.item (index: varies)

CompositeFontEntry CompositeFontEntries.itemByID (id: number)

CompositeFontEntry CompositeFontEntries.itemByName (name: string)

Array of CompositeFontEntry CompositeFontEntries.itemByRange (from: varies, to: varies)

CompositeFontEntry CompositeFontEntries.lastItem ()

CompositeFontEntry CompositeFontEntries.middleItem ()

CompositeFontEntry CompositeFontEntries.nextItem (obj: CompositeFontEntry)

CompositeFontEntry CompositeFontEntries.previousItem (obj: CompositeFontEntry)

Array of CompositeFontEntry CompositeFontEntry.getElements ()

Jongware, 20-Jun-2010 v3.0.3dContents :: Index