CompositeFontEntry
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| appliedFont | FontString | r/w | 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 | r/w | The amount of baseline shift. |
| customCharacters | string | r/w | The characters that the set affects. |
| eventListeners | EventListeners | readonly | A collection of event listeners. |
| events | Events | readonly | A collection of events. |
| fontStyle | string | r/w | The name of the font style. |
| horizontalScale | number | r/w | 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 | 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. |
| locked | bool | readonly | If true, the CompositeFontEntry is locked. |
| name | string | r/w | The name of the CompositeFontEntry. |
| parent | CompositeFont | readonly | The parent of the CompositeFontEntry (a CompositeFont). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| relativeSize | number | r/w | The size of the entry relative to the base entry. Note: The base entry cannot be modified. |
| scaleOption | bool | r/w | If true, scales characters from the center. |
| verticalScale | number | r/w | The vertical scaling applied to the CompositeFontEntry. |
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) |
string extractLabel (key:
string)
Gets the label value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The 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.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
| value | string | The value. |
void remove ()
Deletes the CompositeFontEntry.
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) |
string toSource ()
Generates a string which, if executed, will return the CompositeFontEntry.
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, 23-Mar-2011 v3.0.3d | Contents :: Index |