public class Appointment extends Item implements java.lang.Cloneable
Appointment
class represents appointments within a schedule.Constructor and Description |
---|
Appointment()
Initializes a new instance of the
Appointment class. |
Modifier and Type | Method and Description |
---|---|
Appointment |
clone()
Creates an exact shallow clone of this appointment.
|
boolean |
getAllDayEvent()
Gets a value indicating whether the appointment is an all-day event.
|
boolean |
getAllowChangeEnd()
Gets a value indicating whether users are allowed to change the appointment's end time.
|
boolean |
getAllowChangeStart()
Gets a value indicating whether users are allowed to change the appointment's start time.
|
boolean |
getAllowMove()
Gets a value indicating whether users are allowed to move the appointment.
|
ResourceList<Contact> |
getAttendees()
Gets the attendees of this appointment.
|
ResourceList<Contact> |
getContacts()
Gets a list with all contacts associated with this appointment.
|
java.lang.String |
getDescriptionText()
Gets the details text displayed for this appointment by scheduling controls.
|
java.lang.String |
getDetails()
Gets the detailed description of this appointment.
|
DateTime |
getEndTime()
Gets the appointment's scheduled end time.
|
java.lang.String |
getHeaderText()
Gets the header text displayed for this appointment by scheduling controls.
|
java.lang.String |
getId()
Gets the string identifier of this appointment.
|
Location |
getLocation()
Gets the location associated with this appointment.
|
boolean |
getLocked()
Gets a value indicating whether users are forbidden to modify this appointment.
|
Style |
getPointedSelectedStyle()
Gets the style associated with this appointment.
|
Style |
getPointedStyle()
Gets the style associated with this appointment.
|
Reminder |
getReminder()
Gets the reminder for this appointment.
|
ResourceList<Resource> |
getResources()
Gets a list with all resources associated with this appointment.
|
Style |
getSelectedStyle()
Gets the style used when this appointment is selected.
|
DateTime |
getStartTime()
Gets the appointment's scheduled start time.
|
Style |
getStyle()
Gets the style associated with this appointment.
|
java.lang.String |
getSubject()
Gets the subject of this appointment.
|
java.lang.Object |
getTag()
Gets custom data associated with the appointment.
|
Task |
getTask()
Gets the task associated with this item.
|
boolean |
getVisible()
Gets whether the appointment is visible or not.
|
void |
loadFrom(org.w3c.dom.Element element,
XmlSerializationContext context)
Loads appointment data from an XML document.
|
void |
loadFrom(JsonObject obj,
JsonSerializationContext context)
Loads appointment data from a JsonObject.
|
void |
saveTo(org.w3c.dom.Element element,
XmlSerializationContext context)
Saves the appointment data to an XML document.
|
void |
saveTo(JsonObject obj,
JsonSerializationContext context)
Saves the appointment data to a JsonObject
|
void |
setAllDayEvent(boolean value)
Sets a value indicating whether the appointment is an all-day event.
|
void |
setAllowChangeEnd(boolean value)
Sets a value indicating whether users are allowed to change the appointment's end time.
|
void |
setAllowChangeStart(boolean value)
Sets a value indicating whether users are allowed to change the appointment's start time.
|
void |
setAllowMove(boolean value)
Sets a value indicating whether users are allowed to move the appointment.
|
void |
setDescriptionText(java.lang.String value)
Sets the details text displayed for this appointment by scheduling controls.
|
void |
setDetails(java.lang.String value)
Sets the detailed description of this appointment.
|
void |
setEndTime(DateTime value)
Sets the appointment's scheduled end time.
|
void |
setHeaderText(java.lang.String value)
Sets the header text displayed for this appointment by scheduling controls.
|
void |
setId(java.lang.String value)
Sets the string identifier of this appointment.
|
void |
setLocation(Location value)
Sets the location associated with this appointment.
|
void |
setLocked(boolean value)
Sets a value indicating whether users are forbidden to modify this appointment.
|
void |
setPointedSelectedStyle(Style value)
Sets the style associated with this appointment.
|
void |
setPointedStyle(Style value)
Sets the style associated with this appointment.
|
void |
setReminder(Reminder value)
Sets the reminder for this appointment.
|
void |
setSelectedStyle(Style value)
Sets the style used when this appointment is selected.
|
void |
setStartTime(DateTime value)
Sets the appointment's scheduled start time.
|
void |
setStyle(Style value)
Sets the style associated with this appointment.
|
void |
setSubject(java.lang.String value)
Sets the subject of this appointment.
|
void |
setTag(java.lang.Object value)
Sets custom data associated with the appointment.
|
void |
setTask(Task value)
Sets the task associated with this item.
|
void |
setVisible(boolean value)
Sets whether the appointment is visible or not.
|
addItemListener, copyOccurrence, createState, getAffectsLayout, getAlwaysOnTop, getHideAdornments, getHideShadow, getIsAffectedByLayout, getOccurrenceIndex, getPriority, getRecurrence, getRecurrenceState, getViewData, hashCode, onVisualsChanged, removeItemListener, restoreState, saveState, setPriority, setRecurrence, setViewData
public Appointment()
Appointment
class.public Appointment clone()
The clone()
method creates an exact copy of an item with the following exceptions.
The duplicates of a recurring item created through the clone()
method are no
longer recurring items. The Id
of the newly created item is unique and
not the same as the Id
of the source item.
clone
in class Item
Appointment
object representing a shallow copy of this one.public void saveTo(org.w3c.dom.Element element, XmlSerializationContext context)
This method saves the appointment's fields as elements of an XML document, from which
they can be loaded later via the loadFrom(Element, XmlSerializationContext)
method.
saveTo
in class Item
element
- Allows adding data to the XML document.context
- The context object contains the file format revision number
of the schedule being loaded. It also provides methods that
facilitate reading and writing various data types from and
to the XML document.public void loadFrom(org.w3c.dom.Element element, XmlSerializationContext context)
Loads the appointment's fields from an XML document where they were stored by a
previous call to the saveTo(Element, XmlSerializationContext)
method.
loadFrom
in class Item
element
- Allows reading data from the XML document.context
- The context object contains the file format revision number
of the schedule being loaded. It also provides methods that
facilitate reading and writing various data types from and
to the XML document.public void saveTo(JsonObject obj, JsonSerializationContext context)
public void loadFrom(JsonObject obj, JsonSerializationContext context)
public ResourceList<Contact> getContacts()
This method is equivalent to getAttendees()
.
getContacts
in class Item
ResourceList
class containing
the contacts associated with this appointment.public ResourceList<Resource> getResources()
getResources
in class Item
ResourceList
class containing
the resources associated with this item.public Location getLocation()
getLocation
in class Item
Location
class specifying the appointment's location.
The default is null.public void setLocation(Location value)
setLocation
in class Item
value
- An instance of the Location
class specifying the appointment's location.
The default is null.public Task getTask()
public void setTask(Task value)
public java.lang.String getId()
public void setId(java.lang.String value)
If you need to change this value, make sure it is always unique.
public boolean getLocked()
public void setLocked(boolean value)
public DateTime getStartTime()
This property affects the initial time cell occupied by the item when it is
displayed in a Calendar
component.
getStartTime
in class Item
DateTime
instance specifying the scheduled time for the item.public void setStartTime(DateTime value)
This property affects the initial time cell occupied by the item when it is
displayed in a Calendar
component.
setStartTime
in class Item
value
- A DateTime
instance specifying the scheduled time for the item.public DateTime getEndTime()
getEndTime
in class Item
DateTime
object specifying the appointment's end time.
The default is DateTime.MaxValue
.public void setEndTime(DateTime value)
setEndTime
in class Item
value
- A DateTime
object specifying the appointment's end time.
The default is DateTime.MaxValue
.public boolean getAllowChangeStart()
getAllowChangeStart
in class Item
public void setAllowChangeStart(boolean value)
setAllowChangeStart
in class Item
value
- true if the appointment's start can be modified interactively; otherwise, false.
The default is true.public boolean getAllowChangeEnd()
getAllowChangeEnd
in class Item
public void setAllowChangeEnd(boolean value)
setAllowChangeEnd
in class Item
value
- true if the appointment's end can be modified interactively; otherwise, false.
The default is true.public boolean getAllowMove()
getAllowMove
in class Item
public void setAllowMove(boolean value)
setAllowMove
in class Item
value
- true if the appointment can be moved interactively; otherwise, false.
The default is true.public boolean getAllDayEvent()
All day events are displayed in a special header area when the Calendar
displays a timetable view.
getAllDayEvent
in class Item
public void setAllDayEvent(boolean value)
All day events are displayed in a special header area when the Calendar
displays a timetable view.
setAllDayEvent
in class Item
value
- true if the item is an all day event; otherwise, false. The default is false.public java.lang.String getHeaderText()
This method is equivalent to getSubject()
.
getHeaderText
in class Item
public void setHeaderText(java.lang.String value)
This method is equivalent to setSubject(java.lang.String)
.
setHeaderText
in class Item
value
- A string containing the appointment's header text. The default is an empty string.public java.lang.String getDescriptionText()
This method is equivalent to getDetails()
.
getDescriptionText
in class Item
public void setDescriptionText(java.lang.String value)
This method is equivalent to setDetails(java.lang.String)
.
setDescriptionText
in class Item
value
- A string containing the appointment's description. The default is an empty string.public java.lang.String getSubject()
This method is equivalent to getHeaderText()
.
public void setSubject(java.lang.String value)
This method is equivalent to setHeaderText(java.lang.String)
.
value
- A string that identifies the subject of the appointment.
The default is an empty string.public java.lang.String getDetails()
This method is equivalent to getDescriptionText()
.
public void setDetails(java.lang.String value)
This method is equivalent to setDescriptionText(java.lang.String)
.
value
- A string containing the appointment's description.
The default is an empty string.public ResourceList<Contact> getAttendees()
This method is equivalent to getContacts()
.
ResourceList
class specifying the appointment's attendees.public Reminder getReminder()
If the reminder type is Exact
, the
itemReminderTriggered
event is
raised at the time set in the reminder's Time
property.
If the reminder type is Leading
, the
itemReminderTriggered
event is
raised certain amount of time prior to the item's StartTime
,
as specified in the reminder's TimeInterval
property.
Note: Recurring items cannot have leading reminders.
getReminder
in class Item
Reminder
class.public void setReminder(Reminder value)
If the reminder type is Exact
, the
itemReminderTriggered
event is
raised at the time set in the reminder's Time
property.
If the reminder type is Leading
, the
itemReminderTriggered
event is
raised certain amount of time prior to the item's StartTime
,
as specified in the reminder's TimeInterval
property.
Note: Recurring items cannot have leading reminders.
setReminder
in class Item
value
- An instance of the Reminder
class.public Style getStyle()
This style is applied to the appointment when it is neither pointed with the mouse nor selected.
public void setStyle(Style value)
This style is applied to the appointment when it is neither pointed with the mouse nor selected.
public Style getSelectedStyle()
This style is applied on the appointment when it is selected.
getSelectedStyle
in class Item
Style
class that defines the appearance of the item.public void setSelectedStyle(Style value)
This style is applied on the appointment when it is selected.
setSelectedStyle
in class Item
value
- An instance of the Style
class that defines the appearance of the item.public Style getPointedStyle()
This style is applied to the appointment when it is pointed with the mouse.
This property is ignored and Style
is used instead of it when
UseExtendedStyles
is set to false.
getPointedStyle
in class Item
Style
class that defines the appearance of the item.public void setPointedStyle(Style value)
This style is applied to the appointment when it is pointed with the mouse.
This property is ignored and Style
is used instead of it when
UseExtendedStyles
is set to false.
setPointedStyle
in class Item
value
- An instance of the Style
class that defines the appearance of the item.public Style getPointedSelectedStyle()
This style is applied to the appointment when it is pointed
with the mouse and selected at the same time. This property
is ignored and SelectedStyle
is used
instead of it when UseExtendedStyles
is set to false.
getPointedSelectedStyle
in class Item
Style
class that defines the appearance of the item.public void setPointedSelectedStyle(Style value)
This style is applied to the appointment when it is pointed
with the mouse and selected at the same time. This property
is ignored and SelectedStyle
is used
instead of it when UseExtendedStyles
is set to false.
setPointedSelectedStyle
in class Item
value
- An instance of the Style
class that defines the appearance of the item.public boolean getVisible()
Invisible items are not drawn at all. You could use this property to hide an item temporarily, or to store additional data in a helper item object that always stays invisible.
getVisible
in class Item
public void setVisible(boolean value)
Invisible items are not drawn at all. You could use this property to hide an item temporarily, or to store additional data in a helper item object that always stays invisible.
setVisible
in class Item
value
- true if the item is visible; otherwise, false. The default is true.public java.lang.Object getTag()
Use this property to store your custom data.