GalleyPreference

Galley preferences.

Methods:

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Objects:

AntiAliasType, Boolean, CursorTypes, EventListeners, Events, InCopyUIColors, LineSpacingType, Number, Object, String,

Hierarchy:

Superclass: Preference

Class: GalleyPreference

Property Listing

Property

Type

Access

Description

antiAliasType

AntiAliasType

AntiAliasType.COLOR_ANTIALIASING

AntiAliasType.GRAY_ANTIALIASING

AntiAliasType.THICKER_ANTIALIASING

read/write

The type of text anti-aliasing to use in story and galley views.

backgroundColor

Array of 3 Reals (0 - 255)

InCopyUIColors

read/write

The background color, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values, or as an InCopy UI color. . Can return: Array of 3 Reals (0 - 255) or InCopyUIColors enumerator.

blinkCursor

Boolean

read/write

If true, the cursor blinks.

cursorType

CursorTypes

CursorTypes.BARBELL_CURSOR

CursorTypes.BLOCK_CURSOR

CursorTypes.STANDARD_CURSOR

CursorTypes.THICK_CURSOR

read/write

The cursor type for galley and story views.

displayFont

String

read/write

Font family name to use for text display.

displayFontSize

Number

String

read/write

Size to use for text display.

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

infoColumnWidth

Number

String

read/write

Info column width.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

lineSpacingValue

LineSpacingType

LineSpacingType.DOUBLE_SPACE

LineSpacingType.ONE_AND_HALF_SPACE

LineSpacingType.SINGLE_SPACE

LineSpacingType.TRIPLE_SPACE

read/write

Amount of spacing between lines.

parent

Application

Document

readonly

The parent of the GalleyPreference (a Application or Document).

properties

Object

read/write

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

showDepthRuler

Boolean

read/write

If true, displays the depth ruler.

showInfoColumn

Boolean

read/write

If true, display the Info column.

showParagraphBreakMarks

Boolean

read/write

If true, show paragraph break marks.

showParagraphStyleNames

Boolean

read/write

If true, show paragraph style names.

smoothText

Boolean

read/write

If true, galley text is anti-aliased.

textColor

Array of 3 Reals (0 - 255)

InCopyUIColors

read/write

The text color, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values, or as an InCopy UI color. Can return: Array of 3 Reals (0 - 255) or InCopyUIColors enumerator.

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)

GalleyPreference 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 GalleyPreference.

String toSpecifier ()

Retrieves the object specifier.

Object of

Application.galleyPreferences

Document.galleyPreferences

Event.parent

EventListener.parent

MutationEvent.parent

Return

GalleyPreference.getElements()