GeneralPreference

General application preferences.

Methods:

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Objects:

Boolean, EventListeners, Events, File, Number, Object, PageNumberingOptions, PreviewSizeOptions, ToolTipOptions, ToolsPanelOptions

Hierarchy:

Superclass: Preference

Class: GeneralPreference

Property Listing

Property

Type

Access

Description

applicationBarShown

Boolean

read/write

If true, application bar is shown.

autoCollapseIconPanels

Boolean

read/write

If true, panel drawers close automatically.

autoShowHiddenPanels

Boolean

read/write

If true, vertical reveal strips appear when palette UI is hidden.

completeFontDownloadGlyphLimit

Number

read/write

The threshold at which to trigger font subsetting based on the number of glyphs the font contains.

enableFloatingWindowDocking

Boolean

read/write

If true, floating windows can be docked by user as tabs.

enableMultiTouchGestures

Boolean

read/write

Controls whether or not multi-touch gestures are enabled.

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

includePreview

Boolean

read/write

If true, includes a preview in saved documents.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

objectsMoveWithPage

Boolean

read/write

Controls whether page items move when a page is repositioned from the UI. The option/alt key temporarily reverses this property

openDocumentsAsTabs

Boolean

read/write

If true, documents open as tabs.

openRecentLength

Number (range 0 - 30)

read/write

Number of items to show in the Open Recent menu list. Range: 0 to 30

pageNumbering

PageNumberingOptions

PageNumberingOptions.ABSOLUTE

PageNumberingOptions.SECTION

read/write

The page numbering method.

parent

Application

readonly

The parent of the GeneralPreference (a Application).

placeCursorUsesThumbnails

Boolean

read/write

Controls whether or not to show thumbnails of imported files in the Place icon.

preventSelectingLockedItems

Boolean

read/write

Controls whether or not you can select and interact with a locked item. When this is off, only position is locked.

previewSize

PreviewSizeOptions

PreviewSizeOptions.EXTRA_LARGE

PreviewSizeOptions.LARGE

PreviewSizeOptions.MEDIUM

PreviewSizeOptions.SMALL

read/write

The preview size. Note: Valid when include preview is true.

properties

Object

read/write

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

showContentGrabber

Boolean

read/write

Controls whether or not the content grabber adornment is shown.

showLiveCorners

Boolean

read/write

Controls whether or not the live corners grabber adornment is shown.

showMasterPageOverlay

Boolean

read/write

Controls whether or not to show the master page overlay when a page is selected using the Page Tool.

showTransformationValues

Boolean

read/write

Controls whether or not to dynamically display transformation information as part of the cursor while manipulating page items.

temporaryFolder

File

read/write

The location in which to store temporary files.

toolTips

ToolTipOptions

ToolTipOptions.FAST

ToolTipOptions.NONE

ToolTipOptions.NORMAL

read/write

Tool tip behavior.

toolsPanel

ToolsPanelOptions

ToolsPanelOptions.DOUBLE_COLUMN

ToolsPanelOptions.SINGLE_COLUMN

ToolsPanelOptions.SINGLE_ROW

read/write

Controls the appearance of the Tools panel.

useApplicationFrame

Boolean

read/write

If true, application lives in a frame.

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)

GeneralPreference 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)

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

Object of

Application.generalPreferences

Event.parent

EventListener.parent

MutationEvent.parent

Return

GeneralPreference.getElements()