Class Summary

java.lang.Object

jfxtras.icalendarfx.VElementBase

jfxtras.icalendarfx.VParentBase<Summary>

jfxtras.icalendarfx.properties.VPropertyBase<String,Summary>

jfxtras.icalendarfx.properties.PropBaseLanguage<String,Summary>

jfxtras.icalendarfx.properties.PropBaseAltText<String,Summary>

jfxtras.icalendarfx.properties.component.descriptive.Summary

All Implemented Interfaces:

PropAltText<String>, PropLanguage<String>, VProperty<String>, VChild, VElement, VParent

public class Summary
extends PropBaseAltText<String,Summary>

3.8.1.12. Summary

Property Name: SUMMARY

Purpose: This property defines a short summary or subject for the calendar component.

Value Type: TEXT

Property Parameters: IANA, non-standard, alternate text representation, and language property parameters can be specified on this property.

Conformance: The property can be specified in VEVENT, VTODO, VJOURNAL, or VALARM calendar components.

Description: This property is used in the VEVENT, VTODO AND VJOURNAL calendar components to capture a short, one-line summary about the activity or journal entry.

This property is used in the VALARM calendar component to capture the subject of an EMAIL category of alarm.

Format Definition: This property is defined by the following notation:

• summary
  • "SUMMARY" summparam ":" text CRLF
• summparam
  • The following are OPTIONAL, but MUST NOT occur more than once.
    • ";" Alternate text representation
    • ";" Language for text
  • The following are OPTIONAL, and MAY occur more than once.
    • other-param
      • ";" NonStandardParameter
      • ";"
        invalid reference

        IANAParameter

Example: The following is an example of this property:

• SUMMARY:Department Party

RFC 5545 iCalendar September 2009

Nested Class Summary

Nested classes/interfaces inherited from class VElementBase

VElementBase.Message, VElementBase.MessageEffect

Field Summary

Fields inherited from class VPropertyBase

actualValueContent, allowedValueTypes, defaultValueType, propertyName

Fields inherited from class VParentBase

contentLineGenerator, orderer

Fields inherited from class VElementBase

BEGIN, END

Constructor Summary

Constructors

Constructor	Description
Summary()	Create default Summary with no value set
Summary(String value)	Create Summary with property value set to parameter value
Summary(Summary source)	Create deep copy of source Summary

Method Summary

Modifier and Type	Method	Description
static Summary	parse(String content)	Create new Summary by parsing unfolded calendar content

Methods inherited from class PropBaseAltText

getAlternateText, setAlternateText, setAlternateText, withAlternateText, withAlternateText, withAlternateText

Methods inherited from class PropBaseLanguage

getLanguage, setLanguage, setLanguage, withLanguage, withLanguage

Methods inherited from class VPropertyBase

copyValue, equals, errors, getConverter, getNonStandard, getParent, getUnknownValue, getValue, getValueType, hashCode, modifiedValue, name, parseContent, processInLineChild, setConverter, setConverterByClass, setNonStandard, setParent, setValue, setValueType, setValueType, toString, valueContent, withNonStandard, withNonStandard, withNonStandard, withValue, withValueType

Methods inherited from class VParentBase

addChild, addChild, addChild, addChildInternal, checkChild, childrenUnmodifiable, collectGetterMap, collectSetterMap, copyChildrenInto, getGetter, getGetters, getSetter, getSetters, orderChild, orderChild, orderChild, parseContent, removeChild, removeChild, replaceChild, replaceChild, withChild

Methods inherited from class VElementBase

elementName, isContentValid, newEmptyVElement, parse, throwMessageExceptions

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface PropLanguage

getLanguage, setLanguage

Methods inherited from interface VChild

getParent, setParent

Methods inherited from interface VElement

errors, isValid, name

Methods inherited from interface VParent

addChild, addChild, addChild, childrenUnmodifiable, orderChild, orderChild, orderChild, removeChild, removeChild, replaceChild, replaceChild

Methods inherited from interface VProperty

getNonStandard, getValue, getValueType, setNonStandard, setValue, setValueType

Constructor Details

Summary

public Summary(Summary source)

Create deep copy of source Summary

Summary

public Summary(String value)

Create Summary with property value set to parameter value

Summary

public Summary()

Create default Summary with no value set

Method Details

parse

public static Summary parse(String content)

Create new Summary by parsing unfolded calendar content