Packagecom.adobe.bridge
Classpublic class Document
InheritanceDocument Inheritance CSHostObject Inheritance flash.utils.Proxy

Since : CS5

The user can create multiple browser windows by selecting the New Window command in the File menu. For each browser window, there is one Document instance. Access the object for the active browser window using app.document Access an array of objects for all open browser windows in app.documents



Public Properties
 PropertyDefined By
  additionalMetadata : Array
Identifies up to four lines of additional metadata to display for thumbnails in the Content pane.
Document
  allowDrags : Boolean
Whether to allow drag-and-drop of thumbnails in this browser window.
Document
  bottomNavbar : Navbar
DEPRECATED.
Document
  browserMode : String
The browser window mode, corresponding to the UI button on the upper right, "Switch to compact mode".
Document
  contentPaneMode : String
DEPRECATED.
Document
  context : Thumbnail
[read-only] The Thumbnail object a user has right-clicked to invoke a context menu; otherwise undefined.
Document
  displayInspectorView : Boolean
Whether to display Inspector panels.
Document
  groupedSelections : Array
[read-only] Current selected thumbnails in the Content pane.
Document
  height : Number
The height of the browser window in pixels.
Document
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  hwnd : Number
[read-only] In Windows only, a platform-specific handle to the window for this browser.
Document
  id : Number
[read-only] A unique identifier for the browser window, valid for the life of the window.
Document
  jsFuncs : Object
DEPRECATED.
Document
  maximized : Boolean
[read-only] When true, this browser window is in the zoomed or maximized state.
Document
  minimized : Boolean
[read-only] When true, this browser window is in the collapsed or minimized state.
Document
  navbars : Object
[read-only] Contains the predefined NavBar objects for the configurable navigation bars.
Document
  noItems : String
Text to be displayed in the Content pane when the selected thumbnail is for an empty folder.
Document
  owner : String
The Adobe Bridge-enabled application that created or first activated this browser window, if it was not Adobe Bridge.
Document
  palettes : Array
[read-only] A collection of TabbedPalette objects for all default and script-defined display palettes available to this browser, regardless of their visibility status.
Document
  position : Object
The position of this browser window on the screen.
Document
  presentationMode : String
[read-only] The presentation mode of the Content pane.
Document
  presentationPath : String
The path to the content displayed in the Content pane.
Document
  previewLooping : Boolean
[read-only]
Document
  selectionLength : Number
[read-only] The number of currently selected thumbnails in the Content pane.
Document
  selections : Array
[read-only] The Thumbnail objects for all currently selected files in the Content pane of this document.
Document
  selectionsLength : Number
[read-only] The number of currently selected thumbnails in the Content pane.
Document
  showThumbnailName : Boolean
When true, thumbnail names are displayed in the Content pane.
Document
  sorts : Array
How the thumbnails in the Content pane are sorted.
Document
  stacks : Array
[read-only] A list of all current thumbnail stacks in this browser.
Document
  status : String
The text displayed in the document's status line at the bottom of the Content pane.
Document
  thumbnail : Thumbnail
The Thumbnail object for the node currently selected in the Folders or Favorites pane.
Document
  thumbnailViewMode : String
The view mode of the Content pane, as selected by the View menu.
Document
  topNavbar : Navbar
DEPRECATED.
Document
  visible : Boolean
When true, the browser window is expanded, as opposed to being minimized or collapsed.
Document
  visibleThumbnails : Array
[read-only] An array of Thumbnail objects that are currently shown in the Content pane.
Document
  visibleThumbnailsLength : Number
[read-only] The number of thumbnails in the visibleThumbnails array.
Document
  visitUrl : Function
DEPRECATED.
Document
  width : Number
The width of the browser window in pixels.
Document
  workspace : Object
[read-only] Retrieves the most recently set workspace.
Document
Public Methods
 MethodDefined By
  
Document(file:File = null)
Document
  
Makes this browser window the topmost active window in the windowing system.
Document
  
center():void
Centers this browser window on the screen.
Document
  
Executes an Adobe Bridge-defined or script-defined menu command programatically.
Document
  
close():void
Closes this browser window.
Document
  
deselect(thumb:Thumbnail):void
Deselects a node in the Content pane.
Document
  
Deselects all selected nodes in the Content pane.
Document
  
execJS():void
DEPRECATED.
Document
 Inherited
filterArgsForHBAPI(args:Array):Array
[static] Function to clean up the argument list and put it into a format that makes sense for HBAPI.
CSHostObject
 Inherited
filterSingleObjectForHBAPI(value:Object):Object
[static]
CSHostObject
  
Stores stack properties into the cache file.
Document
 Inherited
getClassObjectForName(className:String):HostObject
[static] This returns a "Class" object, meaning, a HostObject that can be used to make static function calls or get static properties
CSHostObject
  
getSelection():String
Collects selected thumbnails for files of a given type, if any are selected.
Document
 Inherited
getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):*
[static]
CSHostObject
 Inherited
hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
CSHostObject
 Inherited
hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):*
[static] Implements a safe call of a static method on the host
CSHostObject
 Inherited
hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
CSHostObject
 Inherited
hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
CSHostObject
 Inherited
hostGetStatic(className:String, propertyName:String, expectedReturnType:Class):*
[static] Implements a safe get of a static property on the host Used by for instance, all the enum implementations.
CSHostObject
 Inherited
hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
CSHostObject
 Inherited
hostSetStatic(className:String, propertyName:String, rawvalue:*):*
[static] Implements a safe set of a static property on the host
CSHostObject
 Inherited
isDescendedFrom(clz:Class, ancClass:Class):Boolean
[static] Efficiently determines whether or not one class descends from another in inheritance hierarchy- class relationships are cached by the ClassUtils implementation- (uses org.as3commons lib to quickly discover class hierarchy.
CSHostObject
  
maximize():void
Maximizes or zooms this browser window.
Document
  
minimize():void
Minimizes or docks this browser window.
Document
  
normalize():void
Centers this browser window on the screen, and sets the height and width to 80% of the screen height and width.
Document
  
print():Boolean
DEPRECATED.
Document
  
refresh():void
Refreshes the display of this browser window.
Document
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
Restores the default configuration of the tabbed palettes in this browser window.
Document
  
restore():void
Restores this browser window after it has been minimized.
Document
  
reveal():void
Causes the Content pane (not the Folders or Favorites pane) to show the specified thumbnail.
Document
  
select(thumb:Thumbnail):void
Selects a thumbnail in the Content pane.
Document
  
selectAll():void
Selects all children of the currenly selected thumbnail in the Content pane.
Document
  
setPresentationMode(mode:String, path:String):void
Sets the presentation mode of the Content pane, and optionally the path to the current content to display.
Document
  
setWorkspace():Boolean
Sets the browser configuration to a predefined, user-defined or script-defined workspace.
Document
 Inherited
wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):*
[static] Method used on static/normal get/ hostcalls
CSHostObject
Protected Methods
 MethodDefined By
  
createWithArgs(args:Array):void
[override]
Document
 Inherited
hostCreate(args:Array):void
CSHostObject
Property Detail
additionalMetadataproperty
additionalMetadata:Array

Since : CS5

Identifies up to four lines of additional metadata to display for thumbnails in the Content pane.


Implementation
    public function get additionalMetadata():Array
    public function set additionalMetadata(value:Array):void
allowDragsproperty 
allowDrags:Boolean

Since : CS5

Whether to allow drag-and-drop of thumbnails in this browser window.


Implementation
    public function get allowDrags():Boolean
    public function set allowDrags(value:Boolean):void
bottomNavbarproperty 
bottomNavbar:Navbar

Since : CS5

DEPRECATED. Use navbars.filesystem.bottom.


Implementation
    public function get bottomNavbar():Navbar
    public function set bottomNavbar(value:Navbar):void
browserModeproperty 
browserMode:String

Since : CS5

The browser window mode, corresponding to the UI button on the upper right, "Switch to compact mode".


Implementation
    public function get browserMode():String
    public function set browserMode(value:String):void
contentPaneModeproperty 
contentPaneMode:String

Since : CS5

DEPRECATED. Do not use.


Implementation
    public function get contentPaneMode():String
    public function set contentPaneMode(value:String):void
contextproperty 
context:Thumbnail  [read-only]

Since : CS5

The Thumbnail object a user has right-clicked to invoke a context menu; otherwise undefined.


Implementation
    public function get context():Thumbnail
displayInspectorViewproperty 
displayInspectorView:Boolean

Since : CS5

Whether to display Inspector panels.


Implementation
    public function get displayInspectorView():Boolean
    public function set displayInspectorView(value:Boolean):void
groupedSelectionsproperty 
groupedSelections:Array  [read-only]

Since : CS5

Current selected thumbnails in the Content pane.


Implementation
    public function get groupedSelections():Array
heightproperty 
height:Number

Since : CS5

The height of the browser window in pixels.


Implementation
    public function get height():Number
    public function set height(value:Number):void
hwndproperty 
hwnd:Number  [read-only]

Since : CS5

In Windows only, a platform-specific handle to the window for this browser.


Implementation
    public function get hwnd():Number
idproperty 
id:Number  [read-only]

Since : CS5

A unique identifier for the browser window, valid for the life of the window.


Implementation
    public function get id():Number
jsFuncsproperty 
jsFuncs:Object

Since : CS5

DEPRECATED. Do not use.


Implementation
    public function get jsFuncs():Object
    public function set jsFuncs(value:Object):void
maximizedproperty 
maximized:Boolean  [read-only]

Since : CS5

When true, this browser window is in the zoomed or maximized state.


Implementation
    public function get maximized():Boolean
minimizedproperty 
minimized:Boolean  [read-only]

Since : CS5

When true, this browser window is in the collapsed or minimized state.


Implementation
    public function get minimized():Boolean
navbarsproperty 
navbars:Object  [read-only]

Since : CS5

Contains the predefined NavBar objects for the configurable navigation bars.


Implementation
    public function get navbars():Object
noItemsproperty 
noItems:String

Since : CS5

Text to be displayed in the Content pane when the selected thumbnail is for an empty folder.


Implementation
    public function get noItems():String
    public function set noItems(value:String):void
ownerproperty 
owner:String

Since : CS5

The Adobe Bridge-enabled application that created or first activated this browser window, if it was not Adobe Bridge.


Implementation
    public function get owner():String
    public function set owner(value:String):void
palettesproperty 
palettes:Array  [read-only]

Since : CS5

A collection of TabbedPalette objects for all default and script-defined display palettes available to this browser, regardless of their visibility status.


Implementation
    public function get palettes():Array
positionproperty 
position:Object

Since : CS5

The position of this browser window on the screen.


Implementation
    public function get position():Object
    public function set position(value:Object):void
presentationModeproperty 
presentationMode:String  [read-only]

Since : CS5

The presentation mode of the Content pane.


Implementation
    public function get presentationMode():String
presentationPathproperty 
presentationPath:String

Since : CS5

The path to the content displayed in the Content pane.


Implementation
    public function get presentationPath():String
    public function set presentationPath(value:String):void
previewLoopingproperty 
previewLooping:Boolean  [read-only]

Since : CS5


Implementation
    public function get previewLooping():Boolean
selectionLengthproperty 
selectionLength:Number  [read-only]

Since : CS5

The number of currently selected thumbnails in the Content pane.


Implementation
    public function get selectionLength():Number
selectionsproperty 
selections:Array  [read-only]

Since : CS5

The Thumbnail objects for all currently selected files in the Content pane of this document.


Implementation
    public function get selections():Array
selectionsLengthproperty 
selectionsLength:Number  [read-only]

Since : CS5

The number of currently selected thumbnails in the Content pane.


Implementation
    public function get selectionsLength():Number
showThumbnailNameproperty 
showThumbnailName:Boolean

Since : CS5

When true, thumbnail names are displayed in the Content pane.


Implementation
    public function get showThumbnailName():Boolean
    public function set showThumbnailName(value:Boolean):void
sortsproperty 
sorts:Array

Since : CS5

How the thumbnails in the Content pane are sorted.


Implementation
    public function get sorts():Array
    public function set sorts(value:Array):void
stacksproperty 
stacks:Array  [read-only]

Since : CS5

A list of all current thumbnail stacks in this browser.


Implementation
    public function get stacks():Array
statusproperty 
status:String

Since : CS5

The text displayed in the document's status line at the bottom of the Content pane.


Implementation
    public function get status():String
    public function set status(value:String):void
thumbnailproperty 
thumbnail:Thumbnail

Since : CS5

The Thumbnail object for the node currently selected in the Folders or Favorites pane.


Implementation
    public function get thumbnail():Thumbnail
    public function set thumbnail(value:Thumbnail):void
thumbnailViewModeproperty 
thumbnailViewMode:String

Since : CS5

The view mode of the Content pane, as selected by the View menu.


Implementation
    public function get thumbnailViewMode():String
    public function set thumbnailViewMode(value:String):void
topNavbarproperty 
topNavbar:Navbar

Since : CS5

DEPRECATED. Use navbars.filesystem.top.


Implementation
    public function get topNavbar():Navbar
    public function set topNavbar(value:Navbar):void
visibleproperty 
visible:Boolean

Since : CS5

When true, the browser window is expanded, as opposed to being minimized or collapsed.


Implementation
    public function get visible():Boolean
    public function set visible(value:Boolean):void
visibleThumbnailsproperty 
visibleThumbnails:Array  [read-only]

Since : CS5

An array of Thumbnail objects that are currently shown in the Content pane.


Implementation
    public function get visibleThumbnails():Array
visibleThumbnailsLengthproperty 
visibleThumbnailsLength:Number  [read-only]

Since : CS5

The number of thumbnails in the visibleThumbnails array.


Implementation
    public function get visibleThumbnailsLength():Number
visitUrlproperty 
visitUrl:Function

Since : CS5

DEPRECATED. Do not use.


Implementation
    public function get visitUrl():Function
    public function set visitUrl(value:Function):void
widthproperty 
width:Number

Since : CS5

The width of the browser window in pixels.


Implementation
    public function get width():Number
    public function set width(value:Number):void
workspaceproperty 
workspace:Object  [read-only]

Since : CS5

Retrieves the most recently set workspace.


Implementation
    public function get workspace():Object
Constructor Detail
Document()Constructor
public function Document(file:File = null)

Since : CS5

Parameters
file:File (default = null) — (File)
Method Detail
bringToFront()method
public function bringToFront():void

Since : CS5

Makes this browser window the topmost active window in the windowing system.

center()method 
public function center():void

Since : CS5

Centers this browser window on the screen.

chooseMenuItem()method 
public function chooseMenuItem():void

Since : CS5

Executes an Adobe Bridge-defined or script-defined menu command programatically.

close()method 
public function close():void

Since : CS5

Closes this browser window.

createWithArgs()method 
override protected function createWithArgs(args:Array):void

Since : CS5

Parameters

args:Array

deselect()method 
public function deselect(thumb:Thumbnail):void

Since : CS5

Deselects a node in the Content pane.

Parameters

thumb:Thumbnail — (Thumbnail)

deselectAll()method 
public function deselectAll():void

Since : CS5

Deselects all selected nodes in the Content pane.

execJS()method 
public function execJS():void

Since : CS5

DEPRECATED. Do not use.

flushStackProperties()method 
public function flushStackProperties():void

Since : CS5

Stores stack properties into the cache file.

getSelection()method 
public function getSelection():String

Since : CS5

Collects selected thumbnails for files of a given type, if any are selected.

Returns
String
maximize()method 
public function maximize():void

Since : CS5

Maximizes or zooms this browser window.

minimize()method 
public function minimize():void

Since : CS5

Minimizes or docks this browser window.

normalize()method 
public function normalize():void

Since : CS5

Centers this browser window on the screen, and sets the height and width to 80% of the screen height and width.

print()method 
public function print():Boolean

Since : CS5

DEPRECATED. Do not use.

Returns
Boolean
refresh()method 
public function refresh():void

Since : CS5

Refreshes the display of this browser window.

resetToDefaultWorkspace()method 
public function resetToDefaultWorkspace():void

Since : CS5

Restores the default configuration of the tabbed palettes in this browser window.

restore()method 
public function restore():void

Since : CS5

Restores this browser window after it has been minimized.

reveal()method 
public function reveal():void

Since : CS5

Causes the Content pane (not the Folders or Favorites pane) to show the specified thumbnail.

select()method 
public function select(thumb:Thumbnail):void

Since : CS5

Selects a thumbnail in the Content pane.

Parameters

thumb:Thumbnail — (Thumbnail)

selectAll()method 
public function selectAll():void

Since : CS5

Selects all children of the currenly selected thumbnail in the Content pane.

setPresentationMode()method 
public function setPresentationMode(mode:String, path:String):void

Since : CS5

Sets the presentation mode of the Content pane, and optionally the path to the current content to display.

Parameters

mode:String — (String)
 
path:String — (String)

setWorkspace()method 
public function setWorkspace():Boolean

Since : CS5

Sets the browser configuration to a predefined, user-defined or script-defined workspace.

Returns
Boolean