Class
Galley preferences. Base Class: Preference addEventListener, getElements, removeEventListener, toSource, toSpecifier
GalleyPreference
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| antiAliasType | AntiAliasType: AntiAliasType.GRAY_ANTIALIASING AntiAliasType.COLOR_ANTIALIASING AntiAliasType.THICKER_ANTIALIASING |
r/w | The type of text anti-aliasing to use in story and galley views. |
| backgroundColor | 3 Reals (0 - 255) InCopyUIColors |
r/w | 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 | bool | r/w | If true, the cursor blinks. |
| cursorType | CursorTypes: CursorTypes.STANDARD_CURSOR CursorTypes.THICK_CURSOR CursorTypes.BARBELL_CURSOR CursorTypes.BLOCK_CURSOR |
r/w | The cursor type for galley and story views. |
| displayFont | string | r/w | Font family name to use for text display. |
| displayFontSize | Measurement Unit (Number or String) | r/w | Size to use for text display. |
| eventListeners | EventListeners | readonly | A collection of event listeners. |
| events | Events | readonly | A collection of events. |
| infoColumnWidth | Measurement Unit (Number or String) | r/w | Info column width. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| lineSpacingValue | LineSpacingType: LineSpacingType.SINGLE_SPACE LineSpacingType.ONE_AND_HALF_SPACE LineSpacingType.DOUBLE_SPACE LineSpacingType.TRIPLE_SPACE |
r/w | Amount of spacing between lines. |
| overridePreviewFont | string | r/w | The name of the preview font. |
| parent | Application Document |
readonly | The parent of the GalleyPreference (a Application or Document). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| showDepthRuler | bool | r/w | If true, displays the depth ruler. |
| showFootnotes | bool | r/w | If true, displays footnotes in story and galley views. |
| showInfoColumn | bool | r/w | If true, display the Info column. |
| showLineNumbers | bool | r/w | If true, show line numbers. |
| showParagraphBreakMarks | bool | r/w | If true, show paragraph break marks. |
| showParagraphStyleNames | bool | r/w | If true, show paragraph style names. |
| smoothText | bool | r/w | If true, galley text is anti-aliased. |
| textColor | 3 Reals (0 - 255) InCopyUIColors |
r/w | 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. |
| useOverridePreviewFont | bool | r/w | If true, uses the override preview font. |
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 GalleyPreference 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 GalleyPreference.
Element of
Application.galleyPreferences
Document.galleyPreferences
Return
Array of GalleyPreference GalleyPreference.getElements ()
| Jongware, 23-Mar-2011 v3.0.3d | Contents :: Index |