- All Implemented Interfaces:
VParameter<AlarmTriggerRelationship.AlarmTriggerRelationshipType>
,VChild
,VElement
3.2.14. Alarm Trigger Relationship
Parameter Name: RELATED
Purpose: To specify the relationship of the alarm trigger with respect to the start or end of the calendar component.
Description: This parameter can be specified on properties that specify an alarm trigger with a "DURATION" value type. The parameter specifies whether the alarm will trigger relative to the start or end of the calendar component. The parameter value START will set the alarm to trigger off the start of the calendar component; the parameter value END will set the alarm to trigger off the end of the calendar component. If the parameter is not specified on an allowable property, then the default is START.
Format Definition: This property parameter is defined by the following notation::
- triggerparam
- "RELATED" "="
- ("START" ; Trigger off of start
- / "END") ; Trigger off of end
Example:
- TRIGGER;RELATED=END:PT5M
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enum
Property value types for AlarmTriggerRelationshipNested classes/interfaces inherited from class jfxtras.icalendarfx.VElementBase
VElementBase.Message, VElementBase.MessageEffect
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final StringConverter<AlarmTriggerRelationship.AlarmTriggerRelationshipType>
Fields inherited from class jfxtras.icalendarfx.parameters.VParameterBase
converter, elementType
Fields inherited from class jfxtras.icalendarfx.VElementBase
BEGIN, END
-
Constructor Summary
ConstructorsConstructorDescriptionCreate default AlarmTriggerRelationship with property value set to STARTCreate deep copy of source AlarmTriggerRelationshipCreate new AlarmTriggerRelationshipType with property value set to input parameter -
Method Summary
Methods inherited from class jfxtras.icalendarfx.parameters.VParameterBase
equals, errors, extractValue, getParent, getValue, hashCode, name, parseContent, setParent, setValue, setValue, toString, valueAsString, withValue, withValue
Methods inherited from class jfxtras.icalendarfx.VElementBase
elementName, isContentValid, newEmptyVElement, parse, throwMessageExceptions
-
Field Details
-
CONVERTER
private static final StringConverter<AlarmTriggerRelationship.AlarmTriggerRelationshipType> CONVERTER
-
-
Constructor Details
-
AlarmTriggerRelationship
public AlarmTriggerRelationship()Create default AlarmTriggerRelationship with property value set to START -
AlarmTriggerRelationship
Create new AlarmTriggerRelationshipType with property value set to input parameter -
AlarmTriggerRelationship
Create deep copy of source AlarmTriggerRelationship
-
-
Method Details
-
parse
-