org.pepstock.charba.client.utils.CSchedulerRegistration Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of charba Show documentation

Charba, GWT Chart library based on CHART.JS

There is a newer version: 6.5-gwt

/**
    Copyright 2017 Andrea "Stock" Stocchero

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

	    http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
*/
package org.pepstock.charba.client.utils;

/**
 * Registration objects returned when a task has been scheduled, used to cancel the scheduling.
 * 
 * @author Andrea "Stock" Stocchero
 *
 */
public final class CSchedulerRegistration {

	// timeout ID instance
	private final int timeoutID;

	/**
	 * Creates a scheduler registration in order to enable the task removing.
	 * 
	 * @param timeoutID the identifier of the timeout you want to cancel
	 */
	CSchedulerRegistration(int timeoutID) {
		this.timeoutID = timeoutID;
	}

	/**
	 * Cancels the task scheduling is not started yet.
	 */
	public void cancel() {
		Window.clearTimeout(timeoutID);
	}
}