CjkGridPreference

Character grid preferences.

Methods:

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Objects:

Boolean, EventListeners, Events, Number, Object, UIColors,

Hierarchy:

Superclass: Preference

Class: CjkGridPreference

Property Listing

Property

Type

Access

Description

colorEveryNthCell

Number

read/write

Applies the grid color to every nth cell, where n is the value of this property.

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

icfMode

Boolean

read/write

If true, uses ICF mode for grid cells. If false, uses virtual body mode.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

layoutGridColorIndex

Array of 3 Reals (0 - 255)

UIColors

read/write

The layout grid 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 a UI color. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator.

minimumScale

Number (range 5 - 4000)

read/write

The view magnification (as a percentage) less than which grids do not appear. (Range: 5 to 4000)

parent

Application

Document

readonly

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

properties

Object

read/write

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

showAllFrameGrids

Boolean

read/write

If true, displays the frame (story) grids.

showAllLayoutGrids

Boolean

read/write

If true, displays the layout grids.

showCharacterCount

Boolean

read/write

If true, displays the character count for the frame.

singleLineColorMode

Boolean

read/write

If true, applies the grid color from the the edge of the line. If false, applies the grid color from the corner of the frame.

snapToLayoutGrid

Boolean

read/write

If true, objects snap to the layout grid.

useCircularCells

Boolean

read/write

If true, cell shape is circular. If false, cell shape is rectangular.

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)

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

String toSpecifier ()

Retrieves the object specifier.

Object of

Application.cjkGridPreferences

Document.cjkGridPreferences

Event.parent

EventListener.parent

MutationEvent.parent

Return

CjkGridPreference.getElements()