Class Summary
- All Implemented Interfaces:
PropAltText<String>
,PropLanguage<String>
,VProperty<String>
,VChild
,VElement
,VParent
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.
- The following are OPTIONAL, and MAY occur more than once.
- other-param
- ";"
NonStandardParameter
- ";"
invalid reference
IANAParameter
- ";"
- other-param
Example: The following is an example of this property:
- SUMMARY:Department Party
-
Nested Class Summary
Nested classes/interfaces inherited from class jfxtras.icalendarfx.VElementBase
VElementBase.Message, VElementBase.MessageEffect
-
Field Summary
Fields inherited from class jfxtras.icalendarfx.properties.VPropertyBase
actualValueContent, allowedValueTypes, defaultValueType, propertyName
Fields inherited from class jfxtras.icalendarfx.VParentBase
contentLineGenerator, orderer
Fields inherited from class jfxtras.icalendarfx.VElementBase
BEGIN, END
-
Constructor Summary
Constructors -
Method Summary
Methods inherited from class jfxtras.icalendarfx.properties.PropBaseAltText
getAlternateText, setAlternateText, setAlternateText, withAlternateText, withAlternateText, withAlternateText
Methods inherited from class jfxtras.icalendarfx.properties.PropBaseLanguage
getLanguage, setLanguage, setLanguage, withLanguage, withLanguage
Methods inherited from class jfxtras.icalendarfx.properties.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 jfxtras.icalendarfx.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 jfxtras.icalendarfx.VElementBase
elementName, isContentValid, newEmptyVElement, parse, throwMessageExceptions
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface jfxtras.icalendarfx.properties.PropLanguage
getLanguage, setLanguage
Methods inherited from interface jfxtras.icalendarfx.VParent
addChild, addChild, addChild, childrenUnmodifiable, orderChild, orderChild, orderChild, removeChild, removeChild, replaceChild, replaceChild
Methods inherited from interface jfxtras.icalendarfx.properties.VProperty
getNonStandard, getValue, getValueType, setNonStandard, setValue, setValueType
-
Constructor Details
-
Summary
Create deep copy of source Summary -
Summary
Create Summary with property value set to parameter value -
Summary
public Summary()Create default Summary with no value set
-
-
Method Details
-
parse
Create new Summary by parsing unfolded calendar content
-