Class
Character grid preferences. Base Class: Preference addEventListener, getElements, removeEventListener, toSource, toSpecifier
CjkGridPreference
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| colorEveryNthCell | number | r/w | 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 | bool | r/w | If true, uses ICF mode for grid cells. If false, uses virtual body mode. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| layoutGridColorIndex | 3 Reals (0 - 255) UIColors |
r/w | 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 | r/w | 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 | r/w | A property that allows setting of several properties at the same time. |
| showAllFrameGrids | bool | r/w | If true, displays the frame (story) grids. |
| showAllLayoutGrids | bool | r/w | If true, displays the layout grids. |
| showCharacterCount | bool | r/w | If true, displays the character count for the frame. |
| singleLineColorMode | bool | r/w | 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 | bool | r/w | If true, objects snap to the layout grid. |
| useCircularCells | bool | r/w | If true, cell shape is circular. If false, cell shape is rectangular. |
Methods
Instances
EventListener addEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Adds an event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The event type. |
| handler | File JavaScript Function | The event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
Array of CjkGridPreference getElements ()
Resolves the object specifier, creating an array of object references.
bool removeEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Removes the event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The registered event type. |
| handler | File JavaScript Function | The registered event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
string toSource ()
Generates a string which, if executed, will return the CjkGridPreference.
Element of
Application.cjkGridPreferences
Document.cjkGridPreferences
Return
Array of CjkGridPreference CjkGridPreference.getElements ()
| Jongware, 28-Apr-2012 v3.0.3i | Contents :: Index |