turbogui-angular/main/managers/DelayedMethodCallManager.d.ts

A library that tries to help with the most common user interface elements on several frameworks and platforms

/**
 * TurboGUI is A library that helps with the most common and generic UI elements and functionalities
 *
 * Website : -> http://www.turbogui.org
 * License : -> Licensed under the Apache License, Version 2.0. You may not use this file except in compliance with the License.
 * License Url : -> http://www.apache.org/licenses/LICENSE-2.0
 * CopyRight : -> Copyright 2018 Edertone Advanded Solutions. https://www.edertone.com
 */
/**
 * Sometimes it is necessary to apply some kind of buffer to the user input for certain operations that may be executed
 * several times but we need to capture only the latest of them into a certain period of time. This class does exactly this:
 * we can queue as many times as we want a specific method call and only the last one will be executed under a defined window of time.
 * So for example if a user types keys on an input, we can buffer it for x seconds and perform a request only with the last of its changes.
 * Lots of other UI interaction usages may be interesting with this class.
 */
export declare class DelayedMethodCallManager {
    private delay;
    private _functionsToExecute;
    private _timerIsRunning;
    private _setTimeoutHandler;
    /**
     * Sometimes it is necessary to apply some kind of buffer to the user input for certain operations that may be executed
     * several times but we need to capture only the latest of them into a certain period of time. This class does exactly this:
     * we can queue as many times as we want a specific method call and only the last one will be executed under a defined window of time.
     * So for example if a user types keys on an input, we can buffer it for x seconds and perform a request only with the last of its changes.
     * Lots of other UI interaction usages may be interesting with this class.
     *
     * @param delay Amount of time to wait before executing the operations . Defaults to 1000 miliseconds.
     */
    constructor(delay?: number);
    /**
     * Add a method to be called once the delay time is finished.
     * Every time a new call to queue is performed, the delay timer is restarted. When the delay time finishes, only the
     * last of the methods that have been pushed by call() will be executed.
     *
     * Use it to queue several user input operations that should be called only once in a period of time, while waiting
     * for the user to finish his input.
     *
     * @param method The function that will be queued for execution after the delay time has passed
     */
    queue(method: () => void): void;
    /**
     * Abort all methods that may have been pushed to this class and are waiting to be executed, so none of them
     * is executed when the delay time finishes. Basically everything is cleared and stoped when this method is called.
     */
    cancel(): void;
    /**
     * Auxiliary function that performs the call to the latest queued method
     */
    private run;
}
//# sourceMappingURL=DelayedMethodCallManager.d.ts.map