com.smartgwt.client.widgets.calendar

## Class CalendarEvent

- java.lang.Object
- - com.smartgwt.client.core.JsObject
  - - com.smartgwt.client.core.DataClass
    - - com.smartgwt.client.core.RefDataClass
      - - com.smartgwt.client.data.Record
        - - com.smartgwt.client.widgets.calendar.CalendarEvent

- All Implemented Interfaces:
    com.google.gwt.event.shared.HasHandlers

      public class CalendarEvent
      extends Record

  A type of `Record` which represents an event to occur at a specific time, displayed within the calendar.

- - ### Field Summary

    - ### Fields inherited from class com.smartgwt.client.core.RefDataClass

      `id`

    - ### Fields inherited from class com.smartgwt.client.core.DataClass

      `factoryCreated, factoryProperties, readOnly`

    - ### Fields inherited from class com.smartgwt.client.core.JsObject

      `jsObj`

  - ### Constructor Summary

    Constructors
    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)`

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
    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.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` | `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`.
    `void` | `setBackgroundColor(java.lang.String backgroundColor)` An optional background color for the body portion of `canvases` representing this event in the various `calendar views`.
    `void` | `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.
    `void` | `setCanEditLane(java.lang.Boolean canEditLane)` Boolean indicating whether this event can be moved between lanes.
    `void` | `setCanEditSublane(java.lang.Boolean canEditSublane)` Boolean indicating whether this event can be moved between lanes.
    `void` | `setCanResize(java.lang.Boolean canResize)` Optional boolean value controlling whether this event can be drag-resized with the mouse.
    `void` | `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`
    `void` | `setDuration(java.lang.Integer duration)` The duration of this event.
    `void` | `setDurationUnit(TimeUnit durationUnit)` When a `duration` is set for this event, this is the unit of that duration.
    `void` | `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)`
    `void` | `setEventWindowStyle(java.lang.String eventWindowStyle)` Deprecated. in favor of `styleName`
    `void` | `setHeaderBackgroundColor(java.lang.String headerBackgroundColor)` An optional background color for the header portion of `canvases` representing this event in the various `calendar views`.
    `void` | `setHeaderTextColor(java.lang.String headerTextColor)` An optional text color for the header portion of `canvases` representing this event in the various `calendar views`.
    `void` | `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.
    `void` | `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`
    `void` | `setStartDate(java.util.Date startDate)` Date object which represents the start date of a `CalendarEvent`.
    `void` | `setStyleName(java.lang.String styleName)` CSS style series to use for `canvas instances` that represent this event in the various `calendar views`.
    `void` | `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.
    `void` | `setTextColor(java.lang.String textColor)` An optional text color for the body portion of `canvases` representing this event in the various `calendar views`.

    - ### Methods inherited from class com.smartgwt.client.data.Record

      `convertToRecordArray, copyAttributes, copyAttributesInto, getAttributeAsRecordArray, getAttributeAsRecordList, isARecord, toMap`

    - ### Methods inherited from class com.smartgwt.client.core.RefDataClass

      `getRef, getRef, internalSetID`

    - ### Methods inherited from class com.smartgwt.client.core.DataClass

      `applyFactoryProperties, doAddHandler, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsDoubleArray, getAttributeAsFloat, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getAttributes, getHandlerCount, getReadOnly, isFactoryCreated, logConfiguration, 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, setReadOnly`

    - ### Methods inherited from class com.smartgwt.client.core.JsObject

      `equals, getJsObj, hashCode, isCreated, setJavaScriptObject, setJsObj`

    - ### Methods inherited from class java.lang.Object

      `clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### CalendarEvent

          public CalendarEvent()

    - #### CalendarEvent

          public CalendarEvent(com.google.gwt.core.client.JavaScriptObject jsObj)

    - #### CalendarEvent

          public CalendarEvent(int eventId,
                               java.lang.String name,
                               java.lang.String description,
                               java.util.Date startDate,
                               java.util.Date endDate)

    - #### CalendarEvent

          public CalendarEvent(int eventId,
                               java.lang.String name,
                               java.lang.String description,
                               java.util.Date startDate,
                               java.util.Date endDate,
                               boolean canEdit)

    - #### CalendarEvent

          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)

    - #### CalendarEvent

          public CalendarEvent(int eventId,
                               java.lang.String name,
                               java.lang.String description,
                               java.util.Date startDate,
                               java.util.Date endDate,
                               java.lang.String lane)

    - #### CalendarEvent

          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)

    - #### CalendarEvent

          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)

    - #### CalendarEvent

          public CalendarEvent(int eventId,
                               java.lang.String name,
                               java.lang.String description,
                               java.util.Date startDate,
                               int duration,
                               TimeUnit durationUnit)

    - #### CalendarEvent

          public CalendarEvent(int eventId,
                               java.lang.String name,
                               java.lang.String description,
                               java.util.Date startDate,
                               int duration,
                               TimeUnit durationUnit,
                               java.lang.String styleName)

    - #### CalendarEvent

          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)

    - #### CalendarEvent

          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)

  - ### Method Detail

    - #### getOrCreateRef

          public static CalendarEvent getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)

    - #### setBackgroundColor

          public void setBackgroundColor(java.lang.String backgroundColor)

      An optional background color for the body portion of `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.

      Parameters:
        `backgroundColor` - Default value is null

    - #### getBackgroundColor

          public java.lang.String getBackgroundColor()

      An optional background color for the body portion of `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.

      Returns:
        String

    - #### setCanDrag

          public void setCanDrag(java.lang.Boolean canDrag)

      Optional boolean value controlling whether this event can be dragged with the mouse. The name of this field within the CalendarEvent can be changed via `Calendar.canDragEventField`. Only has an effect when `editing` is enabled.

      You can separately disallow drag-resize via `canResize`.

      Parameters:
        `canDrag` - Default value is null

    - #### getCanDrag

          public java.lang.Boolean getCanDrag()

      Optional boolean value controlling whether this event can be dragged with the mouse. The name of this field within the CalendarEvent can be changed via `Calendar.canDragEventField`. Only has an effect when `editing` is enabled.

      You can separately disallow drag-resize via `canResize`.

      Returns:
        Boolean

    - #### setCanEditLane

          public void setCanEditLane(java.lang.Boolean canEditLane)

      Boolean indicating whether this event can be moved between lanes. Can also be set at the `calendar level`.

      The name of this field within the CalendarEvent can be changed via `Calendar.canEditLaneField`.

      Parameters:
        `canEditLane` - Default value is null

    - #### getCanEditLane

          public java.lang.Boolean getCanEditLane()

      Boolean indicating whether this event can be moved between lanes. Can also be set at the `calendar level`.

      The name of this field within the CalendarEvent can be changed via `Calendar.canEditLaneField`.

      Returns:
        Boolean

    - #### setCanEditSublane

          public void setCanEditSublane(java.lang.Boolean canEditSublane)

      Boolean indicating whether this event can be moved between lanes. Can also be set at the `calendar level`.

      The name of this field within the CalendarEvent can be changed via `Calendar.canEditSublaneField`.

      Parameters:
        `canEditSublane` - Default value is null

    - #### getCanEditSublane

          public java.lang.Boolean getCanEditSublane()

      Boolean indicating whether this event can be moved between lanes. Can also be set at the `calendar level`.

      The name of this field within the CalendarEvent can be changed via `Calendar.canEditSublaneField`.

      Returns:
        Boolean

    - #### setCanResize

          public void setCanResize(java.lang.Boolean canResize)

      Optional boolean value controlling whether this event can be drag-resized with the mouse. The name of this field within the CalendarEvent can be changed via `Calendar.canResizeEventField`.

      Only has an effect if `editing` and `dragging` are also enabled.

      Parameters:
        `canResize` - Default value is null

    - #### getCanResize

          public java.lang.Boolean getCanResize()

      Optional boolean value controlling whether this event can be drag-resized with the mouse. The name of this field within the CalendarEvent can be changed via `Calendar.canResizeEventField`.

      Only has an effect if `editing` and `dragging` are also enabled.

      Returns:
        Boolean

    - #### setDescription

          public void 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`
      Parameters:
        `description` - Default value is null

    - #### getDescription

          public 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`
      Returns:
        String

    - #### setDuration

          public void setDuration(java.lang.Integer duration)

      The duration of this event. May be specified instead of an `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.
      Parameters:
        `duration` - Default value is null

    - #### getDuration

          public java.lang.Integer getDuration()

      The duration of this event. May be specified instead of an `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.
      Returns:
        Integer

    - #### setDurationUnit

          public void setDurationUnit(TimeUnit durationUnit)

      When a `duration` is set for this event, this is the unit of that duration. The default is minutes.
      Parameters:
        `durationUnit` - Default value is "minute"

    - #### getDurationUnit

          public TimeUnit getDurationUnit()

      When a `duration` is set for this event, this is the unit of that duration. The default is minutes.
      Returns:
        TimeUnit

    - #### setEndDate

          public void 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`
      Parameters:
        `endDate` - Default value is null

    - #### getEndDate

          public 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`
      Returns:
        Date

    - #### setEventWindowStyle

          public void setEventWindowStyle(java.lang.String eventWindowStyle)

      Deprecated. in favor of `styleName`
      CSS style series to use for the draggable event window that represents this event. If specified, overrides `Calendar.eventWindowStyle` for this specific event.

      The name of this field within the CalendarEvent can be changed via `Calendar.eventWindowStyleField`

      Parameters:
        `eventWindowStyle` - See `CSSStyleName` . Default value is null

    - #### getEventWindowStyle

          public java.lang.String getEventWindowStyle()

      Deprecated. in favor of `styleName`
      CSS style series to use for the draggable event window that represents this event. If specified, overrides `Calendar.eventWindowStyle` for this specific event.

      The name of this field within the CalendarEvent can be changed via `Calendar.eventWindowStyleField`

      Returns:
        See `CSSStyleName`

    - #### setHeaderBackgroundColor

          public void setHeaderBackgroundColor(java.lang.String headerBackgroundColor)

      An optional background color for the header portion of `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.

      Parameters:
        `headerBackgroundColor` - Default value is null

    - #### getHeaderBackgroundColor

          public java.lang.String getHeaderBackgroundColor()

      An optional background color for the header portion of `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.

      Returns:
        String

    - #### setHeaderTextColor

          public void setHeaderTextColor(java.lang.String headerTextColor)

      An optional text color for the header portion of `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.

      Parameters:
        `headerTextColor` - Default value is null

    - #### getHeaderTextColor

          public java.lang.String getHeaderTextColor()

      An optional text color for the header portion of `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.

      Returns:
        String

    - #### setLane

          public void 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. The name of this field within the CalendarEvent can be changed via `Calendar.laneNameField`.
      Parameters:
        `lane` - Default value is null

    - #### getLane

          public 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. The name of this field within the CalendarEvent can be changed via `Calendar.laneNameField`.
      Returns:
        String

    - #### setName

          public void 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`
      Parameters:
        `name` - Default value is null

    - #### getName

          public 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`
      Returns:
        String

    - #### setStartDate

          public void setStartDate(java.util.Date startDate)

      Date object which represents the start date of a `CalendarEvent`. The name of this field within the CalendarEvent can be changed via `Calendar.startDateField`
      Parameters:
        `startDate` - Default value is null

    - #### getStartDate

          public java.util.Date getStartDate()

      Date object which represents the start date of a `CalendarEvent`. The name of this field within the CalendarEvent can be changed via `Calendar.startDateField`
      Returns:
        Date

    - #### setStyleName

          public void setStyleName(java.lang.String styleName)

      CSS style series to use for `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`

      Parameters:
        `styleName` - See `CSSStyleName` . Default value is null

    - #### getStyleName

          public java.lang.String getStyleName()

      CSS style series to use for `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`

      Returns:
        See `CSSStyleName`

    - #### setSublane

          public void 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. The name of this field within the CalendarEvent can be changed via `Calendar.sublaneNameField`.
      Parameters:
        `sublane` - Default value is null

    - #### getSublane

          public 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. The name of this field within the CalendarEvent can be changed via `Calendar.sublaneNameField`.
      Returns:
        String

    - #### setTextColor

          public void setTextColor(java.lang.String textColor)

      An optional text color for the body portion of `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.

      Parameters:
        `textColor` - Default value is null

    - #### getTextColor

          public java.lang.String getTextColor()

      An optional text color for the body portion of `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.

      Returns:
        String

    - #### setEventId

          public void setEventId(java.lang.Integer eventId)

    - #### getEventId

          public java.lang.Integer getEventId()

    - #### setCanEdit

          public void setCanEdit(java.lang.Boolean canEdit)

      Optional boolean value controlling the editability of this particular calendarEvent. The name of this field within the CalendarEvent can be changed via `canEditField`.
      Parameters:
        `canEdit` - canEdit Default value is null

    - #### getCanEdit

          public java.lang.Boolean getCanEdit()

      Optional boolean value controlling the editability of this particular calendarEvent. The name of this field within the CalendarEvent can be changed via `canEditField`.
      Returns:
        String