Expand all

ve.ui.HTMLStringTransferHandler

Extends

Constructor

new ve.ui.HTMLStringTransferHandler(surface, item) #

HTML string transfer handler.

Methods

abort() #

Abort the data transfer handler

Inherited from:
Source:
Abort the data transfer handler

createProgress(progressCompletePromise, label) #

Create a progress bar with a specified label

Parameters:

Name Type Description
progressCompletePromise jQuery.Promise

Promise which resolves when the progress action is complete

label jQuery | string | function

Progress bar label

Inherited from:
Source:
Create a progress bar with a specified label

getInsertableData() → {jQuery.Promise} #

Insert the file at a specified fragment

Inherited from:
Source:

Returns:

Promise which resolves with data to insert

Type
jQuery.Promise
Insert the file at a specified fragment

process() #

Process the file

Implementations should aim to resolve this.insertableDataDeferred.

Overrides:
Source:

Process the file

Implementations should aim to resolve this.insertableDataDeferred.

resolve(dataOrDoc) #

Resolve the data transfer handler with some data

Parameters:

Name Type Description
dataOrDoc ve.dm.Document | string | Array

Insertable data or document

Inherited from:
Source:
Resolve the data transfer handler with some data

setProgress(progress) #

Set progress bar progress

Progress is stored in a property in case the progress bar doesn't exist yet.

Parameters:

Name Type Description
progress number

Progress percent

Inherited from:
Source:

Set progress bar progress

Progress is stored in a property in case the progress bar doesn't exist yet.