Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 | 1x 10x 10x 10x 10x 10x 1x 1x 1x 1x 1x 1x 1x 1x 1x 10x 10x 1x 6x 1x 1x 1x 1x 1x 1x 1x 1x 1x | /*!
* VisualEditor UserInterface data transfer handler class.
*
* @copyright See AUTHORS.txt
*/
/**
* Data transfer handler.
*
* @class
* @abstract
*
* @constructor
* @param {ve.ui.Surface} surface
* @param {ve.ui.DataTransferItem} item Data transfer item to handle
*/
ve.ui.DataTransferHandler = function VeUiDataTransferHandler( surface, item ) {
// Properties
this.surface = surface;
this.item = item;
this.progress = false;
this.progressBar = null;
this.insertableDataDeferred = ve.createDeferred();
};
/* Inheritance */
OO.initClass( ve.ui.DataTransferHandler );
/* Static properties */
/**
* Symbolic name for this handler. Must be unique.
*
* @static
* @property {string}
* @inheritable
*/
ve.ui.DataTransferHandler.static.name = null;
/**
* List of transfer kinds supported by this handler
*
* Null means all kinds are supported.
*
* @static
* @property {string[]|null}
* @inheritable
*/
ve.ui.DataTransferHandler.static.kinds = null;
/**
* List of mime types supported by this handler
*
* @static
* @property {string[]}
* @inheritable
*/
ve.ui.DataTransferHandler.static.types = [];
/**
* Use handler when data transfer source is a paste
*
* @static
* @type {boolean}
* @inheritable
*/
ve.ui.DataTransferHandler.static.handlesPaste = true;
/**
* Use handler when data transfer source is a "paste special"
*
* @static
* @type {boolean}
* @inheritable
*/
ve.ui.DataTransferHandler.static.handlesPasteSpecial = false;
/**
* Custom match function which is given the data transfer item as its only argument
* and returns a boolean indicating if the handler matches
*
* Null means the handler always matches
*
* @static
* @type {Function}
* @inheritable
*/
ve.ui.DataTransferHandler.static.matchFunction = null;
/* Methods */
/**
* Process the file
*
* Implementations should aim to resolve this.insertableDataDeferred.
*
* @abstract
* @method
*/
ve.ui.DataTransferHandler.prototype.process = null;
/**
* Insert the file at a specified fragment
*
* @return {jQuery.Promise} Promise which resolves with data to insert
*/
ve.ui.DataTransferHandler.prototype.getInsertableData = function () {
this.process();
return this.insertableDataDeferred.promise();
};
/**
* Resolve the data transfer handler with some data
*
* @param {ve.dm.Document|string|Array} dataOrDoc Insertable data or document
*/
ve.ui.DataTransferHandler.prototype.resolve = function ( dataOrDoc ) {
this.insertableDataDeferred.resolve( dataOrDoc );
};
/**
* Abort the data transfer handler
*/
ve.ui.DataTransferHandler.prototype.abort = function () {
this.insertableDataDeferred.reject();
};
/**
* Create a progress bar with a specified label
*
* @param {jQuery.Promise} progressCompletePromise Promise which resolves when the progress action is complete
* @param {jQuery|string|Function} label Progress bar label
*/
ve.ui.DataTransferHandler.prototype.createProgress = function ( progressCompletePromise, label ) {
this.surface.createProgress( progressCompletePromise, label ).done( ( progressBar, cancelPromise ) => {
// Set any progress that was achieved before this resolved
progressBar.setProgress( this.progress );
this.progressBar = progressBar;
cancelPromise.fail( this.abort.bind( this ) );
} );
};
/**
* Set progress bar progress
*
* Progress is stored in a property in case the progress bar doesn't exist yet.
*
* @param {number} progress Progress percent
*/
ve.ui.DataTransferHandler.prototype.setProgress = function ( progress ) {
this.progress = progress;
Iif ( this.progressBar ) {
this.progressBar.setProgress( this.progress );
}
};
|