HyphenationException
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| addedExceptions | Array of string | r/w | A list of words added to the hyphenation exceptions list. |
| eventListeners | EventListeners | readonly | A collection of event listeners. |
| events | Events | readonly | A collection of events. |
| index | number | readonly | The index of the HyphenationException within its containing object. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| name | string | readonly | The name of the HyphenationException. |
| parent | Document | readonly | The parent of the HyphenationException (a Document). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| removedExceptions | Array of string | r/w | A list of words removed from the hyphenation exceptions list. |
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) |
void addException (addedExceptions:
Array
of string[, removedList:
bool=false])
Adds the specified words to the hyphenation exceptions list.
| Parameter | Type | Description |
|---|---|---|
| addedExceptions | Array of string | The list of words to add. |
| removedList | bool | If true, adds the words to the removed exceptions list. If false or unspecified, adds the words to the added exceptions list. (Optional) (default: false) |
Array
of HyphenationException getElements ()
Resolves the object specifier, creating an array of object references.
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) |
void removeException (removedExceptions:
Array
of string[, removedList:
bool=false])
Removes the specified words from the hyphenation exceptions list.
| Parameter | Type | Description |
|---|---|---|
| removedExceptions | Array of string | The list of words to remove. |
| removedList | bool | If true, removes the words from the removed exceptions list. If false or unspecified, adds the words to the added exceptions list. (Optional) (default: false) |
string toSource ()
Generates a string which, if executed, will return the HyphenationException.
Used in:
HyphenationException HyphenationExceptions.nextItem (obj: HyphenationException)
HyphenationException HyphenationExceptions.previousItem (obj: HyphenationException)
Return
Array of HyphenationException HyphenationException.getElements ()
HyphenationException HyphenationExceptions.[] (index: number)
HyphenationException HyphenationExceptions.anyItem ()
Array of HyphenationException HyphenationExceptions.everyItem ()
HyphenationException HyphenationExceptions.firstItem ()
HyphenationException HyphenationExceptions.item (index: varies)
HyphenationException HyphenationExceptions.itemByName (name: string)
Array of HyphenationException HyphenationExceptions.itemByRange (from: varies, to: varies)
HyphenationException HyphenationExceptions.lastItem ()
HyphenationException HyphenationExceptions.middleItem ()
HyphenationException HyphenationExceptions.nextItem (obj: HyphenationException)
HyphenationException HyphenationExceptions.previousItem (obj: HyphenationException)
| Jongware, 23-Mar-2011 v3.0.3d | Contents :: Index |