Package | com.adobe.bridge |
Class | public class Document |
Inheritance | Document ![]() ![]() |
Since : | CS5 |
Property | Defined 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 | ||
![]() | hostObjectDelegate : 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 |
Method | Defined By | ||
---|---|---|---|
Document(file:File = null) | Document | ||
bringToFront():void
Makes this browser window the topmost active window in the windowing system. | Document | ||
center():void
Centers this browser window on the screen. | Document | ||
chooseMenuItem():void
Executes an Adobe Bridge-defined or script-defined menu command programatically. | Document | ||
close():void
Closes this browser window. | Document | ||
Deselects a node in the Content pane. | Document | ||
deselectAll():void
Deselects all selected nodes in the Content pane. | Document | ||
execJS():void
DEPRECATED. | Document | ||
![]() | 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 | |
flushStackProperties():void
Stores stack properties into the cache file. | Document | ||
![]() | 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 | ||
![]() | getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):* [static] | CSHostObject | |
![]() | hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
| CSHostObject | |
![]() | hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):* [static]
Implements a safe call of a static method on the host
| CSHostObject | |
![]() | hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
| CSHostObject | |
![]() | hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
| CSHostObject | |
![]() | hostGetStatic(className:String, propertyName:String, expectedReturnType:Class):* [static]
Implements a safe get of a static property on the host
Used by for instance, all the enum implementations. | CSHostObject | |
![]() | hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
| CSHostObject | |
![]() | hostSetStatic(className:String, propertyName:String, rawvalue:*):* [static]
Implements a safe set of a static property on the host
| CSHostObject | |
![]() | isDescendedFrom(clz:Class, ancClass:Class):Boolean [static] Efficiently determines whether or not one class descends from
another in inheritance hierarchy- class relationships are cached
by the ClassUtils implementation-
(uses org.as3commons lib to quickly discover class hierarchy. | CSHostObject | |
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 | ||
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
resetToDefaultWorkspace():void
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 | ||
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 | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
Method | Defined By | ||
---|---|---|---|
createWithArgs(args:Array):void [override] | Document | ||
![]() | hostCreate(args:Array):void | CSHostObject |
additionalMetadata | property |
additionalMetadata:Array
Since : | CS5 |
Identifies up to four lines of additional metadata to display for thumbnails in the Content pane.
public function get additionalMetadata():Array
public function set additionalMetadata(value:Array):void
allowDrags | property |
allowDrags:Boolean
Since : | CS5 |
Whether to allow drag-and-drop of thumbnails in this browser window.
public function get allowDrags():Boolean
public function set allowDrags(value:Boolean):void
bottomNavbar | property |
bottomNavbar:Navbar
Since : | CS5 |
DEPRECATED. Use navbars.filesystem.bottom.
public function get bottomNavbar():Navbar
public function set bottomNavbar(value:Navbar):void
browserMode | property |
browserMode:String
Since : | CS5 |
The browser window mode, corresponding to the UI button on the upper right, "Switch to compact mode".
public function get browserMode():String
public function set browserMode(value:String):void
contentPaneMode | property |
contentPaneMode:String
Since : | CS5 |
DEPRECATED. Do not use.
public function get contentPaneMode():String
public function set contentPaneMode(value:String):void
context | property |
context:Thumbnail
[read-only] Since : | CS5 |
The Thumbnail object a user has right-clicked to invoke a context menu; otherwise undefined.
public function get context():Thumbnail
displayInspectorView | property |
displayInspectorView:Boolean
Since : | CS5 |
Whether to display Inspector panels.
public function get displayInspectorView():Boolean
public function set displayInspectorView(value:Boolean):void
groupedSelections | property |
groupedSelections:Array
[read-only] Since : | CS5 |
Current selected thumbnails in the Content pane.
public function get groupedSelections():Array
height | property |
height:Number
Since : | CS5 |
The height of the browser window in pixels.
public function get height():Number
public function set height(value:Number):void
hwnd | property |
hwnd:Number
[read-only] Since : | CS5 |
In Windows only, a platform-specific handle to the window for this browser.
public function get hwnd():Number
id | property |
id:Number
[read-only] Since : | CS5 |
A unique identifier for the browser window, valid for the life of the window.
public function get id():Number
jsFuncs | property |
jsFuncs:Object
Since : | CS5 |
DEPRECATED. Do not use.
public function get jsFuncs():Object
public function set jsFuncs(value:Object):void
maximized | property |
maximized:Boolean
[read-only] Since : | CS5 |
When true, this browser window is in the zoomed or maximized state.
public function get maximized():Boolean
minimized | property |
minimized:Boolean
[read-only] Since : | CS5 |
When true, this browser window is in the collapsed or minimized state.
public function get minimized():Boolean
navbars | property |
navbars:Object
[read-only] Since : | CS5 |
Contains the predefined NavBar objects for the configurable navigation bars.
public function get navbars():Object
noItems | property |
noItems:String
Since : | CS5 |
Text to be displayed in the Content pane when the selected thumbnail is for an empty folder.
public function get noItems():String
public function set noItems(value:String):void
owner | property |
owner:String
Since : | CS5 |
The Adobe Bridge-enabled application that created or first activated this browser window, if it was not Adobe Bridge.
public function get owner():String
public function set owner(value:String):void
palettes | property |
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.
public function get palettes():Array
position | property |
position:Object
Since : | CS5 |
The position of this browser window on the screen.
public function get position():Object
public function set position(value:Object):void
presentationMode | property |
presentationMode:String
[read-only] Since : | CS5 |
The presentation mode of the Content pane.
public function get presentationMode():String
presentationPath | property |
presentationPath:String
Since : | CS5 |
The path to the content displayed in the Content pane.
public function get presentationPath():String
public function set presentationPath(value:String):void
previewLooping | property |
previewLooping:Boolean
[read-only] Since : | CS5 |
public function get previewLooping():Boolean
selectionLength | property |
selectionLength:Number
[read-only] Since : | CS5 |
The number of currently selected thumbnails in the Content pane.
public function get selectionLength():Number
selections | property |
selections:Array
[read-only] Since : | CS5 |
The Thumbnail objects for all currently selected files in the Content pane of this document.
public function get selections():Array
selectionsLength | property |
selectionsLength:Number
[read-only] Since : | CS5 |
The number of currently selected thumbnails in the Content pane.
public function get selectionsLength():Number
showThumbnailName | property |
showThumbnailName:Boolean
Since : | CS5 |
When true, thumbnail names are displayed in the Content pane.
public function get showThumbnailName():Boolean
public function set showThumbnailName(value:Boolean):void
sorts | property |
sorts:Array
Since : | CS5 |
How the thumbnails in the Content pane are sorted.
public function get sorts():Array
public function set sorts(value:Array):void
stacks | property |
stacks:Array
[read-only] Since : | CS5 |
A list of all current thumbnail stacks in this browser.
public function get stacks():Array
status | property |
status:String
Since : | CS5 |
The text displayed in the document's status line at the bottom of the Content pane.
public function get status():String
public function set status(value:String):void
thumbnail | property |
thumbnail:Thumbnail
Since : | CS5 |
The Thumbnail object for the node currently selected in the Folders or Favorites pane.
public function get thumbnail():Thumbnail
public function set thumbnail(value:Thumbnail):void
thumbnailViewMode | property |
thumbnailViewMode:String
Since : | CS5 |
The view mode of the Content pane, as selected by the View menu.
public function get thumbnailViewMode():String
public function set thumbnailViewMode(value:String):void
topNavbar | property |
topNavbar:Navbar
Since : | CS5 |
DEPRECATED. Use navbars.filesystem.top.
public function get topNavbar():Navbar
public function set topNavbar(value:Navbar):void
visible | property |
visible:Boolean
Since : | CS5 |
When true, the browser window is expanded, as opposed to being minimized or collapsed.
public function get visible():Boolean
public function set visible(value:Boolean):void
visibleThumbnails | property |
visibleThumbnails:Array
[read-only] Since : | CS5 |
An array of Thumbnail objects that are currently shown in the Content pane.
public function get visibleThumbnails():Array
visibleThumbnailsLength | property |
visibleThumbnailsLength:Number
[read-only] Since : | CS5 |
The number of thumbnails in the visibleThumbnails array.
public function get visibleThumbnailsLength():Number
visitUrl | property |
visitUrl:Function
Since : | CS5 |
DEPRECATED. Do not use.
public function get visitUrl():Function
public function set visitUrl(value:Function):void
width | property |
width:Number
Since : | CS5 |
The width of the browser window in pixels.
public function get width():Number
public function set width(value:Number):void
workspace | property |
workspace:Object
[read-only] Since : | CS5 |
Retrieves the most recently set workspace.
public function get workspace():Object
Document | () | Constructor |
public function Document(file:File = null)
Since : | CS5 |
Parameters
file:File (default = null ) — (File)
|
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.
ReturnsString |
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.
() | method |
public function print():Boolean
Since : | CS5 |
DEPRECATED. Do not use.
ReturnsBoolean |
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.
ReturnsBoolean |