@refinitiv-ui/efx-grid 6.0.0-next.0

package/lib/core/es6/grid/util/HttpRequest.js

@@ -0,0 +1,371 @@
+import EventDispatcher from "../event/EventDispatcher.js";
+import Ext from "../../../../tr-grid-util/es6/Ext.js";
+
+/**
+* @event HttpRequest#loadstart
+*/
+/** Triggered when the request is responded with a success
+* @event HttpRequest#load
+*/
+/** Triggered when the request is responded with an error
+* @event HttpRequest#error
+*/
+/** Triggered when the request is aborted
+* @event HttpRequest#abort
+*/
+/** Triggered when the request is timeout
+* @event HttpRequest#timeout
+*/
+/** Triggered when the request is completed (after HttpRequest#load, HttpRequest#error, HttpRequest#abort, or HttpRequest#timeout)
+* @event HttpRequest#loadend
+*/
+
+/** @constructor
+* @extends {EventDispatcher}
+* @mixes Promise
+* @param {string} url
+* @param {Object|string=} payload
+* @param {string=} opt_serviceName
+*/
+var HttpRequest = function(url, payload, opt_serviceName) {
+	this._onDone = this._onDone.bind(this);
+
+	if(url) {
+		this._url = url;
+	}
+	if(payload) {
+		if(typeof payload === "string") {
+			this._payloadText = payload;
+			try {
+				this._payload = /** @type{Object} */(JSON.parse(this._payloadText));
+			} catch(err) { }
+		} else  if (typeof payload === "object") {
+			this._payload = payload;
+			this._payloadText = JSON.stringify(payload);
+		} else {
+			this._payloadText = payload + "";
+			try {
+				this._payload = /** @type{Object} */(JSON.parse(this._payloadText));
+			} catch(err) { }
+		}
+	}
+	if(opt_serviceName) {
+		this._serviceName = opt_serviceName;
+	}
+
+	this._promise = new Promise(function(resolve, reject) {
+		this._resolve = resolve;
+		this._reject = reject;
+	}.bind(this));
+
+	this._state = "pending";
+	this._timeout = HttpRequest["defaultTimeout"];
+
+	this._addEvents(
+		"loadstart",
+		"load",
+		"error",
+		"abort",
+		"timeout",
+		"loadend"
+	);
+};
+Ext.inherits(HttpRequest, EventDispatcher);
+
+/**@type {number}
+* @public
+*/
+HttpRequest["defaultTimeout"] = 30000;
+
+/**@type {XMLHttpRequest}
+* @private
+*/
+HttpRequest.prototype._xhr = null;
+/**@type {string}
+* @private
+*/
+HttpRequest.prototype._url = "";
+/**@type {string}
+* @private
+*/
+HttpRequest.prototype._type = "POST";
+/**@type {Object}
+* @private
+*/
+HttpRequest.prototype._payload = null;
+/**@type {string}
+* @private
+*/
+HttpRequest.prototype._payloadText = "";
+/**@type {string}
+* @private
+*/
+HttpRequest.prototype._serviceName = "";
+/**@type {string}
+* @private
+*/
+HttpRequest.prototype._state = "";
+
+/**@type {boolean}
+* @private
+*/
+HttpRequest.prototype._sent = false;
+/**@type {boolean}
+* @private
+*/
+HttpRequest.prototype._done = false;
+
+/**@type {Object|string}
+* @private
+*/
+HttpRequest.prototype._response = null;
+/**@type {string}
+* @private
+*/
+HttpRequest.prototype._responseText = "";
+/**@type {string}
+* @private
+*/
+HttpRequest.prototype._responseType = "json";
+/**@type {number}
+* @private
+*/
+HttpRequest.prototype._timeout = 0;
+
+/**@type {number}
+* @private
+*/
+HttpRequest.prototype._responseStatus = NaN;
+
+/**@type {!Promise}
+* @private
+*/
+HttpRequest.prototype._promise;
+/**@type {Function}
+* @private
+*/
+HttpRequest.prototype._resolve = null; // Nullable
+/**@type {Function}
+* @private
+*/
+HttpRequest.prototype._reject = null; // Nullable
+
+/** @public
+* @return {string}
+*/
+HttpRequest.prototype.getUrl = function() { return this._url; };
+/** @public
+* @return {string}
+*/
+HttpRequest.prototype.getType = function() { return this._type; };
+/** @public
+* @return {Object}
+*/
+HttpRequest.prototype.getPayload = function() { return this._payload; };
+/** @public
+* @return {string}
+*/
+HttpRequest.prototype.getPayloadText = function() { return this._payloadText; };
+/** @public
+* @return {string}
+*/
+HttpRequest.prototype.getState = function() { return this._state; };
+/** @public
+* @return {Object|string}
+*/
+HttpRequest.prototype.getResponse = function() { return this._response; };
+/** @public
+* @return {string}
+*/
+HttpRequest.prototype.getResponseText = function() { return this._responseText; };
+/** @public
+* @return {number}
+*/
+HttpRequest.prototype.getResponseStatus = function() { return this._responseStatus; };
+/** Set data type of the response for automatic type conversion
+* @public
+* @param {string} dataType Use "text" to turn off automatic type conversion
+*/
+HttpRequest.prototype.setResponseType = function(dataType) { this._responseType = dataType; };
+/**
+* @public
+* @param {number} timeout
+*/
+HttpRequest.prototype.setRequestTimeout = function(timeout) { this._timeout = timeout; };
+
+/** @public
+* @function
+* @return {Object|string}
+*/
+HttpRequest.prototype.valueOf = HttpRequest.prototype.getResponse;
+/** @public
+* @function
+* @return {string}
+*/
+HttpRequest.prototype.toString = HttpRequest.prototype.getResponseText;
+/** @public
+*/
+HttpRequest.prototype.log = function() {
+	console.log({
+		"state": this._state,
+		"payload": this._payload,
+		"response": this._response
+	});
+};
+
+/** @public
+* @param {Object.<string, string>=} opt_requestedHeaders
+* @return {!HttpRequest}
+*/
+HttpRequest.prototype.send = function(opt_requestedHeaders) {
+	if(this._sent) {
+		return this;
+	}
+
+	this._state = "loading";
+	try {
+		if(!this._payloadText) { // No payload to post message (e.g. ping)
+			this._type = "GET";
+		}
+
+		this._xhr = new XMLHttpRequest();
+		this._xhr.onloadstart = this._dispatch.bind(this, "loadstart");
+		this._xhr.onload = this._onDone;
+		this._xhr.onerror = this._onDone;
+		this._xhr.onabort = this._onDone;
+		this._xhr.ontimeout = this._onDone;
+
+		this._xhr.open(this._type, this._url, true);
+		var defaultContentType = true;
+		if(opt_requestedHeaders) {
+			for(var requestedHeader in opt_requestedHeaders) {
+				this._xhr.setRequestHeader(requestedHeader, opt_requestedHeaders[requestedHeader]);
+				if(requestedHeader === "Content-Type") {
+					defaultContentType = false;
+				}
+			}
+		}
+		if(defaultContentType) {
+			this._xhr.setRequestHeader("Content-Type", "application/json");
+		}
+		// Specifically in IE, the timeout property may be set only in the time interval between a call to the open method and the first call to the send method.
+		// https://msdn.microsoft.com/en-us/library/cc304105(v=vs.85).aspx
+		this._xhr.timeout = this._timeout;
+
+		this._xhr.send(this._payloadText);
+		this._sent = true;
+	} catch(err) {
+		this.reject(err.message);
+	}
+	return this;
+};
+/** @public
+*/
+HttpRequest.prototype.abort = function() {
+	if(this._sent && !this._done) {
+		this._xhr.abort();
+	}
+};
+
+/** @public
+* @param {Function} onFulfilled
+* @param {Function=} onRejected
+* @return {!HttpRequest}
+*/
+HttpRequest.prototype.then = function(onFulfilled, onRejected) {
+	this._promise = this._promise.then(onFulfilled, onRejected);
+	return this;
+};
+/** @public
+* @param {function (*): ?} onRejected
+* @return {!HttpRequest}
+*/
+HttpRequest.prototype.catch = function(onRejected) {
+	this._promise = this._promise.catch(onRejected);
+	return this;
+};
+/** @public
+* @param {*=} reason
+* @return {!HttpRequest}
+*/
+HttpRequest.prototype.reject = function(reason) {
+	if(this._sent) {
+		this.abort(); // The request is already sent and hence abort the request
+	} else if(this._reject) {
+		this._reject(reason);
+		this._cleanUp();
+	}
+	return this;
+};
+
+/** Load a file as text from the given url
+* @public
+* @return {!HttpRequest}
+*/
+HttpRequest.prototype.loadFile = function() {
+	this.setResponseType("text");
+	return this.send();
+};
+/** @public
+* @function
+* @return {!HttpRequest}
+*/
+HttpRequest.prototype.loadText = HttpRequest.prototype.loadFile;
+
+/** @private
+* @param {Object} e
+*/
+HttpRequest.prototype._onDone = function(e) {
+	this._done = true;
+	this._state = e.type;
+	var xhr = e.target;
+
+	if(xhr.status >= 200 && xhr.status < 300) {
+		this._responseText = xhr.responseText || xhr.response;
+		if(this._responseText) {
+			if(this._responseType === "json") { // Automatically perform JSON string conversion
+				try {
+					this._response = /** @type{Object} */(JSON.parse(this._responseText));
+				} catch (err) {
+					this._responseText = err.message;
+				}
+			} else {
+				this._response = this._responseText;
+			}
+		}
+	} else {
+		this._responseText = xhr.responseText || xhr.statusText || "net::ERR_CONNECTION_REFUSED";
+	}
+	this._responseStatus = xhr.status;
+
+	if (this._state) {
+		this._dispatch(this._state, e);
+	}
+	this._dispatch("loadend", e);
+
+	if(this._response) {
+		this._resolve(this._response);
+	} else {
+		this._reject(this._responseText);
+	}
+
+	this._cleanUp();
+};
+/** @private
+*/
+HttpRequest.prototype._cleanUp = function() {
+	this._sent = true; // Prevent sending further request
+	this._done = true;
+	this._resolve = null;
+	this._reject = null;
+
+	// Promise.then and Promise.catch will be executed in asynchronous fashion and thus we cannot clean up payload and xhr right after receiving response
+	// this._payload = null; // User input
+	// this._xhr = null;
+	this.unlistenAll();
+};
+
+HttpRequest._proto = HttpRequest.prototype;
+
+export default HttpRequest;
+export { HttpRequest };

package/lib/core/es6/grid/util/PercentBar.d.ts

@@ -0,0 +1,43 @@
+import Ext from "../../../../tr-grid-util/es6/Ext.js";
+import ElementWrapper from "../components/ElementWrapper.js";
+
+declare class PercentBar extends ElementWrapper {
+
+    constructor(opt_element?: Element);
+
+    public getValue(): number;
+
+    public getPercent(): number;
+
+    public setValue(value: number|string, opt_max?: number, opt_displayText?: string): void;
+
+    public setMax(absVal: number): void;
+
+    public setText(txt: string): void;
+
+    public hideText(opt_hiden?: boolean): void;
+
+    public isTextHidden(): boolean;
+
+    public setTextWidth(width: number|string): void;
+
+    public setMaxTextLength(width: number|string): void;
+
+    public getTextScrollWidth(): number;
+
+    public getAlignment(): string;
+
+    public setAlignment(alignment: string): void;
+
+    public setMovementColor(colorObject?: any): void;
+
+    public useMovementColor(opt_enabled?: boolean): void;
+
+    public setTrackColor(color?: string): void;
+
+    public enableTooltip(opt_enabled?: boolean): void;
+
+}
+
+export default PercentBar;
+export { PercentBar };