Packagecom.adobe.bridge
Classpublic class Thumbnail
InheritanceThumbnail Inheritance CSHostObject Inheritance flash.utils.Proxy

Since : CS5

Thumbnail objects can represent: Files and folders in the local file system. URLs Navigation nodes of types defined by a node-handling extension. A thumbnail's applicable node handler determines how nodes are displayed when that thumbnail is selected. The Content pane can show thumbnail icons. CAUTION: When a script accesses the properties of a Thumbnail object, some properties of the object may not be immediately available. To ensure the object contains current data, set app.synchronousMode to true before accessing properties.



Public Properties
 PropertyDefined By
  aliasType : String
[read-only] If the value of type is alias, the kind of target this thumbnail represents.
Thumbnail
  children : Array
[read-only] The node children of this container node.
Thumbnail
  container : Boolean
[read-only] When true, the node is a container.
Thumbnail
  core : Infoset
[read-only] Provides access to the core node-data sets defined by the default node handler.
Thumbnail
  creationDate : String
[read-only] Date the referenced file or folder was created, if it can be determined.
Thumbnail
  displayMode : String
DEPRECATED.
Thumbnail
  displayPath : String
DEPRECATED.
Thumbnail
  exists : Boolean
[read-only] For a file or folder, whether the resource for this node exists on the local disk.
Thumbnail
  extensions : Array
[read-only] All of the ExtensionHandler objects that could handle this node.
Thumbnail
  hasMetadata : Boolean
[read-only] Whether this thumbnail is associated with a file that contains embedded metadata.
Thumbnail
  hidden : Boolean
[read-only] Whether this thumbnail is displayable.
Thumbnail
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  iconPath : String
The path to the operating-system icon image file for this node, when it represents a web page.
Thumbnail
  label : String
The label string for this thumbnail.
Thumbnail
  lastModifiedDate : String
[read-only] Date the referenced file or folder was last modified, if it can be determined.
Thumbnail
  location : String
[read-only] 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).
Thumbnail
  locked : Boolean
[read-only] Whether this node represents a read-only file in Windows, or a file that has been locked in the Finder in Mac OS.
Thumbnail
  metadata : Object
The Metadata object associated with this thumbnail, if it supports embedded metadata.
Thumbnail
  mimeType : String
[read-only] The referenced file’s MIME type, if it can be determined.
Thumbnail
  model : Object
[read-only] The ExtensionModel object associated with this node.
Thumbnail
  name : String
The label displayed for the thumbnail.
Thumbnail
  parent : Thumbnail
[read-only] The Thumbnail object for the parent node of this thumbnail.
Thumbnail
  path : String
[read-only] DEPRECATED.
Thumbnail
  rating : Number
The rating value for this thumbnail.
Thumbnail
  rotation : Number
The angle of rotation for the icon image of this node, in degrees.
Thumbnail
  spec : File
[read-only] A File or Folder object for this thumbnail’s referenced node.
Thumbnail
  synchronousMetadata : Object
Waits for confirmation of a valid value to return the Metadata object associated with this thumbnail, if any.
Thumbnail
  type : String
[read-only] The type of node this thumbnail references.
Thumbnail
  uri : String
[read-only] The full Bridge URI ( unique resource identifier) for this thumbnail.
Thumbnail
Public Methods
 MethodDefined By
  
Thumbnail(file:File = null, displayName:String = null)
Thumbnail
  
add(thumbnail:Thumbnail):void
DEPRECATED.
Thumbnail
  
copyTo(path:String):Boolean
Creates a new Thumbnail object that references the same node as this one.
Thumbnail
 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
 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
 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
  
insert(thumbnail:Thumbnail):void
DEPRECATED.
Thumbnail
 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
  
moveTo(path:String):Boolean
Changes the parent of this thumbnail.
Thumbnail
  
open():Boolean
Launches the file referenced by this thumbnail in the appropriate application (such as Photoshop for JPEG files).
Thumbnail
  
openWith(appPath:String):Boolean
Launches the file referenced by this thumbnail in the specified application.
Thumbnail
  
refresh(infoset:String):Boolean
Refreshes an associated information set or sets to reflect the current state of this node’s referenced file or folder.
Thumbnail
  
registerInterest(callback:Function):void
Registers a callback function that is executed whenever a node-data value in this thumbnail changes.
Thumbnail
  
remove():void
Deletes this Thumbnail object.
Thumbnail
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
If the value of type is alias, retrieves a Thumbnail object for the target of the alias.
Thumbnail
  
Opens the platform-specific native file browser, displays and selects the file or folder for this thumbnail.
Thumbnail
  
unregisterInterest(callback:Function):void
Removes a callback function from the list of callbacks registered for this thumbnail.
Thumbnail
  
Re-enumerates the children of a container node.
Thumbnail
 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]
Thumbnail
 Inherited
hostCreate(args:Array):void
CSHostObject
Property Detail
aliasTypeproperty
aliasType:String  [read-only]

Since : CS5

If the value of type is alias, the kind of target this thumbnail represents.


Implementation
    public function get aliasType():String
childrenproperty 
children:Array  [read-only]

Since : CS5

The node children of this container node.


Implementation
    public function get children():Array
containerproperty 
container:Boolean  [read-only]

Since : CS5

When true, the node is a container.


Implementation
    public function get container():Boolean
coreproperty 
core:Infoset  [read-only]

Since : CS5

Provides access to the core node-data sets defined by the default node handler.


Implementation
    public function get core():Infoset
creationDateproperty 
creationDate:String  [read-only]

Since : CS5

Date the referenced file or folder was created, if it can be determined.


Implementation
    public function get creationDate():String
displayModeproperty 
displayMode:String

Since : CS5

DEPRECATED. Do not use.


Implementation
    public function get displayMode():String
    public function set displayMode(value:String):void
displayPathproperty 
displayPath:String

Since : CS5

DEPRECATED. Do not use.


Implementation
    public function get displayPath():String
    public function set displayPath(value:String):void
existsproperty 
exists:Boolean  [read-only]

Since : CS5

For a file or folder, whether the resource for this node exists on the local disk.


Implementation
    public function get exists():Boolean
extensionsproperty 
extensions:Array  [read-only]

Since : CS5

All of the ExtensionHandler objects that could handle this node.


Implementation
    public function get extensions():Array
hasMetadataproperty 
hasMetadata:Boolean  [read-only]

Since : CS5

Whether this thumbnail is associated with a file that contains embedded metadata.


Implementation
    public function get hasMetadata():Boolean
hiddenproperty 
hidden:Boolean  [read-only]

Since : CS5

Whether this thumbnail is displayable.


Implementation
    public function get hidden():Boolean
iconPathproperty 
iconPath:String

Since : CS5

The path to the operating-system icon image file for this node, when it represents a web page.


Implementation
    public function get iconPath():String
    public function set iconPath(value:String):void
labelproperty 
label:String

Since : CS5

The label string for this thumbnail.


Implementation
    public function get label():String
    public function set label(value:String):void
lastModifiedDateproperty 
lastModifiedDate:String  [read-only]

Since : CS5

Date the referenced file or folder was last modified, if it can be determined.


Implementation
    public function get lastModifiedDate():String
locationproperty 
location:String  [read-only]

Since : CS5

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).


Implementation
    public function get location():String
lockedproperty 
locked:Boolean  [read-only]

Since : CS5

Whether this node represents a read-only file in Windows, or a file that has been locked in the Finder in Mac OS.


Implementation
    public function get locked():Boolean
metadataproperty 
metadata:Object

Since : CS5

The Metadata object associated with this thumbnail, if it supports embedded metadata.


Implementation
    public function get metadata():Object
    public function set metadata(value:Object):void
mimeTypeproperty 
mimeType:String  [read-only]

Since : CS5

The referenced file’s MIME type, if it can be determined.


Implementation
    public function get mimeType():String
modelproperty 
model:Object  [read-only]

Since : CS5

The ExtensionModel object associated with this node.


Implementation
    public function get model():Object
nameproperty 
name:String

Since : CS5

The label displayed for the thumbnail.


Implementation
    public function get name():String
    public function set name(value:String):void
parentproperty 
parent:Thumbnail  [read-only]

Since : CS5

The Thumbnail object for the parent node of this thumbnail.


Implementation
    public function get parent():Thumbnail
pathproperty 
path:String  [read-only]

Since : CS5

DEPRECATED. Use spec or uri instead.


Implementation
    public function get path():String
ratingproperty 
rating:Number

Since : CS5

The rating value for this thumbnail.


Implementation
    public function get rating():Number
    public function set rating(value:Number):void
rotationproperty 
rotation:Number

Since : CS5

The angle of rotation for the icon image of this node, in degrees.


Implementation
    public function get rotation():Number
    public function set rotation(value:Number):void
specproperty 
spec:File  [read-only]

Since : CS5

A File or Folder object for this thumbnail’s referenced node.


Implementation
    public function get spec():File
synchronousMetadataproperty 
synchronousMetadata:Object

Since : CS5

Waits for confirmation of a valid value to return the Metadata object associated with this thumbnail, if any.


Implementation
    public function get synchronousMetadata():Object
    public function set synchronousMetadata(value:Object):void
typeproperty 
type:String  [read-only]

Since : CS5

The type of node this thumbnail references.


Implementation
    public function get type():String
uriproperty 
uri:String  [read-only]

Since : CS5

The full Bridge URI ( unique resource identifier) for this thumbnail.


Implementation
    public function get uri():String
Constructor Detail
Thumbnail()Constructor
public function Thumbnail(file:File = null, displayName:String = null)

Since : CS5

Parameters
file:File (default = null) — (File)
 
displayName:String (default = null) — (String)
Method Detail
add()method
public function add(thumbnail:Thumbnail):void

Since : CS5

DEPRECATED. Do not use.

Parameters

thumbnail:Thumbnail — (Thumbnail)

copyTo()method 
public function copyTo(path:String):Boolean

Since : CS5

Creates a new Thumbnail object that references the same node as this one.

Parameters

path:String — (String)

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

Since : CS5

Parameters

args:Array

insert()method 
public function insert(thumbnail:Thumbnail):void

Since : CS5

DEPRECATED. Do not use.

Parameters

thumbnail:Thumbnail — (Thumbnail)

moveTo()method 
public function moveTo(path:String):Boolean

Since : CS5

Changes the parent of this thumbnail.

Parameters

path:String — (String)

Returns
Boolean
open()method 
public function open():Boolean

Since : CS5

Launches the file referenced by this thumbnail in the appropriate application (such as Photoshop for JPEG files).

Returns
Boolean
openWith()method 
public function openWith(appPath:String):Boolean

Since : CS5

Launches the file referenced by this thumbnail in the specified application.

Parameters

appPath:String — (String)

Returns
Boolean
refresh()method 
public function refresh(infoset:String):Boolean

Since : CS5

Refreshes an associated information set or sets to reflect the current state of this node’s referenced file or folder.

Parameters

infoset:String — (String)

Returns
Boolean
registerInterest()method 
public function registerInterest(callback:Function):void

Since : CS5

Registers a callback function that is executed whenever a node-data value in this thumbnail changes.

Parameters

callback:Function — (Function)

remove()method 
public function remove():void

Since : CS5

Deletes this Thumbnail object.

resolve()method 
public function resolve():Thumbnail

Since : CS5

If the value of type is alias, retrieves a Thumbnail object for the target of the alias.

Returns
Thumbnail
revealInSystemBrowser()method 
public function revealInSystemBrowser():void

Since : CS5

Opens the platform-specific native file browser, displays and selects the file or folder for this thumbnail.

unregisterInterest()method 
public function unregisterInterest(callback:Function):void

Since : CS5

Removes a callback function from the list of callbacks registered for this thumbnail.

Parameters

callback:Function — (Function)

verifyExternalChanges()method 
public function verifyExternalChanges():void

Since : CS5

Re-enumerates the children of a container node.