Packagecom.adobe.bridge
Classpublic class ProgressOperator
InheritanceProgressOperator Inheritance CSHostObject Inheritance flash.utils.Proxy

Since : CS5

When implementing a node-handling extension, you must define certain methods for a node-handler’s ExtensionHandler and ExtensionModel to create and return an Operator object, which actually implements the operation. The model method returns immediately. To start the operation, your node handler (or Adobe Bridge) passes the returned Operator object to app.enqueueOperation(). This in turn calls the start() method defined in the object. This object encapsulates an operation that performs a background task, while Adobe Bridge displays a Progress bar. It can do so incrementally, periodically notifying Adobe Bridge of the current status. For this object, the start() method should spawn a thread to perform the operation and return immediately. Adobe Bridge displays a Progress bar, and resumes activity on the main thread. When the background thread updates the status in any way that affects the display, it must pass this object to app.operationChanged(). Adobe Bridge queries this object in order to update the Progress dialog or display the Adobe Bridge-supplied error handling or resolution conflict dialogs.



Public Properties
 PropertyDefined By
  cancelRequested : Object
When true, the user has requested that the operation be canceled.
ProgressOperator
  conflictMessage : Object
A string describing the current file-system conflict that prevents the operation from being performed.
ProgressOperator
  conflictType : Object
The type of the current file-system conflict encountered during the operation.
ProgressOperator
  description : Object
A description of the operation, suitable for display.
ProgressOperator
  errorTarget : Thumbnail
When operationStatus is inError, the problematic thumbnail.
ProgressOperator
  getConflictInfo : Object
Implement a method that returns a description of a file-system conflict that prevents the operation from being performed on the current thumbnail.
ProgressOperator
  getOperationStatus : Object
ProgressOperator
  getPercentageComplete : Object
Implement a method that returns the percentage of the operation that has currently been completed, for use in displaying the Progress dialog.
ProgressOperator
  getProcessedNodeCount : Object
Implement a method that returns the number of source nodes that have been processed so far.
ProgressOperator
  getProcessingStatus : Object
Implement a method that returns the current overall status of the operation with respect to Adobe Bridge.
ProgressOperator
  getProgressMessage : Object
Implement a method that returns a message suitable for display in the Progress dialog.
ProgressOperator
  getPurpose : Object
ProgressOperator
  getTotalBytesTransferred : Object
Implement a method that returns the current number of bytes that have been transferred to the target in the course of this operation.
ProgressOperator
  getTotalNodeCount : Object
Implement a method that returns the total number of source nodes to be operated on.
ProgressOperator
  getType : Object
Implement a method that returns the subclass type of this operator.
ProgressOperator
  getUIPolicy : Object
ProgressOperator
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  newNames : Object
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.
ProgressOperator
  operationStatus : Object
The status of the operation with respect to the immediate action.
ProgressOperator
  percentageComplete : Object
How much of the operation has currently been completed, in the range [0..100].
ProgressOperator
  processingStatus : Object
The current overall status of the operation with respect to Adobe Bridge.
ProgressOperator
  progressMessage : Object
A description of the current state of the operation, suitable for display.
ProgressOperator
  resolveConflict : Object
Implement a method that resolves a file-system conflict, as identified by the conflictType and conflictMessage values.
ProgressOperator
  resolveMethod : Object
How to resolve file-system conflicts.
ProgressOperator
  resolvePolicy : Object
How to apply the conflict-resolution method, applyForOneConflictOnly or applyToAllConflicts This is for the developer's information in a ModalOperator or when UI is suppressed; Adobe Bridge does not check it.
ProgressOperator
  result : Object
An optional result for an operation, such as the path that results from a createNewContainer() operation.
ProgressOperator
  resume : Object
Implement a method that restarts the operation after it has been stopped by user interaction.
ProgressOperator
  showUi : Object
ProgressOperator
  sources : Object
A set of Thumbnail objects that the operation acts upon.
ProgressOperator
  start : Object
Implement a method that initiates the operation.
ProgressOperator
  stop : Object
Implement a method that terminates the operation.
ProgressOperator
  target : Thumbnail
A target Thumbnail object for the operation.
ProgressOperator
  timeout : Object
A number of milliseconds to wait before aborting the operation.
ProgressOperator
Public Methods
 MethodDefined By
 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
 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
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
 Inherited
wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):*
[static] Method used on static/normal get/ hostcalls
CSHostObject
Protected Methods
 MethodDefined By
 Inherited
createWithArgs(args:Array):void
CSHostObject
 Inherited
hostCreate(args:Array):void
CSHostObject
Property Detail
cancelRequestedproperty
cancelRequested:Object

Since : CS5

When true, the user has requested that the operation be canceled.


Implementation
    public function get cancelRequested():Object
    public function set cancelRequested(value:Object):void
conflictMessageproperty 
conflictMessage:Object

Since : CS5

A string describing the current file-system conflict that prevents the operation from being performed. Can identify one of the preset Adobe Bridge error messages, or can be an arbitrary descriptive string. Preset messages are identified by the following string values: none, deleteFile, deleteMultipleFiles, deleteReadOnlyFile, moveReadOnlyFile, readOnlyFileExists, fileExists, fileIsBusy, targetFolderExists, fatalErrorSameFile, fatalErrorSameFolder, fatalErrorMoveToChild, fatalErrorSourceNotAvailable, fatalErrorStorageFull, fatalErrorSourceAccessDenied, fatalErrorTargetAccessDenied, fatalErrorUnknown, noXMPSupport, undoDelete, messageCustom


Implementation
    public function get conflictMessage():Object
    public function set conflictMessage(value:Object):void
conflictTypeproperty 
conflictType:Object

Since : CS5

The type of the current file-system conflict encountered during the operation. One of: none, userConfirmationRequired, fatal


Implementation
    public function get conflictType():Object
    public function set conflictType(value:Object):void
descriptionproperty 
description:Object

Since : CS5

A description of the operation, suitable for display.


Implementation
    public function get description():Object
    public function set description(value:Object):void
errorTargetproperty 
errorTarget:Thumbnail

Since : CS5

When operationStatus is inError, the problematic thumbnail.


Implementation
    public function get errorTarget():Thumbnail
    public function set errorTarget(value:Thumbnail):void
getConflictInfoproperty 
getConflictInfo:Object

Since : CS5

Implement a method that returns a description of a file-system conflict that prevents the operation from being performed on the current thumbnail. The string can identify one of the preset Adobe Bridge error messages, or can be an arbitrary descriptive string suitable for display in a conflict-resolution dialog. Preset messages are identified by the following string values: readOnlyFile, readOnlyFileExists, targetFolderExists, fileExists, sameFile, sameFolder, moveToChild, sourceNotAvailable, storageFull, sourceAccessDenied, targetAccessDenied, unknown


Implementation
    public function get getConflictInfo():Object
    public function set getConflictInfo(value:Object):void
getOperationStatusproperty 
getOperationStatus:Object

Since : CS5


Implementation
    public function get getOperationStatus():Object
    public function set getOperationStatus(value:Object):void
getPercentageCompleteproperty 
getPercentageComplete:Object

Since : CS5

Implement a method that returns the percentage of the operation that has currently been completed, for use in displaying the Progress dialog. Adobe Bridge invokes this when it needs to update the Progress bar. Return a number in the range [0..100].


Implementation
    public function get getPercentageComplete():Object
    public function set getPercentageComplete(value:Object):void
getProcessedNodeCountproperty 
getProcessedNodeCount:Object

Since : CS5

Implement a method that returns the number of source nodes that have been processed so far. Return a number.


Implementation
    public function get getProcessedNodeCount():Object
    public function set getProcessedNodeCount(value:Object):void
getProcessingStatusproperty 
getProcessingStatus:Object

Since : CS5

Implement a method that returns the current overall status of the operation with respect to Adobe Bridge. Describes whether the operation has begun, is still going on, has been paused by the user, or has finished. Return one of the following string values: notStarted, inProgress, awaitingResume, completed


Implementation
    public function get getProcessingStatus():Object
    public function set getProcessingStatus(value:Object):void
getProgressMessageproperty 
getProgressMessage:Object

Since : CS5

Implement a method that returns a message suitable for display in the Progress dialog. Return a string.


Implementation
    public function get getProgressMessage():Object
    public function set getProgressMessage(value:Object):void
getPurposeproperty 
getPurpose:Object

Since : CS5


Implementation
    public function get getPurpose():Object
    public function set getPurpose(value:Object):void
getTotalBytesTransferredproperty 
getTotalBytesTransferred:Object

Since : CS5

Implement a method that returns the current number of bytes that have been transferred to the target in the course of this operation. Return a number.


Implementation
    public function get getTotalBytesTransferred():Object
    public function set getTotalBytesTransferred(value:Object):void
getTotalNodeCountproperty 
getTotalNodeCount:Object

Since : CS5

Implement a method that returns the total number of source nodes to be operated on. Return a number.


Implementation
    public function get getTotalNodeCount():Object
    public function set getTotalNodeCount(value:Object):void
getTypeproperty 
getType:Object

Since : CS5

Implement a method that returns the subclass type of this operator. Return a string, modal or progress.


Implementation
    public function get getType():Object
    public function set getType(value:Object):void
getUIPolicyproperty 
getUIPolicy:Object

Since : CS5


Implementation
    public function get getUIPolicy():Object
    public function set getUIPolicy(value:Object):void
newNamesproperty 
newNames:Object

Since : CS5

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.


Implementation
    public function get newNames():Object
    public function set newNames(value:Object):void
operationStatusproperty 
operationStatus:Object

Since : CS5

The status of the operation with respect to the immediate action. Also returned by getOperationStatus(). One of: incomplete, inCancellation, inConflict, inError, succeeded, cancelled, failed


Implementation
    public function get operationStatus():Object
    public function set operationStatus(value:Object):void
percentageCompleteproperty 
percentageComplete:Object

Since : CS5

How much of the operation has currently been completed, in the range [0..100].


Implementation
    public function get percentageComplete():Object
    public function set percentageComplete(value:Object):void
processingStatusproperty 
processingStatus:Object

Since : CS5

The current overall status of the operation with respect to Adobe Bridge. Reports whether the operation has begun, is still going on, has been paused by the user, or has finished. Also returned by the getProcessingStatus(). One of: notStarted, inProgress, awaitingResume, completed


Implementation
    public function get processingStatus():Object
    public function set processingStatus(value:Object):void
progressMessageproperty 
progressMessage:Object

Since : CS5

A description of the current state of the operation, suitable for display. Also returned by getProgressMessage()..


Implementation
    public function get progressMessage():Object
    public function set progressMessage(value:Object):void
resolveConflictproperty 
resolveConflict:Object

Since : CS5

Implement a method that resolves a file-system conflict, as identified by the conflictType and conflictMessage values. Adobe Bridge invokes this after the user makes selections in a conflict-resolution dialog, passing in the user’s choices. See Adobe Bridge JavaScript Reference for additional details.


Implementation
    public function get resolveConflict():Object
    public function set resolveConflict(value:Object):void
resolveMethodproperty 
resolveMethod:Object

Since : CS5

How to resolve file-system conflicts. This is for the developer's information in a ModalOperator or when UI is suppressed; Adobe Bridge does not check it. One of: abort, noOverride, override, overrideConditionally


Implementation
    public function get resolveMethod():Object
    public function set resolveMethod(value:Object):void
resolvePolicyproperty 
resolvePolicy:Object

Since : CS5

How to apply the conflict-resolution method, applyForOneConflictOnly or applyToAllConflicts This is for the developer's information in a ModalOperator or when UI is suppressed; Adobe Bridge does not check it.


Implementation
    public function get resolvePolicy():Object
    public function set resolvePolicy(value:Object):void
resultproperty 
result:Object

Since : CS5

An optional result for an operation, such as the path that results from a createNewContainer() operation.


Implementation
    public function get result():Object
    public function set result(value:Object):void
resumeproperty 
resume:Object

Since : CS5

Implement a method that restarts the operation after it has been stopped by user interaction. Return true if the operation has been successfully restarted.


Implementation
    public function get resume():Object
    public function set resume(value:Object):void
showUiproperty 
showUi:Object

Since : CS5


Implementation
    public function get showUi():Object
    public function set showUi(value:Object):void
sourcesproperty 
sources:Object

Since : CS5

A set of Thumbnail objects that the operation acts upon.


Implementation
    public function get sources():Object
    public function set sources(value:Object):void
startproperty 
start:Object

Since : CS5

Implement a method that initiates the operation. Adobe Bridge invokes this after the operator has been enqueued. For a modal operator, the method should return when the operation is complete. For a progress operator, the method should begin the background task and return. Return undefined.


Implementation
    public function get start():Object
    public function set start(value:Object):void
stopproperty 
stop:Object

Since : CS5

Implement a method that terminates the operation. Adobe Bridge invokes this after the operation has been stopped by user interaction. Return undefined.


Implementation
    public function get stop():Object
    public function set stop(value:Object):void
targetproperty 
target:Thumbnail

Since : CS5

A target Thumbnail object for the operation.


Implementation
    public function get target():Thumbnail
    public function set target(value:Thumbnail):void
timeoutproperty 
timeout:Object

Since : CS5

A number of milliseconds to wait before aborting the operation. Default is 0, meaning that the operation does not time out.


Implementation
    public function get timeout():Object
    public function set timeout(value:Object):void