Class
General application preferences. Base Class: Preference addEventListener, getElements, removeEventListener, toSource, toSpecifier
GeneralPreference
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| applicationBarShown | bool | r/w | If true, application bar is shown. |
| autoCollapseIconPanels | bool | r/w | If true, panel drawers close automatically. |
| autoShowHiddenPanels | bool | r/w | If true, vertical reveal strips appear when palette UI is hidden. |
| enableFloatingWindowDocking | bool | r/w | If true, floating windows can be docked by user as tabs. |
| enableMultiTouchGestures | bool | r/w | 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. |
| highlightObjectUnderSelectionTool | bool | r/w | Controls whether or not to highlight object under selection tool. |
| includePreview | bool | r/w | If true, include a preview image when saving the document |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| openDocumentsAsTabs | bool | r/w | If true, documents open as tabs. |
| openRecentLength | number (range: 0 - 30) | r/w | Number of items to show in the Open Recent menu list. Range: 0 to 30 |
| parent | Application | readonly | The parent of the GeneralPreference (a Application). |
| placeCursorUsesThumbnails | bool | r/w | Controls whether or not to show thumbnails of imported files in the Place icon. |
| previewPages | PreviewPagesOptions: PreviewPagesOptions.FIRST_PAGE PreviewPagesOptions.FIRST_2_PAGES PreviewPagesOptions.FIRST_5_PAGES PreviewPagesOptions.FIRST_10_PAGES PreviewPagesOptions.ALL_PAGES |
r/w | The pages to create preview images for. Note: Valid when include preview is true. |
| previewSize | PreviewSizeOptions: PreviewSizeOptions.SMALL PreviewSizeOptions.MEDIUM PreviewSizeOptions.LARGE PreviewSizeOptions.EXTRA_LARGE |
r/w | The size of the preview image. |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| temporaryFolder | File | r/w | The location in which to store temporary files. |
| toolTips | ToolTipOptions: ToolTipOptions.NORMAL ToolTipOptions.NONE ToolTipOptions.FAST |
r/w | Tool tip behavior. |
| toolsPanel | ToolsPanelOptions: ToolsPanelOptions.SINGLE_COLUMN ToolsPanelOptions.DOUBLE_COLUMN ToolsPanelOptions.SINGLE_ROW |
r/w | Controls the appearance of the Tools panel. |
| useApplicationFrame | bool | r/w | If true, application lives in a frame. |
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 GeneralPreference 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 GeneralPreference.
Element of
Application.generalPreferences
Return
Array of GeneralPreference GeneralPreference.getElements ()
| Jongware, 29-Apr-2012 v3.0.3i | Contents :: Index |