Created: [Apr 6, 2004]
Defines a TRANSP iCalendar component property.
4.8.2.7 Time Transparency
Property Name: TRANSP
Purpose: This property defines whether an event is transparent or not
to busy time searches.
Value Type: TEXT
Property Parameters: Non-standard property parameters can be
specified on this property.
Conformance: This property can be specified once in a "VEVENT"
calendar component.
Description: Time Transparency is the characteristic of an event that
determines whether it appears to consume time on a calendar. Events
that consume actual time for the individual or resource associated
with the calendar SHOULD be recorded as OPAQUE, allowing them to be
detected by free-busy time searches. Other events, which do not take
up the individual's (or resource's) time SHOULD be recorded as
TRANSPARENT, making them invisible to free-busy time searches.
Format Definition: The property is specified by the following
notation:
transp = "TRANSP" tranparam ":" transvalue CRLF
tranparam = *(";" xparam)
transvalue = "OPAQUE" ;Blocks or opaque on busy time searches.
/ "TRANSPARENT" ;Transparent on busy time searches.
;Default value is OPAQUE
Example: The following is an example of this property for an event
that is transparent or does not block on free/busy time searches:
TRANSP:TRANSPARENT
The following is an example of this property for an event that is
opaque or blocks on free/busy time searches:
TRANSP:OPAQUE
| Modifier and Type | Class and Description |
|---|---|
| public static class |
| Modifier and Type | Field and Description |
|---|---|
| private static final long | |
| private String | |
| public static final String | |
| public static final String |
| Access | Constructor and Description |
|---|---|
| public | |
| public | |
| public | Transp(final ParameterList
a list of parameters for this component aList, final String a value string for this component aValue)
|
| Modifier and Type | Method and Description |
|---|---|
| public final String | |
| protected PropertyFactory | newFactory()
Implements abstract net. Returns a new property factory used to create deep copies. |
| public void | setValue(final String
a string representation of the property value aValue)Implements abstract net. Sets the current value of the property. |
| public ValidationResult | validate()
Implements abstract net. Perform validation on a property. |
| serialVersionUID | back to summary |
|---|---|
| private static final long serialVersionUID | |
| value | back to summary |
|---|---|
| private String value | |
| VALUE_OPAQUE | back to summary |
|---|---|
| public static final String VALUE_OPAQUE | |
| VALUE_TRANSPARENT | back to summary |
|---|---|
| public static final String VALUE_TRANSPARENT | |
| Transp | back to summary |
|---|---|
| public Transp() Default constructor. | |
| Transp | back to summary |
|---|---|
public Transp(final String aValue)
| |
| Transp | back to summary |
|---|---|
public Transp(final ParameterList aList, final String aValue)
| |
| getValue | back to summary |
|---|---|
| public final String getValue() Implements abstract net.
| |
| newFactory | back to summary |
|---|---|
| protected PropertyFactory Implements abstract net. Doc from net. Returns a new property factory used to create deep copies.
| |
| setValue | back to summary |
|---|---|
| public void setValue(final String aValue) Implements abstract net. Doc from net. Sets the current value of the property. | |
| validate | back to summary |
|---|---|
| public ValidationResult validate() throws ValidationException Implements abstract net. Doc from net. Perform validation on a property.
| |
| Modifier and Type | Field and Description |
|---|---|
| private static final long |
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public Transp | createProperty(final ParameterList
a list of property parameters parameters, final String a property value value)Implements net.
|
| public Transp |
| serialVersionUID | back to summary |
|---|---|
| private static final long serialVersionUID | |
| Factory | back to summary |
|---|---|
| public Factory() | |
| createProperty | back to summary |
|---|---|
| public Transp createProperty(final ParameterList parameters, final String value) Implements net.
| |
| createProperty | back to summary |
|---|---|
| public Transp createProperty() Implements net.
| |