FileWriter class / dart:html Library / Dart API Reference

FileWriter class

@DocsEditable
@DomName('FileWriter')
// http://www.w3.org/TR/file-writer-api/#the-filewriter-interface
@Experimental
class FileWriter extends EventTarget native "FileWriter" {

 @DomName('FileWriter.abortEvent')
 @DocsEditable
 static const EventStreamProvider<ProgressEvent> abortEvent = const EventStreamProvider<ProgressEvent>('abort');

 @DomName('FileWriter.errorEvent')
 @DocsEditable
 static const EventStreamProvider<Event> errorEvent = const EventStreamProvider<Event>('error');

 @DomName('FileWriter.progressEvent')
 @DocsEditable
 static const EventStreamProvider<ProgressEvent> progressEvent = const EventStreamProvider<ProgressEvent>('progress');

 @DomName('FileWriter.writeEvent')
 @DocsEditable
 static const EventStreamProvider<ProgressEvent> writeEvent = const EventStreamProvider<ProgressEvent>('write');

 @DomName('FileWriter.writeendEvent')
 @DocsEditable
 static const EventStreamProvider<ProgressEvent> writeEndEvent = const EventStreamProvider<ProgressEvent>('writeend');

 @DomName('FileWriter.writestartEvent')
 @DocsEditable
 static const EventStreamProvider<ProgressEvent> writeStartEvent = const EventStreamProvider<ProgressEvent>('writestart');

 @DomName('FileWriter.DONE')
 @DocsEditable
 static const int DONE = 2;

 @DomName('FileWriter.INIT')
 @DocsEditable
 static const int INIT = 0;

 @DomName('FileWriter.WRITING')
 @DocsEditable
 static const int WRITING = 1;

 @DomName('FileWriter.error')
 @DocsEditable
 final FileError error;

 @DomName('FileWriter.length')
 @DocsEditable
 final int length;

 @DomName('FileWriter.position')
 @DocsEditable
 final int position;

 @DomName('FileWriter.readyState')
 @DocsEditable
 final int readyState;

 @DomName('FileWriter.abort')
 @DocsEditable
 void abort() native;

 @JSName('addEventListener')
 @DomName('FileWriter.addEventListener')
 @DocsEditable
 void $dom_addEventListener(String type, EventListener listener, [bool useCapture]) native;

 @DomName('FileWriter.dispatchEvent')
 @DocsEditable
 bool dispatchEvent(Event evt) native;

 @JSName('removeEventListener')
 @DomName('FileWriter.removeEventListener')
 @DocsEditable
 void $dom_removeEventListener(String type, EventListener listener, [bool useCapture]) native;

 @DomName('FileWriter.seek')
 @DocsEditable
 void seek(int position) native;

 @DomName('FileWriter.truncate')
 @DocsEditable
 void truncate(int size) native;

 @DomName('FileWriter.write')
 @DocsEditable
 void write(Blob data) native;

 @DomName('FileWriter.onabort')
 @DocsEditable
 Stream<ProgressEvent> get onAbort => abortEvent.forTarget(this);

 @DomName('FileWriter.onerror')
 @DocsEditable
 Stream<Event> get onError => errorEvent.forTarget(this);

 @DomName('FileWriter.onprogress')
 @DocsEditable
 Stream<ProgressEvent> get onProgress => progressEvent.forTarget(this);

 @DomName('FileWriter.onwrite')
 @DocsEditable
 Stream<ProgressEvent> get onWrite => writeEvent.forTarget(this);

 @DomName('FileWriter.onwriteend')
 @DocsEditable
 Stream<ProgressEvent> get onWriteEnd => writeEndEvent.forTarget(this);

 @DomName('FileWriter.onwritestart')
 @DocsEditable
 Stream<ProgressEvent> get onWriteStart => writeStartEvent.forTarget(this);
}

Extends

Interceptor > EventTarget > FileWriter

Static Properties

const EventStreamProvider<ProgressEvent> abortEvent #

static const EventStreamProvider<ProgressEvent> abortEvent = const EventStreamProvider<ProgressEvent>('abort')

const int DONE #

static const int DONE = 2

const EventStreamProvider<Event> errorEvent #

static const EventStreamProvider<Event> errorEvent = const EventStreamProvider<Event>('error')

const int INIT #

static const int INIT = 0

const EventStreamProvider<ProgressEvent> progressEvent #

static const EventStreamProvider<ProgressEvent> progressEvent = const EventStreamProvider<ProgressEvent>('progress')

const EventStreamProvider<ProgressEvent> writeEndEvent #

static const EventStreamProvider<ProgressEvent> writeEndEvent = const EventStreamProvider<ProgressEvent>('writeend')

const EventStreamProvider<ProgressEvent> writeEvent #

static const EventStreamProvider<ProgressEvent> writeEvent = const EventStreamProvider<ProgressEvent>('write')

const EventStreamProvider<ProgressEvent> writeStartEvent #

static const EventStreamProvider<ProgressEvent> writeStartEvent = const EventStreamProvider<ProgressEvent>('writestart')

const int WRITING #

static const int WRITING = 1

Properties

final FileError error #

final FileError error

final int hashCode #

inherited from Interceptor

Get a hash code for this object.

All objects have hash codes. Hash codes are guaranteed to be the same for objects that are equal when compared using the equality operator ==. Other than that there are no guarantees about the hash codes. They will not be consistent between runs and there are no distribution guarantees.

If a subclass overrides hashCode it should override the equality operator as well to maintain consistency.

docs inherited from Object

int get hashCode => Primitives.objectHashCode(this);

final int length #

final int length

final Events on #

inherited from EventTarget

This is an ease-of-use accessor for event streams which should only be used when an explicit accessor is not available.

Events get on => new Events(this);

final Stream<ProgressEvent> onAbort #

@DomName('FileWriter.onabort')
@DocsEditable
Stream<ProgressEvent> get onAbort => abortEvent.forTarget(this);

final Stream<Event> onError #

@DomName('FileWriter.onerror')
@DocsEditable
Stream<Event> get onError => errorEvent.forTarget(this);

final Stream<ProgressEvent> onProgress #

@DomName('FileWriter.onprogress')
@DocsEditable
Stream<ProgressEvent> get onProgress => progressEvent.forTarget(this);

final Stream<ProgressEvent> onWrite #

@DomName('FileWriter.onwrite')
@DocsEditable
Stream<ProgressEvent> get onWrite => writeEvent.forTarget(this);

final Stream<ProgressEvent> onWriteEnd #

@DomName('FileWriter.onwriteend')
@DocsEditable
Stream<ProgressEvent> get onWriteEnd => writeEndEvent.forTarget(this);

final Stream<ProgressEvent> onWriteStart #

@DomName('FileWriter.onwritestart')
@DocsEditable
Stream<ProgressEvent> get onWriteStart => writeStartEvent.forTarget(this);

final int position #

final int position

final int readyState #

final int readyState

final Type runtimeType #

inherited from Interceptor

A representation of the runtime type of the object.

docs inherited from Object

Type get runtimeType => getRuntimeType(this);

Operators

bool operator ==(other) #

inherited from Interceptor

The equality operator.

The default behavior for all Objects is to return true if and only if this and other are the same object.

If a subclass overrides the equality operator it should override the hashCode method as well to maintain consistency.

docs inherited from Object

bool operator ==(other) => identical(this, other);

Methods

void abort() #

@DomName('FileWriter.abort')
@DocsEditable
void abort() native;

bool dispatchEvent(Event evt) #

@DomName('FileWriter.dispatchEvent')
@DocsEditable
bool dispatchEvent(Event evt) native;

dynamic noSuchMethod(Invocation invocation) #

inherited from Interceptor

noSuchMethod is invoked when users invoke a non-existant method on an object. The name of the method and the arguments of the invocation are passed to noSuchMethod in an Invocation. If noSuchMethod returns a value, that value becomes the result of the original invocation.

The default behavior of noSuchMethod is to throw a noSuchMethodError.

docs inherited from Object

dynamic noSuchMethod(Invocation invocation) {
 throw new NoSuchMethodError(
     this,
     _symbolToString(invocation.memberName),
     invocation.positionalArguments,
     _symbolMapToStringMap(invocation.namedArguments));
}

void seek(int position) #

@DomName('FileWriter.seek')
@DocsEditable
void seek(int position) native;

String toString() #

inherited from Interceptor

Returns a string representation of this object.

docs inherited from Object

String toString() => Primitives.objectToString(this);

void truncate(int size) #

@DomName('FileWriter.truncate')
@DocsEditable
void truncate(int size) native;

void write(Blob data) #

@DomName('FileWriter.write')
@DocsEditable
void write(Blob data) native;

void $dom_addEventListener(String type, EventListener listener, [bool useCapture]) #

@JSName('addEventListener')
@DomName('FileWriter.addEventListener')
@DocsEditable
void $dom_addEventListener(String type, EventListener listener, [bool useCapture]) native;

void $dom_removeEventListener(String type, EventListener listener, [bool useCapture]) #

@JSName('removeEventListener')
@DomName('FileWriter.removeEventListener')
@DocsEditable
void $dom_removeEventListener(String type, EventListener listener, [bool useCapture]) native;