Package | com.adobe.bridge |
Class | public class App |
Inheritance | App ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
defaultFilterCriteria : Array [read-only]
A collection of the default FilterDescription objects used to populate the Filter palette. | App | ||
defaultSortCriteria : Array [read-only]
A collection of the default SortCriterion objects used to sort the contents of container nodes. | App | ||
displayDialogs : String
The policy for the display of modal dialogs. | App | ||
document : Document
The active (top-most) Document object, representing the active browser window. | App | ||
documents : Array [read-only]
A collection of Document objects representing the set of all open browser windows. | App | ||
extensions : Array [read-only]
A collection of ExtensionHandler objects representing registered node-handling extensions. | App | ||
favorites : Favorites [read-only]
The top-level Favoritesobject for the navigation hierarchy displayed in the Favorites palette. | App | ||
folderRoots : Array [read-only]
The list of Bridge URI strings for the root nodes of the Folders palette. | App | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
inspectorPanels : Array [read-only]
The collection of script-defined InspectorPanel objects that make up the Inspector view for new browser windows. | App | ||
language : String [read-only]
The display name of the language for the current locale, as configured by the operating system. | App | ||
lastSender : String
The application specifier for the application that has most recently sent an interapplication message to Adobe Bridge. | App | ||
locale : String [read-only]
The Adobe locale code for the current locale, as configured by the operating system. | App | ||
name : String [read-only]
The application specifier for this application, "bridge". | App | ||
pendingJobs : Number [read-only]
The number of background tasks that Adobe Bridge has left to process. | App | ||
preferences : Preferences [read-only]
The Preferences object, which provides access to the user preferences shown in the Preferences dialog. | App | ||
standardFavorites : Array [read-only]
| App | ||
synchronousMode : Boolean
When true, Adobe Bridge attempts to ensure that all Thumbnail properties are valid before returning their values. | App | ||
userFavorites : Array [read-only]
| App | ||
version : String [read-only]
The version number of the Adobe Bridge application. | App | ||
watchDirInterval : Number
The duration in seconds between checks for folder consistency (checking whether files have been added or removed). | App | ||
workspaces : Array [read-only]
The list of all available workspaces, both default and user- or script-defined. | App |
Method | Defined By | ||
---|---|---|---|
acquirePhysicalFiles(thumbnails:Array):void
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. | App | ||
addCollectionMember(member:Thumbnail):void
Adds a member thumbnail, or set of member thumbnails, to a collection. | App | ||
addCredits(title:String, content:String):void
Appends a line of text to the Credits section of the Adobe Bridge About box. | App | ||
addCustomRoot(uri:String):Boolean
Appends a custom URI to the list of root nodes in app.folderRoots, which appear in the Folders palette. | App | ||
addLegalNotice(title:String, content:String):void
Appends a line of text to the Legal Notice section of the Adobe Bridge About box. | App | ||
beep():void
Calls on the operating system to emit a short audio tone. | App | ||
bringToFront():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. | App | ||
browseTo(path:String):void
Deprecated in Creative Suite 3. | App | ||
buildFolderCache(path:String, recurse:Boolean, buildFullsize:Boolean):Boolean
Forces Adobe Bridge to create thumbnail images for the specified folder. | App | ||
cancelTask(id:Number):void
Cancels a task that has been scheduled using app.scheduleTask(). | App | ||
createCollection(name:String):Thumbnail
Creates a new, named collection node. | App | ||
deleteCollection(collection:Thumbnail):Boolean
Deletes a collection node. | App | ||
enqueueOperation():void
Enqueues a long-running node-handling operation for execution at an appropriate time. | App | ||
exportKeywordsToFile(file:File):void | App | ||
![]() | filterArgsForHBAPI(args:Array):Array [static]
Function to clean up the argument list and put it into a format that
makes sense for HBAPI. | CSHostObject | |
![]() | filterSingleObjectForHBAPI(value:Object):Object [static]
| CSHostObject | |
![]() | getClassObjectForName(className:String):HostObject [static] This returns a "Class" object, meaning, a HostObject that can be used
to make static function calls or get static properties
| CSHostObject | |
getCollectionMembers(thumbnails:Array, collection:Thumbnail):void | App | ||
getCollections(thumbnails:Array):void
Retrieves all collection nodes, as created with app.createCollection(). | App | ||
![]() | getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):* [static] | CSHostObject | |
hide():void
Hides or minimizes all Adobe Bridge browser windows. | App | ||
![]() | hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
| CSHostObject | |
![]() | hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):* [static]
Implements a safe call of a static method on the host
| CSHostObject | |
![]() | hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
| CSHostObject | |
![]() | hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
| CSHostObject | |
![]() | hostGetStatic(className:String, propertyName:String, expectedReturnType:Class):* [static]
Implements a safe get of a static property on the host
Used by for instance, all the enum implementations. | CSHostObject | |
![]() | hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
| CSHostObject | |
![]() | hostSetStatic(className:String, propertyName:String, rawvalue:*):* [static]
Implements a safe set of a static property on the host
| CSHostObject | |
importKeywordsFromFile(file:File, importType:String):void
Imports keywords from a file to the Keywords palette. | App | ||
Reports whether a given thumbnail is a member of a given collection. | App | ||
![]() | isDescendedFrom(clz:Class, ancClass:Class):Boolean [static] Efficiently determines whether or not one class descends from
another in inheritance hierarchy- class relationships are cached
by the ClassUtils implementation-
(uses org.as3commons lib to quickly discover class hierarchy. | CSHostObject | |
isProcessingJob():Boolean
Reports whether Adobe Bridge is processing any jobs. | App | ||
launchHelp(params:Object):Boolean | App | ||
App | |||
openUrl(url:String):void
Opens a page in the platform's default web browser. | App | ||
operationChanged(operator:Operator):void
Notifies Adobe Bridge of an update to the processing status or progress of a long-running background operation implemented by a ProgressOperator object. | App | ||
preflightFiles(files:Array):Boolean
DEPRECATED in Creative Suite 3. | App | ||
purgeAllCaches():void
Purges the thumbnail caches for all folders. | App | ||
purgeFolderCache(path:String):void
Purges the thumbnail cache for a folder. | App | ||
quit():void
Shuts down the Adobe Bridge application and closes all browser windows. | App | ||
registerBrowseScheme(protocol:String, handler:Object):Boolean
DEPRECATED in Creative Suite 3. | App | ||
registerExtension(extension:ExtensionHandler):Boolean
Adds a script-defined node-handling extension to the application's list of available handlers, app.extensions. | App | ||
Declares a new node-data information set, associating it with a node-handling extension. | App | ||
registerInspectorPanel(pivotpanel:InspectorPanel):Boolean
Registers a script-defined Inspector panel, adding it to app.inspectorPanels. | App | ||
registerPrefix(prefix:String, extension:ExtensionHandler):Boolean
Associates a URI prefix string with a node-handling extension. | App | ||
removeCollectionMember(member:Thumbnail):void
Removes one or more member thumbnails from a collection. | App | ||
removeCredits(title:String):void
Removes a text item from the Credits area of the Adobe Bridge About box. | App | ||
removeLegalNotice(title:String):void
Removes a text item from the LegalNotice area of the Adobe Bridge About box. | App | ||
renameCollection(thumbnail:Thumbnail, name:String):Boolean | App | ||
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
runSlideshow(sources:Array):void
Loads a set of files or thumbnails as a slideshow, using the Preference options currently set for Adobe Bridge. | App | ||
scheduleTask(code:String, delay:Number, repeat:Boolean):Number
Executes a script after a specified delay. | App | ||
system(command:String):void
Issues the argument to the operating system, as if it were entered on the command line in a shell. | App | ||
unregisterExtension(extension:ExtensionHandler):void
Removes a node-handling extension, previously registered with app.registerExtension(), from the application’s global list. | App | ||
Removes the association between an extension and an information set, previously established with app.registerInfoset(). | App | ||
unregisterInspectorPanel(pivotpanel:InspectorPanel):Boolean
Removes a script-defined Inspector panel from the global list in app.inspectorPanels(). | App | ||
unregisterPrefix(prefix:String):Boolean
Removes a node URI prefix from the list of prefixes that the associated node-handling extension manages. | App | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
defaultFilterCriteria | property |
defaultFilterCriteria:Array
[read-only] Since : | CS5 |
A collection of the default FilterDescription objects used to populate the Filter palette.
public function get defaultFilterCriteria():Array
defaultSortCriteria | property |
defaultSortCriteria:Array
[read-only] Since : | CS5 |
A collection of the default SortCriterion objects used to sort the contents of container nodes.
public function get defaultSortCriteria():Array
displayDialogs | property |
displayDialogs:String
Since : | CS5 |
The policy for the display of modal dialogs.
public function get displayDialogs():String
public function set displayDialogs(value:String):void
document | property |
document:Document
Since : | CS5 |
The active (top-most) Document object, representing the active browser window.
public function get document():Document
public function set document(value:Document):void
documents | property |
documents:Array
[read-only] Since : | CS5 |
A collection of Document objects representing the set of all open browser windows.
public function get documents():Array
extensions | property |
extensions:Array
[read-only] Since : | CS5 |
A collection of ExtensionHandler objects representing registered node-handling extensions.
public function get extensions():Array
favorites | property |
favorites:Favorites
[read-only] Since : | CS5 |
The top-level Favoritesobject for the navigation hierarchy displayed in the Favorites palette.
public function get favorites():Favorites
folderRoots | property |
folderRoots:Array
[read-only] Since : | CS5 |
The list of Bridge URI strings for the root nodes of the Folders palette.
public function get folderRoots():Array
inspectorPanels | property |
inspectorPanels:Array
[read-only] Since : | CS5 |
The collection of script-defined InspectorPanel objects that make up the Inspector view for new browser windows.
public function get inspectorPanels():Array
language | property |
language:String
[read-only] Since : | CS5 |
The display name of the language for the current locale, as configured by the operating system.
public function get language():String
lastSender | property |
lastSender:String
Since : | CS5 |
The application specifier for the application that has most recently sent an interapplication message to Adobe Bridge.
public function get lastSender():String
public function set lastSender(value:String):void
locale | property |
locale:String
[read-only] Since : | CS5 |
The Adobe locale code for the current locale, as configured by the operating system.
public function get locale():String
name | property |
name:String
[read-only] Since : | CS5 |
The application specifier for this application, "bridge".
public function get name():String
pendingJobs | property |
pendingJobs:Number
[read-only] Since : | CS5 |
The number of background tasks that Adobe Bridge has left to process.
public function get pendingJobs():Number
preferences | property |
preferences:Preferences
[read-only] Since : | CS5 |
The Preferences object, which provides access to the user preferences shown in the Preferences dialog.
public function get preferences():Preferences
standardFavorites | property |
standardFavorites:Array
[read-only] Since : | CS5 |
public function get standardFavorites():Array
synchronousMode | property |
synchronousMode:Boolean
Since : | CS5 |
When true, Adobe Bridge attempts to ensure that all Thumbnail properties are valid before returning their values.
public function get synchronousMode():Boolean
public function set synchronousMode(value:Boolean):void
userFavorites | property |
userFavorites:Array
[read-only] Since : | CS5 |
public function get userFavorites():Array
version | property |
version:String
[read-only] Since : | CS5 |
The version number of the Adobe Bridge application.
public function get version():String
watchDirInterval | property |
watchDirInterval:Number
Since : | CS5 |
The duration in seconds between checks for folder consistency (checking whether files have been added or removed).
public function get watchDirInterval():Number
public function set watchDirInterval(value:Number):void
workspaces | property |
workspaces:Array
[read-only] Since : | CS5 |
The list of all available workspaces, both default and user- or script-defined.
public function get workspaces():Array
acquirePhysicalFiles | () | method |
public function acquirePhysicalFiles(thumbnails:Array):void
Since : | CS5 |
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.
Parameters
thumbnails:Array — (Array)
|
addCollectionMember | () | method |
public function addCollectionMember(member:Thumbnail):void
Since : | CS5 |
Adds a member thumbnail, or set of member thumbnails, to a collection.
Parameters
member:Thumbnail — (Thumbnail)
|
addCredits | () | method |
public function addCredits(title:String, content:String):void
Since : | CS5 |
Appends a line of text to the Credits section of the Adobe Bridge About box.
Parameters
title:String — (String)
| |
content:String — (String)
|
addCustomRoot | () | method |
public function addCustomRoot(uri:String):Boolean
Since : | CS5 |
Appends a custom URI to the list of root nodes in app.folderRoots, which appear in the Folders palette.
Parameters
uri:String — (String)
|
Boolean |
addLegalNotice | () | method |
public function addLegalNotice(title:String, content:String):void
Since : | CS5 |
Appends a line of text to the Legal Notice section of the Adobe Bridge About box.
Parameters
title:String — (String)
| |
content:String — (String)
|
beep | () | method |
public function beep():void
Since : | CS5 |
Calls on the operating system to emit a short audio tone.
bringToFront | () | method |
public function bringToFront():void
Since : | CS5 |
Gives Adobe Bridge the application focus for the operating system, and makes the current browser window the topmost active window in the windowing system.
browseTo | () | method |
public function browseTo(path:String):void
Since : | CS5 |
Deprecated in Creative Suite 3. Do not use.
Parameters
path:String — (String)
|
buildFolderCache | () | method |
public function buildFolderCache(path:String, recurse:Boolean, buildFullsize:Boolean):Boolean
Since : | CS5 |
Forces Adobe Bridge to create thumbnail images for the specified folder.
Parameters
path:String — (String)
| |
recurse:Boolean — (Boolean)
| |
buildFullsize:Boolean — (Boolean)
|
Boolean |
cancelTask | () | method |
public function cancelTask(id:Number):void
Since : | CS5 |
Cancels a task that has been scheduled using app.scheduleTask().
Parameters
id:Number — (Number)
|
createCollection | () | method |
public function createCollection(name:String):Thumbnail
Since : | CS5 |
Creates a new, named collection node.
Parameters
name:String — (String)
|
Thumbnail |
deleteCollection | () | method |
public function deleteCollection(collection:Thumbnail):Boolean
Since : | CS5 |
Deletes a collection node.
Parameters
collection:Thumbnail — (Thumbnail)
|
Boolean |
enqueueOperation | () | method |
public function enqueueOperation():void
Since : | CS5 |
Enqueues a long-running node-handling operation for execution at an appropriate time.
exportKeywordsToFile | () | method |
public function exportKeywordsToFile(file:File):void
Since : | CS5 |
Parameters
file:File — (File)
|
getCollectionMembers | () | method |
public function getCollectionMembers(thumbnails:Array, collection:Thumbnail):void
Since : | CS5 |
Parameters
thumbnails:Array — (Array)
| |
collection:Thumbnail — (Thumbnail)
|
getCollections | () | method |
public function getCollections(thumbnails:Array):void
Since : | CS5 |
Retrieves all collection nodes, as created with app.createCollection().
Parameters
thumbnails:Array — (Array)
|
hide | () | method |
public function hide():void
Since : | CS5 |
Hides or minimizes all Adobe Bridge browser windows.
importKeywordsFromFile | () | method |
public function importKeywordsFromFile(file:File, importType:String):void
Since : | CS5 |
Imports keywords from a file to the Keywords palette.
Parameters
file:File — (File)
| |
importType:String — (String)
|
isCollectionMember | () | method |
public function isCollectionMember(collection:Thumbnail, member:Thumbnail):Boolean
Since : | CS5 |
Reports whether a given thumbnail is a member of a given collection.
Parameters
collection:Thumbnail — (Thumbnail)
| |
member:Thumbnail — (Thumbnail)
|
Boolean |
isProcessingJob | () | method |
public function isProcessingJob():Boolean
Since : | CS5 |
Reports whether Adobe Bridge is processing any jobs. Returns false if all the jobs are finished.
ReturnsBoolean |
launchHelp | () | method |
public function launchHelp(params:Object):Boolean
Since : | CS5 |
Parameters
params:Object — (Object)
|
Boolean |
makeSearch | () | method |
public function makeSearch(scope:Thumbnail, specification:Object):Thumbnail
Since : | CS5 |
Parameters
scope:Thumbnail — (Thumbnail)
| |
specification:Object — (Object)
|
Thumbnail |
openUrl | () | method |
public function openUrl(url:String):void
Since : | CS5 |
Opens a page in the platform's default web browser.
Parameters
url:String — (String)
|
operationChanged | () | method |
public function operationChanged(operator:Operator):void
Since : | CS5 |
Notifies Adobe Bridge of an update to the processing status or progress of a long-running background operation implemented by a ProgressOperator object.
Parameters
operator:Operator — ( Operator)
|
preflightFiles | () | method |
public function preflightFiles(files:Array):Boolean
Since : | CS5 |
DEPRECATED in Creative Suite 3. Use app.acquirePhysicalFiles() instead.
Parameters
files:Array — (Array)
|
Boolean |
purgeAllCaches | () | method |
public function purgeAllCaches():void
Since : | CS5 |
Purges the thumbnail caches for all folders.
purgeFolderCache | () | method |
public function purgeFolderCache(path:String):void
Since : | CS5 |
Purges the thumbnail cache for a folder.
Parameters
path:String — (String)
|
quit | () | method |
public function quit():void
Since : | CS5 |
Shuts down the Adobe Bridge application and closes all browser windows.
registerBrowseScheme | () | method |
public function registerBrowseScheme(protocol:String, handler:Object):Boolean
Since : | CS5 |
DEPRECATED in Creative Suite 3. Do not use.
Parameters
protocol:String — (String)
| |
handler:Object — (Object)
|
Boolean |
registerExtension | () | method |
public function registerExtension(extension:ExtensionHandler):Boolean
Since : | CS5 |
Adds a script-defined node-handling extension to the application's list of available handlers, app.extensions.
Parameters
extension:ExtensionHandler — (ExtensionHandler)
|
Boolean |
registerInfoset | () | method |
public function registerInfoset(extension:ExtensionHandler, infoset:Infoset):Boolean
Since : | CS5 |
Declares a new node-data information set, associating it with a node-handling extension.
Parameters
extension:ExtensionHandler — (ExtensionHandler)
| |
infoset:Infoset — (Infoset)
|
Boolean |
registerInspectorPanel | () | method |
public function registerInspectorPanel(pivotpanel:InspectorPanel):Boolean
Since : | CS5 |
Registers a script-defined Inspector panel, adding it to app.inspectorPanels.
Parameters
pivotpanel:InspectorPanel — (InspectorPanel)
|
Boolean |
registerPrefix | () | method |
public function registerPrefix(prefix:String, extension:ExtensionHandler):Boolean
Since : | CS5 |
Associates a URI prefix string with a node-handling extension.
Parameters
prefix:String — (String)
| |
extension:ExtensionHandler — (ExtensionHandler)
|
Boolean |
removeCollectionMember | () | method |
public function removeCollectionMember(member:Thumbnail):void
Since : | CS5 |
Removes one or more member thumbnails from a collection.
Parameters
member:Thumbnail — (Thumbnail)
|
removeCredits | () | method |
public function removeCredits(title:String):void
Since : | CS5 |
Removes a text item from the Credits area of the Adobe Bridge About box.
Parameters
title:String — (String)
|
removeLegalNotice | () | method |
public function removeLegalNotice(title:String):void
Since : | CS5 |
Removes a text item from the LegalNotice area of the Adobe Bridge About box.
Parameters
title:String — (String)
|
renameCollection | () | method |
public function renameCollection(thumbnail:Thumbnail, name:String):Boolean
Since : | CS5 |
Parameters
thumbnail:Thumbnail — ( thumbnailThumbnail)
| |
name:String — (String)
|
Boolean |
runSlideshow | () | method |
public function runSlideshow(sources:Array):void
Since : | CS5 |
Loads a set of files or thumbnails as a slideshow, using the Preference options currently set for Adobe Bridge.
Parameters
sources:Array — (Array)
|
scheduleTask | () | method |
public function scheduleTask(code:String, delay:Number, repeat:Boolean):Number
Since : | CS5 |
Executes a script after a specified delay.
Parameters
code:String — (String)
| |
delay:Number — (Number)
| |
repeat:Boolean — (Boolean)
|
Number |
system | () | method |
public function system(command:String):void
Since : | CS5 |
Issues the argument to the operating system, as if it were entered on the command line in a shell.
Parameters
command:String — (String)
|
unregisterExtension | () | method |
public function unregisterExtension(extension:ExtensionHandler):void
Since : | CS5 |
Removes a node-handling extension, previously registered with app.registerExtension(), from the application’s global list.
Parameters
extension:ExtensionHandler — (ExtensionHandler)
|
unregisterInfoset | () | method |
public function unregisterInfoset(extension:ExtensionHandler, infoset:Infoset):void
Since : | CS5 |
Removes the association between an extension and an information set, previously established with app.registerInfoset().
Parameters
extension:ExtensionHandler — (ExtensionHandler)
| |
infoset:Infoset — (Infoset)
|
unregisterInspectorPanel | () | method |
public function unregisterInspectorPanel(pivotpanel:InspectorPanel):Boolean
Since : | CS5 |
Removes a script-defined Inspector panel from the global list in app.inspectorPanels().
Parameters
pivotpanel:InspectorPanel — (InspectorPanel)
|
Boolean |
unregisterPrefix | () | method |
public function unregisterPrefix(prefix:String):Boolean
Since : | CS5 |
Removes a node URI prefix from the list of prefixes that the associated node-handling extension manages.
Parameters
prefix:String — (String)
|
Boolean |