HyphenationException

A hyphenation exceptions list.

Methods:

addEventListener, addException, getElements, removeEventListener, removeException, toSource, toSpecifier

Objects:

Boolean, EventListeners, Events, Number, Object, String

Preferences:

String

Property Listing

Property

Type

Access

Description

addedExceptions

Array of String

read/write

A list of words added to the hyphenation exceptions list.

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

index

Number

readonly

The index of the HyphenationException within its containing object.

isValid

Boolean

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

read/write

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

removedExceptions

Array of String

read/write

A list of words removed from the hyphenation exceptions list.

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)

undefined addException (addedExceptions:Array of String, [removedList:Boolean=Boolean])

Adds the specified words to the hyphenation exceptions list.

Parameter

Type

Description

addedExceptions

Array of String

The list of words to add.

removedList

Boolean

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)

HyphenationException getElements ()

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

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)

undefined removeException (removedExceptions:Array of String, [removedList:Boolean=Boolean])

Removes the specified words from the hyphenation exceptions list.

Parameter

Type

Description

removedExceptions

Array of String

The list of words to remove.

removedList

Boolean

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.

String toSpecifier ()

Retrieves the object specifier.

Object of

Event.parent

EventListener.parent

MutationEvent.parent

Return

HyphenationException.getElements()

HyphenationExceptions.anyItem()

HyphenationExceptions.everyItem()

HyphenationExceptions.nextItem()

HyphenationExceptions.previousItem()

HyphenationExceptions.item()

HyphenationExceptions.[]()

HyphenationExceptions.itemByName()

HyphenationExceptions.itemByRange()

HyphenationExceptions.firstItem()

HyphenationExceptions.lastItem()

HyphenationExceptions.middleItem()