com.smartgwt.client.widgets.calendar
Class CalendarEvent

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

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.JsObject
jsObj
 
Constructor Summary
CalendarEvent()
           
CalendarEvent(int eventId, String name, String description, Date startDate, Date endDate)
           
CalendarEvent(int eventId, String name, String description, Date startDate, Date endDate, boolean canEdit)
           
CalendarEvent(int eventId, String name, String description, Date startDate, Date endDate, boolean canEdit, String eventWindowStyle)
           
CalendarEvent(JavaScriptObject jsObj)
           
 
Method Summary
 Boolean getCanEdit()
          Optional boolean value controlling the editability of this particular calendarEvent.
 String getDescription()
          String which represents the description of a CalendarEvent The name of this field within the CalendarEvent can be changed via descriptionField
 Date getEndDate()
          Date object which represents the end date of a CalendarEvent The name of this field within the CalendarEvent can be changed via endDateField
 Integer getEventId()
           
 String getEventWindowStyle()
          CSS style series to use for the draggable event window that represents this event.
 String getName()
          String which represents the name of a CalendarEvent The name of this field within the CalendarEvent can be changed via nameField
static CalendarEvent getOrCreateRef(JavaScriptObject jsObj)
           
 Date getStartDate()
          Date object which represents the start date of a CalendarEvent.
 void setCanEdit(Boolean canEdit)
          Optional boolean value controlling the editability of this particular calendarEvent.
 void setDescription(String description)
          String which represents the description of a CalendarEvent The name of this field within the CalendarEvent can be changed via descriptionField
 void setEndDate(Date endDate)
          Date object which represents the end date of a CalendarEvent The name of this field within the CalendarEvent can be changed via endDateField
 void setEventId(Integer eventId)
           
 void setEventWindowStyle(String eventWindowStyle)
          CSS style series to use for the draggable event window that represents this event.
 void setName(String name)
          String which represents the name of a CalendarEvent The name of this field within the CalendarEvent can be changed via nameField
 void setStartDate(Date startDate)
          Date object which represents the start date of a CalendarEvent.
 
Methods inherited from class com.smartgwt.client.data.Record
convertToRecordArray, getAttributeAsRecordArray, getAttributeAsRecordList, toMap
 
Methods inherited from class com.smartgwt.client.core.RefDataClass
getRef, getRef
 
Methods inherited from class com.smartgwt.client.core.DataClass
doAddHandler, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsDoubleArray, getAttributeAsFloat, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getAttributes, getHandlerCount, getJsObj, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute
 
Methods inherited from class com.smartgwt.client.core.JsObject
isCreated, setJsObj
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CalendarEvent

public CalendarEvent()

CalendarEvent

public CalendarEvent(JavaScriptObject jsObj)

CalendarEvent

public CalendarEvent(int eventId,
                     String name,
                     String description,
                     Date startDate,
                     Date endDate)

CalendarEvent

public CalendarEvent(int eventId,
                     String name,
                     String description,
                     Date startDate,
                     Date endDate,
                     boolean canEdit)

CalendarEvent

public CalendarEvent(int eventId,
                     String name,
                     String description,
                     Date startDate,
                     Date endDate,
                     boolean canEdit,
                     String eventWindowStyle)
Method Detail

getOrCreateRef

public static CalendarEvent getOrCreateRef(JavaScriptObject jsObj)

setDescription

public void setDescription(String description)
String which represents the description of a CalendarEvent The name of this field within the CalendarEvent can be changed via descriptionField

Parameters:
description - description Default value is null

getDescription

public String getDescription()
String which represents the description of a CalendarEvent The name of this field within the CalendarEvent can be changed via descriptionField

Returns:
String

setEndDate

public void setEndDate(Date endDate)
Date object which represents the end date of a CalendarEvent The name of this field within the CalendarEvent can be changed via endDateField

Parameters:
endDate - endDate Default value is null

getEndDate

public Date getEndDate()
Date object which represents the end date of a CalendarEvent The name of this field within the CalendarEvent can be changed via endDateField

Returns:
java.util.Date

setEventWindowStyle

public void setEventWindowStyle(String eventWindowStyle)
CSS style series to use for the draggable event window that represents this event. If specified, overrides eventWindowStyle for this specific event.

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

Parameters:
eventWindowStyle - eventWindowStyle Default value is null

getEventWindowStyle

public String getEventWindowStyle()
CSS style series to use for the draggable event window that represents this event. If specified, overrides eventWindowStyle for this specific event.

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

Returns:
String

setName

public void setName(String name)
String which represents the name of a CalendarEvent The name of this field within the CalendarEvent can be changed via nameField

Parameters:
name - name Default value is null

getName

public String getName()
String which represents the name of a CalendarEvent The name of this field within the CalendarEvent can be changed via nameField

Returns:
String

setStartDate

public void setStartDate(Date startDate)
Date object which represents the start date of a CalendarEvent. The name of this field within the CalendarEvent can be changed via startDateField

Parameters:
startDate - startDate Default value is null

getStartDate

public Date getStartDate()
Date object which represents the start date of a CalendarEvent. The name of this field within the CalendarEvent can be changed via startDateField

Returns:
java.util.Date

setEventId

public void setEventId(Integer eventId)

getEventId

public Integer getEventId()

setCanEdit

public void setCanEdit(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 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