FileReader (lib-gwt-file 0.3.9 API)

java.lang.Object
- org.vectomatic.file.FileReader

All Implemented Interfaces:

com.google.gwt.event.dom.client.HasLoadHandlers, com.google.gwt.event.shared.HasHandlers, HasAbortHandlers, HasErrorHandlers, HasLoadEndHandlers, HasLoadStartHandlers, HasProgressHandlers
```
public class FileReader
extends Object
implements com.google.gwt.event.dom.client.HasLoadHandlers, HasLoadStartHandlers, HasLoadEndHandlers, HasAbortHandlers, HasProgressHandlers, HasErrorHandlers
```
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. File objects may be obtained in one of two ways: from a FileList object returned as a result of a user selecting files using the <input> element, or from a drag and drop operation's DataTransferExt object. To create a FileReader, simply do the following:
```
 FileReader reader = new FileReader();
 
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class FileReader.State
Enum to represent FileReader state constants.

Nested Classes
Modifier and Type	Class and Description
`static class`	`FileReader.State` Enum to represent FileReader state constants.

Field Summary

Fields
Modifier and Type Field and Description

protected static com.google.gwt.event.shared.EventBus eventBus

Fields
Modifier and Type	Field and Description
`protected static com.google.gwt.event.shared.EventBus`	`eventBus`

Constructor Summary

Constructors
Constructor and Description

FileReader()
Constructor.

Constructors
Constructor and Description
`FileReader()` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`abort()` Aborts the read operation.
`com.google.gwt.event.shared.HandlerRegistration`	`addAbortHandler(AbortHandler handler)` Adds a `AbortHandler` handler.
`protected <H extends com.google.gwt.event.shared.EventHandler> com.google.gwt.event.shared.HandlerRegistration`	`addDomHandler(H handler, com.google.gwt.event.dom.client.DomEvent.Type<H> type)`
`com.google.gwt.event.shared.HandlerRegistration`	`addErrorHandler(ErrorHandler handler)` Adds a `ErrorHandler` handler.
`com.google.gwt.event.shared.HandlerRegistration`	`addLoadEndHandler(LoadEndHandler handler)` Adds a `LoadEndHandler` handler.
`com.google.gwt.event.shared.HandlerRegistration`	`addLoadHandler(com.google.gwt.event.dom.client.LoadHandler handler)`
`com.google.gwt.event.shared.HandlerRegistration`	`addLoadStartHandler(LoadStartHandler handler)` Adds a `LoadStartHandler` handler.
`com.google.gwt.event.shared.HandlerRegistration`	`addProgressHandler(ProgressHandler handler)` Adds a `ProgressHandler` handler.
`void`	`dispatch(com.google.gwt.dom.client.NativeEvent event)` Dispatches the specified event to this node event handlers
`void`	`fireEvent(com.google.gwt.event.shared.GwtEvent<?> event)`
`com.google.gwt.typedarrays.shared.ArrayBuffer`	`getArrayBufferResult()` Returns the file's contents.
`FileError`	`getError()`
`FileReader.State`	`getReadyState()` Indicates the state of the FileReader.
`String`	`getResult()` Deprecated. As of version 0.3, users should use the `getStringResult()` or `getArrayBufferResult()` depending on the kind of return which is expected.
`String`	`getStringResult()` Returns the file's contents.
`void`	`readAsArrayBuffer(Blob fileBlob)` Starts reading the contents of the specified `Blob`, which may be a `File`.
`void`	`readAsBinaryString(Blob fileBlob)` Starts reading the contents of the specified `Blob`, which may be a `File`.
`void`	`readAsDataURL(Blob fileBlob)` Starts reading the contents of the specified `Blob`, which may be a `File`.
`void`	`readAsText(Blob fileBlob)` Starts reading the contents of the specified `Blob`, which may be a `File`.
`void`	`readAsText(Blob fileBlob, String encoding)` Starts reading the contents of the specified `Blob`, which may be a `File`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - eventBus
```
protected static com.google.gwt.event.shared.EventBus eventBus
```
- Constructor Detail
  - FileReader
```
public FileReader()
```
    Constructor.
- Method Detail
  - getReadyState
```
public FileReader.State getReadyState()
```
    Indicates the state of the FileReader. This will be one of the FileReader.State constants. Read only.
    
    Returns:
    
    the state of the FileReader
  - getResult
```
public String getResult()
```
    Deprecated. As of version 0.3, users should use the getStringResult() or getArrayBufferResult() depending on the kind of return which is expected.
    
    Returns:
    
    the file's contents
  - getStringResult
```
public String getStringResult()
```
    Returns the file's contents. This method should only be called 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 (one of: readAsBinaryString(org.vectomatic.file.Blob), readAsText(org.vectomatic.file.Blob), readAsText(org.vectomatic.file.Blob, java.lang.String) or readAsDataURL(org.vectomatic.file.Blob)).
    
    Returns:
    
    the file's contents
  - getArrayBufferResult
```
public com.google.gwt.typedarrays.shared.ArrayBuffer getArrayBufferResult()
```
    Returns the file's contents. This method should only be called after the read operation (triggered by readAsArrayBuffer(org.vectomatic.file.Blob)) is complete.
    
    Returns:
    
    the file's contents
  - getError
```
public FileError getError()
```
  - abort
```
public void abort()
```
    Aborts the read operation. Upon return, the readyState will be FileReader.State.DONE.
  - readAsBinaryString
```
public void readAsBinaryString(Blob fileBlob)
```
    Starts reading the contents of the specified Blob, which may be a File. When the read operation is finished, the getReadyState() will become FileReader.State.DONE, and the LoadEndEvent event, if any, will be fired. At that time, the getStringResult() provides access to the raw binary data from the file.
    
    Parameters:
    
    fileBlob - The DOM Blob or File from which to read.
  - readAsText
```
public void readAsText(Blob fileBlob)
```
    Starts reading the contents of the specified Blob, which may be a File. When the read operation is finished, the getReadyState() will become FileReader.State.DONE, and the LoadEndEvent event, if any, will be fired. At that time, the getStringResult() provides access to the contents of the file as a text string.
    
    Parameters:
    
    fileBlob - The DOM Blob or File from which to read.
  - readAsText
```
public void readAsText(Blob fileBlob,
                       String encoding)
```
    Starts reading the contents of the specified Blob, which may be a File. When the read operation is finished, the getReadyState() will become FileReader.State.DONE, and the LoadEndEvent event, if any, will be fired. At that time, the getStringResult() provides access to the contents of the file as a text string.
    
    Parameters:
    
    fileBlob - The DOM Blob or File from which to read.
    
    encoding - A string indicating the encoding to use for the returned data. By default, UTF-8 is assumed if this parameter is not specified.
  - readAsDataURL
```
public void readAsDataURL(Blob fileBlob)
```
    Starts reading the contents of the specified Blob, which may be a File. When the read operation is finished, the getReadyState() will become FileReader.State.DONE, and the LoadEndEvent event, if any, will be fired. At that time, the getStringResult() provides access to the contents of the file as a data: URL representing the file's data.
    
    Parameters:
    
    fileBlob - The DOM Blob or File from which to read.
  - readAsArrayBuffer
```
public void readAsArrayBuffer(Blob fileBlob)
```
    Starts reading the contents of the specified Blob, which may be a File. When the read operation is finished, the getReadyState() will become FileReader.State.DONE, and the LoadEndEvent event, if any, will be fired. At that time, the getArrayBufferResult() provides access to an ArrayBuffer representing the file's data.
    
    Parameters:
    
    fileBlob - The DOM Blob or File from which to read.
  - dispatch
```
public void dispatch(com.google.gwt.dom.client.NativeEvent event)
```
    Dispatches the specified event to this node event handlers
    
    Parameters:
    
    event - The event to dispatch
  - fireEvent
```
public void fireEvent(com.google.gwt.event.shared.GwtEvent<?> event)
```
    Specified by:
    
    fireEvent in interface com.google.gwt.event.shared.HasHandlers
  - addDomHandler
```
protected final <H extends com.google.gwt.event.shared.EventHandler> com.google.gwt.event.shared.HandlerRegistration addDomHandler(H handler,
                                                                                                                                   com.google.gwt.event.dom.client.DomEvent.Type<H> type)
```
  - addErrorHandler
```
public com.google.gwt.event.shared.HandlerRegistration addErrorHandler(ErrorHandler handler)
```
    Description copied from interface: HasErrorHandlers
    
    Adds a ErrorHandler handler.
    
    Specified by:
    
    addErrorHandler in interface HasErrorHandlers
    
    Parameters:
    
    handler - the begin handler
    
    Returns:
    
    HandlerRegistration used to remove this handler
  - addProgressHandler
```
public com.google.gwt.event.shared.HandlerRegistration addProgressHandler(ProgressHandler handler)
```
    Description copied from interface: HasProgressHandlers
    
    Adds a ProgressHandler handler.
    
    Specified by:
    
    addProgressHandler in interface HasProgressHandlers
    
    Parameters:
    
    handler - the begin handler
    
    Returns:
    
    HandlerRegistration used to remove this handler
  - addAbortHandler
```
public com.google.gwt.event.shared.HandlerRegistration addAbortHandler(AbortHandler handler)
```
    Description copied from interface: HasAbortHandlers
    
    Adds a AbortHandler handler.
    
    Specified by:
    
    addAbortHandler in interface HasAbortHandlers
    
    Parameters:
    
    handler - the begin handler
    
    Returns:
    
    HandlerRegistration used to remove this handler
  - addLoadEndHandler
```
public com.google.gwt.event.shared.HandlerRegistration addLoadEndHandler(LoadEndHandler handler)
```
    Description copied from interface: HasLoadEndHandlers
    
    Adds a LoadEndHandler handler.
    
    Specified by:
    
    addLoadEndHandler in interface HasLoadEndHandlers
    
    Parameters:
    
    handler - the begin handler
    
    Returns:
    
    HandlerRegistration used to remove this handler
  - addLoadStartHandler
```
public com.google.gwt.event.shared.HandlerRegistration addLoadStartHandler(LoadStartHandler handler)
```
    Description copied from interface: HasLoadStartHandlers
    
    Adds a LoadStartHandler handler.
    
    Specified by:
    
    addLoadStartHandler in interface HasLoadStartHandlers
    
    Parameters:
    
    handler - the begin handler
    
    Returns:
    
    HandlerRegistration used to remove this handler
  - addLoadHandler
```
public com.google.gwt.event.shared.HandlerRegistration addLoadHandler(com.google.gwt.event.dom.client.LoadHandler handler)
```
    Specified by:
    
    addLoadHandler in interface com.google.gwt.event.dom.client.HasLoadHandlers

Class FileReader

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

eventBus

Constructor Detail

FileReader

Method Detail

getReadyState

getResult

getStringResult

getArrayBufferResult

getError

abort

readAsBinaryString

readAsText

readAsText

readAsDataURL

readAsArrayBuffer

dispatch

fireEvent

addDomHandler

addErrorHandler

addProgressHandler

addAbortHandler

addLoadEndHandler

addLoadStartHandler

addLoadHandler