Top Description Inners Fields Constructors Methods
net.fortuna.ical4j.model.parameter

public Class Display

extends Parameter
implements Encodable
Class Inheritance
All Implemented Interfaces
net.fortuna.ical4j.model.Encodable
Imports
net.fortuna.ical4j.model.Content, .Encodable, .Parameter, .ParameterFactory, net.fortuna.ical4j.util.RegEx, java.util.Arrays, .Collections, .HashSet, .Set

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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
public static enum

Field Summary

Modifier and TypeField and Description
private static final String
private static final long
private final Set<String>
Inherited from net.fortuna.ical4j.model.Parameter:
ABBREVALTREPCNCUTYPEDELEGATED_FROMDELEGATED_TODERIVEDDIRDISPLAYEMAILENCODINGEXPERIMENTAL_PREFIXFBTYPEFEATUREFMTTYPELABELLANGUAGEMEMBERORDERPARTSTATRANGERELATEDRELTYPEROLERSVPSCHEDULE_AGENTSCHEDULE_STATUSSCHEMASENT_BYTYPETZIDVALUEVVENUE

Constructor Summary

AccessConstructor and Description
public
Display(String value)

Method Summary

Modifier and TypeMethod and Description
public String
Inherited from net.fortuna.ical4j.model.Parameter:
compareToequalsgetNamehashCodetoString

Field Detail

PARAMETER_NAMEback to summary
private static final String PARAMETER_NAME
serialVersionUIDback to summary
private static final long serialVersionUID

Hides net.fortuna.ical4j.model.Parameter.serialVersionUID.

valuesback to summary
private final Set<String> values

Constructor Detail

Displayback to summary
public Display(String value)

Method Detail

getValueback to summary
public String getValue()

Implements abstract net.fortuna.ical4j.model.Content.getValue.

Returns:String

Doc from net.fortuna.ical4j.model.Content.getValue.

the content value

Annotations
@Override
net.fortuna.ical4j.model.parameter back to summary

public Class Display.Factory

extends Factory
implements ParameterFactory<Display>
Class Inheritance
All Implemented Interfaces
net.fortuna.ical4j.model.ParameterFactory, java.io.Serializable

Field Summary

Modifier and TypeField and Description
private static final long

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public Display
createParameter(final String
a value to assign to the returned parameter
value
)

Implements net.fortuna.ical4j.model.ParameterFactory.createParameter.

Returns a parameter instance of the appropriate type with the specified value.

Inherited from net.fortuna.ical4j.model.Content.Factory:
supports

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Constructor Detail

Factoryback to summary
public Factory()

Method Detail

createParameterback to summary
public Display createParameter(final String value)

Implements net.fortuna.ical4j.model.ParameterFactory.createParameter.

Doc from net.fortuna.ical4j.model.ParameterFactory.createParameter.

Returns a parameter instance of the appropriate type with the specified value.

Parameters
value:String

a value to assign to the returned parameter

Returns:Display

a parameter instance, or null if this factory is unable to create an appropriate parameter

Annotations
@Override
net.fortuna.ical4j.model.parameter back to summary

public final Enum Display.Value

extends Enum<Display.Value>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final Display.Value
public static final Display.Value
public static final Display.Value
public static final Display.Value

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static Display.Value
public static Display.Value[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

BADGEback to summary
public static final Display.Value BADGE
FULLSIZEback to summary
public static final Display.Value FULLSIZE
GRAPHICback to summary
public static final Display.Value GRAPHIC
THUMBNAILback to summary
public static final Display.Value THUMBNAIL

Constructor Detail

Valueback to summary
private Value()

Method Detail

valueOfback to summary
public static Display.Value valueOf(String name)
valuesback to summary
public static Display.Value[] values()