akasha

Class FileReader

java.lang.Object

akasha.EventTarget

akasha.FileReader

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="FileReader")
public class FileReader
extends EventTarget

The FileReader object lets web applications asynchronously read the contents of files (or raw data buffers) stored on the user's computer, using File or Blob objects to specify the file or data to read.

See Also:

FileReader - MDN, FileReader - File API

Field Summary

Fields

Modifier and Type	Field and Description
static int	DONE
static int	EMPTY
static int	LOADING
ProgressEventHandler	onabort The FileReader.onabort property contains an event handler executed when the abort event is fired, i.e.
ProgressEventHandler	onerror The FileReader onerror handler receives an Event object, not an Error object, as a parameter, but an error can be accessed from the FileReader object, as instanceOfFileReader.error
ProgressEventHandler	onload The FileReader.onload property contains an event handler executed when the load event is fired, when content read with readAsArrayBuffer, readAsBinaryString, readAsDataURL or readAsText is available.
ProgressEventHandler	onloadend
ProgressEventHandler	onloadstart
ProgressEventHandler	onprogress

Constructor Summary

Constructors

Constructor and Description
FileReader() The FileReader() constructor creates a new FileReader.

Method Summary

Modifier and Type	Method and Description
void	abort() The abort method aborts the read operation.
void	addAbortListener(ProgressEventListener callback)
void	addAbortListener(ProgressEventListener callback, AddEventListenerOptions options)
void	addAbortListener(ProgressEventListener callback, boolean useCapture)
void	addErrorListener(ProgressEventListener callback)
void	addErrorListener(ProgressEventListener callback, AddEventListenerOptions options)
void	addErrorListener(ProgressEventListener callback, boolean useCapture)
void	addLoadendListener(ProgressEventListener callback)
void	addLoadendListener(ProgressEventListener callback, AddEventListenerOptions options)
void	addLoadendListener(ProgressEventListener callback, boolean useCapture)
void	addLoadListener(ProgressEventListener callback)
void	addLoadListener(ProgressEventListener callback, AddEventListenerOptions options)
void	addLoadListener(ProgressEventListener callback, boolean useCapture)
void	addLoadstartListener(ProgressEventListener callback)
void	addLoadstartListener(ProgressEventListener callback, AddEventListenerOptions options)
void	addLoadstartListener(ProgressEventListener callback, boolean useCapture)
void	addProgressListener(ProgressEventListener callback)
void	addProgressListener(ProgressEventListener callback, AddEventListenerOptions options)
void	addProgressListener(ProgressEventListener callback, boolean useCapture)
DOMException	error() The FileReader error property returns the error that occurred while reading the file.
void	readAsArrayBuffer(Blob blob) The FileReader interface's readAsArrayBuffer() method is used to start reading the contents of a specified Blob or File.
void	readAsBinaryString(Blob blob) The readAsBinaryString method is used to start reading the contents of the specified Blob or File.
void	readAsDataURL(Blob blob) The readAsDataURL method is used to read the contents of the specified Blob or File.
void	readAsText(Blob blob) The readAsText() method is used to read the contents of the specified Blob or File.
void	readAsText(Blob blob, java.lang.String encoding) The readAsText() method is used to read the contents of the specified Blob or File.
int	readyState() The FileReader readyState property provides the current state of the reading operation a FileReader is in.
void	removeAbortListener(ProgressEventListener callback)
void	removeAbortListener(ProgressEventListener callback, boolean useCapture)
void	removeAbortListener(ProgressEventListener callback, EventListenerOptions options)
void	removeErrorListener(ProgressEventListener callback)
void	removeErrorListener(ProgressEventListener callback, boolean useCapture)
void	removeErrorListener(ProgressEventListener callback, EventListenerOptions options)
void	removeLoadendListener(ProgressEventListener callback)
void	removeLoadendListener(ProgressEventListener callback, boolean useCapture)
void	removeLoadendListener(ProgressEventListener callback, EventListenerOptions options)
void	removeLoadListener(ProgressEventListener callback)
void	removeLoadListener(ProgressEventListener callback, boolean useCapture)
void	removeLoadListener(ProgressEventListener callback, EventListenerOptions options)
void	removeLoadstartListener(ProgressEventListener callback)
void	removeLoadstartListener(ProgressEventListener callback, boolean useCapture)
void	removeLoadstartListener(ProgressEventListener callback, EventListenerOptions options)
void	removeProgressListener(ProgressEventListener callback)
void	removeProgressListener(ProgressEventListener callback, boolean useCapture)
void	removeProgressListener(ProgressEventListener callback, EventListenerOptions options)
StringOrArrayBufferUnion	result() The FileReader result property returns the file's contents.

Methods inherited from class akasha.EventTarget

addEventListener, addEventListener, addEventListener, dispatchEvent, removeEventListener, removeEventListener, removeEventListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DONE

@JsOverlay
public static final int DONE

See Also:

Constant Field Values

EMPTY

@JsOverlay
public static final int EMPTY

See Also:

Constant Field Values

LOADING

@JsOverlay
public static final int LOADING

See Also:

Constant Field Values

onabort

@Nullable
public ProgressEventHandler onabort

The FileReader.onabort property contains an event handler executed when the abort event is fired, i.e. when the process of reading the file is aborted.

See Also:

FileReader.onabort - MDN

onerror

@Nullable
public ProgressEventHandler onerror

The FileReader onerror handler receives an Event object, not an Error object, as a parameter, but an error can be accessed from the FileReader object, as instanceOfFileReader.error

See Also:

FileReader.onerror - MDN

onload

@Nullable
public ProgressEventHandler onload

The FileReader.onload property contains an event handler executed when the load event is fired, when content read with readAsArrayBuffer, readAsBinaryString, readAsDataURL or readAsText is available.

See Also:

FileReader.onload - MDN

onloadend

@Nullable
public ProgressEventHandler onloadend

onloadstart

@Nullable
public ProgressEventHandler onloadstart

onprogress

@Nullable
public ProgressEventHandler onprogress

Constructor Detail

FileReader

public FileReader()

The FileReader() constructor creates a new FileReader.

See Also:

FileReader.FileReader - MDN, File API

Method Detail

error

@JsProperty(name="error")
 @Nullable
public DOMException error()

The FileReader error property returns the error that occurred while reading the file.

See Also:

FileReader.error - MDN, FileReader: error - File API

readyState

@JsProperty(name="readyState")
 @FileReaderReadyState
public int readyState()

The FileReader readyState property provides the current state of the reading operation a FileReader is in. A FileReader exists in one of the following states:

See Also:

FileReader.readyState - MDN, readyState - File API

result

@JsProperty(name="result")
 @Nullable
public StringOrArrayBufferUnion result()

The FileReader result property returns the file's contents. This property is only valid after the read operation is complete, and the format of the data depends on which of the methods was used to initiate the read operation.

See Also:

FileReader.result - MDN, result - File API

abort

public void abort()

The abort method aborts the read operation. Upon return, the readyState will be DONE.

See Also:

FileReader.abort - MDN, abort() - File API

readAsArrayBuffer

public void readAsArrayBuffer(@Nonnull
                              Blob blob)

The FileReader interface's readAsArrayBuffer() method is used to start reading the contents of a specified Blob or File. When the read operation is finished, the readyState becomes DONE, and the loadend is triggered. At that time, the result attribute contains an ArrayBuffer representing the file's data.

See Also:

FileReader.readAsArrayBuffer - MDN, FileReader.readAsArrayBuffer - File API

readAsBinaryString

public void readAsBinaryString(@Nonnull
                               Blob blob)

The readAsBinaryString method is used to start reading the contents of the specified Blob or File. When the read operation is finished, the readyState becomes DONE, and the loadend is triggered. At that time, the result attribute contains the raw binary data from the file.

See Also:

FileReader.readAsBinaryString - MDN, readAsBinaryString - File API

readAsDataURL

public void readAsDataURL(@Nonnull
                          Blob blob)

The readAsDataURL method is used to read the contents of the specified Blob or File. When the read operation is finished, the readyState becomes DONE, and the loadend is triggered. At that time, the result attribute contains the data as a data: URL representing the file's data as a base64 encoded string.

See Also:

FileReader.readAsDataURL - MDN, readAsDataURL() - File API

readAsText

public void readAsText(@Nonnull
                       Blob blob,
                       @Nonnull
                       java.lang.String encoding)

The readAsText() method is used to read the contents of the specified Blob or File. When the read operation is complete, the readyState is changed to DONE, the loadend event is triggered, and the result property contains the contents of the file as a text string.

See Also:

FileReader.readAsText - MDN, readAsText() - File API

readAsText

public void readAsText(@Nonnull
                       Blob blob)

The readAsText() method is used to read the contents of the specified Blob or File. When the read operation is complete, the readyState is changed to DONE, the loadend event is triggered, and the result property contains the contents of the file as a text string.

See Also:

FileReader.readAsText - MDN, readAsText() - File API

addAbortListener

@JsOverlay
public final void addAbortListener(@Nonnull
                                              ProgressEventListener callback,
                                              @Nonnull
                                              AddEventListenerOptions options)

addAbortListener

@JsOverlay
public final void addAbortListener(@Nonnull
                                              ProgressEventListener callback,
                                              boolean useCapture)

addAbortListener

@JsOverlay
public final void addAbortListener(@Nonnull
                                              ProgressEventListener callback)

removeAbortListener

@JsOverlay
public final void removeAbortListener(@Nonnull
                                                 ProgressEventListener callback,
                                                 @Nonnull
                                                 EventListenerOptions options)

removeAbortListener

@JsOverlay
public final void removeAbortListener(@Nonnull
                                                 ProgressEventListener callback,
                                                 boolean useCapture)

removeAbortListener

@JsOverlay
public final void removeAbortListener(@Nonnull
                                                 ProgressEventListener callback)

addErrorListener

@JsOverlay
public final void addErrorListener(@Nonnull
                                              ProgressEventListener callback,
                                              @Nonnull
                                              AddEventListenerOptions options)

addErrorListener

@JsOverlay
public final void addErrorListener(@Nonnull
                                              ProgressEventListener callback,
                                              boolean useCapture)

addErrorListener

@JsOverlay
public final void addErrorListener(@Nonnull
                                              ProgressEventListener callback)

removeErrorListener

@JsOverlay
public final void removeErrorListener(@Nonnull
                                                 ProgressEventListener callback,
                                                 @Nonnull
                                                 EventListenerOptions options)

removeErrorListener

@JsOverlay
public final void removeErrorListener(@Nonnull
                                                 ProgressEventListener callback,
                                                 boolean useCapture)

removeErrorListener

@JsOverlay
public final void removeErrorListener(@Nonnull
                                                 ProgressEventListener callback)

addLoadListener

@JsOverlay
public final void addLoadListener(@Nonnull
                                             ProgressEventListener callback,
                                             @Nonnull
                                             AddEventListenerOptions options)

addLoadListener

@JsOverlay
public final void addLoadListener(@Nonnull
                                             ProgressEventListener callback,
                                             boolean useCapture)

addLoadListener

@JsOverlay
public final void addLoadListener(@Nonnull
                                             ProgressEventListener callback)

removeLoadListener

@JsOverlay
public final void removeLoadListener(@Nonnull
                                                ProgressEventListener callback,
                                                @Nonnull
                                                EventListenerOptions options)

removeLoadListener

@JsOverlay
public final void removeLoadListener(@Nonnull
                                                ProgressEventListener callback,
                                                boolean useCapture)

removeLoadListener

@JsOverlay
public final void removeLoadListener(@Nonnull
                                                ProgressEventListener callback)

addLoadendListener

@JsOverlay
public final void addLoadendListener(@Nonnull
                                                ProgressEventListener callback,
                                                @Nonnull
                                                AddEventListenerOptions options)

addLoadendListener

@JsOverlay
public final void addLoadendListener(@Nonnull
                                                ProgressEventListener callback,
                                                boolean useCapture)

addLoadendListener

@JsOverlay
public final void addLoadendListener(@Nonnull
                                                ProgressEventListener callback)

removeLoadendListener

@JsOverlay
public final void removeLoadendListener(@Nonnull
                                                   ProgressEventListener callback,
                                                   @Nonnull
                                                   EventListenerOptions options)

removeLoadendListener

@JsOverlay
public final void removeLoadendListener(@Nonnull
                                                   ProgressEventListener callback,
                                                   boolean useCapture)

removeLoadendListener

@JsOverlay
public final void removeLoadendListener(@Nonnull
                                                   ProgressEventListener callback)

addLoadstartListener

@JsOverlay
public final void addLoadstartListener(@Nonnull
                                                  ProgressEventListener callback,
                                                  @Nonnull
                                                  AddEventListenerOptions options)

addLoadstartListener

@JsOverlay
public final void addLoadstartListener(@Nonnull
                                                  ProgressEventListener callback,
                                                  boolean useCapture)

addLoadstartListener

@JsOverlay
public final void addLoadstartListener(@Nonnull
                                                  ProgressEventListener callback)

removeLoadstartListener

@JsOverlay
public final void removeLoadstartListener(@Nonnull
                                                     ProgressEventListener callback,
                                                     @Nonnull
                                                     EventListenerOptions options)

removeLoadstartListener

@JsOverlay
public final void removeLoadstartListener(@Nonnull
                                                     ProgressEventListener callback,
                                                     boolean useCapture)

removeLoadstartListener

@JsOverlay
public final void removeLoadstartListener(@Nonnull
                                                     ProgressEventListener callback)

addProgressListener

@JsOverlay
public final void addProgressListener(@Nonnull
                                                 ProgressEventListener callback,
                                                 @Nonnull
                                                 AddEventListenerOptions options)

addProgressListener

@JsOverlay
public final void addProgressListener(@Nonnull
                                                 ProgressEventListener callback,
                                                 boolean useCapture)

addProgressListener

@JsOverlay
public final void addProgressListener(@Nonnull
                                                 ProgressEventListener callback)

removeProgressListener

@JsOverlay
public final void removeProgressListener(@Nonnull
                                                    ProgressEventListener callback,
                                                    @Nonnull
                                                    EventListenerOptions options)

removeProgressListener

@JsOverlay
public final void removeProgressListener(@Nonnull
                                                    ProgressEventListener callback,
                                                    boolean useCapture)

removeProgressListener

@JsOverlay
public final void removeProgressListener(@Nonnull
                                                    ProgressEventListener callback)