Extends
Constructor
new ve.ui.PlainTextFileTransferHandler(surface, item)
#
Plain text file transfer handler.
Parameters:
| Name | Type | Description |
|---|---|---|
surface |
ve.ui.Surface | |
item |
ve.ui.DataTransferItem |
Methods
abort()
#
Abort the data transfer handler
- Inherited from:
- Source:
createProgress(progressCompletePromise, [label])
#
Overrides the parent to make the default label the filename
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
progressCompletePromise |
jQuery.Promise | ||
label |
jQuery | string | function |
optional |
Progress bar label, defaults to file name |
- Inherited from:
- Source:
getInsertableData() → {jQuery.Promise}
#
Insert the file at a specified fragment
- Inherited from:
- Source:
Returns:
Promise which resolves with data to insert
- Type
- jQuery.Promise
onFileError(e)
#
Handle error events from the file reader
Parameters:
| Name | Type | Description |
|---|---|---|
e |
Event | Error event |
- Inherited from:
- Source:
onFileLoad(e)
#
Handle load events from the file reader
Parameters:
| Name | Type | Description |
|---|---|---|
e |
Event | Load event |
- Overrides:
- Source:
onFileProgress(e)
#
Handle progress events from the file reader
Parameters:
| Name | Type | Description |
|---|---|---|
e |
Event | Progress event |
- Inherited from:
- Source:
process()
#
Process the file
Implementations should aim to resolve this.insertableDataDeferred.
- Inherited from:
- 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:
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.