acm.util.SwingTimer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of javakarel Show documentation
This the original Stanford Karel for Java, packaged for Maven. ACM Library is included. See also https://cs.stanford.edu/people/eroberts/karel-the-robot-learns-java.pdf
The newest version!
/*
 * @(#)SwingTimer.java   1.99.1 08/12/08
 */

// ************************************************************************
// * Copyright (c) 2008 by the Association for Computing Machinery        *
// *                                                                      *
// * The Java Task Force seeks to impose few restrictions on the use of   *
// * these packages so that users have as much freedom as possible to     *
// * use this software in constructive ways and can make the benefits of  *
// * that work available to others.  In view of the legal complexities    *
// * of software development, however, it is essential for the ACM to     *
// * maintain its copyright to guard against attempts by others to        *
// * claim ownership rights.  The full text of the JTF Software License   *
// * is available at the following URL:                                   *
// *                                                                      *
// *          http://www.acm.org/jtf/jtf-software-license.pdf             *
// *                                                                      *
// ************************************************************************

package acm.util;

import java.awt.event.*;
import javax.swing.*;

/* Class: SwingTimer */
/**
 * This class is equivalent to javax.swing.Timer and
 * exists only to avoid the ambiguity that arises because there is
 * also a Timer class in java.util.
 */
public class SwingTimer extends Timer {

/* Constructor: SwingTimer(rate, listener) */
/**
 * Creates a new timer that ticks at the specified rate.  On each tick,
 * the timer sends an ActionEvent to the listener.
 *
 * Example: SwingTimer timer = new SwingTimer(rate, listener);
 * @param rate The number of milliseconds between ticks
 * @param listener The ActionListener receiving the events
 */
	public SwingTimer(int rate, ActionListener listener) {
		super(rate, listener);
	}

/* Inherited method: addActionListener(listener) */
/**
 * @inherited Timer#void addActionListener(ActionListener listener)
 * Adds the specified action listener to the timer.
 */

/* Inherited method: removeActionListener(listener) */
/**
 * @inherited Timer#void removeActionListener(ActionListener listener)
 * Removes the specified action listener from the timer.
 */

/* Inherited method: setDelay(delay) */
/**
 * @inherited Timer#void setDelay(int delay)
 * Sets the timer delay in milliseconds.
 */

/* Inherited method: getDelay() */
/**
 * @inherited Timer#int getDelay()
 * Returns the timer delay.
 */

/* Inherited method: setRepeats(flag) */
/**
 * @inherited Timer#void setRepeats(boolean flag)
 * Sets whether the timer repeats or is a one-shot event.
 */

/* Inherited method: isRepeats() */
/**
 * @inherited Timer#boolean isRepeats()
 * Returns true if the timer repeats.
 */

/* Inherited method: start() */
/**
 * @inherited Timer#void start()
 * Starts the timer.
 */

/* Inherited method: stop() */
/**
 * @inherited Timer#void stop()
 * Stops the timer.
 */

/* Inherited method: isRunning() */
/**
 * @inherited Timer#boolean isRunning()
 * Returns true if the timer is running.
 */

/* Serial version UID */
/**
 * The serialization code for this class.  This value should be incremented
 * whenever you change the structure of this class in an incompatible way,
 * typically by adding a new instance variable.
 */
	static final long serialVersionUID = 1L;
}