public class CalendarEvent extends Record
Record
which represents an event to occur at a specific time, displayed
within the calendar.Data overview and related methods
id
factoryCreated, factoryProperties
Constructor and Description |
---|
CalendarEvent() |
CalendarEvent(int eventId,
java.lang.String name,
java.lang.String description,
java.util.Date startDate,
java.util.Date endDate) |
CalendarEvent(int eventId,
java.lang.String name,
java.lang.String description,
java.util.Date startDate,
java.util.Date endDate,
boolean canEdit) |
CalendarEvent(int eventId,
java.lang.String name,
java.lang.String description,
java.util.Date startDate,
java.util.Date endDate,
boolean canEdit,
java.lang.String eventWindowStyle) |
CalendarEvent(int eventId,
java.lang.String name,
java.lang.String description,
java.util.Date startDate,
java.util.Date endDate,
boolean canEdit,
java.lang.String eventWindowStyle,
java.lang.String lane) |
CalendarEvent(int eventId,
java.lang.String name,
java.lang.String description,
java.util.Date startDate,
java.util.Date endDate,
boolean canEdit,
java.lang.String eventWindowStyle,
java.lang.String lane,
java.lang.String sublane) |
CalendarEvent(int eventId,
java.lang.String name,
java.lang.String description,
java.util.Date startDate,
java.util.Date endDate,
java.lang.String lane) |
CalendarEvent(int eventId,
java.lang.String name,
java.lang.String description,
java.util.Date startDate,
int duration,
TimeUnit durationUnit) |
CalendarEvent(int eventId,
java.lang.String name,
java.lang.String description,
java.util.Date startDate,
int duration,
TimeUnit durationUnit,
java.lang.String styleName) |
CalendarEvent(int eventId,
java.lang.String name,
java.lang.String description,
java.util.Date startDate,
int duration,
TimeUnit durationUnit,
java.lang.String styleName,
java.lang.String lane) |
CalendarEvent(int eventId,
java.lang.String name,
java.lang.String description,
java.util.Date startDate,
int duration,
TimeUnit durationUnit,
java.lang.String styleName,
java.lang.String lane,
java.lang.String sublane) |
CalendarEvent(com.google.gwt.core.client.JavaScriptObject jsObj) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getBackgroundColor()
An optional background color for the body portion of
canvases
representing this event in the various calendar views . |
java.lang.String |
getBorderColor()
An optional border color for the body portion of
canvases
representing this event in the various calendar views . |
java.lang.Boolean |
getCanDrag()
Optional boolean value controlling whether this event can be dragged with the mouse.
|
java.lang.Boolean |
getCanEdit()
Optional boolean value controlling the editability of this particular calendarEvent.
|
java.lang.Boolean |
getCanEditLane()
Boolean indicating whether this event can be moved between lanes.
|
java.lang.Boolean |
getCanEditSublane()
Boolean indicating whether this event can be moved between lanes.
|
java.lang.Boolean |
getCanResize()
Optional boolean value controlling whether this event can be drag-resized with the mouse.
|
java.lang.String |
getDescription()
String which represents the description of a
CalendarEvent The name of this
field within the CalendarEvent can be changed via Calendar.descriptionField |
java.lang.Integer |
getDuration()
The duration of this event.
|
TimeUnit |
getDurationUnit()
When a
duration is set for this event, this is
the unit of that duration. |
java.util.Date |
getEndDate()
Date object which represents the end date of a
CalendarEvent The name of
this field within the CalendarEvent can be changed via Calendar.endDateField |
java.lang.Integer |
getEventId() |
java.lang.String |
getEventWindowStyle()
Deprecated.
in favor of
styleName |
java.lang.String |
getHeaderBackgroundColor()
An optional background color for the header portion of
canvases
representing this event in the various calendar views . |
java.lang.String |
getHeaderBorderColor()
An optional border color for the header portion of
canvases
representing this event in the various calendar views . |
java.lang.String |
getHeaderTextColor()
An optional text color for the header portion of
canvases
representing this event in the various calendar views . |
java.lang.String |
getLane()
When in Timeline mode, or when
Calendar.showDayLanes is true, a string that represents the name of the lane this CalendarEvent should sit in. |
java.lang.String |
getName()
String which represents the name of a
CalendarEvent The name of this field
within the CalendarEvent can be changed via Calendar.nameField |
static CalendarEvent |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
java.util.Date |
getStartDate()
Date object which represents the start date of a
CalendarEvent . |
java.lang.String |
getStyleName()
CSS style series to use for
canvas instances that
represent this event in the various calendar views . |
java.lang.String |
getSublane()
When in Timeline mode, or when
Calendar.showDayLanes is true, a string that represents the name of the sublane this CalendarEvent should sit in. |
java.lang.String |
getTextColor()
An optional text color for the body portion of
canvases
representing this event in the various calendar views . |
CalendarEvent |
setBackgroundColor(java.lang.String backgroundColor)
An optional background color for the body portion of
canvases
representing this event in the various calendar views . |
CalendarEvent |
setBorderColor(java.lang.String borderColor)
An optional border color for the body portion of
canvases
representing this event in the various calendar views . |
CalendarEvent |
setCanDrag(java.lang.Boolean canDrag)
Optional boolean value controlling whether this event can be dragged with the mouse.
|
void |
setCanEdit(java.lang.Boolean canEdit)
Optional boolean value controlling the editability of this particular calendarEvent.
|
CalendarEvent |
setCanEditLane(java.lang.Boolean canEditLane)
Boolean indicating whether this event can be moved between lanes.
|
CalendarEvent |
setCanEditSublane(java.lang.Boolean canEditSublane)
Boolean indicating whether this event can be moved between lanes.
|
CalendarEvent |
setCanResize(java.lang.Boolean canResize)
Optional boolean value controlling whether this event can be drag-resized with the mouse.
|
CalendarEvent |
setDescription(java.lang.String description)
String which represents the description of a
CalendarEvent The name of this
field within the CalendarEvent can be changed via Calendar.descriptionField |
CalendarEvent |
setDuration(java.lang.Integer duration)
The duration of this event.
|
CalendarEvent |
setDurationUnit(TimeUnit durationUnit)
When a
duration is set for this event, this is
the unit of that duration. |
CalendarEvent |
setEndDate(java.util.Date endDate)
Date object which represents the end date of a
CalendarEvent The name of
this field within the CalendarEvent can be changed via Calendar.endDateField |
void |
setEventId(java.lang.Integer eventId) |
CalendarEvent |
setEventWindowStyle(java.lang.String eventWindowStyle)
Deprecated.
in favor of
styleName |
CalendarEvent |
setHeaderBackgroundColor(java.lang.String headerBackgroundColor)
An optional background color for the header portion of
canvases
representing this event in the various calendar views . |
CalendarEvent |
setHeaderBorderColor(java.lang.String headerBorderColor)
An optional border color for the header portion of
canvases
representing this event in the various calendar views . |
CalendarEvent |
setHeaderTextColor(java.lang.String headerTextColor)
An optional text color for the header portion of
canvases
representing this event in the various calendar views . |
CalendarEvent |
setLane(java.lang.String lane)
When in Timeline mode, or when
Calendar.showDayLanes is true, a string that represents the name of the lane this CalendarEvent should sit in. |
CalendarEvent |
setName(java.lang.String name)
String which represents the name of a
CalendarEvent The name of this field
within the CalendarEvent can be changed via Calendar.nameField |
CalendarEvent |
setStartDate(java.util.Date startDate)
Date object which represents the start date of a
CalendarEvent . |
CalendarEvent |
setStyleName(java.lang.String styleName)
CSS style series to use for
canvas instances that
represent this event in the various calendar views . |
CalendarEvent |
setSublane(java.lang.String sublane)
When in Timeline mode, or when
Calendar.showDayLanes is true, a string that represents the name of the sublane this CalendarEvent should sit in. |
CalendarEvent |
setTextColor(java.lang.String textColor)
An optional text color for the body portion of
canvases
representing this event in the various calendar views . |
convertToRecordArray, copyAttributes, copyAttributesInto, getAttributeAsRecordArray, getAttributeAsRecordList, getPaletteDefaults, isARecord, toMap
getRef, getRef, internalSetID
applyFactoryProperties, doAddHandler, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsDoubleArray, getAttributeAsElement, getAttributeAsFloat, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getAttributes, getHandlerCount, isFactoryCreated, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributeAsJavaObject, setFactoryCreated
public CalendarEvent()
public CalendarEvent(com.google.gwt.core.client.JavaScriptObject jsObj)
public CalendarEvent(int eventId, java.lang.String name, java.lang.String description, java.util.Date startDate, java.util.Date endDate)
public CalendarEvent(int eventId, java.lang.String name, java.lang.String description, java.util.Date startDate, java.util.Date endDate, boolean canEdit)
public CalendarEvent(int eventId, java.lang.String name, java.lang.String description, java.util.Date startDate, java.util.Date endDate, boolean canEdit, java.lang.String eventWindowStyle)
public CalendarEvent(int eventId, java.lang.String name, java.lang.String description, java.util.Date startDate, java.util.Date endDate, java.lang.String lane)
public CalendarEvent(int eventId, java.lang.String name, java.lang.String description, java.util.Date startDate, java.util.Date endDate, boolean canEdit, java.lang.String eventWindowStyle, java.lang.String lane)
public CalendarEvent(int eventId, java.lang.String name, java.lang.String description, java.util.Date startDate, java.util.Date endDate, boolean canEdit, java.lang.String eventWindowStyle, java.lang.String lane, java.lang.String sublane)
public CalendarEvent(int eventId, java.lang.String name, java.lang.String description, java.util.Date startDate, int duration, TimeUnit durationUnit)
public CalendarEvent(int eventId, java.lang.String name, java.lang.String description, java.util.Date startDate, int duration, TimeUnit durationUnit, java.lang.String styleName)
public CalendarEvent(int eventId, java.lang.String name, java.lang.String description, java.util.Date startDate, int duration, TimeUnit durationUnit, java.lang.String styleName, java.lang.String lane)
public CalendarEvent(int eventId, java.lang.String name, java.lang.String description, java.util.Date startDate, int duration, TimeUnit durationUnit, java.lang.String styleName, java.lang.String lane, java.lang.String sublane)
public static CalendarEvent getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public CalendarEvent setBackgroundColor(java.lang.String backgroundColor)
canvases
representing this event in the various calendar views
.
Note that the recommended approach for styling events is to set a custom CSS style
, which allows more complete
customization of both header and body portions.
backgroundColor
- New backgroundColor value. Default value is nullCalendarEvent
instance, for chaining setter callspublic java.lang.String getBackgroundColor()
canvases
representing this event in the various calendar views
.
Note that the recommended approach for styling events is to set a custom CSS style
, which allows more complete
customization of both header and body portions.
public CalendarEvent setBorderColor(java.lang.String borderColor)
canvases
representing this event in the various calendar views
.
Note that the recommended approach for styling events is to set a custom CSS style
, which allows more complete
customization of both header and body portions.
borderColor
- New borderColor value. Default value is nullCalendarEvent
instance, for chaining setter callspublic java.lang.String getBorderColor()
canvases
representing this event in the various calendar views
.
Note that the recommended approach for styling events is to set a custom CSS style
, which allows more complete
customization of both header and body portions.
public CalendarEvent setCanDrag(java.lang.Boolean canDrag)
Calendar.canDragEventField
. Only has an effect when editing
is enabled. You can separately disallow
drag-resize via canResize
.
canDrag
- New canDrag value. Default value is nullCalendarEvent
instance, for chaining setter callspublic java.lang.Boolean getCanDrag()
Calendar.canDragEventField
. Only has an effect when editing
is enabled. You can separately disallow
drag-resize via canResize
.
public CalendarEvent setCanEditLane(java.lang.Boolean canEditLane)
calendar level
. The name of this field within the
CalendarEvent can be changed via Calendar.canEditLaneField
.
canEditLane
- New canEditLane value. Default value is nullCalendarEvent
instance, for chaining setter callspublic java.lang.Boolean getCanEditLane()
calendar level
. The name of this field within the
CalendarEvent can be changed via Calendar.canEditLaneField
.
public CalendarEvent setCanEditSublane(java.lang.Boolean canEditSublane)
calendar level
. The name of this field within the
CalendarEvent can be changed via Calendar.canEditSublaneField
.
canEditSublane
- New canEditSublane value. Default value is nullCalendarEvent
instance, for chaining setter callspublic java.lang.Boolean getCanEditSublane()
calendar level
. The name of this field within the
CalendarEvent can be changed via Calendar.canEditSublaneField
.
public CalendarEvent setCanResize(java.lang.Boolean canResize)
Calendar.canResizeEventField
. Only has an effect if editing
and dragging
are also enabled.
canResize
- New canResize value. Default value is nullCalendarEvent
instance, for chaining setter callspublic java.lang.Boolean getCanResize()
Calendar.canResizeEventField
. Only has an effect if editing
and dragging
are also enabled.
public CalendarEvent setDescription(java.lang.String description)
CalendarEvent
The name of this
field within the CalendarEvent can be changed via Calendar.descriptionField
description
- New description value. Default value is nullCalendarEvent
instance, for chaining setter callspublic java.lang.String getDescription()
CalendarEvent
The name of this
field within the CalendarEvent can be changed via Calendar.descriptionField
public CalendarEvent setDuration(java.lang.Integer duration)
end date
and implies that this is a "Period" type event.
If set to zero, implies an "Instant" type event - an event with a start date but no length.duration
- New duration value. Default value is nullCalendarEvent
instance, for chaining setter callspublic java.lang.Integer getDuration()
end date
and implies that this is a "Period" type event.
If set to zero, implies an "Instant" type event - an event with a start date but no length.public CalendarEvent setDurationUnit(TimeUnit durationUnit)
duration
is set for this event, this is
the unit of that duration. The default is minutes.durationUnit
- New durationUnit value. Default value is "minute"CalendarEvent
instance, for chaining setter callspublic TimeUnit getDurationUnit()
duration
is set for this event, this is
the unit of that duration. The default is minutes.public CalendarEvent setEndDate(java.util.Date endDate)
CalendarEvent
The name of
this field within the CalendarEvent can be changed via Calendar.endDateField
endDate
- New endDate value. Default value is nullCalendarEvent
instance, for chaining setter callspublic java.util.Date getEndDate()
CalendarEvent
The name of
this field within the CalendarEvent can be changed via Calendar.endDateField
public CalendarEvent setEventWindowStyle(java.lang.String eventWindowStyle)
styleName
Calendar.eventWindowStyle
for this specific event.
The name of this field within the CalendarEvent can be changed via Calendar.eventWindowStyleField
eventWindowStyle
- New eventWindowStyle value. Default value is nullCalendarEvent
instance, for chaining setter callsCSSStyleName
public java.lang.String getEventWindowStyle()
styleName
Calendar.eventWindowStyle
for this specific event.
The name of this field within the CalendarEvent can be changed via Calendar.eventWindowStyleField
CSSStyleName
public CalendarEvent setHeaderBackgroundColor(java.lang.String headerBackgroundColor)
canvases
representing this event in the various calendar views
.
Note that the recommended approach for styling events is to set a custom CSS style
, which allows more complete
customization of both header and body portions.
headerBackgroundColor
- New headerBackgroundColor value. Default value is nullCalendarEvent
instance, for chaining setter callspublic java.lang.String getHeaderBackgroundColor()
canvases
representing this event in the various calendar views
.
Note that the recommended approach for styling events is to set a custom CSS style
, which allows more complete
customization of both header and body portions.
public CalendarEvent setHeaderBorderColor(java.lang.String headerBorderColor)
canvases
representing this event in the various calendar views
.
Note that the recommended approach for styling events is to set a custom CSS style
, which allows more complete
customization of both header and body portions.
headerBorderColor
- New headerBorderColor value. Default value is nullCalendarEvent
instance, for chaining setter callspublic java.lang.String getHeaderBorderColor()
canvases
representing this event in the various calendar views
.
Note that the recommended approach for styling events is to set a custom CSS style
, which allows more complete
customization of both header and body portions.
public CalendarEvent setHeaderTextColor(java.lang.String headerTextColor)
canvases
representing this event in the various calendar views
.
Note that the recommended approach for styling events is to set a custom CSS style
, which allows more complete
customization of both header and body portions.
headerTextColor
- New headerTextColor value. Default value is nullCalendarEvent
instance, for chaining setter callspublic java.lang.String getHeaderTextColor()
canvases
representing this event in the various calendar views
.
Note that the recommended approach for styling events is to set a custom CSS style
, which allows more complete
customization of both header and body portions.
public CalendarEvent setLane(java.lang.String lane)
Calendar.showDayLanes
is true, a string that represents the name of the lane
this CalendarEvent
should sit in. The name of this field within the CalendarEvent can
be changed via Calendar.laneNameField
.lane
- New lane value. Default value is nullCalendarEvent
instance, for chaining setter callspublic java.lang.String getLane()
Calendar.showDayLanes
is true, a string that represents the name of the lane
this CalendarEvent
should sit in. The name of this field within the CalendarEvent can
be changed via Calendar.laneNameField
.public CalendarEvent setName(java.lang.String name)
CalendarEvent
The name of this field
within the CalendarEvent can be changed via Calendar.nameField
name
- New name value. Default value is nullCalendarEvent
instance, for chaining setter callspublic java.lang.String getName()
CalendarEvent
The name of this field
within the CalendarEvent can be changed via Calendar.nameField
public CalendarEvent setStartDate(java.util.Date startDate)
CalendarEvent
. The name of
this field within the CalendarEvent can be changed via Calendar.startDateField
startDate
- New startDate value. Default value is nullCalendarEvent
instance, for chaining setter callspublic java.util.Date getStartDate()
CalendarEvent
. The name of
this field within the CalendarEvent can be changed via Calendar.startDateField
public CalendarEvent setStyleName(java.lang.String styleName)
canvas instances
that
represent this event in the various calendar views
. The basic
series should include three classes - the base style and others suffixed "Header" and "Body". If not specified on
the event, the style can be specified on the calendar
, the view
or individually on each
lane
or sublane
.
The name of this field within the CalendarEvent can
be changed via Calendar.eventStyleNameField
styleName
- New styleName value. Default value is nullCalendarEvent
instance, for chaining setter callsCSSStyleName
public java.lang.String getStyleName()
canvas instances
that
represent this event in the various calendar views
. The basic
series should include three classes - the base style and others suffixed "Header" and "Body". If not specified on
the event, the style can be specified on the calendar
, the view
or individually on each
lane
or sublane
.
The name of this field within the CalendarEvent can
be changed via Calendar.eventStyleNameField
CSSStyleName
public CalendarEvent setSublane(java.lang.String sublane)
Calendar.showDayLanes
is true, a string that represents the name of the sublane
this CalendarEvent
should sit in. The name of this field within the CalendarEvent can
be changed via Calendar.sublaneNameField
.sublane
- New sublane value. Default value is nullCalendarEvent
instance, for chaining setter callspublic java.lang.String getSublane()
Calendar.showDayLanes
is true, a string that represents the name of the sublane
this CalendarEvent
should sit in. The name of this field within the CalendarEvent can
be changed via Calendar.sublaneNameField
.public CalendarEvent setTextColor(java.lang.String textColor)
canvases
representing this event in the various calendar views
.
Note that the recommended approach for styling events is to set a custom CSS style
, which allows more complete
customization of both header and body portions.
textColor
- New textColor value. Default value is nullCalendarEvent
instance, for chaining setter callspublic java.lang.String getTextColor()
canvases
representing this event in the various calendar views
.
Note that the recommended approach for styling events is to set a custom CSS style
, which allows more complete
customization of both header and body portions.
public void setEventId(java.lang.Integer eventId)
public java.lang.Integer getEventId()
public void setCanEdit(java.lang.Boolean canEdit)
canEditField
.canEdit
- canEdit Default value is nullpublic java.lang.Boolean getCanEdit()
canEditField
.