CompositeFontEntry

A composite font entry.

Methods:

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

Objects:

Boolean, EventListeners, Events, Font, Number, Object, String,

Property Listing

Property

Type

Access

Description

appliedFont

Font

String

read/write

The font applied to the CompositeFontEntry, specified as either a font object or the name of font family. Can return: Font or String.

baselineShift

Number

read/write

The amount of baseline shift.

customCharacters

String

read/write

The characters that the set affects.

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

fontStyle

String

read/write

The name of the font style.

horizontalScale

Number

read/write

The horizontal scaling applied to the CompositeFontEntry.

id

Number

readonly

The unique ID of the CompositeFontEntry.

index

Number

readonly

The index of the CompositeFontEntry within its containing object.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

label

String

read/write

A property that can be set to any string.

locked

Boolean

readonly

If true, the CompositeFontEntry is locked.

name

String

read/write

The name of the CompositeFontEntry.

parent

CompositeFont

readonly

The parent of the CompositeFontEntry (a CompositeFont).

properties

Object

read/write

A property that allows setting of several properties at the same time.

relativeSize

Number

read/write

The size of the entry relative to the base entry. Note: The base entry cannot be modified.

scaleOption

Boolean

read/write

If true, scales characters from the center.

verticalScale

Number

read/write

The vertical scaling applied to the CompositeFontEntry.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter

Type

Description

key

String

The key.

CompositeFontEntry getElements ()

Resolves the object specifier, creating an array of object references.

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

undefined remove ()

Deletes the CompositeFontEntry.

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter

Type

Description

eventType

String

The registered event type.

handler

File

JavaScriptFunction

The registered event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

String toSource ()

Generates a string which, if executed, will return the CompositeFontEntry.

String toSpecifier ()

Retrieves the object specifier.

Object of

Event.parent

EventListener.parent

MutationEvent.parent

Return

CompositeFontEntries.add()

CompositeFontEntry.getElements()

CompositeFontEntries.anyItem()

CompositeFontEntries.everyItem()

CompositeFontEntries.itemByRange()

CompositeFontEntries.nextItem()

CompositeFontEntries.previousItem()

CompositeFontEntries.itemByID()

CompositeFontEntries.item()

CompositeFontEntries.[]()

CompositeFontEntries.itemByName()

CompositeFontEntries.firstItem()

CompositeFontEntries.lastItem()

CompositeFontEntries.middleItem()