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.
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.
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.
[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.
When true, the user has requested that the operation be canceled.
Implementation public function get cancelRequested():Object public function set cancelRequested(value:Object):void
conflictMessage
property
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
conflictType
property
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
description
property
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
When operationStatus is inError, the problematic thumbnail.
Implementation public function get errorTarget():Thumbnail public function set errorTarget(value:Thumbnail):void
getConflictInfo
property
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
getOperationStatus
property
getOperationStatus:Object
Since :
CS5
Implementation public function get getOperationStatus():Object public function set getOperationStatus(value:Object):void
getPercentageComplete
property
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
getProcessedNodeCount
property
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
getProcessingStatus
property
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
getProgressMessage
property
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
getPurpose
property
getPurpose:Object
Since :
CS5
Implementation public function get getPurpose():Object public function set getPurpose(value:Object):void
getTotalBytesTransferred
property
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
getTotalNodeCount
property
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
getType
property
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
getUIPolicy
property
getUIPolicy:Object
Since :
CS5
Implementation public function get getUIPolicy():Object public function set getUIPolicy(value:Object):void
newNames
property
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
operationStatus
property
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
percentageComplete
property
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
processingStatus
property
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
progressMessage
property
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
resolveConflict
property
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
resolveMethod
property
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
resolvePolicy
property
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
result
property
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
resume
property
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
showUi
property
showUi:Object
Since :
CS5
Implementation public function get showUi():Object public function set showUi(value:Object):void
sources
property
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
start
property
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
stop
property
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