Module jfxtras.icalendarfx

Package jfxtras.icalendarfx.properties.component.descriptive

Class Description

java.lang.Object

jfxtras.icalendarfx.VElementBase

jfxtras.icalendarfx.VParentBase<U>

jfxtras.icalendarfx.properties.VPropertyBase<T,U>

jfxtras.icalendarfx.properties.PropBaseLanguage<T,U>

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

jfxtras.icalendarfx.properties.component.descriptive.Description

All Implemented Interfaces:

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

public class Description
extends PropBaseAltText<String,Description>

3.8.1.5. Description

Property Name: DESCRIPTION

Purpose: This property provides a more complete description of the calendar component than that provided by the SUMMARY property.

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 the VEVENT, VTODO, VJOURNAL, or VALARM calendar components. The property can be specified multiple times only within a VJOURNAL calendar component.

Description: This property is used in the VEVENT and VTODO to capture lengthy textual descriptions associated with the activity.

This property is used in the VJOURNAL calendar component to capture one or more textual journal entries.

This property is used in the VALARM calendar component to capture the display text for a DISPLAY category of alarm, and to capture the body text for an EMAIL category of alarm.

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

• description
  • "DESCRIPTION" descparam ":" text CRLF
• descparam
  • 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
      • ";" IANAParameter

  Example: The following is an example of this property with formatted line breaks in the property value:

  • DESCRIPTION:Meeting to provide technical review for "Phoenix"
    design.\nHappy Face Conference Room. Phoenix design team
    MUST attend this meeting.\nRSVP to team leader.
  RFC 5545 iCalendar September 2009

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

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

Method Summary

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

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.VChild

getParent, setParent

Methods inherited from interface jfxtras.icalendarfx.VElement

errors, isValid, name

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

Description

public Description(Description source)

Create deep copy of source Description

Description

public Description(String value)

Create Description with property value set to input parameter

Description

public Description()

Create default Description with no value set

Method Details

parse

public static Description parse(String unfoldedContent)

Create new Description by parsing unfolded calendar content