Package | com.adobe.incopy |
Class | public class GeneralPreference |
Inheritance | GeneralPreference ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined 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 | ||
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 | ||
highlightObjectUnderSelectionTool : Boolean
Controls whether or not to highlight object under selection tool. | GeneralPreference | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
includePreview : Boolean
If true, include a preview image when saving the document
| GeneralPreference | ||
isValid : Boolean [override] [read-only]
Returns true if the object specifier resolves to valid objects. | GeneralPreference | ||
openDocumentsAsTabs : Boolean
If true, documents open as tabs. | GeneralPreference | ||
openRecentLength : Number
Number of items to show in the Open Recent menu list. | 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 | ||
previewSize : PreviewSizeOptions
The size of the preview image. | GeneralPreference | ||
properties : Object [override]
A property that allows setting of several properties at the same time. | 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 |
Method | Defined By | ||
---|---|---|---|
addEventListenerGeneralPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | GeneralPreference | ||
![]() | addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | Preference | |
![]() | filterArgsForHBAPI(args:Array):Array [static]
Function to clean up the argument list and put it into a format that
makes sense for HBAPI. | CSHostObject | |
![]() | filterSingleObjectForHBAPI(value:Object):Object [static]
| CSHostObject | |
![]() | 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 | ||
![]() | getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):* [static] | CSHostObject | |
![]() | hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
| CSHostObject | |
![]() | hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):* [static]
Implements a safe call of a static method on the host
| CSHostObject | |
![]() | hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
| CSHostObject | |
![]() | hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
| CSHostObject | |
![]() | 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 | |
![]() | hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
| CSHostObject | |
![]() | hostSetStatic(className:String, propertyName:String, rawvalue:*):* [static]
Implements a safe set of a static property on the host
| CSHostObject | |
![]() | 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 | ||
![]() | removeEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | Preference | |
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
toSpecifier():String [override]
Retrieves the object specifier. | GeneralPreference | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
applicationBarShown | property |
applicationBarShown:Boolean
Since : | CS5 |
If true, application bar is shown.
public function get applicationBarShown():Boolean
public function set applicationBarShown(value:Boolean):void
autoCollapseIconPanels | property |
autoCollapseIconPanels:Boolean
Since : | CS5 |
If true, panel drawers close automatically.
public function get autoCollapseIconPanels():Boolean
public function set autoCollapseIconPanels(value:Boolean):void
autoShowHiddenPanels | property |
autoShowHiddenPanels:Boolean
Since : | CS5 |
If true, vertical reveal strips appear when palette UI is hidden.
public function get autoShowHiddenPanels():Boolean
public function set autoShowHiddenPanels(value:Boolean):void
enableFloatingWindowDocking | property |
enableFloatingWindowDocking:Boolean
Since : | CS5 |
If true, floating windows can be docked by user as tabs.
public function get enableFloatingWindowDocking():Boolean
public function set enableFloatingWindowDocking(value:Boolean):void
enableMultiTouchGestures | property |
enableMultiTouchGestures:Boolean
Since : | CS5 |
Controls whether or not multi-touch gestures are enabled.
public function get enableMultiTouchGestures():Boolean
public function set enableMultiTouchGestures(value:Boolean):void
eventListeners | property |
eventListeners:EventListeners
[read-only] [override] Since : | CS5 |
A collection of event listeners.
public function get eventListeners():EventListeners
events | property |
events:Events
[read-only] [override] Since : | CS5 |
A collection of events.
public function get events():Events
highlightObjectUnderSelectionTool | property |
highlightObjectUnderSelectionTool:Boolean
Since : | CS5.5 |
Controls whether or not to highlight object under selection tool.
public function get highlightObjectUnderSelectionTool():Boolean
public function set highlightObjectUnderSelectionTool(value:Boolean):void
includePreview | property |
includePreview:Boolean
Since : | CS5 |
If true, include a preview image when saving the document
public function get includePreview():Boolean
public function set includePreview(value:Boolean):void
isValid | property |
isValid:Boolean
[read-only] [override] Since : | CS5 |
Returns true if the object specifier resolves to valid objects.
public function get isValid():Boolean
openDocumentsAsTabs | property |
openDocumentsAsTabs:Boolean
Since : | CS5 |
If true, documents open as tabs.
public function get openDocumentsAsTabs():Boolean
public function set openDocumentsAsTabs(value:Boolean):void
openRecentLength | property |
openRecentLength:Number
Since : | CS5 |
Number of items to show in the Open Recent menu list. Range: 0 to 30
public function get openRecentLength():Number
public function set openRecentLength(value:Number):void
parent | property |
parent:Object
[read-only] [override] Since : | CS5 |
The parent of the GeneralPreference (a Application).
public function get parent():Object
placeCursorUsesThumbnails | property |
placeCursorUsesThumbnails:Boolean
Since : | CS5 |
Controls whether or not to show thumbnails of imported files in the Place icon.
public function get placeCursorUsesThumbnails():Boolean
public function set placeCursorUsesThumbnails(value:Boolean):void
previewSize | property |
previewSize:PreviewSizeOptions
Since : | CS5 |
The size of the preview image.
public function get previewSize():PreviewSizeOptions
public function set previewSize(value:PreviewSizeOptions):void
properties | property |
properties:Object
[override] Since : | CS5 |
A property that allows setting of several properties at the same time.
public function get properties():Object
public function set properties(value:Object):void
temporaryFolder | property |
temporaryFolder:File
Since : | CS5 |
The location in which to store temporary files.
public function get temporaryFolder():File
public function set temporaryFolder(value:File):void
toolsPanel | property |
toolsPanel:ToolsPanelOptions
Since : | CS5 |
Controls the appearance of the Tools panel.
public function get toolsPanel():ToolsPanelOptions
public function set toolsPanel(value:ToolsPanelOptions):void
toolTips | property |
toolTips:ToolTipOptions
Since : | CS5 |
Tool tip behavior.
public function get toolTips():ToolTipOptions
public function set toolTips(value:ToolTipOptions):void
useApplicationFrame | property |
useApplicationFrame:Boolean
Since : | CS5 |
If true, application lives in a frame.
public function get useApplicationFrame():Boolean
public function set useApplicationFrame(value:Boolean):void
addEventListenerGeneralPreference | () | method |
public function addEventListenerGeneralPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Since : | CS5 |
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)
|
EventListener |
getElements | () | method |
override public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
removeEventListenerGeneralPreference | () | method |
public function removeEventListenerGeneralPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Since : | CS5 |
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)
|
Boolean |
toSpecifier | () | method |
override public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |