ui.properties

Interface AlarmSystem

All Known Subinterfaces:

DrawUserInterface, OthelloUserInterface

public interface AlarmSystem

Interfaces that implement this property provide the possibility to set an alarm, which generates an event for the Input.

Author:

Atze van der Ploeg (Code), Jan Stienstra (Documentation)

Method Summary

Methods

Modifier and Type	Method and Description
void	setAlarm(java.lang.String name, int time, boolean repeat) This function sets an alarm, which generates an event for the Input.
void	stopAlarm(java.lang.String name) Stops an alarm.

Method Detail

setAlarm

void setAlarm(java.lang.String name,
            int time,
            boolean repeat)

This function sets an alarm, which generates an event for the Input.

Parameters:

name - The name for the alarm, used as the data by the Input.getEvent() method and used by the user to stop an alarm.

time - Time, in milliseconds, before the alarm is raised.

repeat - If true, the alarm will repeat itself over and over again.

stopAlarm

void stopAlarm(java.lang.String name)

Stops an alarm.

Parameters:

name - The name of the alarm, provided as an argument at setAlarm(String, int, boolean).