// Bridge + ScriptUI — Adobe Bridge 2021 Object Model // Generated from Adobe’s object model export on 2026-09-16. // https://www.indesignjs.de/indesignapi/bridge/ // // Object model, Core JavaScript, the global names AND ScriptUI in one // file — for scripts that put up a dialog. // // 0 product classes give way to the ScriptUI classes of the same name: . // TypeScript holds one meaning per global name, and a dialog needs // new Window(…). References to them read "any" — no help, but nothing // false either. Where those classes matter more than a dialog, take // the plain product file instead. // // ExtendScript is not a browser. With the DOM library loaded, Document, // Event, Text and Window resolve to the browser versions and everything // below becomes invisible — doc.pages would be unknown, doc.createElement // would not. Put this next to your scripts as jsconfig.json: // // { // "compilerOptions": { "lib": ["es5"], "types": [], "checkJs": false }, // "include": ["**/*.js", "**/*.d.ts"] // } // // The descriptive texts are Adobe’s. Where Adobe’s own type information // is unusable, the type is "any" — see the project README. // // Parameters whose Adobe name is a reserved word carry a trailing // underscore: findKeyStrings(for_), prompt(…, default_, …). // Adobe references these type names without ever defining them. // The name is kept so the intent stays readable; the type is not known. type Application = any; /** * The $ object provides a number of debugging facilities and informational * methods. */ declare class $ { /** * The ExtendScript build information. */ static readonly build: string; /** * The ExtendScript build date. */ static readonly buildDate: Date; /** * The character used as the decimal point character in formatted numeric * output. */ static decimalPoint: string; /** * The name of the current ExtendScript engine, if set. */ static readonly engineName: string; /** * The most recent run-time error information. */ static error: Error; /** * The file name of the current script. */ static readonly fileName: string; /** * Gets or sets low-level debug output flags. */ static flags: number; /** * A reference to the global object, which contains the JavaScript global * namespace. */ static readonly global: any; /** * A high-resolution timer, measuring the time in microseconds. The timer * starts when ExtendScript is initialized during the application startup * sequence. Every read access resets the timer to Zero. */ static readonly hiresTimer: number; /** * The path for include files for the current script. */ static readonly includePath: string; /** * The current debugging level, which enables or disables the JavaScript * debugger. */ static level: number; /** * The current line number of the currently executing script. */ static readonly line: number; /** * Gets or sets the current locale. */ static locale: string; /** * Set to true to enable the extended localization features of the built-in * toString() method. */ static localize: boolean; /** * The ExtendScript memory cache size, in bytes. */ static memCache: number; /** * The current operating system version information. */ static readonly os: string; /** * An array of objects containing information about the display screens * attached to your computer. */ static readonly screens: Object[]; /** * The current stack trace. */ static readonly stack: string; /** * Sets or clears strict mode for object modification. */ static strict: any; /** * The version number of the ExtendScript engine. */ static readonly version: string; /** * Shows an About box for the ExtendScript component, and returns the text for * the box. */ static about(): string; /** * Breaks execution at the current position. * @param condition A string containing a JavaScript statement to be used as a condition. If the statement evaluates to true or nonzero when this point is reached, execution stops. */ static bp(condition?: any): void; /** * Invokes the platform-specific color selection dialog, and returns the * selected color. * @param color The color to be preselected in the dialog, as 0xRRGGBB, or -1 for the platform default. */ static colorPicker(color: number): number; /** * Loads and evaluates a file. * @param file The file to load. * @param timeout An optional timeout in milliseconds. */ static evalFile(file: File, timeout?: number): any; /** * Initiates garbage collection in the ExtendScript engine. */ static gc(): void; /** * Retrieves the value of an environment variable. * @param name The name of the variable. */ static getenv(name: string): string; /** * Sets the value of an environment variable. * @param name The name of the variable. * @param value The value of the variable. */ static setenv(name: string, value: string): void; /** * Suspends the calling thread for a number of milliseconds. * @param msecs Number of milliseconds to sleep. */ static sleep(msecs: number): void; /** * Converts this object to a string. */ static toString(): string; /** * Prints text to the Console. * @param text The text to print. All arguments are concatenated. */ static write(text: any): void; /** * Prints text to the Console, and adds a newline character. * @param text The text to print. All arguments are concatenated. */ static writeln(text: any): void; } /** * Represents the Adobe Bridge application. */ declare class App { /** * A collection of the default FilterDescription objects used to populate the * Filter palette. */ readonly defaultFilterCriteria: any[]; /** * A collection of the default SortCriterion objects used to sort the contents * of container nodes. */ readonly defaultSortCriteria: any[]; /** * The policy for the display of modal dialogs. */ displayDialogs: string; /** * The active (top-most) Document object, representing the active browser * window. */ document: Document; /** * A collection of Document objects representing the set of all open browser * windows. */ readonly documents: any[]; /** * An array of event handler objects installed by scripts. */ eventHandlers: any[]; /** * A collection of ExtensionHandler objects representing registered * node-handling extensions. */ readonly extensions: any[]; /** * The top-level Favoritesobject for the navigation hierarchy displayed in the * Favorites palette. */ readonly favorites: Favorites; /** * The list of Bridge URI strings for the root nodes of the Folders palette. */ readonly folderRoots: any[]; /** * The collection of script-defined InspectorPanel objects that make up the * Inspector view for new browser windows. */ readonly inspectorPanels: any[]; /** * The display name of the language for the current locale, as configured by * the operating system. */ readonly language: string; /** * The application specifier for the application that has most recently sent an * interapplication message to Adobe Bridge. */ lastSender: string; /** * The Adobe locale code for the current locale, as configured by the operating * system. */ readonly locale: string; /** * The application specifier for this application, "bridge". */ readonly name: string; /** * The number of background tasks that Adobe Bridge has left to process. */ readonly pendingJobs: number; /** * The Preferences object, which provides access to the user preferences shown * in the Preferences dialog. */ readonly preferences: Preferences; readonly standardFavorites: any[]; /** * When true, Adobe Bridge attempts to ensure that all Thumbnail properties are * valid before returning their values. */ synchronousMode: boolean; readonly userFavorites: any[]; /** * The version number of the Adobe Bridge application. */ readonly version: string; /** * The duration in seconds between checks for folder consistency (checking * whether files have been added or removed). */ watchDirInterval: number; /** * The list of all available workspaces, both default and user- or * script-defined. */ readonly workspaces: any[]; /** * For each specified file or folder, if it refers to a resource that does not * have a local copy (such as the files referenced by VersionCue nodes), * downloads the resource. * @param files An array of strings, each of which is a file or folder specification */ acquirePhysicalFiles(files: any[]): void; /** * Adds a member thumbnail, or set of member thumbnails, to a collection. * @param collection The Thumbnail object for the collection node, as returned by app.createCollection(). * @param member A Thumbnail object or Array of Thumbnail objects to be added to the collection. */ addCollectionMember(collection: Thumbnail, member: any): boolean; /** * Appends a line of text to the Credits section of the Adobe Bridge About box. * @param title The unique identifying string for this addition. * @param content The localizable string to be displayed. */ addCredits(title: string, content: string): any; /** * Appends a custom URI to the list of root nodes in app.folderRoots, which * appear in the Folders palette. * @param uri The Bridge URI string. */ addCustomRoot(uri: string): boolean; /** * Appends a line of text to the Legal Notice section of the Adobe Bridge About * box. * @param title The unique identifying string for this addition. * @param content The localizable string to be displayed. */ addLegalNotice(title: string, content: string): any; /** * Calls on the operating system to emit a short audio tone. */ beep(): void; /** * Gives Adobe Bridge the application focus for the operating system, and makes * the current browser window the topmost active window in the windowing * system. */ bringToFront(): void; /** * Deprecated in Creative Suite 3. Do not use. */ browseTo(): any; /** * Forces Adobe Bridge to create thumbnail images for the specified folder. * @param path The folder. * @param recurse Optional in Adobe Bridge 1.0, not used in Adobe Bridge 2.0. * @param quality Whether to create low or high quality thumbnail images. * @param buildFullSize Whether to export fullsize images to cache folder. */ buildFolderCache(path: Object | string, recurse?: boolean, quality?: string, buildFullSize?: boolean): any; /** * Cancels a task that has been scheduled using app.scheduleTask(). * @param taskId The task ID number, as returned from app.scheduleTask(). */ cancelTask(taskId: number): any; /** * Creates a new, named collection node. * @param name The name of the new collection. */ createCollection(name: string): Thumbnail; /** * Creates a new, named smart collection node. * @param name The name of the new smart collection. * @param scope A Thumbnail object for the target container node. * @param searchSpec A SearchSpecification object used to generate the search result. */ createSmartCollection(name: string, scope: Thumbnail, searchSpec: SearchSpecification): Thumbnail; /** * Deletes a collection node. * @param collection The Thumbnail object for the collection node, as returned by app.createCollection(). */ deleteCollection(collection: Thumbnail): boolean; /** * Deletes a smart collection node. * @param collection The Thumbnail object for the collection node, as returned by app.createSmartCollection(). */ deleteSmartCollection(collection: Thumbnail): boolean; /** * Enqueues a long-running node-handling operation for execution at an * appropriate time. * @param operator The ModalOperator or ProgressOperator instance that encapsulates the operation, returned by an ExtensionModel method. */ enqueueOperation(operator: Object): void; /** * Exports keywords from the Keywords palette to a file. * @param keywordsFile The file, specified as a string or ExtendScript File object. */ exportKeywordsFromFile(keywordsFile: string | File): void; /** * Retrieves the collection members for a collection node. * @param collection The Thumbnail object for the collection node, as returned by app.createCollection(). */ getCollectionMembers(collection: Thumbnail): any[]; /** * Retrieves all collection nodes, as created with app.createCollection(). */ getCollections(): any[]; /** * Retrieves all smart collection nodes, as created with * app.createSmartCollection(). */ getSmartCollections(): any[]; /** * Hides or minimizes all Adobe Bridge browser windows. */ hide(): void; /** * Imports keywords from a file to the Keywords palette. * @param keywordsFile The file, specified as a string or ExtendScript File object. * @param importType Whether to replace existing keywords in the palette, or merge these keywords with any existing keywords in the palette. */ importKeywordsFromFile(keywordsFile: string | File, importType?: string): void; /** * Reports whether a given thumbnail is a member of a given collection. * @param collection The Thumbnail object for the collection node, as returned by app.createCollection(). * @param member The Thumbnail object for the node to be tested. */ isCollectionMember(collection: Thumbnail, member: Thumbnail): boolean; /** * Reports whether Adobe Bridge is processing any jobs. Returns false if all * the jobs are finished. */ isProcessingJob(): boolean; /** * Opens a page in the platform's default web browser. * @param url The URL for the page to open. */ openUrl(url: string): void; /** * Notifies Adobe Bridge of an update to the processing status or progress of a * long-running background operation implemented by a ProgressOperator object. * @param operator The ProgressOperator object that encapsulates the operation. */ operationChanged(operator: ProgressOperator): void; /** * DEPRECATED in Creative Suite 3. Use app.acquirePhysicalFiles() instead. * @param files */ preflightFiles(files: any): boolean; /** * Purges the thumbnail caches for all folders. */ purgeAllCaches(): void; /** * Purges the thumbnail cache for a folder. * @param path The folder to purge. */ purgeFolderCache(path?: Object | string): any; /** * Shuts down the Adobe Bridge application and closes all browser windows. */ quit(): void; /** * DEPRECATED in Creative Suite 3. Do not use. * @param protocol * @param handler */ registerBrowseScheme(protocol: string, handler: Object): boolean; /** * Adds a script-defined node-handling extension to the application's list of * available handlers, app.extensions. * @param extension The ExtensionHandler object. */ registerExtension(extension: ExtensionHandler): boolean; /** * Declares a new node-data information set, associating it with a * node-handling extension. * @param extension The ExtensionHandler object. * @param infoset The Infoset object. */ registerInfoset(extension: ExtensionHandler, infoset: Infoset): boolean; /** * Registers a script-defined Inspector panel, adding it to * app.inspectorPanels. * @param panel The InspectorPanel object. */ registerInspectorPanel(panel: InspectorPanel): boolean; /** * Associates a URI prefix string with a node-handling extension. * @param prefix The prefix string , which must contain only ASCII characters. * @param extension The ExtensionHandler object. */ registerPrefix(prefix: string, extension: ExtensionHandler): boolean; /** * Removes one or more member thumbnails from a collection. * @param collection The Thumbnail object for the collection node, as returned by app.createCollection(). * @param member The Thumbnail object for the node to be removed, or an Array of Thumbnail objects. */ removeCollectionMember(collection: Thumbnail, member: any): boolean; /** * Removes a text item from the Credits area of the Adobe Bridge About box. * @param title The unique identifying string for the item to remove. */ removeCredits(title: any): any; /** * Removes a text item from the LegalNotice area of the Adobe Bridge About box. * @param title The unique identifying string for the item to remove. */ removeLegalNotice(title: any): any; /** * @param arg1 * @param name */ renameCollection(arg1: Thumbnail, name: string): Thumbnail; /** * @param arg1 * @param name */ renameSmartCollection(arg1: Thumbnail, name: string): Thumbnail; /** * Loads a set of files or thumbnails as a slideshow, using the Preference * options currently set for Adobe Bridge. * @param sources An array of Thumbnail objects or file path strings. */ runSlideshow(sources: any[]): void; /** * Executes a script after a specified delay. * @param script A string containing the script to be run. * @param delay A number of milliseconds to wait before executing the script. * @param repeat When true, execute the script repeatedly after each elapsed delay. */ scheduleTask(script: string, delay: number, repeat?: boolean): number; /** * Issues the argument to the operating system, as if it were entered on the * command line in a shell. * @param commandLine The command to pass to the operating system. */ system(commandLine: string): any; /** * Removes a node-handling extension, previously registered with * app.registerExtension(), from the application’s global list. * @param extension The ExtensionHandler object. */ unregisterExtension(extension: ExtensionHandler): void; /** * Removes the association between an extension and an information set, * previously established with app.registerInfoset(). * @param extension The ExtensionHandler object. * @param infoset The Infoset object. */ unregisterInfoset(extension: ExtensionHandler, infoset: Infoset): any; /** * Removes a script-defined Inspector panel from the global list in * app.inspectorPanels(). * @param panel The InspectorPanel object. */ unregisterInspectorPanel(panel: InspectorPanel): boolean; /** * Removes a node URI prefix from the list of prefixes that the associated * node-handling extension manages. * @param prefix The prefix string. * @param extension The ExtensionHandler object. */ unregisterPrefix(prefix: string, extension: ExtensionHandler): boolean; } /** * Represents an image as a matrix of pixell. */ declare class BitmapData { readonly channelCount: number; /** * A 32-bit Adler checksum of the image data. */ readonly checksum: number; readonly colorSpace: number; /** * Image height in pixels. */ readonly height: number; /** * A pointer to the buffer storing the matrix of pixels. */ readonly pointer: number; /** * The rectangle that defines the size of the bitmap image, in the format [0, * 0, w, h]. Origin is top left. */ readonly rectangle: any[]; /** * The length in bytes of a row of pixels. */ readonly rowBytes: number; /** * True if the bitmap image supports per-pixel transparency. */ readonly transparent: boolean; /** * Image width in pixels. */ readonly width: number; /** * Duplicates this object, creating a new object with an exact copy of the * contained bitmap. */ clone(): BitmapData; /** * Explicitly frees the memory used to store pixel data for this object. */ dispose(): void; /** * Writes the image data to a file in JPEG format. * @param dest A File object or a string containing the platform-specific path and filename for the target file. * @param jpegQuality The quality of the image. */ exportTo(dest: File, jpegQuality?: number): void; /** * Retrieves the color data for a specific pixel from the image. * @param x The horizontal coordinate of the pixel, relative to the bitmap's origin, the top left. * @param y The vertical coordinate of the pixel, relative to the bitmap's origin, the top left. */ getPixel(x: number, y: number): number; /** * Retrieves the color data for a specific pixel from the image, including its * alpha channel. * @param x The horizontal coordinate of the pixel, relative to the bitmap's origin, the top left. * @param y The vertical coordinate of the pixel, relative to the bitmap's origin, the top left. */ getPixel32(x: number, y: number): number; /** * Loads the JPEG stream at a memory address into this object, replacing the * previous content. * @param data The address of the data stream. * @param dataSize The length of the data buffer in bytes. */ loadFromJpegStream(data: number, dataSize: number): void; /** * Loads the PNG stream at a memory address into this object, replacing the * previous content. * @param data The address of the data stream. * @param dataSize The length of the data buffer in bytes. */ loadFromPngStream(data: number, dataSize: number): void; /** * Resizes the bitmap to the specified dimensions. * @param dimensions The desired edge size, in pixels, of the resized image. * @param quality The algorithm to use in scaling, which trades off image quality and execution time. */ resize(dimensions: number, quality?: string): BitmapData; /** * Rotates the bitmap by the specified multiple of 90 degrees. * @param angle The rotation angle in degrees. */ rotate(angle: number): BitmapData; /** * Sets the color data for a specific pixel from the image. * @param x The horizontal coordinate of the pixel, relative to the bitmap's origin, the top left. * @param y The vertical coordinate of the pixel, relative to the bitmap's origin, the top left. * @param color The color. */ setPixel(x: number, y: number, color: Object): void; /** * Sets the color data for a specific pixel from the image, including its alpha * channel. * @param x The horizontal coordinate of the pixel, relative to the bitmap's origin, the top left. * @param y The vertical coordinate of the pixel, relative to the bitmap's origin, the top left. * @param color The color. */ setPixel32(x: number, y: number, color: Object): void; } /** * Defines the boundaries of a window within the screen’s coordinate space, or * of a UI element within the container’s coordinate space. */ declare class Bounds { /** * The vertical coordinate, a pixel offset from the origin of the element's * coordinate space. */ bottom: number; /** * The height in pixels. */ height: number; /** * The horizontal coordinate, a pixel offset from the origin of the element's * coordinate space. */ left: number; /** * The array length. */ readonly length: number; /** * The width in pixels. */ right: number; /** * The height in pixels. */ top: number; /** * The width in pixels. */ width: number; /** * The horizontal coordinate, a pixel offset from the origin of the element's * coordinate space. */ x: number; /** * The vertical coordinate, a pixel offset from the origin of the element's * coordinate space. */ y: number; } /** * A pushbutton element containing a mouse-sensitive text string. */ declare class Button { /** * True if this element is active. */ active: boolean; /** * The alignment style for this element. If defined, this value overrides the * alignChildren setting for the parent container. */ alignment: string; /** * The boundaries of the element, in parent-relative coordinates. */ bounds: Bounds; /** * A number of characters for which to reserve space when calculating the * preferred size of the element. * @remarks Range: 0 to … */ characters: number; /** * An array of child elements. */ readonly children: Object[]; /** * True if this element is enabled. */ enabled: boolean; /** * The graphics object that can be used to customize the element's appearance, * in response to the onDraw() event. */ readonly graphics: ScriptUIGraphics; /** * The help string that is displayed when the mouse hovers over the element. */ helpTip: string; /** * The number of pixels to indent the element during automatic layout. * @remarks Range: 0 to … */ indent: number; /** * The text justification style. */ justify: string; /** * The upper left corner of this element relative to its parent. */ location: Point; /** * The maximum height and width to which the element can be resized. */ maximumSize: Dimension; /** * The minimum height and width to which the element can be resized. */ minimumSize: Dimension; /** * The parent element. */ readonly parent: any; /** * The preferred size, used by layout managers to determine the best size for * each element. */ preferredSize: Dimension; /** * An object that contains one or more creation properties of the container * (properties used only when the element is created). */ properties: Object; /** * The key sequence that invokes the onShortcutKey() callback for this element * (in Windows only). */ shortcutKey: string; /** * The current dimensions of this element. */ size: Dimension; /** * The text to display, a localizable string. */ text: string; /** * The element type; "button". */ readonly type: string; /** * True if this element is shown, false if it is hidden. */ visible: boolean; /** * The window that this element belongs to. */ readonly window: Window; /** * The bounds of this element relative to the top-level parent window. */ readonly windowBounds: Bounds; /** * Registers an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase When true, the handler is called only in the capturing phase of the event propagation. */ addEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Simulates the occurrence of an event in this target. */ dispatchEvent(): Event; /** * Hides this element. */ hide(): void; /** * Sends a notification message, simulating the specified user interaction * event. * @param eventName The name of the control event handler to call. */ notify(eventName?: string): void; /** * An event-handler callback function, called when the element acquires the * keyboard focus. */ onActivate(): void; /** * An event-handler callback function, called when the element has been clicked */ onClick(): void; /** * An event-handler callback function, called when the element loses the * keyboard focus. */ onDeactivate(): void; /** * An event-handler callback function, called when the window is about to be * drawn. */ onDraw(): void; /** * An event-handler callback function, called when the element's shortcutKey * sequence is typed in the active window. */ onShortcutKey(): void; /** * Unregisters an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase Whether to call the handler only in the capturing phase of the event propagation. */ removeEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Shows this element. */ show(): any; } /** * Tracks the current cache status of node data in an Infoset object. */ declare class CacheData { /** * Opaque storage to aid extensions in discovering the cache status. */ cookie: string; /** * The cache status for a member of the associated information set, or of the * set itself. */ status: string; } /** * Encapsulates all node-handling data and the node handler for a Thumbnail * object. */ declare class CacheElement { /** * Core data set. */ badges: Infoset; /** * Core data set. */ cameraRaw: Infoset; /** * Core data set. */ children: Infoset; /** * Core data set. */ fullsize: Infoset; /** * Core data set. */ icon: Infoset; /** * Core data set. */ immediate: Infoset; /** * Core data set. */ item: Infoset; /** * Core data set. */ itemContent: Infoset; /** * Core data set. */ linkTarget: Infoset; /** * Core data set. */ metadata: Infoset; /** * The path of the asset associated with this object. */ readonly path: string; /** * Core data set. */ preview: Infoset; /** * Core data set. */ quickMetadata: Infoset; /** * Core data set. */ thumbnail: Infoset; /** * Calls the authenticate() method defined in the ExtensionHandler object * associated with this element. */ doAuthentication(): void; } /** * A dual-state control showing a box that has a checkmark when the value is * true, and is empty when the value is false. */ declare class Checkbox { /** * True if this element is active. */ active: boolean; /** * The alignment style for this element. If defined, this value overrides the * alignChildren setting for the parent container. */ alignment: string; /** * The boundaries of the element, in parent-relative coordinates. */ bounds: Bounds; /** * A number of characters for which to reserve space when calculating the * preferred size of the element. * @remarks Range: 0 to … */ characters: number; /** * An array of child elements. */ readonly children: Object[]; /** * True if this element is enabled. */ enabled: boolean; /** * The graphics object that can be used to customize the element's appearance, * in response to the onDraw() event. */ readonly graphics: ScriptUIGraphics; /** * The help text that is displayed when the mouse hovers over the element. */ helpTip: string; /** * The number of pixels to indent the element during automatic layout. * @remarks Range: 0 to … */ indent: number; /** * The default text justification style for child text elements. */ justify: string; /** * The upper left corner of this element relative to its parent. */ location: Point; /** * The maximum height and width to which the element can be resized. */ maximumSize: Dimension; /** * The minimum height and width to which the element can be resized. */ minimumSize: Dimension; /** * The parent element. */ readonly parent: any; /** * The preferred size, used by layout managers to determine the best size for * each element. */ preferredSize: Dimension; /** * An object that contains one or more creation properties of the item * (properties used only when the element is created). */ properties: Object; /** * The key sequence that invokes the onShortcutKey() callback for this element * (in Windows only). */ shortcutKey: string; /** * The current dimensions of this element. */ size: Dimension; /** * The text to display, a localizable string. */ text: string; /** * The element type; "checkbox". */ readonly type: string; /** * The selection state of the control. */ value: boolean; /** * True if this element is shown, false if it is hidden. */ visible: boolean; /** * The window that this element belongs to. */ readonly window: Window; /** * The bounds of this element relative to the top-level parent window. */ readonly windowBounds: Bounds; /** * Registers an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase When true, the handler is called only in the capturing phase of the event propagation. */ addEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Simulates the occurrence of an event in this target. */ dispatchEvent(): Event; /** * Hides this element. */ hide(): void; /** * Sends a notification message, simulating the specified user interaction * event. * @param eventName The name of the control event handler to call. */ notify(eventName?: string): void; /** * An event-handler callback function, called when the element acquires the * keyboard focus. */ onActivate(): void; /** * An event-handler callback function, called when the element has been * clicked. */ onClick(): void; /** * An event-handler callback function, called when the element loses the * keyboard focus. */ onDeactivate(): void; /** * An event-handler callback function, called when the window is about to be * drawn. */ onDraw(): void; /** * An event-handler callback function, called when the element's shortcutKey * sequence is typed in the active window. */ onShortcutKey(): void; /** * Unregisters an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase Whether to call the handler only in the capturing phase of the event propagation. */ removeEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Shows this element. */ show(): any; } /** * Represents a pixel in the sRGB color space, with an optional alpha channel * for opacity. */ declare class Color { /** * Degree of opacity when the color is composited. */ alpha: number; /** * Blue component value. */ blue: number; /** * Green component value. */ green: number; /** * The color expressed as a 32-bit ARGB value. */ number: number; /** * Red component value. */ red: number; /** * Retrieves the hexadecimal value of this color, including the alpha channel. */ toString(): string; } /** * Defines the size of a window or UI element. Contains a 2-element array. */ declare class Dimension { /** * The height in pixels. */ height: number; /** * The array length. */ readonly length: number; /** * The width in pixels. */ width: number; } /** * Represents an Adobe Bridge browser window. */ declare class Document { /** * Identifies up to four lines of additional metadata to display for thumbnails * in the Content pane. */ additionalMetadata: any[]; /** * Whether to allow drag-and-drop of thumbnails in this browser window. */ allowDrags: boolean; /** * DEPRECATED. Use navbars.filesystem.bottom. */ bottomNavbar: any; /** * The browser window mode, corresponding to the UI button on the upper right, * "Switch to compact mode". */ browserMode: string; /** * DEPRECATED. Do not use. */ readonly content: any; /** * DEPRECATED. Do not use. */ contentPaneMode: string; /** * The Thumbnail object a user has right-clicked to invoke a context menu; * otherwise undefined. */ readonly context: Thumbnail; /** * Whether to display Inspector panels. */ displayInspectorView: boolean; /** * Current selected thumbnails in the Content pane. */ readonly groupedSelections: any[]; /** * The height of the browser window in pixels. */ height: number; /** * In Windows only, a platform-specific handle to the window for this browser. */ readonly hwnd: number; /** * A unique identifier for the browser window, valid for the life of the * window. */ readonly id: number; /** * DEPRECATED. Do not use. */ jsFuncs: any; /** * When true, this browser window is in the zoomed or maximized state. */ readonly maximized: boolean; /** * When true, this browser window is in the collapsed or minimized state. */ readonly minimized: boolean; /** * Contains the predefined NavBar objects for the configurable navigation bars. */ readonly navbars: any; /** * Text to be displayed in the Content pane when the selected thumbnail is for * an empty folder. */ noItems: string; /** * The Adobe Bridge-enabled application that created or first activated this * browser window, if it was not Adobe Bridge. */ owner: string; /** * A collection of TabbedPalette objects for all default and script-defined * display palettes available to this browser, regardless of their visibility * status. */ readonly palettes: any[]; /** * The position of this browser window on the screen. */ position: Object; /** * The presentation mode of the Content pane. */ readonly presentationMode: string; /** * The path to the content displayed in the Content pane. */ presentationPath: string; /** * The number of currently selected thumbnails in the Content pane. */ readonly selectionLength: number; /** * The Thumbnail objects for all currently selected files in the Content pane * of this document. */ readonly selections: any[]; /** * The number of currently selected thumbnails in the Content pane. */ readonly selectionsLength: number; /** * When true, thumbnail names are displayed in the Content pane. */ showThumbnailName: boolean; /** * How the thumbnails in the Content pane are sorted. */ sorts: any[]; /** * A list of all current thumbnail stacks in this browser. */ stacks: any[]; /** * The text displayed in the document's status line at the bottom of the * Content pane. */ status: string; /** * The Thumbnail object for the node currently selected in the Folders or * Favorites pane. */ thumbnail: Thumbnail; /** * The view mode of the Content pane, as selected by the View menu. */ thumbnailViewMode: string; /** * DEPRECATED. Use navbars.filesystem.top. */ topNavbar: any; /** * When true, the browser window is expanded, as opposed to being minimized or * collapsed. */ visible: boolean; /** * An array of Thumbnail objects that are currently shown in the Content pane. */ readonly visibleThumbnails: any[]; /** * The number of thumbnails in the visibleThumbnails array. */ readonly visibleThumbnailsLength: number; /** * DEPRECATED. Do not use. */ visitUrl: any; /** * The width of the browser window in pixels. */ width: number; /** * Retrieves the most recently set workspace. */ readonly workspace: any; /** * Makes this browser window the topmost active window in the windowing system. */ bringToFront(): void; /** * Centers this browser window on the screen. */ center(): void; /** * Executes an Adobe Bridge-defined or script-defined menu command * programatically. * @param menuID The unique identifier for the command to execute. */ chooseMenuItem(menuID: string): void; /** * Closes this browser window. */ close(): void; /** * Deselects a node in the Content pane. * @param thumbnail The Thumbnail for the node. */ deselect(thumbnail: Thumbnail): boolean; /** * Deselects all selected nodes in the Content pane. */ deselectAll(): void; /** * DEPRECATED. Do not use. */ execJS(): void; /** * Stores stack properties into the cache file. */ flushStackProperties(): void; /** * Collects selected thumbnails for files of a given type, if any are selected. * @param filter A comma-delimited list of file extensions to match. */ getSelection(filter?: string): any[]; /** * Maximizes or zooms this browser window. */ maximize(): void; /** * Minimizes or docks this browser window. */ minimize(): void; /** * Centers this browser window on the screen, and sets the height and width to * 80% of the screen height and width. */ normalize(): void; /** * DEPRECATED in Creative Suite 3. Use app.acquirePhysicalFiles() instead. */ preflightFiles(): void; /** * DEPRECATED. Do not use. */ print(): void; /** * Refreshes the display of this browser window. */ refresh(): void; /** * Restores the default configuration of the tabbed palettes in this browser * window. */ resetToDefaultWorkspace(): void; /** * Restores this browser window after it has been minimized. */ restore(): void; /** * Causes the Content pane (not the Folders or Favorites pane) to show the * specified thumbnail. * @param thumbnail The Thumbnail object. */ reveal(thumbnail: Thumbnail): void; /** * Selects a thumbnail in the Content pane. * @param thumbnail The Thumbnail object. */ select(thumbnail: any): boolean; /** * Selects all children of the currenly selected thumbnail in the Content pane. */ selectAll(): void; /** * Sets the presentation mode of the Content pane, and optionally the path to * the current content to display. * @param mode The new display mode. * @param path The path string, a Bridge URI. */ setPresentationMode(mode: string, path?: string): void; /** * Sets the browser configuration to a predefined, user-defined or * script-defined workspace. * @param workspaceId The unique, identifying name string for the new workspace. */ setWorkspace(workspaceId: string): boolean; } /** * Describes an input state at the time of the triggering * ScriptUIGraphics.onDraw() event. */ declare class DrawState { /** * True if the Alt key is being pressed (in Windows only). */ readonly altKeyPressed: boolean; /** * True if the Caps Lock key is being pressed. */ readonly capsLockKeyPressed: boolean; /** * True if the Command key is being pressed (in Mac OS only). */ readonly cmdKeyPressed: boolean; /** * True if the Ctrl key is being pressed. */ readonly ctrlKeyPressed: boolean; /** * True if the element has the input focus. */ readonly hasFocus: boolean; /** * True if the left mouse button is being pressed. */ readonly leftButtonPressed: boolean; /** * True if the middle mouse button is being pressed. */ readonly middleButtonPressed: boolean; /** * True if the cursor is hovering over this element. */ readonly mouseOver: boolean; /** * True if the Num Lock key is being pressed. */ readonly numLockKeyPressed: boolean; /** * True if the Option key is being pressed (in Mac OS only). */ readonly optKeyPressed: boolean; /** * True if the right mouse button is being pressed. */ readonly rightButtonPressed: boolean; /** * True if the Shift key is being pressed. */ readonly shiftKeyPressed: boolean; } /** * Displays a single visible item. When you click the control, a list drops * down or pops up, and allows you to select one of the other items in the * list. */ declare class DropDownList { /** * True if this element is active. */ active: boolean; /** * The alignment style for this element. If defined, this value overrides the * alignChildren setting for the parent container. */ alignment: string; /** * The boundaries of the element, in parent-relative coordinates. */ bounds: Bounds; /** * An array of child elements. */ readonly children: Object[]; /** * True if this element is enabled. */ enabled: boolean; /** * The graphics object that can be used to customize the element's appearance, * in response to the onDraw() event. */ readonly graphics: ScriptUIGraphics; /** * The help text that is displayed when the mouse hovers over the element. */ helpTip: string; /** * The number of pixels to indent the element during automatic layout. * @remarks Range: 0 to … */ indent: number; /** * The width and height in pixels of each item in the list. */ itemSize: Dimension; /** * The array of choice items displayed in the drop-down or pop-up list. */ readonly items: ListItem[]; /** * The upper left corner of this element relative to its parent. */ location: Point; /** * The maximum height and width to which the element can be resized. */ maximumSize: Dimension; /** * The minimum height and width to which the element can be resized. */ minimumSize: Dimension; /** * The parent element. */ readonly parent: any; /** * The preferred size, used by layout managers to determine the best size for * each element. */ preferredSize: Dimension; /** * An object that contains one or more creation properties of the container * (properties used only when the element is created). */ properties: Object; /** * The currently selected list item. */ selection: ListItem; /** * The key sequence that invokes the onShortcutKey() callback for this element * (in Windows only). */ shortcutKey: string; /** * The current dimensions of this element. */ size: Dimension; /** * The element type; "dropdownlist". */ readonly type: string; /** * True if this element is shown, false if it is hidden. */ visible: boolean; /** * The window that this element belongs to. */ readonly window: Window; /** * The bounds of this element relative to the top-level parent window. */ readonly windowBounds: Bounds; /** * Adds an item or separator to the choices in this list. * @param type The type of the child element. * @param text The localizable text label for the item. */ add(type: string, text?: string): ListItem; /** * Registers an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase When true, the handler is called only in the capturing phase of the event propagation. */ addEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Simulates the occurrence of an event in this target. */ dispatchEvent(): Event; /** * Retrieves an item object from the list that has a given text label. * @param text The text string to match. */ find(text: string): ListItem; /** * Hides this element. */ hide(): void; /** * Sends a notification message, simulating the specified user interaction * event. * @param eventName The name of the control event handler to call. */ notify(eventName?: string): void; /** * An event-handler callback function, called when the element acquires the * keyboard focus. */ onActivate(): void; /** * An event-handler callback function, called when the content of the element * has been changed */ onChange(): void; /** * An event-handler callback function, called when the element loses the * keyboard focus. */ onDeactivate(): void; /** * An event-handler callback function, called when the window is about to be * drawn. */ onDraw(): void; /** * An event-handler callback function, called when the element's shortcutKey * sequence is typed in the active window. */ onShortcutKey(): void; /** * Removes a child item from the list. * @param what The item or child to remove, specified by 0-based index, text value, or as a ListItem object. */ remove(what: any): void; /** * Removes all child items from the list. */ removeAll(): void; /** * Unregisters an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase Whether to call the handler only in the capturing phase of the event propagation. */ removeEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Shows this element. */ show(): any; } /** * Provides ways to edit the capture time of .jpeg and .raw files. */ declare class EditCaptureTime { /** * Reverts the capture time of all selected files to the original capture time. */ revertToOriginalTime(): void; /** * Sets the capture time of all files to a specified time. * @param date Date to be set for the selected files. * @param month Month to be set for the selected files. * @param year Year to be set for the selected files. * @param hour Hour to be set for the selected files. * @param minute Minute to be set for the selected files. * @param second Second to be set for the selected files. */ setToCorrectedTime(date: number, month: number, year: number, hour: number, minute: number, second: number): boolean; /** * Shift capture time by set time. * @param sign Signifies whether you want to add or subtract the set time. * @param Shiftedhour Shifts the capture time of the selected files by a specified number of hours. * @param ShiftedMinute Shifts the capture time of the selected files by a specified number of minutes. * @param ShiftedSecond Shifts the capture time of the selected files by a specified number of seconds. */ shiftBySetTime(sign: string, Shiftedhour: number, ShiftedMinute?: number, ShiftedSecond?: number): boolean; } /** * An editable text field that the user can select and change. */ declare class EditText { /** * True if this element is active. */ active: boolean; /** * The alignment style for this element. If defined, this value overrides the * alignChildren setting for the parent container. */ alignment: string; /** * The boundaries of the element, in parent-relative coordinates. */ bounds: Bounds; /** * A number of characters for which to reserve space when calculating the * preferred size of the element. * @remarks Range: 0 to … */ characters: number; /** * An array of child elements. */ readonly children: Object[]; /** * True if this element is enabled. */ enabled: boolean; /** * The graphics object that can be used to customize the element's appearance, * in response to the onDraw() event. */ readonly graphics: ScriptUIGraphics; /** * The help text that is displayed when the mouse hovers over the element. */ helpTip: string; /** * The number of pixels to indent the element during automatic layout. * @remarks Range: 0 to … */ indent: number; /** * The text justification style. */ justify: string; /** * The upper left corner of this element relative to its parent. */ location: Point; /** * The maximum height and width to which the element can be resized. */ maximumSize: Dimension; /** * The minimum height and width to which the element can be resized. */ minimumSize: Dimension; /** * The parent element. */ readonly parent: any; /** * The preferred size, used by layout managers to determine the best size for * each element. */ preferredSize: Dimension; /** * An object that contains one or more creation properties of the container * (properties used only when the element is created). */ properties: Object; /** * The key sequence that invokes the onShortcutKey() callback for this element * (in Windows only). */ shortcutKey: string; /** * The current dimensions of this element. */ size: Dimension; /** * The current text displayed in the field, a localizable string. */ text: string; /** * The currently selected text, or the empty string if there is no text * selected. */ textselection: string; /** * The element type; "edittext". */ readonly type: string; /** * True if this element is shown, false if it is hidden. */ visible: boolean; /** * The window that this element belongs to. */ readonly window: Window; /** * The bounds of this element relative to the top-level parent window. */ readonly windowBounds: Bounds; /** * Registers an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase When true, the handler is called only in the capturing phase of the event propagation. */ addEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Simulates the occurrence of an event in this target. */ dispatchEvent(): Event; /** * Hides this element. */ hide(): void; /** * Sends a notification message, simulating the specified user interaction * event. * @param eventName The name of the control event handler to call. */ notify(eventName?: string): void; /** * An event-handler callback function, called when the element acquires the * keyboard focus. */ onActivate(): void; /** * An event-handler callback function, called when the content of the element * has been changed */ onChange(): void; /** * An event-handler callback function, called when the content of the element * is in the process of changing */ onChanging(): void; /** * An event-handler callback function, called when the element loses the * keyboard focus. */ onDeactivate(): void; /** * An event-handler callback function, called when the window is about to be * drawn. */ onDraw(): void; /** * An event-handler callback function, called when the element's shortcutKey * sequence is typed in the active window. */ onShortcutKey(): void; /** * Unregisters an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase Whether to call the handler only in the capturing phase of the event propagation. */ removeEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Shows this element. */ show(): any; } /** * Defines attributes of the ScriptUI environment. */ declare class Environment { /** * An object that reports the active state of the keyboard at any time. */ readonly keyboardState: KeyboardState; } /** * Base class for UIEvent. */ declare class Event { static readonly AT_TARGET: any; static readonly BUBBLING_PHASE: any; static readonly CAPTURING_PHASE: any; static readonly NOT_DISPATCHING: any; /** * True if the event is of a type that bubbles. */ readonly bubbles: boolean; /** * True if the default action associated with the event can be canceled with * preventDefault(). */ readonly cancelable: boolean; /** * True if this event can be captured. */ readonly captures: boolean; /** * The event target object which is currently handling the event. During * capturing and bubbling, this is different from the property target. */ readonly currentTarget: boolean; /** * The current phase of event propagation; one of none, target, capture, * bubble. */ readonly eventPhase: string; /** * The event target object for this event. */ readonly target: any; /** * The date and time at which the event occurred. */ readonly timeStamp: Date; /** * The name of the event that this object represents. */ readonly type: string; /** * Prevents the default action associated with this event from being called. */ preventDefault(): void; /** * Stops the propagation of this event. */ stopPropagation(): void; } /** * Provides access to objects used in the ScriptUI event system. */ declare class Events { /** * Creates an instance of the specified Event subclass. * @param eventType The name of an event type: one of "UIEvent", "KeyboardEvent", or "MouseEvent". */ createEvent(eventType: string): Event; } /** * Defines the properties and methods needed to extend the Adobe Bridge node * model. */ declare class ExtensionHandler { /** * Implement a function that acquires actual file data for a set of placeholder * nodes. */ acquirePhysicalFiles: Function; /** * Implement a function that duplicates a set of nodes that are handled by this * handler. */ duplicate: Function; /** * Implement a function that converts a path string to a canonical Bridge URI. */ getBridgeUriForPath: Function; /** * Implement a function that executes an extension-defined search among Adobe * Bridge nodes of an extension-defined node type. */ getBridgeUriForSearch: Function; /** * Implement a function that retrieves existing sidecar files for a set of * nodes. */ getSidecars: Function; /** * A collection of Infoset objects defining node data managed by this handler. */ readonly infosets: any[]; /** * Implement a function that creates a model instance that implements node * handling. */ makeModel: Function; /** * New methods that are defined on Thumbnail objects that are managed by this * handler. */ methods: Object; /** * Implement a function that deletes a set of nodes, marking the associated * files for deletion on disc by moving them to the system trash or recycle * bin. */ moveToTrash: Function; /** * The unique identifying name of this node-handling extension. */ readonly name: string; /** * A collection of lexical prefix strings for Bridge URIs. */ readonly prefixes: any[]; /** * Implement a function that sets the rotation setting in metadata for a set of * thumbnails to the same value for all. Does not rotate image bits. */ rotate: Function; /** * Implement a function that sets the labels for a set of thumbnails. */ setLabels: Function; /** * Implement a function that sets the ratings for a set of thumbnails. */ setRatings: Function; /** * Implement a function that embeds XMP file metadata packets in a set of * files. */ setXmp: Function; } /** * Supports the basic framework for Adobe Bridge node-handling extensions by * tracking the connection between your display model and the file or page * sources. */ declare class ExtensionModel { addToDrag: any; authenticate: any; cancelRefresh: any; copyFrom: any; createNewContainer: any; doLosslessRotate: any; eject: any; exists: any; getCacheStatus: any; getDisplayName: any; getFilterCriteria: any; getParent: any; getPhysicalFileName: any; getSearchDefinition: any; getSearchDetails: any; getSortCriteria: any; getUserSortOrder: any; initialize: any; lock: any; moveFrom: any; needAuthentication: any; physicalFileExists: any; privateData: any; refreshInfoset: any; registerInterest: any; registerStructuralInterest: any; resolveLink: any; setName: any; setUserSortOrder: any; supportsLosslessRotate: any; supportsUserSortOrder: any; terminate: any; unlock: any; unregisterInterest: any; unregisterStructuralInterest: any; verifyExternalChanges: any; wouldAcceptDrop: any; } /** * Represents the navigation nodes that appear in the Favorites pane in the * Adobe Bridge browser. */ declare class Favorites { /** * Sets the section of the Favorites pane for the next node operations in the * immediate scope. */ section: string; /** * Appends a new node into the current section of the favorites array. * @param thumbnail The Thumbnail object for the node to add. */ add(thumbnail: Thumbnail): boolean; /** * Inserts a new node into favorites. * @param parent The Thumbnail object for the parent node. * @param child The Thumbnail object for the new subnode. */ addChild(parent: Thumbnail, child: Thumbnail): boolean; /** * Associates a named workspace with a thumbnail in the standard section of the * Favorites pane. * @param thumb The Thumbnail object. * @param workspace The workspace name. */ associateWorkspace(thumb: Thumbnail, workspace: string): boolean; /** * Deletes all the nodes from the current section of the favorites array and * updates the Favorites pane. */ clearAll(): void; /** * Reports whether the list of favorites currently contains a specific node, * either in the standard or user sections. * @param uri The Bridge URI string for the node. */ contains(uri: string): boolean; /** * Disables a node from the standard section. * @param uri The Bridge URI string for the node. */ disable(uri: string): void; /** * Enables a node from the standard section. * @param uri The Bridge URI string for the node. */ enable(uri: string): void; /** * Retrieves the children of a node in the Standard section of the Favorites * pane. * @param uri The Bridge URI string for the node. */ getChildren(uri: string): any[]; /** * Inserts a new node into the current section of the favorites array. * @param thumbnail The Thumbnail object for the node to add. * @param index A 0-based index into the existing node array at which to insert the new node, or an object reference for a node in the existing node array. */ insert(thumbnail: Thumbnail, index?: any): boolean; /** * Removes the specified script-defined node from the favorites array and * updates the Favorites pane. * @param thumbnail The Thumbnail object for the node to remove. */ remove(thumbnail: Thumbnail): boolean; } /** * Represents a file in the local file system in a platform-independent manner. */ declare class File { /** * The full path name for the referenced file in URI notation. */ readonly absoluteURI: string; /** * If true, the object refers to a file system alias or shortcut. */ readonly alias: boolean; /** * The creation date of the referenced file, or null if the object does not * refer to a file on disk. */ readonly created: Date; /** * In Mac OS, the file creator as a four-character string. In Windows or UNIX, * value is "????". */ readonly creator: string; /** * The localized name of the referenced file, without the path specification. */ readonly displayName: string; /** * Gets or sets the encoding for subsequent read/write operations. */ encoding: string; /** * When true, a read attempt caused the current position to be at the end of * the file, or the file is not open. */ readonly eof: boolean; /** * A string containing a message describing the most recent file system error. */ error: string; /** * If true, this object refers to a file or file-system alias that actually * exists in the file system. */ readonly exists: boolean; /** * The name of the file system. */ static readonly fs: string; /** * The platform-specific full path name for the referenced file. */ readonly fsName: string; /** * The full path name for the referenced file in URI notation. */ readonly fullName: string; /** * When true, the file is not shown in the platform-specific file browser. */ hidden: boolean; /** * The size of the file in bytes. */ length: number; /** * How line feed characters are written in the file system. */ lineFeed: string; /** * The date of the referenced file's last modification, or null if the object * does not refer to a file on the disk. */ readonly modified: Date; /** * The file name portion of the absolute URI for the referenced file, without * the path specification. */ readonly name: string; /** * The Folder object for the folder that contains this file. */ readonly parent: Folder; /** * The path portion of the absolute URI for the referenced file, without the * file name. */ readonly path: string; /** * When true, prevents the file from being altered or deleted. */ readonly: boolean; /** * The path name for the object in URI notation, relative to the current * folder. */ readonly relativeURI: string; /** * The file type as a four-character string. */ readonly type: string; /** * Creates and returns a new File object referring to a given file system * location. * @param path The full or partial path name of the file, in platform-specific or URI format. */ constructor(path?: string); /** * Changes the path specification of the referenced file. * @param path A string containing the new path, absolute or relative to the current folder. */ changePath(path: string): boolean; /** * Closes this open file. */ close(): boolean; /** * Copies this object’s referenced file to the specified target location. * @param target A string with the URI path to the target location, or a File object that references the target location. */ copy(target: string | File): boolean; /** * Makes this file a file-system alias or shortcut to the specified file. * @param path A string containing the path of the target file. */ createAlias(path: string): void; /** * Decodes a UTF-8 encoded string as required by RFC 2396, and returns the * decoded string. * @param uri The UTF-8 encoded string to decode. */ decode(uri: string): string; /** * Encodes a string as required by RFC 2396, and returns the encoded string. * @param name The string to encode. */ encode(name: string): string; /** * Executes or opens this file using the appropriate application, as if it had * been double-clicked in a file browser. */ execute(): boolean; /** * Retrieves and returns the path for this file, relative to the specified base * path, in URI notation. * @param basePath A base path in URI notation. */ getRelativeURI(basePath: string): string; /** * Reports whether a given encoding is available. * @param name The encoding name. */ isEncodingAvailable(name: string): boolean; /** * Opens the referenced file for subsequent read/write operations. The method * resolves any aliases to find the file. * @param mode The read-write mode, a single-character string. * @param type In Mac OS, the type of a newly created file, a 4-character string. Ignored in Windows and UNIX. * @param creator In Mac OS, the creator of a newly created file, a 4-character string. Ignored in Windows and UNIX. */ open(mode: string, type?: string, creator?: string): boolean; /** * Opens a dialog so the user can select one or more files to open. * @param prompt The prompt text, displayed if the dialog allows a prompt. * @param filter A filter that limits the types of files displayed in the dialog. * @param multiSelect When true, the user can select multiple files and the return value is an array. */ openDialog(prompt: string, filter?: any, multiSelect?: boolean): File; /** * Opens the built-in platform-specific file-browsing dialog, in which the user * can select an existing file or files, and creates new File objects to * represent the selected files. * @param prompt A string containing the prompt text, if the dialog allows a prompt. * @param filter A filter that limits the types of files displayed in the dialog. * @param multiSelect When true, the user can select multiple files and the return value is an array. */ openDlg(prompt: string, filter?: any, multiSelect?: boolean): File; /** * Reads the contents of the file, starting at the current position. * @param chars An integer specifying the number of characters to read. */ read(chars?: number): string; /** * Reads a single text character from the file at the current position. */ readch(): string; /** * Reads a single line of text from the file at the current position. */ readln(): string; /** * Deletes the file associated with this object from disk immediately, without * moving it to the system trash. */ remove(): boolean; /** * Renames the associated file. * @param newName The new file name, with no path information. */ rename(newName: string): boolean; /** * Attempts to resolve the file-system alias or shortcut that this object * refers to. */ resolve(): File; /** * Opens a dialog so the user can select a file name to save to. * @param prompt The prompt text, displayed if the dialog allows a prompt. * @param filter In Windows only, a filter that limits the types of files displayed in the dialog. */ saveDialog(prompt: string, filter?: any): File; /** * Opens the built-in platform-specific file-browsing dialog, in which the user * can select an existing file location to which to save information, and * creates a new File object to represent the selected file. * @param prompt A string containing the prompt text, if the dialog allows a prompt. * @param filter In Windows only, a filter that limits the types of files displayed in the dialog. */ saveDlg(prompt: string, filter?: any): File; /** * Seeks to a given position in the file. * @param pos The new current position in the file as an offset in bytes from the start, current position, or end, depending on the mode. * @param mode The seek mode. */ seek(pos: number, mode?: number): boolean; /** * Retrieves the current position as a byte offset from the start of the file. */ tell(): number; /** * Creates and returns a serialized string representation of this object. */ toSource(): string; /** * Converts this object to a string. */ toString(): string; /** * Writes the specified text to the file at the current position. * @param text A text string to be written. */ write(text: string): boolean; /** * Writes a string to the file at the current position and appends a line-feed * sequence. * @param text A text string to be written. */ writeln(text: string): boolean; } /** * Provides programmatic control and customization of the Filter Panel, which * allows the user to organize and filter the display of thumbnails in the * Content pane. */ declare class FilterDescription { /** * The set of allowed values for the XMP property, if it has a closed value * list. */ closedValueList: any[]; /** * A localized name for this filter, shown in the heading line for this filter * in the Filter pane. */ displayName: string; /** * The data type of filter-property value, used in sorting the list of values. */ filterType: string; /** * The name of the node property to use as a filter, as defined in the * InfosetMemberDescription object. */ infosetMember: string; /** * When true, only one of the filter values can be set at a time. */ isExclusive: boolean; /** * The unique identifying name of the filter. */ name: string; /** * The namespace of the XMP property used as a filter. */ xmpNamespace: string; /** * The key name of the XMP property used as a filter. */ xmpProperty: string; } /** * A control that contains a Flash Player, which can load and play Flash movies * stored in SWF files. */ declare class FlashPlayer { /** * True if this element is active. */ active: boolean; /** * The alignment style for this element. If defined, this value overrides the * alignChildren setting for the parent container. */ alignment: string; /** * The boundaries of the element, in parent-relative coordinates. */ bounds: Bounds; /** * True if this element is enabled. */ enabled: boolean; /** * The help text that is displayed when the mouse hovers over the element. */ helpTip: string; /** * The number of pixels to indent the element during automatic layout. * @remarks Range: 0 to … */ indent: number; /** * The upper left corner of this element relative to its parent. */ location: Point; /** * The maximum height and width to which the element can be resized. */ maximumSize: Dimension; /** * The minimum height and width to which the element can be resized. */ minimumSize: Dimension; /** * The parent element. */ readonly parent: any; /** * The preferred size, used by layout managers to determine the best size for * each element. */ preferredSize: Dimension; /** * An object that contains one or more creation properties of the container * (properties used only when the element is created). */ properties: Object; /** * The current dimensions of this element. */ size: Dimension; /** * The element type, "flashplayer". */ readonly type: string; /** * True if this element is shown, false if it is hidden. */ visible: boolean; /** * The window that this element belongs to. */ readonly window: Window; /** * The bounds of this element relative to the top-level parent window. */ readonly windowBounds: Bounds; /** * Registers an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase When true, the handler is called only in the capturing phase of the event propagation. */ addEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * A function definition for a callback from the Flash ActionScript * environment. */ callback(): void; /** * Simulates the occurrence of an event in this target. */ dispatchEvent(): Event; /** * Hides this element. */ hide(): void; /** * Invokes an ActionScript function defined in the Flash application. * @param name The name of a Flash ActionScript function that has been registered with the ExternalInterface object by the currently loaded SWF file. * @param argument An argument to pass through to the function. */ invokePlayerFunction(name: string, argument?: any): any; /** * Loads a movie into the Flash Player, and begins playing it. * @param file The File object for the SWF file to load. */ loadMovie(file: File): void; /** * Sends a notification message, simulating the specified user interaction * event. * @param eventName The name of the control event handler to call. */ notify(eventName?: string): void; /** * Restarts a movie that has been stopped. * @param rewind When true, restarts the movie from the beginning; otherwise, starts playing from the point where it was stopped. */ playMovie(rewind: boolean): void; /** * Unregisters an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase Whether to call the handler only in the capturing phase of the event propagation. */ removeEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Shows this element. */ show(): any; /** * Halts playback of the current movie. */ stopMovie(): void; } /** * Represents a file-system folder or directory in a platform-independent * manner. */ declare class Folder { /** * The full path name for the referenced folder in URI notation. */ readonly absoluteURI: string; /** * When true, the object refers to a file system alias or shortcut. */ readonly alias: boolean; /** * The folder containing the application data for all users. */ static readonly appData: Folder; /** * In Mac OS, a Folder object for the folder containing the bundle of the * running application. */ static readonly appPackage: Folder; /** * A Folder object for the folder containing common files for all programs * installed by the user. */ static readonly commonFiles: Folder; /** * The creation date of the referenced folder, or null if the object does not * refer to a folder on disk. */ readonly created: Date; /** * A Folder object for the current folder. */ static current: Folder; /** * A Folder object for the folder that contains the user’s desktop. */ static readonly desktop: Folder; /** * The localized name portion of the absolute URI for the referenced folder, * without the path specification. */ readonly displayName: string; /** * A message describing the most recent file system error. */ error: string; /** * When true, this object refers to a folder that currently exists in the file * system. */ readonly exists: boolean; /** * The name of the current file system. */ static readonly fs: string; /** * The platform-specific name of the referenced folder as a full path name. */ readonly fsName: string; /** * The full path name for the referenced folder in URI notation. . */ readonly fullName: string; /** * The date of the referenced folder's last modification, or null if the object * does not refer to a folder on disk. */ readonly modified: Date; /** * A folder pointing to the user's My Documents folder. */ static readonly myDocuments: Folder; /** * The folder name portion of the absolute URI for the referenced file, without * the path specification. */ readonly name: string; /** * TThe Folder object for the folder that contains this folder, or null if this * object refers to the root folder of a volume. */ readonly parent: Folder; /** * The path portion of the object absolute URI for the referenced file, without * the folder name. */ readonly path: string; /** * The path name for the referenced folder in URI notation, relative to the * current folder. */ readonly relativeURI: string; /** * A Folder object for the folder containing the executable image of the * running application. */ static readonly startup: Folder; /** * A Folder object for the folder containing the operating system files. */ static readonly system: Folder; /** * A Folder object for the default folder for temporary files. */ static readonly temp: Folder; /** * A Folder object for the folder containing deleted items. On Windows, the * trash folder is a virtual folder containing a database; therefore, the * property value is null on Windows. */ static readonly trash: Folder; /** * A Folder object for the folder containing the user's application data. */ static readonly userData: Folder; /** * Creates and returns a new Folder object referring to a given file-system * location. * @param path The absolute or relative path to the folder associated with this object, specified in URI format. */ constructor(path?: string); /** * Changes the path specification of the referenced folder. * @param path A string containing the new path, absolute or relative to the current folder. */ changePath(path: string): boolean; /** * Creates a folder at the location given by this object's path property. */ create(): boolean; /** * Decodes a UTF-8 encoded string as required by RFC 2396, and returns the * decoded string. * @param uri The UTF-8 string to decode. */ decode(uri: string): string; /** * Encodes a string as required by RFC 2396, and returns the encoded string. * @param name The string to encode. */ encode(name: string): string; /** * Opens this folder in the platform-specific file browser (as if it had been * double-clicked in the file browser). */ execute(): boolean; /** * Retrieves the contents of this folder, filtered by the supplied mask. * @param mask A search mask for file names, specified as a string or a function. */ getFiles(mask: any): any[]; /** * Retrieves and returns the path for this file, relative to the specified base * path, in URI notation. * @param basePath A base path in URI notation. */ getRelativeURI(basePath?: string): string; /** * Reports whether a given encoding is available. * @param name The encoding name. */ isEncodingAvailable(name: string): boolean; /** * Deletes the folder associated with this object from disk immediately, * without moving it to the system trash. */ remove(): boolean; /** * Renames the associated folder. * @param newName The new folder name, with no path information. */ rename(newName: string): boolean; /** * Attempts to resolve the file-system alias or shortcut that this object * refers to. */ resolve(): Folder; /** * Opens the built-in platform-specific file-browsing dialog, and creates a new * File or Folder object for the selected file or folder. * @param prompt The prompt text, if the dialog allows a prompt. */ selectDialog(prompt: string): Folder; /** * Opens the built-in platform-specific file-browsing dialog, and creates a new * File or Folder object for the selected file or folder. * @param prompt The prompt text, if the dialog allows a prompt. */ selectDlg(prompt: string): Folder; /** * Creates and returns a serialized string representation of this object. */ toSource(): string; /** * Converts this object to a string. */ toString(): string; } /** * A container for other controls within a window. */ declare class Group { /** * Tells the layout manager how unlike-sized children of this container should * be aligned within a column or row. */ alignChildren: string; /** * The alignment style for this element. If defined, this value overrides the * alignChildren setting for the parent container. */ alignment: string; /** * The boundaries of the element, in parent-relative coordinates. */ bounds: Bounds; /** * An array of child elements. */ readonly children: Object[]; /** * True if this element is enabled. */ enabled: boolean; /** * The graphics object that can be used to customize the element's appearance, * in response to the onDraw() event. */ readonly graphics: ScriptUIGraphics; /** * The help text that is displayed when the mouse hovers over the element. */ helpTip: string; /** * The number of pixels to indent the element during automatic layout. * @remarks Range: 0 to … */ indent: number; /** * The layout manager for this container. */ layout: LayoutManager; /** * The upper left corner of this element relative to its parent. */ location: Point; /** * The number of pixels between the edges of a container and the outermost * child elements. */ margins: number; /** * The maximum height and width to which the element can be resized. */ maximumSize: Dimension; /** * The minimum height and width to which the element can be resized. */ minimumSize: Dimension; /** * The layout orientation of children in a container. */ orientation: string; /** * The parent element. */ readonly parent: any; /** * The preferred size, used by layout managers to determine the best size for * each element. */ preferredSize: Dimension; /** * An object that contains one or more creation properties of the control * (properties used only when the element is created). */ properties: Object; /** * The current dimensions of this element. */ size: Dimension; /** * The number of pixels separating one child element from its adjacent sibling * element. */ spacing: number; /** * The element type; "group". */ readonly type: string; /** * True if this element is shown, false if it is hidden. */ visible: boolean; /** * The window that this element belongs to. */ readonly window: Window; /** * The bounds of this element relative to the top-level parent window. */ readonly windowBounds: Bounds; /** * Adds a child element to this container. * @param type The type of the child element, as specified for the type property. * @param bounds A bounds specification that describes the size and position of the new control or container, relative to its parent. * @param text The text or label, a localizable string. * @param properties An object that contains one or more creation properties of the new child (properties used only when the element is created). */ add(type: string, bounds?: Bounds, text?: string, properties?: Object): any; /** * Registers an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase When true, the handler is called only in the capturing phase of the event propagation. */ addEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Simulates the occurrence of an event in this target. */ dispatchEvent(): Event; /** * Hides this element. */ hide(): void; /** * An event-handler callback function, called when the group is about to be * drawn. */ onDraw(): void; /** * Removes the specified child control from this group's children array. * @param what The child control to remove, specified by 0-based index, text property value, or as a control object. */ remove(what: any): void; /** * Unregisters an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase Whether to call the handler only in the capturing phase of the event propagation. */ removeEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Shows this element. */ show(): any; } /** * A mouse-sensitive pushbutton that displays an image instead of text. */ declare class IconButton { /** * True if this element is active. */ active: boolean; /** * The alignment style for this element. If defined, this value overrides the * alignChildren setting for the parent container. */ alignment: string; /** * The boundaries of the element, in parent-relative coordinates. */ bounds: Bounds; /** * An array of child elements. */ readonly children: Object[]; /** * True if this element is enabled. */ enabled: boolean; /** * The graphics object that can be used to customize the element's appearance, * in response to the onDraw() event. */ readonly graphics: ScriptUIGraphics; /** * The help text that is displayed when the mouse hovers over the element. */ helpTip: string; /** * The image object that defines the image to be drawn. */ image: ScriptUIImage; /** * The number of pixels to indent the element during automatic layout. * @remarks Range: 0 to … */ indent: number; /** * The upper left corner of this element relative to its parent. */ location: Point; /** * The maximum height and width to which the element can be resized. */ maximumSize: Dimension; /** * The minimum height and width to which the element can be resized. */ minimumSize: Dimension; /** * The parent element. */ readonly parent: any; /** * The preferred size, used by layout managers to determine the best size for * each element. */ preferredSize: Dimension; /** * An object that contains one or more creation properties of the container * (properties used only when the element is created). */ properties: Object; /** * The key sequence that invokes the onShortcutKey() callback for this element * (in Windows only). */ shortcutKey: string; /** * The current dimensions of this element. */ size: Dimension; /** * The element type; "iconbutton". */ readonly type: string; /** * True if this element is shown, false if it is hidden. */ visible: boolean; /** * The window that this element belongs to. */ readonly window: Window; /** * The bounds of this element relative to the top-level parent window. */ readonly windowBounds: Bounds; /** * Registers an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase When true, the handler is called only in the capturing phase of the event propagation. */ addEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Simulates the occurrence of an event in this target. */ dispatchEvent(): Event; /** * Hides this element. */ hide(): void; /** * Sends a notification message, simulating the specified user interaction * event. * @param eventName The name of the control event handler to call. */ notify(eventName?: string): void; /** * An event-handler callback function, called when the element acquires the * keyboard focus. */ onActivate(): void; /** * An event-handler callback function, called when the element has been * clicked. */ onClick(): void; /** * An event-handler callback function, called when the element loses the * keyboard focus. */ onDeactivate(): void; /** * An event-handler callback function, called when the window is about to be * drawn. */ onDraw(): void; /** * An event-handler callback function, called when the element's shortcutKey * sequence is typed in the active window. */ onShortcutKey(): void; /** * Unregisters an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase Whether to call the handler only in the capturing phase of the event propagation. */ removeEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Shows this element. */ show(): any; } /** * Represents a member subpanel of an InspectorPanel object that displays two * columns for an icon and text. */ declare class IconListPanelette { /** * The unique, identifying name of this subpanel. */ name: string; /** * A collection of two-member arrays describing the rows to display in the * panelette. */ rows: any[]; /** * Localizable text shown in the subpanel header bar. */ titleMarkup: string; } /** * Represents Adobe Bridge-defined or script-defined data for Adobe Bridge * nodes. */ declare class Infoset { /** * The CacheData object containing cache status for this set. */ cacheData: CacheData; /** * The descriptions of the members of this set. */ description: any[]; /** * The name of the ExtensionHandler object that manages this data. */ readonly extension: string; /** * The name of this set. */ infosetName: string; /** * Adds a child node to the core data set children. * @param path The Bridge URI (path and file name) of the child node * @param model An ExtensionModel object that manages the new child. * @param containerHint Whether the new child is a container. */ addChild(path: string, model?: ExtensionModel, containerHint?: string): void; /** * Sets all members of this set to the default value for the data type. */ initializeMembersToDefaultValues(): void; } /** * Associates a data type with a single node-data value for Adobe Bridge nodes. */ declare class InfosetMemberDescription { /** * The name of this value, which becomes a property of the parent Infoset * object. */ name: string; /** * The data type for values accessed through the name property of the parent * Infoset object. */ type: string; } /** * Represents an object-inspection panel, a special type of tabbed palette that * displays contextual information for a selected thumbnail. */ declare class InspectorPanel { /** * Whether to display this panel. */ displayInInspector: boolean; /** * The localized title string to display in the panel's tab header. */ readonly displayTitle: string; /** * The unique menu identifier of a script-defined flyout menu for this panel. */ readonly flyoutMenuId: string; /** * When true, the panel is minimized or iconified. */ minimized: boolean; /** * A collection of panelettes contained in this panel, in display order. */ readonly panelettes: any[]; /** * The preferred default position of this tabbed panel in the Inspector, * relative to other panels. */ sortPosition: number; /** * The title text of this panel, displayed in the tab header. */ title: string; /** * When true, the majority of this panel is visible on the screen. */ readonly visible: boolean; /** * When true, this panel occupies the entire available horizontal space. */ wide: boolean; /** * Registers a script-defined panelette as a member of this panel, adding it to * panelettes list. * @param panelette The panelette object. */ registerPanelette(panelette: Object): boolean; /** * Removes a member panelette from this panel. * @param panelette The panelette object. */ unregisterPanelette(panelette: Object): void; } /** * Reports the active state of the keyboard. */ declare class KeyboardState { /** * True if the Alt or Option key is pressed. */ readonly altKey: boolean; /** * True if the Ctrl key is pressed. */ readonly ctrlKey: boolean; /** * A string containing the name of the currently pressed key, such as "a", or * an empty string. */ readonly keyName: string; /** * True if the Cmd key (in Mac OS) or Windows key (in Windows) is pressed. */ readonly metaKey: boolean; /** * True if the Shift key is pressed. */ readonly shiftKey: boolean; } /** * Controls the automatic layout behavior for a window or container. */ declare class LayoutManager { /** * Invokes the automatic layout behavior for the managed container. */ layout(): void; /** * Performs a layout after a Window is resized, based on the new size. */ resize(): void; } /** * Displays a list of choices, represented by ListItem objects. */ declare class ListBox { /** * True if this element is active. */ active: boolean; /** * The alignment style for this element. If defined, this value overrides the * alignChildren setting for the parent container. */ alignment: string; /** * The boundaries of the element, in parent-relative coordinates. */ bounds: Bounds; /** * An array of child ListItem elements. */ readonly children: Object[]; /** * For a multi-column list box, the column properties. */ readonly columns: any; /** * True if this element is enabled. */ enabled: boolean; /** * The graphics object that can be used to customize the element's appearance, * in response to the onDraw() event. */ readonly graphics: ScriptUIGraphics; /** * The help text that is displayed when the mouse hovers over the element. */ helpTip: string; /** * The number of pixels to indent the element during automatic layout. * @remarks Range: 0 to … */ indent: number; /** * The width and height in pixels of each item in the list. */ itemSize: Dimension; /** * The array of choice items displayed in the list. */ readonly items: ListItem[]; /** * The upper left corner of this element relative to its parent. */ location: Point; /** * The maximum height and width to which the element can be resized. */ maximumSize: Dimension; /** * The minimum height and width to which the element can be resized. */ minimumSize: Dimension; /** * The parent element. */ readonly parent: any; /** * The preferred size, used by layout managers to determine the best size for * each element. */ preferredSize: Dimension; /** * An object that contains one or more creation properties of the control * (properties used only when the element is created). */ properties: Object; /** * The currently selected item for a single-selection list, or an array of * items for current selection in a multi-selection list. */ selection: ListItem; /** * The key sequence that invokes the onShortcutKey() callback for this element * (in Windows only). */ shortcutKey: string; /** * The current dimensions of this element. */ size: Dimension; /** * The element type; "listbox". */ readonly type: string; /** * True if this element is shown, false if it is hidden. */ visible: boolean; /** * The window that this element belongs to. */ readonly window: Window; /** * The bounds of this element relative to the top-level parent window. */ readonly windowBounds: Bounds; /** * Adds an item to the choices in this list. * @param type The type of the child element, the string "item". * @param text The localizable text label for the item. */ add(type: string, text?: string): ListItem; /** * Registers an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase When true, the handler is called only in the capturing phase of the event propagation. */ addEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Simulates the occurrence of an event in this target. */ dispatchEvent(): Event; /** * Retrieves an item object from the list that has a given text label. * @param text The text string to match. */ find(text: string): ListItem; /** * Hides this element. */ hide(): void; /** * Sends a notification message, simulating the specified user interaction * event. * @param eventName The name of the control event handler to call. */ notify(eventName?: string): void; /** * An event-handler callback function, called when the element acquires the * keyboard focus. */ onActivate(): void; /** * An event-handler callback function, called when the content of the element * has been changed */ onChange(): void; /** * An event-handler callback function, called when the element loses the * keyboard focus. */ onDeactivate(): void; /** * An event-handler callback function, called when an item in the listbox is * double-clicked */ onDoubleClick(): void; /** * An event-handler callback function, called when the window is about to be * drawn. */ onDraw(): void; /** * An event-handler callback function, called when the element's shortcutKey * sequence is typed in the active window. */ onShortcutKey(): void; /** * Removes a child item from the list. * @param what The item or child to remove, specified by 0-based index, text value, or as a ListItem object. */ remove(what: any): void; /** * Removes all child items from the list. */ removeAll(): void; /** * Unregisters an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase Whether to call the handler only in the capturing phase of the event propagation. */ removeEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Shows this element. */ show(): any; } /** * An item in a list box, drop-down list, or tree view. */ declare class ListItem { /** * The checked state of an item in a list. */ checked: boolean; /** * The expansion state of an item of type node that is a child of a TreeView * list control. */ expanded: boolean; /** * An image object for an icon to display in the item. */ image: ScriptUIImage; /** * The 0-based index of this item in the items collection of its parent list * control. */ readonly index: number; /** * The parent element, a list control. */ readonly parent: any; /** * An object that contains one or more creation properties of the item * (properties used only when the element is created). */ properties: Object; /** * The selection state of this item. */ selected: boolean; /** * When the parent is a multi-column ListBox, this describes the labels for * this selectable row in additional columns. */ readonly subItems: any[]; /** * The label text to display for the item, a localizable string. */ text: string; /** * The element type. */ readonly type: string; } /** * Manages Bridge cache. */ declare class ManageCache { /** * Builds cache for a folder and all subfolders. * @param path Platform path of the folder for which cache export needs to be done. * @param buildFullPreviews Specifies whether you want to build and export full-size previews. */ buildAndExportSharedCache(path: string, buildFullPreviews?: boolean): boolean; /** * Imports the already exported cache. * @param path Platform path of the folder for which cache export needs to be done. */ importSharedCache(path: string): boolean; /** * Purges all local (thumbnail) cache for all the folders. */ purgeAllLocalCache(): void; /** * Purges all cache for input folder. * @param path Platform path of the folder for which cache export needs to be done. * @param includeSubFolders Specifies if the cache is to be purged for all the subfolders on the selected path. * @param purgeForAllUsers */ purgeCacheForLocation(path: string, includeSubFolders?: boolean, purgeForAllUsers?: boolean): void; } /** * Represents the application menu bar, menus and submenus, and individual * items or commands. */ declare class MenuElement { /** * When true, the Alt modifier key was pressed when the item was selected. */ readonly altDown: boolean; /** * Whether the menu item can be checked. */ readonly canBeChecked: boolean; /** * Whether the item is checked. */ checked: boolean; /** * When true, the Command modifier key was pressed when the item was selected. */ readonly cmdDown: boolean; /** * When true, the Control modifier key was pressed when the item was selected. */ readonly ctrlDown: boolean; /** * Whether the menu or item is enabled. */ enabled: boolean; /** * A unique identifier for the element. */ readonly id: string; /** * A string describing the location of the new menu element, with respect to * existing menu elements. */ readonly location: string; /** * When true, the Option modifier key was pressed when the item was selected. */ readonly optionDown: boolean; /** * Whether there is a separator after this item. */ separatorAfter: boolean; /** * Whether there is a separator before this item. */ separatorBefore: boolean; /** * When true, the Shift modifier key was pressed when the item was selected. */ readonly shiftDown: boolean; /** * The displayed label text, a localizable string. */ text: string; /** * The type of menu element, a menu or command. */ readonly type: string; /** * Adds a new menu to the menu bar, a new submenu to an existing menu, or a new * command to an existing menu or submenu. * @param type The type of menu element, a menu or command. * @param text The localizable string that is displayed as the label text. * @param location A string describing the location of the new menu element, with respect to existing menu elements. * @param id The unique identifier for this element. */ create(type: string, text: string, location: string, id?: string): MenuElement; /** * Retrieves a menu element object using its unique identifier. * @param id The unique identifier for the menu element to find. */ find(id: string): MenuElement; /** * Removes a script-defined menu or menu item. * @param id The unique identifier for the menu element to remove. */ remove(id: string): void; } /** * Allows you to access the Extensible Metadata Platform (XMP) metadata * associated with the file node of a Thumbnail object. */ declare class Metadata { /** * The current XMP namespace, used to search for XMP properties. */ namespace: string; /** * Adds metadata properties to this object that were saved to an XMP template * from the FileInfo dialog. * @param templateName The name of the XMP template. * @param modType The modification type. */ applyMetadataTemplate(templateName: string, modType: string): void; /** * Retrieves and returns the string value of a metadata property in the * specified namespace. * @param namespace The XMP namespace. * @param property The property name. */ read(namespace: string, property: string): string; /** * Serializes the XMP packet into a string. */ serialize(): string; } /** * An independant node-handling operation with its own user interface. */ declare class ModalOperator { /** * When true, the user has requested that the operation be canceled. */ cancelRequested: boolean; /** * A string describing the current file-system conflict that prevents the * operation from being performed. */ conflictMessage: string; /** * The type of the current file-system conflict encountered during the * operation. */ conflictType: string; /** * A description of the operation, suitable for display. */ description: string; /** * When operationStatus is inError, the problematic thumbnail. */ errorTarget: Thumbnail; /** * Implement a method that returns a description of a file-system conflict that * prevents the operation from being performed on the current thumbnail. */ getConflictInfo: Function; /** * Implement a method that returns the percentage of the operation that has * currently been completed, for use in displaying the Progress dialog. */ getPercentageComplete: Function; /** * Implement a method that returns the number of source nodes that have been * processed so far. */ getProcessedNodeCount: Function; /** * Implement a method that returns the current overall status of the operation * with respect to Adobe Bridge. */ getProcessingStatus: Function; /** * Implement a method that returns a message suitable for display in the * Progress dialog. */ getProgressMessage: Function; /** * Implement a method that returns the current number of bytes that have been * transferred to the target in the course of this operation. */ getTotalBytesTransferred: Function; /** * Implement a method that returns the total number of source nodes to be * operated on. */ getTotalNodeCount: Function; /** * Implement a method that returns the subclass type of this operator. */ getType: Function; /** * When sources has a value, an array of the same length containing the new * name strings to be assigned to the source Thumbnail objects after they are * transfered to the target. */ newNames: any[]; /** * The status of the operation with respect to the immediate action. */ operationStatus: string; /** * How much of the operation has currently been completed, in the range * [0..100]. */ percentageComplete: number; /** * The current overall status of the operation with respect to Adobe Bridge. */ processingStatus: string; /** * A description of the current state of the operation, suitable for display. */ progressMessage: string; /** * Implement a method that resolves a file-system conflict, as identified by * the conflictType and conflictMessage values. */ resolveConflict: Function; /** * How to resolve file-system conflicts. */ resolveMethod: string; /** * How to apply the conflict-resolution method, applyForOneConflictOnly or * applyToAllConflicts */ resolvePolicy: string; /** * An optional result for an operation, such as the path that results from a * createNewContainer() operation. */ result: Object; /** * Implement a method that restarts the operation after it has been stopped by * user interaction. */ resume: Function; /** * A set of Thumbnail objects that the operation acts upon. */ sources: any[]; /** * Implement a method that initiates the operation. */ start: Function; /** * Implement a method that terminates the operation. */ stop: Function; /** * A target Thumbnail object for the operation. */ target: Thumbnail; /** * A number of milliseconds to wait before aborting the operation. */ timeout: number; } /** * A XML namespace object. */ declare class Namespace { /** * The named prefix. */ readonly prefix: string; /** * The URI. */ readonly uri: string; /** * Creates a Namespace object. * @param prefix The URI prefix, specified as an existing Namespace object, QName object, or string. * @param uri The URI if the prefix is specified as a string. */ constructor(prefix: any, uri?: string); } /** * A helper object for node searches. */ declare class Operand { /** * The localized display name for the corresponding field in the Find dialog. */ displayName: string; /** * The operand value. */ valueName: string; } /** * A container for other types of controls, with an optional frame. */ declare class Panel { /** * Specifies how to align the child elements. */ alignChildren: string; /** * The alignment style for this element. If defined, this value overrides the * alignChildren setting for the parent container. */ alignment: string; /** * The boundaries of the element, in parent-relative coordinates. */ bounds: Bounds; /** * Reserve space for the specified number of characters; affects calculation of * preferredSize . * @remarks Range: 0 to … */ characters: number; /** * An array of child elements. */ readonly children: Object[]; /** * True if this element is enabled. */ enabled: boolean; /** * The graphics object that can be used to customize the element's appearance, * in response to the onDraw() event. */ readonly graphics: ScriptUIGraphics; /** * The help text that is displayed when the mouse hovers over the element. */ helpTip: string; /** * The number of pixels to indent the element during automatic layout. * @remarks Range: 0 to … */ indent: number; /** * The default text justification style for child text elements. */ justify: string; /** * The layout manager for this container. */ layout: LayoutManager; /** * The upper left corner of this element's frame relative to its parent. */ location: Point; /** * The number of pixels between the edges of a container and the outermost * child elements. */ margins: number; /** * The maximum height and width to which the element can be resized. */ maximumSize: Dimension; /** * The minimum height and width to which the element can be resized. */ minimumSize: Dimension; /** * The layout orientation of children in a container. */ orientation: string; /** * The parent element. */ readonly parent: any; /** * The preferred size, used by layout managers to determine the best size for * each element. */ preferredSize: Dimension; /** * An object that contains one or more creation properties of the control * (properties used only when the element is created). */ properties: Object; /** * The current dimensions of this element. */ size: Dimension; /** * The number of pixels separating one child element from its adjacent sibling * element. */ spacing: number; /** * The title or label text, a localizable string. */ text: string; /** * The element type; "panel". */ readonly type: string; /** * True if this element is shown, false if it is hidden. */ visible: boolean; /** * The window that this element belongs to. */ readonly window: Window; /** * The bounds of this element relative to the top-level parent window. */ readonly windowBounds: Bounds; /** * Adds a child element to this container. * @param type The type of the child element, as specified for the type property. * @param bounds A bounds specification that describes the size and position of the new control or container, relative to its parent. * @param text The text or label, a localizable string. * @param properties An object that contains one or more creation properties of the new child (properties used only when the element is created). */ add(type: string, bounds?: Bounds, text?: string, properties?: Object): any; /** * Registers an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase When true, the handler is called only in the capturing phase of the event propagation. */ addEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Simulates the occurrence of an event in this target. */ dispatchEvent(): Event; /** * Hides this element. */ hide(): void; /** * An event-handler callback function, called when the panel is about to be * drawn. */ onDraw(): void; /** * Removes the specified child control from this group's children array. * @param what The child control to remove, specified by 0-based index, text property value, or as a control object. */ remove(what: any): void; /** * Unregisters an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase Whether to call the handler only in the capturing phase of the event propagation. */ removeEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Shows this element. */ show(): any; } /** * Defines the location of a window or UI element. Contains a 2-element array. */ declare class Point { /** * The left coordinate. */ left: number; /** * The array length. */ readonly length: number; /** * The top coordinate. */ top: number; /** * The horizontal coordinate, a pixel offset from the origin of the element's * coordinate space. */ x: number; /** * The vertical coordinate, a pixel offset from the origin of the element's * coordinate space. */ y: number; } /** * Allows access to the Adobe Bridge application preferences. */ declare class Preferences { /** * In the General page of the Preferences dialog, the preference associated * with the AccentColor menu. */ AccentColor: string; /** * In the Cache page of the Preferences dialog, the preference associated with * Cache choices. */ AutoExportCaches: boolean; /** * In the Cache page of the Preferences dialog, the preference associated with * the Cache Location. */ CacheDirectory: string; /** * In the General page of the Preferences dialog, the preference associated * with Favorite Items choices. */ Favorites: any[]; /** * A collection of localized display names for the nodes displayed in the * Favorites palette. */ FavoritesDisplayNames: any[]; /** * In the Thumbnails page of the Preferences dialog, the preference associated * with "Do not process files larger than: nnn MB". */ FileSize: number; /** * In the Metadata page of the Preferences dialog, the preference associated * with the "Hide Empty Fields" checkbox. */ HideEmptyFields: boolean; /** * In the File Type Associations page of the Preferences dialog, the preference * associated with the "Hide Undefined File Associations" checkbox. */ HideUnknownOpeners: boolean; /** * In the General page of the Preferences dialog, the preference associated * with the "Image Backdrop" slide bar. */ ImageBackdrop: number; /** * In the Advanced page of the Preferences dialog, the preference associated * with Keyboard. */ Keyboard: string; /** * In the Labels page of the Preferences dialog, the preferences associated * with the label colors and their keyboard shortcuts. */ Label1: string; /** * In the Labels page of the Preferences dialog, the preferences associated * with the label colors and their keyboard shortcuts. */ Label2: string; /** * In the Labels page of the Preferences dialog, the preferences associated * with the label colors and their keyboard shortcuts. */ Label3: string; /** * In the Labels page of the Preferences dialog, the preferences associated * with the label colors and their keyboard shortcuts. */ Label4: string; /** * In the Labels page of the Preferences dialog, the preferences associated * with the label colors and their keyboard shortcuts. */ Label5: string; /** * In the Labels page of the Preferences dialog, the preference associated with * the "Require the Control Key to Apply Labels and Ratings" checkbox. */ LabelCtrlKey: boolean; /** * In the Advanced page of the Preferences dialog, the preference associated * with Language. */ Language: string; /** * In the General page of the Preferences dialog, the preference associated * with "Number of Recent Items to Display". */ MRUCount: number; /** * The set of absolute path strings for recently-visited folders, displayed * when the MRUCount is greater than 0. */ MRUFolders: any[]; /** * In the Startup Scripts the Preferences dialog, the script names associated * with selected script checkboxes. */ PermittedStartupScripts: any[]; /** * In the General page of the Preferences dialog, the preference associated * with the "Double-Click Edits Camera Raw Settings in Bridge" checkbox. */ ShowCameraRawInterface: boolean; /** * In the Metadata page of the Preferences dialog, the preference associated * with the "Show Metadata Placard" checkbox. */ ShowPlacard: boolean; /** * In the Thumbnails page of the Preferences dialog, the preference associated * with "Show Tooltips". */ ShowTooltips: boolean; /** * In the Playback page of the Preferences dialog, the preference associated * with "Stack Playback Frame Rate". */ StackFrameRate: number; /** * In the Startup Scripts the Preferences dialog, setting to true is the * equivalent of clicking Enable All, setting to false is the equivalent of * clicking Disable All. */ StartupScriptsShouldLoad: boolean; /** * The quality of thumbnail image to generate. */ ThumbnailQuality: string; /** * In the General page of the Preferences dialog, the preference associated * with the "User Interface Brightness" slide bar. */ UIBrightness: number; /** * In the Advanced page of the Preferences dialog, the preference associated * with the "Use Software Rendering" checkbox. */ UseSoftwareRendering: boolean; /** * A set of metadata properties to be displayed beneath a thumbnail icon. */ extraMetadata: any[]; /** * Whether to show thumbnail name beneath thumbnail icons. */ showName: boolean; /** * Removes script-created keys and values from the Adobe Bridge preferences, or * resets preferences. * @param name One or more names of preferences to remove. */ clear(name?: any): void; /** * Resets file type associations to their default values. */ resetFileAssociations(): void; /** * Resets "Do not show again" settings to false for all warning dialogs. */ resetWarningDialogs(): void; } /** * Provides access to the Adobe Bridge Preferences dialog, allowing you to add * a panel to the dialog with your own ScriptUI controls that access and set * any application preferences that you have defined by adding properties to * the Preferences Object. You can only access this object as the target of an * event. The object is returned in the object property of an Event Object that * results from an event in a Preferences dialog. See PreferencesDialog events. * The Preferences dialog is modal, which means that no other Adobe Bridge * events can occur until the user dismisses it with the OK or Cancel button, * or closes it with the window-frame icon. For the OK button, the dialog * generates an ok event. Your handler can collect the values from the controls * in your panel, and modify the property values in the Preferences object * accordingly. For the Cancel button, the dialog generates a cancel event, and * for the window-close gesture, it generates a destroy event. Your handler * can, for example, clean up structures you created for the window. The class * defines no properties. */ declare class PreferencesDialog { /** * Creates and returns a ScriptUI Window object to be used as a new page in the * Preferences dialog. * @param name The name of the new page, used as the title of the new Window object. */ addPanel(name: string): void; /** * Closes the Preferences dialog. * @param isOK Pass true to simulate the user clicking OK to close the dialog, false for Cancel. */ close(isOK: boolean): void; } /** * A lengthy node-handling operation that can report its progress and be * interrupted or canceled. */ declare class ProgressOperator { /** * When true, the user has requested that the operation be canceled. */ cancelRequested: boolean; /** * A string describing the current file-system conflict that prevents the * operation from being performed. */ conflictMessage: string; /** * The type of the current file-system conflict encountered during the * operation. */ conflictType: string; /** * A description of the operation, suitable for display. */ description: string; /** * When operationStatus is inError, the problematic thumbnail. */ errorTarget: Thumbnail; /** * Implement a method that returns a description of a file-system conflict that * prevents the operation from being performed on the current thumbnail. */ getConflictInfo: Function; /** * Implement a method that returns the percentage of the operation that has * currently been completed, for use in displaying the Progress dialog. */ getPercentageComplete: Function; /** * Implement a method that returns the number of source nodes that have been * processed so far. */ getProcessedNodeCount: Function; /** * Implement a method that returns the current overall status of the operation * with respect to Adobe Bridge. */ getProcessingStatus: Function; /** * Implement a method that returns a message suitable for display in the * Progress dialog. */ getProgressMessage: Function; /** * Implement a method that returns the current number of bytes that have been * transferred to the target in the course of this operation. */ getTotalBytesTransferred: Function; /** * Implement a method that returns the total number of source nodes to be * operated on. */ getTotalNodeCount: Function; /** * Implement a method that returns the subclass type of this operator. */ getType: Function; /** * When sources has a value, an array of the same length containing the new * name strings to be assigned to the source Thumbnail objects after they are * transfered to the target. */ newNames: any[]; /** * The status of the operation with respect to the immediate action. */ operationStatus: string; /** * How much of the operation has currently been completed, in the range * [0..100]. */ percentageComplete: number; /** * The current overall status of the operation with respect to Adobe Bridge. */ processingStatus: string; /** * A description of the current state of the operation, suitable for display. */ progressMessage: string; /** * Implement a method that resolves a file-system conflict, as identified by * the conflictType and conflictMessage values. */ resolveConflict: Function; /** * How to resolve file-system conflicts. */ resolveMethod: string; /** * How to apply the conflict-resolution method, applyForOneConflictOnly or * applyToAllConflicts */ resolvePolicy: string; /** * An optional result for an operation, such as the path that results from a * createNewContainer() operation. */ result: Object; /** * Implement a method that restarts the operation after it has been stopped by * user interaction. */ resume: Function; /** * A set of Thumbnail objects that the operation acts upon. */ sources: any[]; /** * Implement a method that initiates the operation. */ start: Function; /** * Implement a method that terminates the operation. */ stop: Function; /** * A target Thumbnail object for the operation. */ target: Thumbnail; /** * A number of milliseconds to wait before aborting the operation. */ timeout: number; } /** * A horizontal bar with an indicator that shows the progress of an operation. */ declare class Progressbar { /** * The alignment style for this element. If defined, this value overrides the * alignChildren setting for the parent container. */ alignment: string; /** * The boundaries of the element, in parent-relative coordinates. */ bounds: Bounds; /** * An array of child elements. */ readonly children: Object[]; /** * True if this element is enabled. */ enabled: boolean; /** * The graphics object that can be used to customize the element's appearance, * in response to the onDraw() event. */ readonly graphics: ScriptUIGraphics; /** * The help text that is displayed when the mouse hovers over the element. */ helpTip: string; /** * The number of pixels to indent the element during automatic layout. * @remarks Range: 0 to … */ indent: number; /** * The upper left corner of this element relative to its parent. */ location: Point; /** * The maximum height and width to which the element can be resized. */ maximumSize: Dimension; /** * The maximum value in the range. Default is 100. */ maxvalue: number; /** * The minimum height and width to which the element can be resized. */ minimumSize: Dimension; /** * The minimum value in the range; always 0. If set to a different value, it is * ignored. */ minvalue: number; /** * The parent element. */ readonly parent: any; /** * The preferred size, used by layout managers to determine the best size for * each element. */ preferredSize: Dimension; /** * An object that contains one or more creation properties of the container * (properties used only when the element is created). */ properties: Object; /** * The current dimensions of this element. */ size: Dimension; /** * The element type, "progessbar". */ readonly type: string; /** * The current position of the indicator. */ value: number; /** * True if this element is shown, false if it is hidden. */ visible: boolean; /** * The window that this element belongs to. */ readonly window: Window; /** * The bounds of this element relative to the top-level parent window. */ readonly windowBounds: Bounds; /** * Registers an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase When true, the handler is called only in the capturing phase of the event propagation. */ addEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Simulates the occurrence of an event in this target. */ dispatchEvent(): Event; /** * Hides this element. */ hide(): void; /** * An event-handler callback function, called when the window is about to be * drawn. */ onDraw(): void; /** * Unregisters an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase Whether to call the handler only in the capturing phase of the event propagation. */ removeEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Shows this element. */ show(): any; } /** * A qualified XML name, containing the URI and the local name. */ declare class QName { /** * The local name part of the qualified name. */ readonly localName: string; /** * The URI part of the qualified name. */ readonly uri: string; /** * Creates a QName object. * @param uri The URI, specified as a Namespace object, an existing QName object, or string. * @param name The local name. Used only if URI is given as a string. */ constructor(uri: any, name?: string); } declare class QuickSearchItem { displayName: string; valueName: string; } /** * A dual-state control, grouped with other radiobuttons, of which only one can * be in the selected state. */ declare class RadioButton { /** * True if this element is active. */ active: boolean; /** * The alignment style for this element. If defined, this value overrides the * alignChildren setting for the parent container. */ alignment: string; /** * The boundaries of the element, in parent-relative coordinates. */ bounds: Bounds; /** * A number of characters for which to reserve space when calculating the * preferred size of the element. * @remarks Range: 0 to … */ characters: number; /** * An array of child elements. */ readonly children: Object[]; /** * True if this element is enabled. */ enabled: boolean; /** * The graphics object that can be used to customize the element's appearance, * in response to the onDraw event. */ readonly graphics: ScriptUIGraphics; /** * The help text that is displayed when the mouse hovers over the element. */ helpTip: string; /** * The number of pixels to indent the element during automatic layout. * @remarks Range: 0 to … */ indent: number; /** * The default text justification style for child text elements. */ justify: string; /** * The upper left corner of this element relative to its parent. */ location: Point; /** * The maximum height and width to which the element can be resized. */ maximumSize: Dimension; /** * The minimum height and width to which the element can be resized. */ minimumSize: Dimension; /** * The parent element. */ readonly parent: any; /** * The preferred size, used by layout managers to determine the best size for * each element. */ preferredSize: Dimension; /** * An object that contains one or more creation properties of the container * (properties used only when the element is created). */ properties: Object; /** * The key sequence that invokes the onShortcutKey() callback for this element * (in Windows only). */ shortcutKey: string; /** * The current dimensions of this element. */ size: Dimension; /** * The label text for this button, a localizable string. */ text: string; /** * The element type; "radiobutton". */ readonly type: string; /** * The selection state of this button, selected when true. */ value: boolean; /** * True if this element is shown, false if it is hidden. */ visible: boolean; /** * The window that this element belongs to. */ readonly window: Window; /** * The bounds of this element relative to the top-level parent window. */ readonly windowBounds: Bounds; /** * Registers an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase When true, the handler is called only in the capturing phase of the event propagation. */ addEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Simulates the occurrence of an event in this target. */ dispatchEvent(): Event; /** * Hides this element. */ hide(): void; /** * Sends a notification message, simulating the specified user interaction * event. * @param eventName The name of the control event handler to call. */ notify(eventName?: string): void; /** * An event-handler callback function, called when the element acquires the * keyboard focus. */ onActivate(): void; /** * An event-handler callback function, called when the element has been * clicked. */ onClick(): void; /** * An event-handler callback function, called when the element loses the * keyboard focus. */ onDeactivate(): void; /** * An event-handler callback function, called when the window is about to be * drawn. */ onDraw(): void; /** * An event-handler callback function, called when the element's shortcutKey * sequence is typed in the active window. */ onShortcutKey(): void; /** * Unregisters an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase Whether to call the handler only in the capturing phase of the event propagation. */ removeEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Shows this element. */ show(): any; } /** * A helper object for node searches. */ declare class Rank { /** * The localized display name for the corresponding field in the Find dialog. */ displayName: string; /** * The property name for the ranking property. */ valueName: string; } /** * Provides information about a class. */ declare class Reflection { /** * The long description text. */ readonly description: string; /** * The short description text. */ readonly help: string; /** * An array of method descriptions. */ readonly methods: ReflectionInfo[]; /** * The class name. */ readonly name: string; /** * An array of property descriptions. */ readonly properties: ReflectionInfo[]; /** * Sample code, if present. */ readonly sampleCode: string; /** * A file containing sample code. May be null. */ readonly sampleFile: File; /** * An array of class method descriptions. */ readonly staticMethods: ReflectionInfo[]; /** * An array of class property descriptions. */ readonly staticProperties: ReflectionInfo[]; /** * Finds an element description by name. * @param name The name of the element to find. */ find(name: string): ReflectionInfo; /** * Returns this class information as XML in OMV format. */ toXML(): XML; } /** * Provides information about a method, a property or a method parameters. */ declare class ReflectionInfo { /** * The description of method or function arguments. */ readonly arguments: ReflectionInfo[]; /** * The data type. */ readonly dataType: string; /** * The default value. */ readonly defaultValue: any; /** * The long description text. */ readonly description: string; /** * The short description text. */ readonly help: string; /** * Contains true if the class describes a collection class. */ readonly isCollection: boolean; /** * The maximum value. */ readonly max: number; /** * The minimum value. */ readonly min: number; /** * The element name. */ readonly name: string; /** * The class object that this element belongs to. */ readonly parent: any; /** * Sample code, if present. */ readonly sampleCode: string; /** * A file containing sample code. May be null. */ readonly sampleFile: File; /** * The element type. */ readonly type: string; } /** * A helper object for node searches. */ declare class Scope { /** * The localized display name for the corresponding field in the Find dialog. */ displayName: string; /** * The unique identifying name for the scope modifier. */ valueName: string; } /** * A global class containing central information about ScriptUI. Not * instantiable. */ declare class ScriptUI { /** * Collects the enumerated values that can be used in the alignment and * alignChildren properties of controls and containers. */ static readonly Alignment: string; /** * Collects the enumerated values that can be used as the style argument to the * ScriptUI.newFont() method. */ static readonly FontStyle: any; /** * The font constants defined by the host application. */ static readonly applicationFonts: any; /** * An object whose properties are the names of compatability modes supported by * the host application. */ static readonly compatibility: any; /** * A string containing the internal version number of the ScriptUI module. */ static readonly coreVersion: string; /** * An object whose properties define attributes of the environment in which * ScriptUI operates. */ static readonly environment: Environment; /** * An object whose properties and methods provide access to objects used in the * ScriptUI event system. */ static readonly events: Events; /** * A string containing the name of the UI component framework with which this * version of ScriptUI is compatible. */ static readonly frameworkName: string; /** * A string containing the version number of the ScriptUI component framework */ static readonly version: any; /** * Finds and returns the resource for a given text string from the host * application's resource data. * @param text The text to match. */ static getResourceText(text: string): string; /** * Creates a new font object for use in text controls and titles. * @param name The font name, or the font family name. * @param style The font style; can be string, or one of the values of ScriptUI.FontStyle. * @param size The font size in points. */ static newFont(name: string, style: string | number, size: number): ScriptUIFont; /** * Loads a new image from resources or disk files into an image object. * @param normal The resource name or the disk file path to the image used for the normal state. * @param disabled The resource name, or the disk file path to the image used for the disabled state. * @param pressed The resource name, or the file-system path to the image used for the pressed state. * @param rollover The resource name, or the file-system path to the image used for the rollover state. */ static newImage(normal: string, disabled?: string, pressed?: string, rollover?: string): ScriptUIImage; } /** * A painting brush that encapsulates a color or pattern used to fill paths. */ declare class ScriptUIBrush { /** * The brush color. */ readonly color: number[]; /** * The theme name. */ readonly theme: string; /** * The brush type, solid or theme. */ readonly type: number; } /** * Encapsulates the qualities of a font used to draw text into a control. */ declare class ScriptUIFont { /** * The font family name. */ readonly family: string; /** * The complete font name, consisting of the family and style, if specified. */ readonly name: string; /** * The font point size. */ readonly size: number; /** * The font style. One of the constants in ScriptUIGraphics.FontStyle. */ readonly style: any; /** * The name of a substitution font, a fallback font to substitute for this font * if the requested font family or style is not available. */ readonly substitute: string; } /** * An object used to draw custom graphics, found in the graphics property of * window, container, and control objects. */ declare class ScriptUIGraphics { /** * Contains the enumerated constants for the type argument of newBrush(). */ static readonly BrushType: any; /** * Contains the enumerated constants for the type argument of newPen(). */ static readonly PenType: any; /** * The background color for containers; for non-containers, the parent * background color. */ backgroundColor: ScriptUIBrush; /** * The current drawing path, encapsulated in a path object. */ readonly currentPath: ScriptUIPath; /** * The current position in the current drawing path. */ readonly currentPoint: Point; /** * The background color for containers when disabled or inactive; for * non-containers, the parent background color. */ disabledBackgroundColor: ScriptUIBrush; /** * The text color when the element is disabled or inactive. */ disabledForegroundColor: ScriptUIPen; /** * The default font to use for displaying text. */ font: ScriptUIFont; /** * The text color. */ foregroundColor: ScriptUIPen; /** * Closes the current path. */ closePath(): void; /** * Draws a focus ring within a region of this element. * @param left The left coordinate of the region. * @param top The top coordinate of the region. * @param width The width of the region in pixels. * @param height The height of the region in pixels. */ drawFocusRing(left: number, top: number, width: number, height: number): void; /** * Draws an image within a given region of the element. * @param image The image to draw. * @param left The left coordinate of the region, relative to the origin of this element. * @param top The top coordinate of the region, relative to the origin of this element. * @param width The width in pixels. If provided, the image is stretched or shrunk to fit. If omitted, uses the original image width. * @param height The height in pixels. If provided, the image is stretched or shrunk to fit. If omitted, uses the original image height. */ drawImage(image: ScriptUIImage, left: number, top: number, width?: number, height?: number): void; /** * Draw the platform-specific control associated with this element. */ drawOSControl(): void; /** * Draw a string of text starting at a given point in this element, using a * given drawing pen and font. * @param text The text string. * @param pen The drawing pen to use. * @param x The left coordinate, relative to the origin of this element. * @param y The top coordinate, relative to the origin of this element. * @param font The font to use. Default is the font value in this object. */ drawString(text: string, pen: ScriptUIPen, x: number, y: number, font?: ScriptUIFont): void; /** * Defines an elliptical path within a given rectangular area in the * currentPath object, which can be filled using fillPath() or stroked using * strokePath(). * @param left The left coordinate of the region, relative to the origin of this element. * @param top The top coordinate of the region, relative to the origin of this element. * @param width The width of the region in pixels. * @param height The height of the region in pixels. */ ellipsePath(left: number, top: number, width: number, height: number): Point; /** * Fills a path using a given painting brush. * @param brush The brush object that defines the fill color. * @param path The path object. Default is the currentPath. */ fillPath(brush: ScriptUIBrush, path?: ScriptUIPath): void; /** * Adds a path segment to the currentPath. * @param x The X coordinate for the destination point, relative to the origin of this element. * @param y The Y coordinate for the destination point, relative to the origin of this element. */ lineTo(x: number, y: number): Point; /** * Calculates the size needed to display a string using the given font. * @param text The text string to measure. * @param font The font to use. Default is the font value in this object. * @param boundingWidth The bounding width. */ measureString(text: string, font?: ScriptUIFont, boundingWidth?: number): Dimension; /** * Adds a given point to the currentPath, and makes it the current drawing * position. * @param x The X coordinate for the new point, relative to the origin of this element. * @param y The Y coordinate for the new point, relative to the origin of this element. */ moveTo(x: number, y: number): Point; /** * Creates a new painting brush object. * @param type The brush type, solid or theme. * @param color The brush color. */ newBrush(type: number, color: (number | string)[]): ScriptUIBrush; /** * Creates a new, empty path object. */ newPath(): ScriptUIPath; /** * Creates a new drawing pen object. * @param type The pen type, solid or theme. * @param color The pen color. * @param width The width of the pen line in pixels. */ newPen(type: number, color: (number | string)[], width: number): ScriptUIPen; /** * Defines a rectangular path in the currentPath object. * @param left The left coordinate relative to the origin of this element. * @param top The top coordinate relative to the origin of this element. * @param width The width in pixels. * @param height The height in pixels. */ rectPath(left: number, top: number, width: number, height: number): Point; /** * Strokes the path segments of a path with a given drawing pen. * @param pen The drawing pen that defines the color and line width. * @param path The path object. Default is the currentPath. */ strokePath(pen: ScriptUIPen, path?: ScriptUIPath): void; } /** * Encapsulates a set of images that can be drawn into a control. */ declare class ScriptUIImage { /** * The image format. One of: resource, JPEG, GIF, TIFF, PNG, or PICT * (Macintosh). */ readonly format: string; /** * The image name. Either the file name, or the resource name. */ readonly name: string; /** * The full path to the file that contains the image. */ readonly pathname: string; /** * The image size in pixels. */ readonly size: Dimension; } /** * A helper object that encapsulates a drawing path for a figure to be drawn * into a window or control. */ declare class ScriptUIPath { } /** * A drawing pen that defines a color and line width used to stroke paths. */ declare class ScriptUIPen { /** * The pen color. */ readonly color: number[]; /** * The pixel width of the drawing line. * @remarks Range: 1 to … */ lineWidth: number; /** * The theme name. */ readonly theme: string; /** * The pen type, solid or theme. */ readonly type: string; } /** * A scrollbar with a draggable scroll indicator and stepper buttons to move * the indicator. */ declare class Scrollbar { /** * True if this element is active. */ active: boolean; /** * The alignment style for this element. If defined, this value overrides the * alignChildren setting for the parent container. */ alignment: string; /** * The boundaries of the element, in parent-relative coordinates. */ bounds: Bounds; /** * An array of child elements. */ readonly children: Object[]; /** * True if this element is enabled. */ enabled: boolean; /** * The graphics object that can be used to customize the element's appearance, * in response to the onDraw() event. */ readonly graphics: ScriptUIGraphics; /** * The help text that is displayed when the mouse hovers over the element. */ helpTip: string; /** * The number of pixels to indent the element during automatic layout. * @remarks Range: 0 to … */ indent: number; /** * The amount to increment or decrement a scrollbar indicator's position when * the user clicks ahead or behind the moveable element. * @remarks Range: 0 to … */ jumpdelta: number; /** * The upper left corner of this element relative to its parent. */ location: Point; /** * The maximum height and width to which the element can be resized. */ maximumSize: Dimension; /** * The maximum value allowed in the value property. */ maxvalue: number; /** * The minimum height and width to which the element can be resized. */ minimumSize: Dimension; /** * The minimum value allowed in the value property. */ minvalue: number; /** * The parent element. */ readonly parent: any; /** * The preferred size, used by layout managers to determine the best size for * each element. */ preferredSize: Dimension; /** * An object that contains one or more creation properties of the container * (properties used only when the element is created). */ properties: Object; /** * The key sequence that invokes the onShortcutKey() callback for this element * (in Windows only). */ shortcutKey: string; /** * The current dimensions of this element. */ size: Dimension; /** * The amount by which to increment or decrement a scrollbar element's position * when the user clicks a stepper button. * @remarks Range: 0 to … */ stepdelta: number; /** * The element type, "scrollbar". */ readonly type: string; /** * The current position of the indicator. */ value: number; /** * True if this element is shown, false if it is hidden. */ visible: boolean; /** * The window that this element belongs to. */ readonly window: Window; /** * The bounds of this element relative to the top-level parent window. */ readonly windowBounds: Bounds; /** * Registers an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase When true, the handler is called only in the capturing phase of the event propagation. */ addEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Simulates the occurrence of an event in this target. */ dispatchEvent(): Event; /** * Hides this element. */ hide(): void; /** * Sends a notification message, simulating the specified user interaction * event. * @param eventName The name of the control event handler to call. */ notify(eventName?: string): void; /** * An event-handler callback function, called when the element acquires the * keyboard focus. */ onActivate(): void; /** * An event-handler callback function, called when the user has finished * dragging the position indicator, or has clicked the control. */ onChange(): void; /** * An event-handler callback function, called when the content of the element * is in the process of changing */ onChanging(): void; /** * An event-handler callback function, called when the element loses the * keyboard focus. */ onDeactivate(): void; /** * An event-handler callback function, called when the window is about to be * drawn. */ onDraw(): void; /** * An event-handler callback function, called when the element's shortcutKey * sequence is typed in the active window. */ onShortcutKey(): void; /** * Unregisters an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase Whether to call the handler only in the capturing phase of the event propagation. */ removeEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Shows this element. */ show(): any; } /** * Defines a specific condition that must be met for a handled node to match a * search. */ declare class SearchCondition { /** * The value to compare against the value of the search field in each node. */ operand: string; /** * The comparison operator for the search. */ operatorType: string; /** * The name of some property associated with the search node. */ searchField: string; } /** * Defines one possible search criterion for a search among handled nodes. */ declare class SearchCriteria { /** * The data type of the operand values. */ operandType: string; /** * One or more Operand objects used to populate the drop-down list for the * right-side field of this line in the Find dialog. */ operands: any[]; /** * A set of predefined operator strings that are not displayed for selection. */ operatorTypesToDisable: any[]; /** * A search field, the name of some property associated with the search node. */ searchField: string; /** * A localized display name for the search field, displayed in the Find dialog. * . */ searchFieldDisplay: string; /** * Whether searchfield display names are sorted alphabetically in the Find * dialog. */ searchFieldSort: boolean; } /** * Defines a set of search criteria for a search amond handled nodes. */ declare class SearchDefinition { /** * A collection of possible SearchCriteria objects to use for this search. */ criteriaList: any[]; /** * If non-zero, the Find dialog offers choices to limit the result set to * certain sizes, and the choice defaults to this value. */ defaultResultsLimit: number; quickSearchMenuItems: any[]; /** * A set of Rank objects to use only if the search can limit results. */ ranks: any[]; /** * A set of scopes used to extend or limit the scope of the search. */ scopeSpecifiers: any[]; } /** * Utility class for searches in handled nodes. */ declare class SearchDetails { /** * A SearchSpecification object that was used to generate this search result. */ searchSpecification: SearchSpecification; /** * The Bridge URI for the search target node that was used to generate this * search result. */ searchTargetUri: string; } /** * Defines a specific search among handled nodes. */ declare class SearchSpecification { /** * A collection of SearchCondition objects to use for this search. */ conditionList: any[]; /** * The search conjunction, and or or, as selected in the Find dialog. */ conjunction: string; /** * The maximum number of result nodes to return from the search. */ maximumResults: number; quickSearchItem: string; quickSearchValue: string; /** * The name of a Rank object, as specified for a SearchDefinition object. */ rankField: string; /** * The ordering style, one of ascending (the default) or descending. */ rankOrdering: string; /** * One or more Scope object name strings, as specified for a SearchDefinition * object. */ scopeSpecifiers: any[]; } /** * A slider bar that indicates a numeric value with a moveable position * indicator. */ declare class Slider { /** * True if this element is active. */ active: boolean; /** * The alignment style for this element. If defined, this value overrides the * alignChildren setting for the parent container. */ alignment: string; /** * The boundaries of the element, in parent-relative coordinates. */ bounds: Bounds; /** * An array of child elements. */ readonly children: Object[]; /** * True if this element is enabled. */ enabled: boolean; /** * The graphics object that can be used to customize the element's appearance, * in response to the onDraw() event. */ readonly graphics: ScriptUIGraphics; /** * The help text that is displayed when the mouse hovers over the element. */ helpTip: string; /** * The number of pixels to indent the element during automatic layout. * @remarks Range: 0 to … */ indent: number; /** * The upper left corner of this element relative to its parent. */ location: Point; /** * The maximum height and width to which the element can be resized. */ maximumSize: Dimension; /** * The maximum value allowed in the value property. */ maxvalue: number; /** * The minimum height and width to which the element can be resized. */ minimumSize: Dimension; /** * The minimum value allowed in the value property. */ minvalue: number; /** * The parent element. */ readonly parent: any; /** * The preferred size, used by layout managers to determine the best size for * each element. */ preferredSize: Dimension; /** * An object that contains one or more creation properties of the container * (properties used only when the element is created). */ properties: Object; /** * The key sequence that invokes the onShortcutKey() callback for this element * (in Windows only). */ shortcutKey: string; /** * The current dimensions of this element. */ size: Dimension; /** * The element type, "slider". */ readonly type: string; /** * The current position of the indicator. */ value: number; /** * True if this element is shown, false if it is hidden. */ visible: boolean; /** * The window that this element belongs to. */ readonly window: Window; /** * The bounds of this element relative to the top-level parent window. */ readonly windowBounds: Bounds; /** * Registers an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase When true, the handler is called only in the capturing phase of the event propagation. */ addEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Simulates the occurrence of an event in this target. */ dispatchEvent(): Event; /** * Hides this element. */ hide(): void; /** * Sends a notification message, simulating the specified user interaction * event. * @param eventName The name of the control event handler to call. */ notify(eventName?: string): void; /** * An event-handler callback function, called when the element acquires the * keyboard focus. */ onActivate(): void; /** * An event-handler callback function, called when the user has finished * dragging the position indicator, or has clicked the control. */ onChange(): void; /** * An event-handler callback function, called when the content of the element * is in the process of changing */ onChanging(): void; /** * An event-handler callback function, called when the element loses the * keyboard focus. */ onDeactivate(): void; /** * An event-handler callback function, called when the window is about to be * drawn. */ onDraw(): void; /** * An event-handler callback function, called when the element's shortcutKey * sequence is typed in the active window. */ onShortcutKey(): void; /** * Unregisters an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase Whether to call the handler only in the capturing phase of the event propagation. */ removeEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Shows this element. */ show(): any; } /** * Creates a TCP/IP connection, or establishes a TCP/IP server. */ declare class Socket { /** * When true, the connection is active. */ readonly connected: boolean; /** * Sets or retrieves the name of the encoding used to transmit data. */ encoding: string; /** * When true, the receive buffer is empty. */ readonly eof: boolean; /** * A message describing the most recent error. Setting this value clears any * error message. */ error: string; /** * The name of the remote computer when a connection is established. */ readonly host: string; /** * The timeout in seconds to be applied to read or write operations. */ timeout: number; /** * Creates a new Socket object. */ constructor(); /** * Terminates the open connection. */ close(): boolean; /** * Instructs the object to start listening for an incoming connection. * @param port The TCP/IP port number to listen on. * @param encoding The encoding to be used for the connection */ listen(port: number, encoding?: string): boolean; /** * Opens the connection for subsequent read/write operations. * @param host The server to connect to. * @param encoding The encoding to be used for the connection */ open(host: string, encoding?: string): boolean; /** * Checks a listening object for a new incoming connection. */ poll(): Socket; /** * Reads up to the specified number of characters from the connection. CR * characters are ignored unless the encoding is set to "BINARY". * @param count The number of characters to read. */ read(count?: number): string; /** * Reads one line of text up to the next line feed. */ readln(): string; /** * Concatenates all arguments into a single string and writes that string to * the connection. * @param text Any number of string values. All arguments are concatenated to form the string to be written. CRLF sequences are converted to LFs unless the encoding is set to "BINARY". */ write(text: string): boolean; /** * Concatenates all arguments into a single string, appends a LF character, and * writes that string to the connection. * @param text Any number of string values. All arguments are concatenated to form the string to be written. CRLF sequences are converted to LFs unless the encoding is set to "BINARY". */ writeln(text: string): boolean; } /** * Provides a way for Adobe Bridge extensions to specify how handled nodes can * be sorted. */ declare class SortCriterion { /** * A localized display name for this sorting criterion. */ displayName: string; /** * The name of an Infoset property by which to sort. */ infosetMember: string; /** * The unique identifying name of this sort criterion. */ name: string; /** * The data type of the criterion property. */ type: string; /** * The namespace portion of an XMP property by which to sort. */ xmpNamespace: string; /** * The URI key portion of an XMP property by which to sort. */ xmpUri: string; } /** * A text label that the user cannot change. */ declare class StaticText { /** * Always false. This element cannot have input focus. */ active: boolean; /** * The alignment style for this element. If defined, this value overrides the * alignChildren setting for the parent container. */ alignment: string; /** * The boundaries of the element, in parent-relative coordinates. */ bounds: Bounds; /** * A number of characters for which to reserve space when calculating the * preferred size of the element. * @remarks Range: 0 to … */ characters: number; /** * An array of child elements. */ readonly children: Object[]; /** * True if this element is enabled. */ enabled: boolean; /** * The graphics object that can be used to customize the element's appearance, * in response to the onDraw() event. */ readonly graphics: ScriptUIGraphics; /** * The help text that is displayed when the mouse hovers over the element. */ helpTip: string; /** * The number of pixels to indent the element during automatic layout. * @remarks Range: 0 to … */ indent: number; /** * The text justification style. */ justify: string; /** * The upper left corner of this element relative to its parent. */ location: Point; /** * The maximum height and width to which the element can be resized. */ maximumSize: Dimension; /** * The minimum height and width to which the element can be resized. */ minimumSize: Dimension; /** * The parent element. */ readonly parent: any; /** * The preferred size, used by layout managers to determine the best size for * each element. */ preferredSize: Dimension; /** * An object that contains one or more creation properties of the container * (properties used only when the element is created). */ properties: Object; /** * The key sequence that invokes the onShortcutKey() callback for this element * (in Windows only). */ shortcutKey: string; /** * The current dimensions of this element. */ size: Dimension; /** * The text to display, a localizable string. */ text: string; /** * The element type, "statictext". */ readonly type: string; /** * True if this element is shown, false if it is hidden. */ visible: boolean; /** * The window that this element belongs to. */ readonly window: Window; /** * The bounds of this element relative to the top-level parent window. */ readonly windowBounds: Bounds; /** * Registers an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase When true, the handler is called only in the capturing phase of the event propagation. */ addEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Simulates the occurrence of an event in this target. */ dispatchEvent(): Event; /** * Hides this element. */ hide(): void; /** * Sends a notification message, simulating the specified user interaction * event. * @param eventName The name of the control event handler to call. */ notify(eventName?: string): void; /** * An event-handler callback function, called when the window is about to be * drawn. */ onDraw(): void; /** * An event-handler callback function, called when the element's shortcutKey * sequence is typed in the active window. */ onShortcutKey(): void; /** * Unregisters an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase Whether to call the handler only in the capturing phase of the event propagation. */ removeEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Shows this element. */ show(): any; } /** * Represents a tabbed palette in the Adobe Bridge browser window. */ declare class TabbedPalette { /** * When type is script, the ScriptUI Window object to display. */ readonly content: any; /** * A non-localized unique identifier for the palette. */ id: string; showMenuItem: boolean; /** * The localized string to display as the palette title. */ title: string; /** * The type of content displayed in the palette; script (ScriptUI) or web * (HTML). */ readonly type: string; /** * When type is web, the path to the page to display. */ url: string; /** * When true, this palette is visible, when false it is hidden. */ visible: boolean; /** * Removes this palette from the list of available palettes and destroys it. */ remove(): void; /** * Moves this palette to a specific docking location in the browser. * @param paletteColumn The horizontal location of the palette in the browser. * @param paletteRow The vertical location of the palette in the browser. */ setLocation(paletteColumn: string, paletteRow?: string | number): void; } /** * Represents a member subpanel of an InspectorPanel object that displays * textual information about a set of thumbnails. */ declare class TextPanelette { /** * A set of two-element arrays in the format [key, value]. */ keyValuePairs: any[]; /** * The unique, identifying name of this subpanel. */ name: string; /** * The nodes corresponding to the key-value pairs. */ thumbnails: any[]; /** * Localizable text shown in the subpanel header bar. */ titleMarkup: string; } /** * Represents a reference to a node in the browser navigation hierarchy. */ declare class Thumbnail { /** * If the value of type is alias, the kind of target this thumbnail represents. */ readonly aliasType: string; /** * The node children of this container node. */ readonly children: any[]; /** * When true, the node is a container. */ readonly container: boolean; /** * Provides access to the core node-data sets defined by the default node * handler. */ readonly core: Infoset; /** * Date the referenced file or folder was created, if it can be determined. */ readonly creationDate: Date; /** * DEPRECATED. Do not use. */ displayMode: string; /** * DEPRECATED. Do not use. */ displayPath: string; /** * For a file or folder, whether the resource for this node exists on the local * disk. */ readonly exists: boolean; /** * All of the ExtensionHandler objects that could handle this node. */ readonly extensions: any[]; /** * Whether this thumbnail is associated with a file that contains embedded * metadata. */ readonly hasMetadata: boolean; /** * Whether this thumbnail is displayable. */ readonly hidden: boolean; /** * The path to the operating-system icon image file for this node, when it * represents a web page. */ iconPath: string; /** * The label string for this thumbnail. */ label: string; /** * Date the referenced file or folder was last modified, if it can be * determined. */ readonly lastModifiedDate: Date; /** * Whether the thumbnail is associated with a local file-system object or a * Version Cue node (which can have both a local and remote replica). */ readonly location: string; /** * Whether this node represents a read-only file in Windows, or a file that has * been locked in the Finder in Mac OS. */ readonly locked: boolean; /** * The Metadata object associated with this thumbnail, if it supports embedded * metadata. */ metadata: Metadata; /** * The referenced file’s MIME type, if it can be determined. */ readonly mimeType: string; /** * The ExtensionModel object associated with this node. */ readonly model: ExtensionModel; /** * The label displayed for the thumbnail. */ name: string; /** * The Thumbnail object for the parent node of this thumbnail. */ readonly parent: Thumbnail; /** * DEPRECATED. Use spec or uri instead. */ readonly path: string; /** * The rating value for this thumbnail. */ rating: number; /** * The angle of rotation for the icon image of this node, in degrees. */ rotation: number; /** * A File or Folder object for this thumbnail’s referenced node. */ readonly spec: File; /** * Waits for confirmation of a valid value to return the Metadata object * associated with this thumbnail, if any. */ synchronousMetadata: Metadata; /** * The type of node this thumbnail references. */ readonly type: string; /** * The full Bridge URI ( unique resource identifier) for this thumbnail. */ readonly uri: string; /** * DEPRECATED. Do not use. */ add(): void; /** * Creates a new Thumbnail object that references the same node as this one. * @param path The parent node of the new copy. */ copyTo(path: Object | string): boolean; /** * Returns the position of playback slider from Preview panel. */ getPosition(): void; /** * Returns the position of volume slider for the item being previewed in * Bridge. */ getVolume(): void; /** * DEPRECATED. Do not use. */ insert(): void; /** * Returns true if the auto-loop is enabled in the Preview panel. */ isAutoLoopOn(): void; /** * Returns true if the Thumbnail object can be played in Bridge. */ isDynamicMedia(): void; /** * Returns true if selected file is already playing in the Preview panel. */ isPlaying(): void; /** * Changes the parent of this thumbnail. * @param path The new parent node. */ moveTo(path: Object | string): boolean; /** * Launches the file referenced by this thumbnail in the appropriate * application (such as Photoshop for JPEG files). */ open(): boolean; /** * Launches the file referenced by this thumbnail in the specified application. * @param appPath A platform-specific path string to the application. */ openWith(appPath: string): boolean; /** * Refreshes an associated information set or sets to reflect the current state * of this node’s referenced file or folder. * @param infosetName The data sets to refresh. */ refresh(infosetName?: any[] | string): boolean; /** * Registers a callback function that is executed whenever a node-data value in * this thumbnail changes. * @param callback A developer-defined callback function. */ registerInterest(callback: any): void; /** * Deletes this Thumbnail object. */ remove(): void; /** * If the value of type is alias, retrieves a Thumbnail object for the target * of the alias. */ resolve(): Thumbnail; /** * Opens the platform-specific native file browser, displays and selects the * file or folder for this thumbnail. */ revealInSystemBrowser(): void; /** * Sets seek position of playback slider in the Preview panel. */ setPosition(): void; /** * Sets position of the volume slider in the Preview panel. */ setVolume(): void; /** * Toggles the state of the Auto-Loop button in Preview panel for the selected * item. */ toggleAutoLoop(): void; /** * Toggles the state of the Play or Pause button in Preview panel for the * selected item. */ togglePlayPause(): void; /** * Removes a callback function from the list of callbacks registered for this * thumbnail. * @param callback A developer-defined callback function, previously registered with registerInterest(). */ unregisterInterest(callback: Function): void; /** * Re-enumerates the children of a container node. */ verifyExternalChanges(): void; } /** * Represents a member subpanel of an InspectorPanel object that displays * resizeable thumbnail icons, with corresponding text labels for each * thumbnail. */ declare class ThumbnailPanelette { /** * A set of two-element arrays in the format [key, value]. */ keyValuePairs: any[]; /** * The unique, identifying name of this subpanel. */ name: string; /** * The placement of the displayed text in the horizontal presentation mode. */ textPosition: string; /** * The nodes corresponding to the key-value pairs. */ thumbnails: any[]; /** * Localizable text shown in the subpanel header bar. */ titleMarkup: string; } /** * A hierarchical list whose items can contain child items. */ declare class TreeView { /** * True if this element is active. */ active: boolean; /** * The alignment style for this element. If defined, this value overrides the * alignChildren setting for the parent container. */ alignment: string; /** * The boundaries of the element, in parent-relative coordinates. */ bounds: Bounds; /** * An array of child elements. */ readonly children: Object[]; /** * True if this element is enabled. */ enabled: boolean; /** * The graphics object that can be used to customize the element's appearance, * in response to the onDraw() event. */ readonly graphics: ScriptUIGraphics; /** * The help text that is displayed when the mouse hovers over the element. */ helpTip: string; /** * The number of pixels to indent the element during automatic layout. * @remarks Range: 0 to … */ indent: number; /** * The width and height in pixels of each item in the list. */ itemSize: Dimension; /** * The array of top-level items displayed in the list. */ readonly items: ListItem[]; /** * The upper left corner of this element relative to its parent. */ location: Point; /** * The maximum height and width to which the element can be resized. */ maximumSize: Dimension; /** * The minimum height and width to which the element can be resized. */ minimumSize: Dimension; /** * The parent element. */ readonly parent: any; /** * The preferred size, used by layout managers to determine the best size for * each element. */ preferredSize: Dimension; /** * An object that contains one or more creation properties of the control * (properties used only when the element is created). */ properties: Object; /** * The currently selected list item. */ selection: ListItem; /** * The key sequence that invokes the onShortcutKey() callback for this element * (in Windows only). */ shortcutKey: string; /** * The current dimensions of this element. */ size: Dimension; /** * The element type, "treeview". */ readonly type: string; /** * True if this element is shown, false if it is hidden. */ visible: boolean; /** * The window that this element belongs to. */ readonly window: Window; /** * The bounds of this element relative to the top-level parent window. */ readonly windowBounds: Bounds; /** * Adds an item to the top-level choices in this list. * @param type The type of the child element, the string "item". * @param text The localizable text label for the item. */ add(type: string, text?: string): ListItem; /** * Registers an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase When true, the handler is called only in the capturing phase of the event propagation. */ addEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Simulates the occurrence of an event in this target. */ dispatchEvent(): Event; /** * Retrieves an item object from the list that has a given text label. * @param text The text string to match. */ find(text: string): ListItem; /** * Hides this element. */ hide(): void; /** * Sends a notification message, simulating the specified user interaction * event. * @param eventName The name of the control event handler to call. */ notify(eventName?: string): void; /** * An event-handler callback function, called when the element acquires the * keyboard focus. */ onActivate(): void; /** * An event-handler callback function, called when the content of the element * has been changed */ onChange(): void; /** * An event-handler callback function, called when the user collapses (closes) * an expanded node in the treeview. * @param item The ListItem node that collapsed. */ onCollapse(item: ListItem): void; /** * An event-handler callback function, called when the element loses the * keyboard focus. */ onDeactivate(): void; /** * An event-handler callback function, called when the window is about to be * drawn. */ onDraw(): void; /** * An event-handler callback function, called when the user expands (opens) a * collapsed node in the treeview. * @param item The ListItem node that expanded. */ onExpand(item: ListItem): void; /** * An event-handler callback function, called when the element's shortcutKey * sequence is typed in the active window. */ onShortcutKey(): void; /** * Removes a child item from the list. * @param what The item or child to remove, specified by 0-based index in the top-level item list, text value, or as a ListItem object. */ remove(what: any): void; /** * Removes all child items from the list. */ removeAll(): void; /** * Unregisters an event handler for a particular type of event occuring in this * element. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase Whether to call the handler only in the capturing phase of the event propagation. */ removeEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Shows this element. */ show(): any; } /** * Encapsulates input event information for an event that propagates through a * container and control hierarchy. */ declare class UIEvent { /** * True if the event is of a type that bubbles. */ readonly bubbles: boolean; /** * True if the default action associated with the event can be canceled with * preventDefault(). */ readonly cancelable: boolean; /** * True if this event can be captured. */ readonly captures: boolean; /** * The event target object which is currently handling the event. During * capturing and bubbling, this is different from the property target. */ readonly currentTarget: boolean; /** * The click count for a mouse-click event. */ readonly detail: any; /** * The current phase of event propagation; one of none, target, capture, * bubble. */ readonly eventPhase: string; /** * The event target object for this event. */ readonly target: any; /** * The date and time at which the event occurred. */ readonly timeStamp: Date; /** * The name of the event that this object represents. */ readonly type: string; /** * The ScriptUI element that this event relates to. */ readonly view: any; /** * Creates an event. * @param type The event type. See UIEvent.type property. * @param captures Set to true if this event can be captured. * @param bubbles Set to true if the event bubbles. * @param view The ScriptUI element that this event relates to. * @param detail The click count for a mouse-click event. */ constructor(type: string, captures: boolean, bubbles: boolean, view?: Object, detail?: number); /** * Initializes a UI event as a core W3C event. * @param type The event type. * @param captures Set to true if this event can be captured. * @param bubbles Set to true if the event bubbles. * @param cancelable Set to true if the default action is cancelable. */ initEvent(type: string, captures: boolean, bubbles: boolean, cancelable: boolean): void; /** * Initializes an event. * @param type The event type. * @param captures Set to true if this event can be captured. * @param bubbles Set to true if the event bubbles. * @param view The ScriptUI element that this event relates to. * @param detail The click count for a mouse-click event. */ initUIEvent(type: string, captures: boolean, bubbles: boolean, view?: Object, detail?: number): void; /** * Prevents the default action associated with this event from being called. */ preventDefault(): void; /** * Stops the propagation of this event. */ stopPropagation(): void; } /** * Represents a measurement as a combination of values and unit. */ declare class UnitValue { /** * The base unit for all conversions. */ static baseUnit: UnitValue; /** * The base unit. */ baseUnit: UnitValue; /** * The unit name. */ readonly type: string; /** * The numeric value. */ value: number; /** * Returns this instance as a different unit. * @param unitName The unit name. */ as(unitName: string): UnitValue; /** * Converts this instance to a different unit. * @param unitName The unit name. */ convert(unitName: string): any; } /** * The instance represents a top-level window or dialog box, which contains * user-interface elements. */ declare class Window { /** * Set to true to make this window active. */ active: boolean; /** * Tells the layout manager how unlike-sized children of this container should * be aligned within a column or row. */ alignChildren: string; /** * The alignment style for child elements of a container. If defined, this * value overrides the alignChildren setting for the parent container. */ alignment: string; /** * The bounds of the window's drawable area, excluding the frame, in screen * coordinates. */ bounds: Bounds; /** * For windows of type dialog, the UI element to notify when the user presses a * cancellation key combination. */ cancelElement: Object; /** * A number of characters for which to reserve space when calculating the * preferred size of the window. * @remarks Range: 0 to … */ characters: number; /** * The collection of UI elements that have been added to this container. */ readonly children: Object[]; /** * For windows of type dialog, the UI element to notify when the user presses a * Enter key. */ defaultElement: Object; /** * True if this element is enabled. */ enabled: boolean; /** * The bounds of the window frame in screen coordinates. */ readonly frameBounds: Bounds; /** * The top left corner of the window frame in screen coordinates. */ frameLocation: Point; /** * The size and location of the window's frame in screen coordinates. */ readonly frameSize: Dimension; /** * Deprecated. Use ScriptUI.frameworkName instead. */ static readonly frameworkName: string; /** * The graphics object that can be used to customize the window’s appearance, * in response to the onDraw event. */ readonly graphics: ScriptUIGraphics; /** * The help text that is displayed when the mouse hovers over the element. */ helpTip: string; /** * The number of pixels to indent the element. * @remarks Range: 0 to … */ indent: number; /** * The default text justification style for child text elements. */ justify: string; /** * The layout manager for this container. */ layout: LayoutManager; /** * The upper left corner of the window's drawable area. */ location: Point; /** * The number of pixels between the edges of a container and the outermost * child elements. */ margins: number; /** * True if the window is expanded. */ maximized: boolean; /** * The largest rectangle to which the window can be resized. */ maximumSize: Dimension; /** * True if the window is minimized or iconified. */ minimized: boolean; /** * The smallest rectangle to which the window can be resized. */ minimumSize: Dimension; /** * The opacity of the window, in the range [0..1]. */ opacity: number; /** * The layout orientation of children in a container. */ orientation: string; /** * The immediate parent element. */ readonly parent: any; /** * The preferred size of the window. */ preferredSize: Dimension; /** * An object that contains one or more creation properties of the container * (properties used only when the element is created). */ properties: Object; /** * The keypress combination that invokes this element's onShortcutKey() * callback. */ shortcutKey: string; /** * The current size and location of the content area of the window in screen * coordinates. */ size: Dimension; /** * The number of pixels separating one child element from its adjacent sibling * element. */ spacing: number; /** * The title, label, or displayed text, a localizeable string. */ text: string; /** * The element type; "dialog", "palette", or "window". */ readonly type: string; /** * Deprecated. Use ScriptUI.version instead. */ static readonly version: any; /** * When true, the element is shown, when false it is hidden. */ visible: boolean; /** * The window that this element belongs to. */ readonly window: Window; /** * The bounds of this window relative to the top-level parent window. */ readonly windowBounds: Bounds; /** * Creates a new window. * @param type The window type. * @param title The window title, a localizable string. * @param bounds The window's position and size. * @param properties An object containing creation-only properties. */ constructor(type: string, title?: string, bounds?: Bounds, properties?: Object); /** * Creates and returns a new control or container object and adds it to the * children of this window. * @param type The type of the child element, as specified for the type property. * @param bounds A bounds specification that describes the size and position of the new control or container, relative to its parent. * @param text The text or label, a localizable string. * @param properties An object that contains one or more creation properties of the new child (properties used only when the element is created). */ add(type: string, bounds?: Bounds, text?: string, properties?: Object): any; /** * Registers an event handler for a particular type of event occuring in this * window. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase When true, the handler is called only in the capturing phase of the event propagation. */ addEventListener(eventName: string, handler: Function, capturePhase?: boolean): boolean; /** * Displays a platform-standard dialog containing a short message and an OK * button. * @param message TThe string for the displayed message. * @param title A string to appear as the title of the dialog, if the platform supports a title. * @param errorIcon When true, the platform-standard alert icon is replaced by the platform-standard error icon in the dialog. */ alert(message: string, title?: string, errorIcon?: boolean): void; /** * Centers this window on screen or with repect to another window. * @param window The relative window. If not specified, centers on the screen. */ center(window?: Window): void; /** * Closes this window. * @param return_ A number to be returned from the show() method that invoked this window as a modal dialog. */ close(return_?: any): void; /** * Displays a platform-standard dialog containing a short message and two * buttons labeled Yes and No. * @param message The string for the displayed message. * @param noAsDefault When true, the No button is the default choice, selected when the user types Enter. * @param title A string to appear as the title of the dialog, if the platform supports a title. */ confirm(message: string, noAsDefault: boolean, title?: string): boolean; /** * Simulates the occurrence of an event in this target. */ dispatchEvent(): UIEvent; /** * Use this method to find an existing window. * @param type The name of a predefined resource available to JavaScript in the current application; or the window type. * @param title The window title. */ find(type: string, title: string): Window; /** * Hides this windows. */ hide(): void; /** * Sends a notification message to all listeners, simulating the specified user * interaction event. * @param eventName The event name; if omitted, the default event is sent. */ notify(eventName?: string): void; /** * An event-handler callback function, called when the window acquires the * keyboard focus. */ onActivate(): void; /** * An event-handler callback function, called when the window is about to be * closed. */ onClose(): boolean; /** * An event-handler callback function, called when the window loses the * keyboard focus. */ onDeactivate(): void; /** * An event-handler callback function, called when the window has been moved */ onMove(): void; /** * An event-handler callback function, called when the window is being moved */ onMoving(): void; /** * An event-handler callback function, called after the window has been resized */ onResize(): void; /** * An event-handler callback function, called while a window is being resized */ onResizing(): void; /** * In Windows only, an event-handler callback function, called a shortcut-key * sequence is typed that matches the shortcutKey value for this window. */ onShortcutKey(): void; /** * An event-handler callback function, called just before the window is * displayed */ onShow(): void; /** * Displays a modal dialog that returns the user’s text input. * @param prompt The string for the displayed message. * @param default_ The initial value to be displayed in the text edit field. * @param title A string to appear as the title of the dialog. */ prompt(prompt: string, default_?: string, title?: string): string; /** * Removes the specified child control from this window’s children array. * @param what The child control to remove, specified by 0-based index, text property value, or as a control object. */ remove(what: any): void; /** * Unregisters an event handler for a particular type of event occuring in this * window. * @param eventName The name of the event. * @param handler The function that handles the event. * @param capturePhase Whether to call the handler only in the capturing phase of the event propagation. */ removeEventListener(eventName: string, handler: Function, capturePhase: boolean): boolean; /** * Makes this window visible. */ show(): any; } /** * Wraps XML into an object. */ declare class XML { /** * Controls whether XML comments should be parsed (false) or ignored (true). */ static ignoreComments: boolean; /** * Controls whether XML preprocessing instructions should be parsed (false) or * ignored (true). */ static ignoreProcessingInstructions: boolean; /** * Controls whether whitespace should be parsed (false) or ignored (true). */ static ignoreWhitespace: boolean; /** * The number of spaces used to indent pretty-printed XML. */ static prettyIndent: number; /** * When true, XML is pretty-printed when converting to a string. */ static prettyPrinting: boolean; /** * Parses an XML string. Throws an error if the XML is incorrect. * @param text The text to parse. */ constructor(text: string); /** * Adds a namespace declaration to the node. Returns the XML object itself. * @param namespace The namespace to add. */ addNamespace(namespace: Namespace): XML; /** * Appends the given XML to this XML as a child. Returns the XML object itself. * @param child The child XML to add. */ appendChild(child: XML): XML; /** * Returns a list containing all attribute elements matching the given name. * @param name The attribute name to look for. */ attribute(name: string): XML; /** * Returns a list containing all attribute elements. */ attributes(): XML; /** * Returns a list containing all children of this XML matching the given * element name. * @param name The name or the index of the child element. */ child(name: string): XML; /** * Returns a number representing the ordinal position of this XML object within * the context of its parent. */ childIndex(): number; /** * Returns an XML object containing all the properties of this XML object in * order. */ children(): XML; /** * Returns an XML object containing the properties of this XML object that * represent XML comments. */ comments(): XML; /** * Checks if this XML object contains the given XML object. * @param xml The XML to search for. */ contains(xml: XML): boolean; /** * Creates a copy of this XML object. */ copy(): XML; /** * Returns an object containing the default parsing and print settings for XML. */ defaultSettings(): Object; /** * Returns all the XML-valued descendants of this XML object with the given * name. * @param name The name of the descendant to find. */ descendants(name?: string): XML; /** * Returns a list of XML children that are elements with a given name, or all * children that are XML elements. * @param name The element name. If not supplied, gets all children that are XML elements. */ elements(name?: string): XML; /** * Reports whether this XML object contains complex content. */ hasComplexContent(): boolean; /** * Reports whether this XML object contains simple content. */ hasSimpleContent(): boolean; /** * Returns an array of Namespace objects mirroring the current list of valid * namespaces at this element. */ inScopeNamespaces(): any[]; /** * Inserts the given child2 after the given child1 in this XML object and * returns this XML object. * @param child1 The child to insert the other child after. * @param child2 The XML to insert. */ insertChildAfter(child1: XML, child2: XML): void; /** * Inserts the given child2 before the given child1 in this XML object and * returns this XML object. * @param child1 The child to search for. * @param child2 The XML to insert. */ insertChildBefore(child1: XML, child2: XML): void; /** * Returns the number of elements contained in an XML list. If this XML object * is not a list, returns 1. */ length(): number; /** * Returns the local name of this XML object. */ localName(): string; /** * Returns a QName object containing the URI and the local name of the element. */ name(): QName; /** * Returns a Namespace object containing the namespace URI of the current * element. */ namespace(): Namespace; /** * Returns an array containing all namespace declarations of this XML object. */ namespaceDeclarations(): any[]; /** * Returns the type of this XML object as one of the strings "element", * "attribute", "comment", "processing-instruction", or "text". */ nodeKind(): string; /** * Puts all text nodes in this and all descendant XML objects into a normal * form by merging adjacent text nodes and eliminating empty text nodes. * Returns this XML object. */ normalize(): XML; /** * Returns the parent object of this XML object. */ parent(): XML; /** * Inserts a given child into this object before its existing XML properties, * and returns this XML object. * @param child The XML to insert. */ prependChild(child: XML): XML; /** * Returns a list of preprocessing instructions. * @param name The name of the preprocessing instruction to return. */ processingInstructions(name?: string): XML; /** * Removes the given namespace from this XML, and returns this XML. * @param namespace The namespace to remove. */ removeNamespace(namespace: Namespace): XML; /** * Replaces the value of specified XML properties of this XML object returns * this XML object. * @param name The property name. * @param value The XML with which to replace the value of the matching property. */ replace(name: string, value: XML): XML; /** * Replaces all of the XML-valued properties in this object with a new value, * and returns this XML object. * @param value The new value, which can be a single XML object or an XML list. */ setChildren(value: XML): XML; /** * Replaces the local name of this XML object with a string constructed from * the given name * @param name The name to set. */ setLocalName(name: string): void; /** * Replaces the name of this XML object with the given QName object. * @param name The fully qualified name. */ setName(name: QName): void; /** * Sets the namespace for this XML element. * @param namespace The namespace to set. */ setNamespace(namespace: Namespace): void; /** * Sets the parsing and print setting for XML using an object returned by the * settings() method. * @param obj The object containing the settings to set. */ setSettings(obj: Object): void; /** * Returns an object containing the current parsing and print settings for XML. */ settings(): Object; /** * Returns an XML list containing all XML properties of this XML object that * represent XML text nodes. */ text(): XML; /** * Returns the string representation of this object. */ toString(): string; /** * Returns an XML-encoded string representation of this XML object. */ toXMLString(): string; /** * Evaluates the given XPath expression in accordance with the W3C XPath * recommendation, using this XML object as the context node. * @param expr The XPath expression to use. */ xpath(expr: string): XML; } /** * An XML list object. */ declare class XMLList { } /** * The application object */ declare const app: Application; /** * Displays an alert box * @param message The text to display * @param title The title of the alert; ignored on the Macintosh * @param errorIcon Display an Error icon; ignored on the Macintosh */ declare function alert(message: string, title?: string, errorIcon?: boolean): void; /** * Displays an alert box with Yes and No buttons; returns true for Yes * @param message The text to display * @param noAsDefault Set to true to set the No button as the default button * @param title The title of the alert; ignored on the Macintosh */ declare function confirm(message: string, noAsDefault: boolean, title?: string): boolean; /** * Returns true if the supplied string is a valid XML name. * @param name The XML name to test. */ declare function isXMLName(name: string): boolean; /** * Localizes a ZString-encoded string and merges additional arguments into the * string. * @param what The string to localize. A ZString-encoded string that can contain placeholder for additional arguments in the form %1 to %n. * @param argument Optional argument(s) to be merged into the string. There may be more than one argument. */ declare function localize(what: string, argument?: any): string; /** * Displays a dialog allowing the user to enter text * @param prompt The text to display * @param default_ The default text to preset the edit field with * @param title The title of the dialog; */ declare function prompt(prompt: string, default_?: string, title?: string): string; /** * Defines the default XML namespace. * @param namespace The namespace to use. */ declare function setDefaultXMLNamespace(namespace: Namespace): void; /** * Creates a source code representation of the supplied argument, and returns * it as a string. * @param what The object to uneval. */ declare function uneval(what: any): string; /** * Properties and methods available in the global namespace. */ declare class globals { /** * The application object. */ app: App; /** * Displays a platform-standard dialog containing a short message and an OK * button. * @param message TThe string for the displayed message. * @param title A string to appear as the title of the dialog, if the platform supports a title. * @param errorIcon When true, the platform-standard alert icon is replaced by the platform-standard error icon in the dialog. */ alert(message: string, title?: string, errorIcon?: boolean): void; /** * Displays a platform-standard dialog containing a short message and two * buttons labeled Yes and No. * @param message The string for the displayed message. * @param noAsDefault When true, the No button is the default choice, selected when the user types Enter. * @param title A string to appear as the title of the dialog, if the platform supports a title. */ confirm(message: string, noAsDefault: boolean, title?: string): boolean; /** * Displays a modal dialog that returns the user’s text input. * @param prompt The string for the displayed message. * @param default_ The initial value to be displayed in the text edit field. * @param title A string to appear as the title of the dialog. */ prompt(prompt: string, default_?: string, title?: string): string; }