Module ical4j.core

Package net.fortuna.ical4j.model.parameter

Class Display

java.lang.Object

net.fortuna.ical4j.model.Content

net.fortuna.ical4j.model.Parameter

net.fortuna.ical4j.model.parameter.Display

All Implemented Interfaces:

Serializable, Comparable<Parameter>, Encodable

public class Display
extends Parameter
implements Encodable

 Parameter Name:  DISPLAY

 Purpose:  To specify different ways in which an image for a calendar
 or component can be displayed.

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

 displayparam = "DISPLAY" "=" displayval *("," displayval)

 displayval =   ("BADGE" /    ; image inline with the title of the
                              ; event
                 "GRAPHIC" /  ; a full image replacement for the event
                              ; itself
                 "FULLSIZE /  ; an image that is used to enhance the
                              ; event
                 "THUMBNAIL / ; a smaller variant of "FULLSIZE" to be
                              ; used when space for the image is
                              ; constrained
                 x-name /     ; Experimental type
                 iana-token)  ; Other IANA registered type
                              ;
                              ; Default is BADGE

 Description:  This property parameter MAY be specified on "IMAGE"
 properties.  In the absence of this parameter, the value "BADGE"
 MUST be used for the default behavior.  The value determines how a
 client ought to present an image supplied in iCalendar data to the
 user.

 Values for this parameter are registered with IANA as per
 Section 8.3.  New values can be added to this registry following
 the procedure outlined in Section 8.2.1 of [RFC5545].

 Servers and clients MUST handle x-name and iana-token values they
 don't recognize by not displaying any image at all.

 Example:

 IMAGE;VALUE=URI;DISPLAY=BADGE,THUMBNAIL,;FMTTYPE=image/png:http://exa
 mple.com/images/weather-cloudy.png
 

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Display.Factory
static enum	Display.Value

Field Summary

Fields inherited from class net.fortuna.ical4j.model.Parameter

ABBREV, ALTREP, CN, CUTYPE, DELEGATED_FROM, DELEGATED_TO, DERIVED, DIR, DISPLAY, EMAIL, ENCODING, EXPERIMENTAL_PREFIX, FBTYPE, FEATURE, FMTTYPE, LABEL, LANGUAGE, MEMBER, ORDER, PARTSTAT, RANGE, RELATED, RELTYPE, ROLE, RSVP, SCHEDULE_AGENT, SCHEDULE_STATUS, SCHEMA, SENT_BY, TYPE, TZID, VALUE, VVENUE

Constructor Summary

Constructors

Constructor	Description
Display(String value)

Method Summary

Modifier and Type	Method	Description
String	getValue()

Methods inherited from class net.fortuna.ical4j.model.Parameter

compareTo, equals, getName, hashCode, toString

Methods inherited from class java.lang.Object

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

Constructor Details

Display

public Display(String value)

Method Details

getValue

public String getValue()

Specified by:

getValue in class Content

Returns:

the content value