biweekly.property

Class DisplayAlarm

java.lang.Object

biweekly.property.ICalProperty

biweekly.property.VCalAlarmProperty

biweekly.property.DisplayAlarm

public class DisplayAlarm
extends VCalAlarmProperty

Defines an alarm that displays a message when triggered. It is recommended that the VAlarm component be used to created alarms.

Author:

Michael Angstadt

See Also:

vCal 1.0 p.30, VAlarm.display(biweekly.property.Trigger, java.lang.String)

Field Summary

Fields inherited from class biweekly.property.VCalAlarmProperty

repeat, snooze, start

Fields inherited from class biweekly.property.ICalProperty

parameters

Constructor Summary

Constructors

Constructor and Description
DisplayAlarm(String text)

Method Summary

Methods

Modifier and Type	Method and Description
String	getText() Gets the text to display when the alarm is triggered.
void	setText(String text) Sets the text to display when the alarm is triggered.

Methods inherited from class biweekly.property.VCalAlarmProperty

getRepeat, getSnooze, getStart, setRepeat, setSnooze, setStart

Methods inherited from class biweekly.property.ICalProperty

addParameter, getParameter, getParameters, getParameters, removeParameter, setParameter, setParameter, setParameters, validate, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DisplayAlarm

public DisplayAlarm(String text)

Method Detail

getText

public String getText()

Gets the text to display when the alarm is triggered.

Returns:

the display text

setText

public void setText(String text)

Sets the text to display when the alarm is triggered.

Parameters:

text - the display text