AutofitDocumentSettings

AutoFit settings on the document level

Methods:

addEventListener, getElements, isActive, removeEventListener, resetAllToDefaults, resetPreferences, toSource, toSpecifier

Hierarchy:

Superclass: Preference

Class: AutofitDocumentSettings

Property Listing

Property

Type

Access

Description

appearance

AutofitAppearancePreferences

readonly

Appearance preferences for AutoFit relations

enabled

Boolean

read/write

Determine if AutoFit is enabled

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

parent

Document

readonly

The parent of the AutofitDocumentSettings (a Document).

preferences

Preferences Preference

readonly

A collection of preferences objects.

properties

Object

read/write

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

relations

AutofitDocumentRelations

readonly

Entry property for methods related to AutoFit relations on the document level

showRelations

Boolean

read/write

Hide or show the AutoFit relations in the UI

singleColumnFramesCanCollapse

Boolean

read/write

Allow single column text frames to collapse

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)

AutofitDocumentSettings getElements ()

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

Boolean isActive ()

Test whether AutofitDocumentSettings is active in terms of AutoFit

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 resetAllToDefaults ()

Reset the AutoFit specific data of AutofitDocumentSettings to the default values

undefined resetPreferences ()

Reset the AutoFit preferences to their default values

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

Object of

Document.autofitSettings

AutofitAppearancePreferences.parent

AutofitDocumentRelations.parent

Event.parent

EventListener.parent

MutationEvent.parent

Preference.parent

Return

AutofitDocumentSettings.getElements()