Packagecom.adobe.indesign
Classpublic class GeneralPreference
InheritanceGeneralPreference Inheritance Preference Inheritance CSHostObject Inheritance flash.utils.Proxy

Preference



Public Properties
 PropertyDefined By
  applicationBarShown : Boolean
If true, application bar is shown.
GeneralPreference
  autoCollapseIconPanels : Boolean
If true, panel drawers close automatically.
GeneralPreference
  autoShowHiddenPanels : Boolean
If true, vertical reveal strips appear when palette UI is hidden.
GeneralPreference
  completeFontDownloadGlyphLimit : Number
The threshold at which to trigger font subsetting based on the number of glyphs the font contains.
GeneralPreference
  enableFloatingWindowDocking : Boolean
If true, floating windows can be docked by user as tabs.
GeneralPreference
  enableMultiTouchGestures : Boolean
Controls whether or not multi-touch gestures are enabled.
GeneralPreference
  eventListeners : EventListeners
[override] [read-only] A collection of event listeners.
GeneralPreference
  events : Events
[override] [read-only] A collection of events.
GeneralPreference
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  includePreview : Boolean
If true, includes a preview in saved documents.
GeneralPreference
  isValid : Boolean
[override] [read-only] Returns true if the object specifier resolves to valid objects.
GeneralPreference
  objectsMoveWithPage : Boolean
Controls whether page items move when a page is repositioned from the UI.
GeneralPreference
  openDocumentsAsTabs : Boolean
If true, documents open as tabs.
GeneralPreference
  openRecentLength : Number
Number of items to show in the Open Recent menu list.
GeneralPreference
  pageNumbering : PageNumberingOptions
The page numbering method.
GeneralPreference
  parent : Object
[override] [read-only] The parent of the GeneralPreference (a Application).
GeneralPreference
  placeCursorUsesThumbnails : Boolean
Controls whether or not to show thumbnails of imported files in the Place icon.
GeneralPreference
  preventSelectingLockedItems : Boolean
Controls whether or not you can select and interact with a locked item.
GeneralPreference
  previewSize : PreviewSizeOptions
The preview size.
GeneralPreference
  properties : Object
[override] A property that allows setting of several properties at the same time.
GeneralPreference
  showContentGrabber : Boolean
Controls whether or not the content grabber adornment is shown.
GeneralPreference
  showLiveCorners : Boolean
Controls whether or not the live corners grabber adornment is shown.
GeneralPreference
  showMasterPageOverlay : Boolean
Controls whether or not to show the master page overlay when a page is selected using the Page Tool.
GeneralPreference
  showTransformationValues : Boolean
Controls whether or not to dynamically display transformation information as part of the cursor while manipulating page items.
GeneralPreference
  temporaryFolder : File
The location in which to store temporary files.
GeneralPreference
  toolsPanel : ToolsPanelOptions
Controls the appearance of the Tools panel.
GeneralPreference
  toolTips : ToolTipOptions
Tool tip behavior.
GeneralPreference
  useApplicationFrame : Boolean
If true, application lives in a frame.
GeneralPreference
Public Methods
 MethodDefined By
  
addEventListenerGeneralPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
GeneralPreference
 Inherited
addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
Preference
 Inherited
filterArgsForHBAPI(args:Array):Array
[static] Function to clean up the argument list and put it into a format that makes sense for HBAPI.
CSHostObject
 Inherited
filterSingleObjectForHBAPI(value:Object):Object
[static]
CSHostObject
 Inherited
getClassObjectForName(className:String):HostObject
[static] This returns a "Class" object, meaning, a HostObject that can be used to make static function calls or get static properties
CSHostObject
  
getElements():Object
[override] Resolves the object specifier, creating an array of object references.
GeneralPreference
 Inherited
getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):*
[static]
CSHostObject
 Inherited
hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
CSHostObject
 Inherited
hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):*
[static] Implements a safe call of a static method on the host
CSHostObject
 Inherited
hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
CSHostObject
 Inherited
hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
CSHostObject
 Inherited
hostGetStatic(className:String, propertyName:String, expectedReturnType:Class):*
[static] Implements a safe get of a static property on the host Used by for instance, all the enum implementations.
CSHostObject
 Inherited
hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
CSHostObject
 Inherited
hostSetStatic(className:String, propertyName:String, rawvalue:*):*
[static] Implements a safe set of a static property on the host
CSHostObject
 Inherited
isDescendedFrom(clz:Class, ancClass:Class):Boolean
[static] Efficiently determines whether or not one class descends from another in inheritance hierarchy- class relationships are cached by the ClassUtils implementation- (uses org.as3commons lib to quickly discover class hierarchy.
CSHostObject
  
removeEventListenerGeneralPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
GeneralPreference
 Inherited
removeEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
Preference
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
toSpecifier():String
[override] Retrieves the object specifier.
GeneralPreference
 Inherited
wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):*
[static] Method used on static/normal get/ hostcalls
CSHostObject
Protected Methods
 MethodDefined By
 Inherited
createWithArgs(args:Array):void
CSHostObject
 Inherited
hostCreate(args:Array):void
CSHostObject
Property Detail
applicationBarShownproperty
applicationBarShown:Boolean

If true, application bar is shown.


Implementation
    public function get applicationBarShown():Boolean
    public function set applicationBarShown(value:Boolean):void
autoCollapseIconPanelsproperty 
autoCollapseIconPanels:Boolean

If true, panel drawers close automatically.


Implementation
    public function get autoCollapseIconPanels():Boolean
    public function set autoCollapseIconPanels(value:Boolean):void
autoShowHiddenPanelsproperty 
autoShowHiddenPanels:Boolean

If true, vertical reveal strips appear when palette UI is hidden.


Implementation
    public function get autoShowHiddenPanels():Boolean
    public function set autoShowHiddenPanels(value:Boolean):void
completeFontDownloadGlyphLimitproperty 
completeFontDownloadGlyphLimit:Number

The threshold at which to trigger font subsetting based on the number of glyphs the font contains.


Implementation
    public function get completeFontDownloadGlyphLimit():Number
    public function set completeFontDownloadGlyphLimit(value:Number):void
enableFloatingWindowDockingproperty 
enableFloatingWindowDocking:Boolean

If true, floating windows can be docked by user as tabs.


Implementation
    public function get enableFloatingWindowDocking():Boolean
    public function set enableFloatingWindowDocking(value:Boolean):void
enableMultiTouchGesturesproperty 
enableMultiTouchGestures:Boolean

Controls whether or not multi-touch gestures are enabled.


Implementation
    public function get enableMultiTouchGestures():Boolean
    public function set enableMultiTouchGestures(value:Boolean):void
eventListenersproperty 
eventListeners:EventListeners  [read-only] [override]

A collection of event listeners.


Implementation
    public function get eventListeners():EventListeners
eventsproperty 
events:Events  [read-only] [override]

A collection of events.


Implementation
    public function get events():Events
includePreviewproperty 
includePreview:Boolean

If true, includes a preview in saved documents.


Implementation
    public function get includePreview():Boolean
    public function set includePreview(value:Boolean):void
isValidproperty 
isValid:Boolean  [read-only] [override]

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
objectsMoveWithPageproperty 
objectsMoveWithPage:Boolean

Controls whether page items move when a page is repositioned from the UI. The option/alt key temporarily reverses this property


Implementation
    public function get objectsMoveWithPage():Boolean
    public function set objectsMoveWithPage(value:Boolean):void
openDocumentsAsTabsproperty 
openDocumentsAsTabs:Boolean

If true, documents open as tabs.


Implementation
    public function get openDocumentsAsTabs():Boolean
    public function set openDocumentsAsTabs(value:Boolean):void
openRecentLengthproperty 
openRecentLength:Number

Number of items to show in the Open Recent menu list. Range: 0 to 30


Implementation
    public function get openRecentLength():Number
    public function set openRecentLength(value:Number):void
pageNumberingproperty 
pageNumbering:PageNumberingOptions

The page numbering method.


Implementation
    public function get pageNumbering():PageNumberingOptions
    public function set pageNumbering(value:PageNumberingOptions):void
parentproperty 
parent:Object  [read-only] [override]

The parent of the GeneralPreference (a Application).


Implementation
    public function get parent():Object
placeCursorUsesThumbnailsproperty 
placeCursorUsesThumbnails:Boolean

Controls whether or not to show thumbnails of imported files in the Place icon.


Implementation
    public function get placeCursorUsesThumbnails():Boolean
    public function set placeCursorUsesThumbnails(value:Boolean):void
preventSelectingLockedItemsproperty 
preventSelectingLockedItems:Boolean

Controls whether or not you can select and interact with a locked item. When this is off, only position is locked.


Implementation
    public function get preventSelectingLockedItems():Boolean
    public function set preventSelectingLockedItems(value:Boolean):void
previewSizeproperty 
previewSize:PreviewSizeOptions

The preview size. Note: Valid when include preview is true.


Implementation
    public function get previewSize():PreviewSizeOptions
    public function set previewSize(value:PreviewSizeOptions):void
propertiesproperty 
properties:Object[override]

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


Implementation
    public function get properties():Object
    public function set properties(value:Object):void
showContentGrabberproperty 
showContentGrabber:Boolean

Controls whether or not the content grabber adornment is shown.


Implementation
    public function get showContentGrabber():Boolean
    public function set showContentGrabber(value:Boolean):void
showLiveCornersproperty 
showLiveCorners:Boolean

Controls whether or not the live corners grabber adornment is shown.


Implementation
    public function get showLiveCorners():Boolean
    public function set showLiveCorners(value:Boolean):void
showMasterPageOverlayproperty 
showMasterPageOverlay:Boolean

Controls whether or not to show the master page overlay when a page is selected using the Page Tool.


Implementation
    public function get showMasterPageOverlay():Boolean
    public function set showMasterPageOverlay(value:Boolean):void
showTransformationValuesproperty 
showTransformationValues:Boolean

Controls whether or not to dynamically display transformation information as part of the cursor while manipulating page items.


Implementation
    public function get showTransformationValues():Boolean
    public function set showTransformationValues(value:Boolean):void
temporaryFolderproperty 
temporaryFolder:File

The location in which to store temporary files.


Implementation
    public function get temporaryFolder():File
    public function set temporaryFolder(value:File):void
toolsPanelproperty 
toolsPanel:ToolsPanelOptions

Controls the appearance of the Tools panel.


Implementation
    public function get toolsPanel():ToolsPanelOptions
    public function set toolsPanel(value:ToolsPanelOptions):void
toolTipsproperty 
toolTips:ToolTipOptions

Tool tip behavior.


Implementation
    public function get toolTips():ToolTipOptions
    public function set toolTips(value:ToolTipOptions):void
useApplicationFrameproperty 
useApplicationFrame:Boolean

If true, application lives in a frame.


Implementation
    public function get useApplicationFrame():Boolean
    public function set useApplicationFrame(value:Boolean):void
Method Detail
addEventListenerGeneralPreference()method
public function addEventListenerGeneralPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener

Adds an event listener.

Parameters

eventTypeParam:String (default = null) — (String) The event type.
 
handlerParam:Object (default = null) — (Object) The event handler. Can accept: File or JavaScript Function.
 
capturesParam:Boolean (default = false) — (Boolean) This parameter is obsolete. (Optional)

Returns
EventListener
getElements()method 
override public function getElements():Object

Resolves the object specifier, creating an array of object references.

Returns
Object
removeEventListenerGeneralPreference()method 
public function removeEventListenerGeneralPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean

Removes the event listener.

Parameters

eventTypeParam:String (default = null) — (String) The registered event type.
 
handlerParam:Object (default = null) — (Object) The registered event handler. Can accept: File or JavaScript Function.
 
capturesParam:Boolean (default = false) — (Boolean) This parameter is obsolete. (Optional)

Returns
Boolean
toSpecifier()method 
override public function toSpecifier():String

Retrieves the object specifier.

Returns
String