elemental.js.html

Class JsFileReaderSync

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

elemental.js.util.JsElementalBase

elemental.js.dom.JsElementalMixinBase

elemental.js.html.JsFileReaderSync

All Implemented Interfaces:

ElementalMixinBase, ElementTraversal, NodeSelector, EventTarget, FileReaderSync, ElementTimeControl, SVGExternalResourcesRequired, SVGFilterPrimitiveStandardAttributes, SVGFitToViewBox, SVGLangSpace, SVGLocatable, SVGStylable, SVGTests, SVGTransformable, SVGURIReference, SVGZoomAndPan, Indexable, IndexableInt, IndexableNumber, Mappable, Settable, SettableInt, SettableNumber

public class JsFileReaderSync
extends JsElementalMixinBase
implements FileReaderSync

Field Summary

Fields inherited from interface elemental.svg.SVGZoomAndPan

SVG_ZOOMANDPAN_DISABLE, SVG_ZOOMANDPAN_MAGNIFY, SVG_ZOOMANDPAN_UNKNOWN

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JsFileReaderSync()

Method Summary

Methods

Modifier and Type	Method and Description
JsArrayBuffer	readAsArrayBuffer(Blob blob) This method reads the contents of the specified Blob or File.
String	readAsBinaryString(Blob blob) This method reads the contents of the specified Blob, which may be a File.
String	readAsDataURL(Blob blob) This method reads the contents of the specified Blob or File.
String	readAsText(Blob blob) This methods reads the specified blob's contents.
String	readAsText(Blob blob, String encoding) This methods reads the specified blob's contents.

Methods inherited from class elemental.js.dom.JsElementalMixinBase

addEventListener, addEventListener, beginElement, beginElementAt, dispatchEvent, endElement, endElementAt, getAnimatedClassName, getAnimatedHeight, getAnimatedHref, getAnimatedResult, getAnimatedTransform, getAnimatedWidth, getAnimatedX, getAnimatedY, getBBox, getChildElementCount, getCTM, getExternalResourcesRequired, getFarthestViewportElement, getFirstElementChild, getLastElementChild, getNearestViewportElement, getNextElementSibling, getPresentationAttribute, getPreserveAspectRatio, getPreviousElementSibling, getRequiredExtensions, getRequiredFeatures, getScreenCTM, getSvgStyle, getSystemLanguage, getTransformToElement, getViewBox, getXmllang, getXmlspace, getZoomAndPan, hasExtension, querySelector, querySelectorAll, removeEventListener, removeEventListener, setXmllang, setXmlspace, setZoomAndPan

Methods inherited from class elemental.js.util.JsElementalBase

at, at, intAt, intAt, length, numberAt, numberAt, setAt, setAt, setAt, setAt, setAt, setAt

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface elemental.util.IndexableInt

intAt, length

Methods inherited from interface elemental.util.IndexableNumber

numberAt

Constructor Detail

JsFileReaderSync

protected JsFileReaderSync()

Method Detail

readAsArrayBuffer

public final JsArrayBuffer readAsArrayBuffer(Blob blob)

Description copied from interface: FileReaderSync

This method reads the contents of the specified Blob or File. When the read operation is finished, it returns an ArrayBuffer representing the file's data. If an error happened during the read, the adequate exception is sent.

Parameters

blob

The DOM Blob or File to read into the ArrayBuffer.

Return value

An ArrayBuffer representing the file's data.

Exceptions

The following exceptions can be raised by this method:

NotFoundError

is raised when the resource represented by the DOM Blob or File cannot be found, e. g. because it has been erased.

SecurityError

is raised when one of the following problematic situation is detected:

• the resource has been modified by a third party;
• two many read are performed simultaneously;
• the file pointed by the resource is unsafe for a use from the Web (like it is a system file).

NotReadableError

is raised when the resource cannot be read due to a permission problem, like a concurrent lock.

EncodingError

is raised when the resource is a data URL and exceed the limit length defined by each browser.

Specified by:

readAsArrayBuffer in interface FileReaderSync

readAsBinaryString

public final String readAsBinaryString(Blob blob)

Description copied from interface: FileReaderSync

This method reads the contents of the specified Blob, which may be a File. When the read operation is finished, it returns a DOMString containing the raw binary data from the file. If an error happened during the read, the adequate exception is sent.

Note : This method is deprecated and readAsArrayBuffer() should be used instead.

Parameters

blob

The DOM Blob or File to read into the DOMString.

Return value

A DOMString containing the raw binary data from the resource

Exceptions

The following exceptions can be raised by this method:

NotFoundError

is raised when the resource represented by the DOM Blob or File cannot be found, e. g. because it has been erased.

SecurityError

is raised when one of the following problematic situation is detected:

• the resource has been modified by a third party;
• two many read are performed simultaneously;
• the file pointed by the resource is unsafe for a use from the Web (like it is a system file).

NotReadableError

is raised when the resource cannot be read due to a permission problem, like a concurrent lock.

EncodingError

is raised when the resource is a data URL and exceed the limit length defined by each browser.

Specified by:

readAsBinaryString in interface FileReaderSync

readAsDataURL

public final String readAsDataURL(Blob blob)

Description copied from interface: FileReaderSync

This method reads the contents of the specified Blob or File. When the read operation is finished, it returns a data URL representing the file's data. If an error happened during the read, the adequate exception is sent.

Parameters

blob

The DOM Blob or File to read.

Return value

An DOMString representing the file's data as a data URL.

Exceptions

The following exceptions can be raised by this method:

NotFoundError

is raised when the resource represented by the DOM Blob or File cannot be found, e. g. because it has been erased.

SecurityError

is raised when one of the following problematic situation is detected:

• the resource has been modified by a third party;
• too many read are performed simultaneously;
• the file pointed by the resource is unsafe for a use from the Web (like it is a system file).

NotReadableError

is raised when the resource cannot be read due to a permission problem, like a concurrent lock.

EncodingError

is raised when the resource is a data URL and exceed the limit length defined by each browser.

Specified by:

readAsDataURL in interface FileReaderSync

readAsText

public final String readAsText(Blob blob)

Description copied from interface: FileReaderSync

This methods reads the specified blob's contents. When the read operation is finished, it returns a DOMString containing the file represented as a text string. The optional encoding parameter indicates the encoding to be used. If not present, the method will apply a detection algorithm for it. If an error happened during the read, the adequate exception is sent.

Parameters

blob

The DOM Blob or File to read into the DOMString.

encoding

Optional. A string representing the encoding to be used, like iso-8859-1 or UTF-8.

Return value

A DOMString containing the raw binary data from the resource

Exceptions

The following exceptions can be raised by this method:

NotFoundError

is raised when the resource represented by the DOM Blob or File cannot be found, e. g. because it has been erased.

SecurityError

is raised when one of the following problematic situation is detected:

• the resource has been modified by a third party;
• two many read are performed simultaneously;
• the file pointed by the resource is unsafe for a use from the Web (like it is a system file).

NotReadableError

is raised when the resource cannot be read due to a permission problem, like a concurrent lock.

Specified by:

readAsText in interface FileReaderSync

readAsText

public final String readAsText(Blob blob,
                String encoding)

Description copied from interface: FileReaderSync

This methods reads the specified blob's contents. When the read operation is finished, it returns a DOMString containing the file represented as a text string. The optional encoding parameter indicates the encoding to be used. If not present, the method will apply a detection algorithm for it. If an error happened during the read, the adequate exception is sent.

Parameters

blob

The DOM Blob or File to read into the DOMString.

encoding

Optional. A string representing the encoding to be used, like iso-8859-1 or UTF-8.

Return value

A DOMString containing the raw binary data from the resource

Exceptions

The following exceptions can be raised by this method:

NotFoundError

is raised when the resource represented by the DOM Blob or File cannot be found, e. g. because it has been erased.

SecurityError

is raised when one of the following problematic situation is detected:

• the resource has been modified by a third party;
• two many read are performed simultaneously;
• the file pointed by the resource is unsafe for a use from the Web (like it is a system file).

NotReadableError

is raised when the resource cannot be read due to a permission problem, like a concurrent lock.

Specified by:

readAsText in interface FileReaderSync