Package com.smartgwt.client.widgets.calendar

Class Calendar

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.smartgwt.client.widgets.BaseWidget

com.smartgwt.client.widgets.Canvas

com.smartgwt.client.widgets.calendar.Calendar

All Implemented Interfaces:

HasAttachHandlers, HasHandlers, EventListener, HasVisibility, IsWidget, LogicalStructure, HasBackgroundClickHandlers, HasBackgroundMouseDownHandlers, HasBackgroundMouseUpHandlers, HasCurrentViewChangedHandlers, HasDateChangedHandlers, HasDayBodyClickHandlers, HasDayHeaderClickHandlers, HasEventAddedHandlers, HasEventChangedHandlers, HasEventClickHandlers, HasEventRemoveClickHandlers, HasEventRemovedHandlers, HasEventRepositionMoveHandlers, HasEventRepositionStopHandlers, HasEventResizeMoveHandlers, HasEventResizeStopHandlers, HasEventSaveErrorHandlers, HasEventsRenderedHandlers, HasIndicatorClickHandlers, HasZoneClickHandlers, DataBoundComponent, HasClearHandlers, HasClickHandlers, HasDoubleClickHandlers, HasDragCompleteHandlers, HasDragMoveHandlers, HasDragRepositionMoveHandlers, HasDragRepositionStartHandlers, HasDragRepositionStopHandlers, HasDragResizeMoveHandlers, HasDragResizeStartHandlers, HasDragResizeStopHandlers, HasDragStartHandlers, HasDragStopHandlers, HasDropCompleteHandlers, HasDropHandlers, HasDropMoveHandlers, HasDropOutHandlers, HasDropOverHandlers, HasFetchDataHandlers, HasFocusChangedHandlers, HasHoverHandlers, HasHoverHiddenHandlers, HasKeyDownHandlers, HasKeyPressHandlers, HasMouseDownHandlers, HasMouseMoveHandlers, HasMouseOutHandlers, HasMouseOverHandlers, HasMouseStillDownHandlers, HasMouseUpHandlers, HasMouseWheelHandlers, HasMovedHandlers, HasParentMovedHandlers, HasResizedHandlers, HasRightMouseDownHandlers, HasRuleContextChangedHandlers, HasScrolledHandlers, HasShowContextMenuHandlers, HasVisibilityChangedHandlers

Direct Known Subclasses:

Timeline

public class Calendar
extends Canvas
implements DataBoundComponent, HasBackgroundClickHandlers, HasBackgroundMouseDownHandlers, HasBackgroundMouseUpHandlers, HasCurrentViewChangedHandlers, HasDateChangedHandlers, HasDayBodyClickHandlers, HasDayHeaderClickHandlers, HasEventAddedHandlers, HasEventChangedHandlers, HasEventClickHandlers, HasEventRemoveClickHandlers, HasEventRemovedHandlers, HasEventRepositionMoveHandlers, HasEventRepositionStopHandlers, HasEventResizeMoveHandlers, HasEventResizeStopHandlers, HasEventSaveErrorHandlers, HasEventsRenderedHandlers, HasIndicatorClickHandlers, HasZoneClickHandlers

The Calendar component provides several different ways for a user to view and edit a set of events. Note that the standard Calendar module must be loaded to make use of the Calendar class.

CalendarEvents

Events are represented as ordinary JavaScript Objects (see CalendarEvent). The Calendar expects to be able to read and write a basic set of properties on events: name, startDate, endDate, description, etc, which can be stored under configurable property names (see eg startDateField).

Much like a ListGrid manages it's ListGridRecords, the Calendar can either be passed an ordinary Array of CalendarEvents or can fetch data from a DataSource. When this is the case, if the DataSource does not contain fields with the configured property names, an attempt is made to auto-detect likely-looking fields from those that are present. To see logs indicating that this has happened, switch default logging preferences to INFO level in the Developer Console.

If the calendar is bound to a DataSource, event changes by user action or by calling methods will be saved to the DataSource.

Navigation

The calendar supports a number of views by default: day, week, month and timeline. The user can navigate using back and forward buttons or via an attached DateChooser.

Event Manipulation

Events can be created by clicking directly onto one of the views, or via the Add Event button. In the day, week and timeline views, the user may click and drag to create an event of a specific duration.

Creating an event via click or click and drag pops up the EventDialog, which provides a simple form for quick event entry (for normal events, only the description is required by default - for events that are shown in a lane, that field is also required).

A separate editor called the EventEditor provides an interface for editing all possible properties of an event, including custom properties. The EventEditor is used whenever a pre-existing event is being edited, and can also be invoked by the user wherever the simpler EventDialog appears.

Events can also be programmatically added, removed, or updated.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled

Field Summary

Fields inherited from class com.smartgwt.client.widgets.BaseWidget

config, configOnly, factoryCreated, factoryProperties, id, nativeObject, scClassName

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor	Description
Calendar()
Calendar(JavaScriptObject jsObj)

Method Summary

Modifier and Type	Method	Description
HandlerRegistration	addBackgroundClickHandler(BackgroundClickHandler handler)	Add a backgroundClick handler.
HandlerRegistration	addBackgroundMouseDownHandler(BackgroundMouseDownHandler handler)	Add a backgroundMouseDown handler.
HandlerRegistration	addBackgroundMouseUpHandler(BackgroundMouseUpHandler handler)	Add a backgroundMouseUp handler.
void	addCalendarEvent(CalendarEvent event)	Create a new event in this calendar.
void	addCalendarEvent(CalendarEvent event, Map customValues)	Create a new event in this calendar.
HandlerRegistration	addCurrentViewChangedHandler(CurrentViewChangedHandler handler)	Add a currentViewChanged handler.
HandlerRegistration	addDateChangedHandler(DateChangedHandler handler)	Add a dateChanged handler.
HandlerRegistration	addDayBodyClickHandler(DayBodyClickHandler handler)	Add a dayBodyClick handler.
HandlerRegistration	addDayHeaderClickHandler(DayHeaderClickHandler handler)	Add a dayHeaderClick handler.
HandlerRegistration	addDragCompleteHandler(DragCompleteHandler handler)	Add a com.smartgwt.client.widgets.DragCompleteHandler.
HandlerRegistration	addDropCompleteHandler(DropCompleteHandler handler)	Add a com.smartgwt.client.widgets.DropCompleteHandler.
void	addEvent(Date startDate, Date endDate, String name, String description)	Create a new event in this calendar instance.
void	addEvent(Date startDate, Date endDate, String name, String description, Map otherFields)	Create a new event in this calendar instance.
HandlerRegistration	addEventAddedHandler(EventAddedHandler handler)	Add a eventAdded handler.
HandlerRegistration	addEventChangedHandler(EventChangedHandler handler)	Add a eventChanged handler.
HandlerRegistration	addEventClickHandler(EventClickHandler handler)	Add a eventClick handler.
HandlerRegistration	addEventRemoveClickHandler(EventRemoveClickHandler handler)	Add a eventRemoveClick handler.
HandlerRegistration	addEventRemovedHandler(EventRemovedHandler handler)	Add a eventRemoved handler.
HandlerRegistration	addEventRepositionMoveHandler(EventRepositionMoveHandler handler)	Add a eventRepositionMove handler.
HandlerRegistration	addEventRepositionStopHandler(EventRepositionStopHandler handler)	Add a eventRepositionStop handler.
HandlerRegistration	addEventResizeMoveHandler(EventResizeMoveHandler handler)	Add a eventResizeMove handler.
HandlerRegistration	addEventResizeStopHandler(EventResizeStopHandler handler)	Add a eventResizeStop handler.
HandlerRegistration	addEventSaveErrorHandler(EventSaveErrorHandler handler)	Add a eventSaveError handler.
HandlerRegistration	addEventsRenderedHandler(EventsRenderedHandler handler)	Add a eventsRendered handler.
HandlerRegistration	addFetchDataHandler(FetchDataHandler handler)	Add a fetchData handler.
void	addFormulaField()	Convenience method to display a {@link com.smartgwt.client..FormulaBuilder} to create a new Formula Field.
void	addIndicator(CalendarEvent indicator)	Adds a new indicator to the calendar.
HandlerRegistration	addIndicatorClickHandler(IndicatorClickHandler handler)	Add a indicatorClick handler.
void	addLane(Lane lane)	Adds a new Lane to the calendar, for display in the timeline view, and in the day view if showDayLanes is true.
void	addLaneEvent(Lane laneName, Date startDate)	Deprecated. in favor of addCalendarEvent()
void	addLaneEvent(Lane laneName, Date startDate, Date endDate)
void	addLaneEvent(Lane laneName, Date startDate, Date endDate, String name)
void	addLaneEvent(Lane laneName, Date startDate, Date endDate, String name, String description)
void	addLaneEvent(Lane laneName, Date startDate, Date endDate, String name, String description, Object otherFields)	Deprecated. in favor of addCalendarEvent()
void	addSummaryField()	Convenience method to display a {@link com.smartgwt.client..SummaryBuilder} to create a new Summary Field.
void	addZone(CalendarEvent zone)	Adds a new zone to the calendar.
HandlerRegistration	addZoneClickHandler(ZoneClickHandler handler)	Add a zoneClick handler.
Boolean	anySelected()	Whether at least one item is selected&#010
static boolean	calendarLoaded()	Static method indicating whether the optional Calendar module is loaded for the page.
void	cancelEditing()	Cancels the current edit-session, closing the builtin event dialog or editor and clearing any visible edit-selection from the current CalendarView.
static void	changeAutoChildDefaults(String autoChildName, Canvas defaults)	Changes the defaults for Canvas AutoChildren named autoChildName.
static void	changeAutoChildDefaults(String autoChildName, FormItem defaults)	Changes the defaults for FormItem AutoChildren named autoChildName.
protected JavaScriptObject	create()
Canvas	createEventCanvasComponent(EventCanvas canvas)	Called from EventCanvas.setEvent() when showEventCanvasComponents is true and an eventCanvas needs a component.
boolean	dateIsWorkday(Date date)	See dateIsWorkday(Date,String).
boolean	dateIsWorkday(Date date, String laneName)	Should the parameter date be considered a workday? By default this method tries to find the parameter date day in workdays, and returns true if found.
void	deselectAllRecords()	&#010 Deselect all records&#010&#010
Boolean	deselectEvent(CalendarEvent event)	Removes an event from the list of selected events in the current view, clearing its selected style.
Boolean	deselectEvents(CalendarEvent... events)	Removes one or more events from the list of selected events in the current view, clearing their selected styles.
void	deselectRecord(int record)	Deselect a Record passed in explicitly, or by index.
void	deselectRecord(Record record)	Deselect a Record passed in explicitly, or by index.
void	deselectRecords(int[] records)	Deselect a list of Records passed in explicitly, or by index.
void	deselectRecords(Record[] records)	Deselect a list of Records passed in explicitly, or by index.
void	disableHilite(String hiliteID)	Disable a hilite&#010&#010
void	disableHiliting()	Disable all hilites.&#010&#010
void	editFields()	Shows a FieldPicker interface allowing end-users to rearrange the order and visibiility of the fields in the associated DataBoundComponent.
void	editHilites()	Shows a HiliteEditor interface allowing end-users to edit the data-hilites currently in use by this DataBoundComponent.
void	enableHilite(String hiliteID)	Enable / disable a hilites&#010&#010
void	enableHilite(String hiliteID, boolean enable)	Enable / disable a hilites&#010&#010
void	enableHiliting()	Enable all hilites.&#010&#010
void	enableHiliting(boolean enable)	Enable all hilites.&#010&#010
boolean	eventMoved(Date newDate, CalendarEvent event, String newLane)	Deprecated. in favor of Calendar.eventRepositionStop()
Boolean	eventRepositionStart(CalendarEvent event)	Notification fired when a user drags an EventCanvas.
boolean	eventResized(Date newDate, CalendarEvent event)	Deprecated. in favor of Calendar.eventResizeStop()
void	exportData()	See DataBoundComponent.exportData(com.smartgwt.client.data.DSRequest,com.smartgwt.client.rpc.RPCCallback)
void	exportData(DSRequest requestProperties)	See DataBoundComponent.exportData(com.smartgwt.client.data.DSRequest,com.smartgwt.client.rpc.RPCCallback)
void	exportData(DSRequest requestProperties, RPCCallback callback)	Uses a "fetch" operation on the current DataSource to retrieve data that matches the current filter and sort criteria for this component, then exports the resulting data to a file or window in the requested format.
void	fetchData()	Retrieves data from the DataSource that matches the specified criteria.
void	fetchData(Criteria criteria)	Retrieves data from the DataSource that matches the specified criteria.
void	fetchData(Criteria criteria, DSCallback callback)	Retrieves data from the DataSource that matches the specified criteria.
void	fetchData(Criteria criteria, DSCallback callback, DSRequest requestProperties)	Retrieves data from the DataSource that matches the specified criteria.
void	filterData()	Retrieves data that matches the provided criteria and displays the matching data in this component.
void	filterData(Criteria criteria)	Retrieves data that matches the provided criteria and displays the matching data in this component.
void	filterData(Criteria criteria, DSCallback callback)	Retrieves data that matches the provided criteria and displays the matching data in this component.
void	filterData(Criteria criteria, DSCallback callback, DSRequest requestProperties)	Retrieves data that matches the provided criteria and displays the matching data in this component.
Record	find(AdvancedCriteria adCriteria)	Filters all objects according to the AdvancedCriteria passed and returns the first matching object or null if not found
Record[]	findAll(AdvancedCriteria adCriteria)	Filters all objects according to the AdvancedCriteria passed
int	findIndex(AdvancedCriteria adCriteria)	Finds the index of the first Record that matches with the AdvacendCriteria passed.
int	findNextIndex(int startIndex, AdvancedCriteria adCriteria)	Like RecordList.findIndex(java.util.Map), but considering the startIndex parameter.
int	findNextIndex(int startIndex, AdvancedCriteria adCriteria, int endIndex)	Like RecordList.findIndex(java.util.Map), but considering the startIndex and endIndex parameters.
Integer	getActiveDay()	Gets the day of the week (0-6) that the mouse is currently over.
Date	getActiveTime()	Gets a date object representing the date over which the mouse is hovering for the current selected view.
Boolean	getAddDropValues()	Indicates whether to add "drop values" to items dropped on this component, if both the source and target widgets are databound, either to the same DataSource or to different DataSources that are related via a foreign key.
ImgButton	getAddEventButton()	An ImgButton that appears in a Calendar's week/day/month views and offers an alternative way to create a new event.
String	getAddEventButtonHoverText()	The text to be displayed when a user hovers over the add event toolbar button
String	getAddFormulaFieldText()	Text for a menu item allowing users to add a formula field
String	getAddOperation()	operationId this component should use when performing add operations.
String	getAddSummaryFieldText()	Text for a menu item allowing users to add a formula field
Boolean	getAllowDurationEvents()	When set to true, allows events to be managed by duration, as well as by end date.
Boolean	getAlternateLaneStyles()	When showing a Timeline, or a day view when showDayLanes is true, whether to make lane boundaries more obvious by showing alternate lanes in a different color.
Boolean	getAlwaysShowEventHovers()	By default, EventCanvases show their content in hovers.
Boolean	getAutoFetchAsFilter()	If DataBoundComponent.setAutoFetchData(Boolean) is true, this attribute determines whether the initial fetch operation should be performed via DataBoundComponent.fetchData() or DataBoundComponent.filterData()
Boolean	getAutoFetchData()	If true, when this component is first drawn, automatically call DataBoundComponent.fetchData() or DataBoundComponent.filterData() depending on DataBoundComponent.getAutoFetchAsFilter() .
TextMatchStyle	getAutoFetchTextMatchStyle()	If autoFetchData is true, this attribute allows the developer to specify a textMatchStyle for the initial DataBoundComponent.fetchData() call.
String	getBackButtonIconSrc()	The icon to show in the month-button on Handsets when the month view is the current visible view.
String	getBackButtonTitle()	The title of the month on Handsets when the month view is the current visible view.
String	getBaseStyle()	The base name for the CSS class applied to the grid cells of the day and week views of the calendar.
Boolean	getBringEventsToFront()	If set to true, clicking an event will bring it to the front of the zorder.
String	getCalMonthEventLinkStyle()	The base name for the CSS class applied to the links rendered by getDayBodyHTML().
Boolean	getCanAddFormulaFields()	Adds an item to the header context menu allowing users to launch a dialog to define a new&#010 field based on values present in other fields, using the {@link com.smartgwt.client..FormulaBuilder}.&#010
Boolean	getCanAddSummaryFields()	Adds an item to the header context menu allowing users to launch a dialog to define a new&#010 text field that can contain both user-defined text and the formatted values present in other &#010 fields, using the {@link com.smartgwt.client..SummaryBuilder}.&#010
IButton	getCancelButton()	An com.smartgwt.client.types.AutoChild of type IButton, used to cancel editing of an event and close the eventEditor.
String	getCancelButtonTitle()	The title for the Cancel button in the event editor.
Boolean	getCanCreateEvents()	If true, users can create new events.
Boolean	getCanCreateOtherDayEvents()	When showOtherDays is true, determines whether clicking in a Month-view body-cell that represents a date outside the selected month will open the event-editor window at the cell's location.
Boolean	getCanDeleteEvents()	Deprecated. in favor of canRemoveEvents
Boolean	getCanDragCreateEvents()	A boolean value controlling whether new events of varying length can be created by dragging the cursor.
String	getCanDragEventField()	Name of the field on each CalendarEvent that determines whether an EventCanvas can be moved or resized by dragging with the mouse.
Boolean	getCanDragEvents()	A boolean value controlling whether users can drag-reposition events.
Boolean	getCanEditEvents()	If true, users can edit existing events.
String	getCanEditField()	Name of the field on each CalendarEvent that determines whether it can be edited in the event editor.
Boolean	getCanEditLane()	Can events be moved between lanes? If so, the event can be dragged to a different lane, and the event quick dialog and editor allow a lane to be selected with a drop-down chooser.
String	getCanEditLaneField()	Name of the field on each CalendarEvent that determines whether that event can be moved between lanes.
Boolean	getCanEditSublane()	Can events be moved between sublanes?
String	getCanEditSublaneField()	Name of the field on each CalendarEvent that determines whether that event can be moved between individual sublanes in a Lane.
Boolean	getCanGroupLanes()	If true, allows the lanes in a Timeline to be grouped by providing a value for laneGroupByField.
Boolean	getCanRemoveEvents()	If true, users can remove existing events.
String	getCanRemoveField()	Name of the field on each CalendarEvent that determines whether an event shows a remove button.
Boolean	getCanReorderLanes()	If true, lanes can be reordered by dragging their laneFields with the mouse.
String	getCanResizeEventField()	Name of the field on each CalendarEvent that determines whether an event can be resized by dragging.
Boolean	getCanResizeEvents()	Can events be resized by dragging appropriate edges of the canvas? Only has an effect when both canEditEvents and canDragEvents are true.
Boolean	getCanResizeTimelineEvents()	Deprecated. in favor of canResizeEvents;
Boolean	getCanSelectEvents()	When set to true, makes individual event canvases selectable.
Date	getCellDate()	Return the Date instance associated with the passed co-ordinates in the passed or selected view.
Date	getCellDate(Integer rowNum)
Date	getCellDate(Integer rowNum, Integer colNum)
Date	getCellDate(Integer rowNum, Integer colNum, CalendarView view)	Return the Date instance associated with the passed co-ordinates in the passed or selected view.
String	getCellHoverHTML(CalendarView view, Record record, Integer rowNum, Integer colNum, Date date, String defaultValue)	Returns the hover HTML for the cell at the passed co-ordinates in the passed view.
Date	getChosenDate()	The date for which events are displayed in the day, week, and month tabs of the calendar.
VLayout	getColumnLayout()	Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists.
Integer	getColumnsPerPage()	When using the Next and Previous arrows to scroll a Timeline, this is the number of columns of the timelineGranularity to scroll by.
String	getControlBarIconBaseStyle()	A CSS style to apply to icons in the controlsBar.
Integer	getControlBarIconSize()	The size of the various icons displayed in the controlsBar of this Calendar.
HLayout	getControlsBar()	An HLayout shown above the Calendar views and displaying a set of controls for interacting with the current view - namely, the next, previous and add buttons, the date label and the date-picker icon.
Integer	getControlsBarHeight()	Default height of the controlsBar shown above the main Calendar grid.
ViewName	getCurrentViewName()	The name of the view that should be visible initially by default.
CalendarEvent[]	getData()	A List of CalendarEvent objects, specifying the data to be used to populate the calendar.
JavaScriptObject	getDataAsJSList()
FetchMode	getDataFetchMode()	How to fetch and manage records retrieve from the server.
int	getDataPageSize()	When using data paging, how many records to fetch at a time.
DataSource	getDataSource()	The DataSource that this component should bind to for default fields and for performing DataSource requests.
String	getDateCellAlign(Date date, Integer rowNum, Integer colNum, CalendarView view)	When getDateHTML returns a value, this method returns the horizontal alignment for that value in its cell, in the passed view.
String	getDateCellVAlign(Date date, Integer rowNum, Integer colNum, CalendarView view)	When getDateHTML returns a value, this method returns the vertical alignment for that value in its cell, in the passed view.
DateChooser	getDateChooser()	DateChooser used to select the date for which events will be displayed.
String	getDateCSSText(Date date, Integer rowNum, Integer colNum, CalendarView view)	Return CSS text for styling the cell associated with the passed date and/or rowNum & colNum, which will be applied in addition to the CSS class for the cell, as overrides.
DateEditingStyle	getDateEditingStyle()	Indicates the type of controls to use in event-windows.
DateDisplayFormat	getDateFormatter()	Date formatter for displaying events.
Date	getDateFromPoint()	Returns a Date instance representing the point at the passed offsets into the body of the current view.
Date	getDateFromPoint(Integer x)
Date	getDateFromPoint(Integer x, Integer y)
Date	getDateFromPoint(Integer x, Integer y, Boolean snapOffsets)
Date	getDateFromPoint(Integer x, Integer y, Boolean snapOffsets, CalendarView view)	Returns a Date instance representing the point at the passed offsets into the body of the current view.
String	getDateHeaderTitle(Date date, int dayOfWeek, String defaultValue, CalendarView view)	Return the title text to display in the header-button of the ListGridField showing the passed date, in the passed view.
String	getDateHTML(Date date, Integer rowNum, Integer colNum, CalendarView view)	Return the HTML to be displayed in the associated date-cell in the passed view.
Label	getDateLabel()	The com.smartgwt.client.types.AutoChild Label used to display the current date or range above the selected calendar view.
String	getDateLabelText(String viewName, Date startDate, Date endDate)	Returns the text to display with the navigation buttons above the Calendar - indicates the visible date range.
ImgButton	getDatePickerButton()	An ImgButton that appears above the various views of the calendar and offers alternative access to a DateChooser to pick the current day.
String	getDatePickerHoverText()	The text to be displayed when a user hovers over the date picker toolbar button
String	getDateStyle(Date date, Integer rowNum, Integer colNum, CalendarView view)	Return the CSS styleName for the associated date-cell in the passed view.
String	getDayBodyBaseStyle()	The base name for the CSS class applied to the day body of the month view of the calendar.
protected String	getDayBodyHTML(Date date, CalendarEvent[] events, Calendar calendar, int rowNum, int colNum)	Return the HTML to be shown in the body of a day in the month view.
String	getDayHeaderBaseStyle()	The base name for the CSS class applied to the day headers of the month view.
CalendarView	getDayView()	CalendarView used to display events that pertain to a given day.
String	getDayViewTitle()	The title for the day view.
Boolean	getDeepCloneOnEdit()	Before we start editing values in this DataBoundComponent, should we perform a deep clone of the underlying values.
int	getDefaultTimelineColumnSpan()	The number of columns of the timelineGranularity to give the timeline by default if no endDate is provided.
String	getDescriptionField()	The name of the description field on a CalendarEvent.
String	getDetailsButtonTitle()	The title for the edit button in the quick quick event dialog.
Boolean	getDisableWeekends()	If true, weekend days appear in a disabled style and events cannot be created on weekends.
Record[]	getDragData()	During a drag-and-drop interaction, this method returns the set of records being dragged out of the component.
DragDataAction	getDragDataAction()	Indicates what to do with data dragged into another DataBoundComponent.
String	getDragHoverHTML(CalendarView view, CalendarEvent event, String defaultValue)	Returns the HTML to show in a hover when an existing event is dragged, or when a new event is being created by dragging with the mouse.
String	getDragTrackerStyle()	CSS Style to apply to the drag tracker when dragging occurs on this component.
Map	getDropValues()	When an item is dropped on this component, and addDropValues is true and both the source and target widgets are databound, either to the same DataSource or to different DataSources that are related via a foreign key, this object provides the "drop values" that Smart GWT will apply to the dropped object before updating it.
String	getDuplicateDragMessage()	Message to show when a user attempts to transfer duplicate records into this component, and&#010 preventDuplicates is enabled.
String	getDurationField()	The name of the duration field on a CalendarEvent.
String	getDurationUnitField()	The name of the durationUnit field on a CalendarEvent.
String	getEditFormulaFieldText()	Text for a menu item allowing users to edit a formula field
String	getEditSummaryFieldText()	Text for a menu item allowing users to edit the formatter for a field
Date	getEndDate()	The end date of the calendar timeline view.
String	getEndDateField()	The name of the end date field on a CalendarEvent.
Boolean	getEventAutoArrange()	If set to true, enables the auto-arrangement of events that share time in the calendar.
String	getEventBodyHTML(CalendarEvent event)	Returns the description text for the passed event, for display in the body area of an event canvas.
String	getEventBodyHTML(CalendarEvent event, CalendarView view)	Returns the description text for the passed event, for display in the body area of an event canvas.
EventCanvas	getEventCanvas()	Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists.
HLayout	getEventCanvasButtonLayout()	HLayout that snaps to the top-right of an event canvas on rollover and contains the close and/or context buttons.
ImgButton	getEventCanvasCloseButton()	The close button that snaps to the top-right of an event canvas on rollover and allows an event to be removed from a CalendarView.
Integer	getEventCanvasCloseButtonSize()	The size of the close-button that snaps to the top-right of an event canvas on rollover and shows allows an event to be removed from a CalendarView.
Integer	getEventCanvasCloseIconSize()	The size of the icon in the close-button floated over events on rollover.
Canvas	getEventCanvasComponent()	Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists.
ImgButton	getEventCanvasContextButton()	The context button that snaps to the top-right of an event canvas on rollover and shows a custom context menu when clicked.
Menu	getEventCanvasContextMenu()	Context menu displayed when an event canvas is right-clicked, or when the rollover context button is clicked.
Img	getEventCanvasGripper()	Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists.
Img	getEventCanvasHResizer()	Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists.
Label	getEventCanvasLabel()	Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists.
String	getEventCanvasStyle(CalendarEvent event)	Returns the styleName to use for the passed event, in the passed view.
String	getEventCanvasStyle(CalendarEvent event, CalendarView view)	Returns the styleName to use for the passed event, in the passed view.
Img	getEventCanvasVResizer()	Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists.
String	getEventDescriptionFieldTitle()	The title for the descriptionField field in the quick event dialog and the detailed editor.
Window	getEventDialog()	An com.smartgwt.client.types.AutoChild of type Window that displays a quick event entry form in a popup window.
Integer	getEventDragGap()	The number of pixels to leave to the right of events so overlapping events can still be added using the mouse.
String	getEventDurationFieldTitle()	The title for the duration field in the quick event dialog and the detailed editor.
String	getEventDurationUnitFieldTitle()	The title for the duration unit field in the quick event dialog and the detailed editor.
DynamicForm	getEventEditor()	An com.smartgwt.client.types.AutoChild of type DynamicForm which displays event data.
HLayout	getEventEditorButtonLayout()	An com.smartgwt.client.types.AutoChild of type HLayout which houses the Save, Remove and Cancel buttons in the eventEditor.
Object[]	getEventEditorButtons()	The list of buttons to include in the eventEditor.
String	getEventEditorDateFieldTitle()	The title for the Date-field in the eventEditor that allows for changing the logical start-date of an event, along with its start and end times, when editing events in the day and week views.
Window	getEventEditorLayout()	An com.smartgwt.client.types.AutoChild of type Window that displays the full event editor
Date	getEventEndDate(CalendarEvent event)	Returns the end date of the passed event.
String	getEventEndDateFieldTitle()	The title for the endDateField in the quick event dialog and the detailed editor.
int	getEventHeaderHeight()	When eventHeaderWrap is false and showEventDescriptions is true, this is the fixed height for the header area in event canvases.
String	getEventHeaderHTML(CalendarEvent event)	Returns the title text for the passed event, which is displayed in the header area of an eventCanvas rendered in a vertical or horizontal view, or as a clickable link in a cell in a Month view.
String	getEventHeaderHTML(CalendarEvent event, CalendarView view)	Returns the title text for the passed event, which is displayed in the header area of an eventCanvas rendered in a vertical or horizontal view, or as a clickable link in a cell in a Month view.
boolean	getEventHeaderWrap()	When rendering the canvas for an event, whether to allow the content of the header area to wrap to multiple lines.
String	getEventHoverHTML(CalendarEvent event, EventCanvas eventCanvas, CalendarView view)	Gets the hover HTML for an event being hovered over.
String	getEventHoverHTML(CalendarEvent event, EventCanvas eventCanvas, CalendarView view, String defaultValue)	Gets the hover HTML for an event being hovered over.
Lane	getEventLane(CalendarEvent event)	Returns the lane associated with the passed event, in the passed view
Lane	getEventLane(CalendarEvent event, CalendarView view)	Returns the lane associated with the passed event, in the passed view
String	getEventLaneFieldTitle()	The title for the laneNameField in the quick event dialog and the detailed editor.
void	getEventLength(CalendarEvent event)	Returns the length of the passed event in the passed unit.
void	getEventLength(CalendarEvent event, TimeUnit unit)	Returns the length of the passed event in the passed unit.
String	getEventNameFieldTitle()	The title for the nameField in the quick event dialog and the detailed editor.
Boolean	getEventOverlap()	When eventAutoArrange is true, setting eventOverlap to true causes events that share timeslots to overlap each other by a percentage of their width, specified by eventOverlapPercent.
Boolean	getEventOverlapIdenticalStartTimes()	When set to true, events that start at the same time will not overlap each other to prevent events having their close button hidden.
int	getEventOverlapPercent()	The size of the overlap, presented as a percentage of the width of events sharing timeslots.
String	getEventScreen()	Screen to create (via createScreen()) in lieu of calling createEventCanvasComponent().
Integer	getEventSnapGap()	The number of minutes that determines the positions to which events will snap when rendered, and when moved or resized with the mouse.
Date	getEventStartDate(CalendarEvent event)	Returns the start date of the passed event.
String	getEventStartDateFieldTitle()	The title for the startDateField in the quick event dialog and the detailed editor.
String	getEventStyleName()	The base name for the CSS class applied to events when they're rendered in calendar views.
String	getEventStyleNameField()	The name of the field used to override eventStyleName for an individual CalendarEvent.styleName.
Lane	getEventSublane(CalendarEvent event)	Returns the sublane associated with the passed event, in the passed view
Lane	getEventSublane(CalendarEvent event, CalendarView view)	Returns the sublane associated with the passed event, in the passed view
String	getEventSublaneFieldTitle()	The title for the sublaneNameField in the quick event dialog and the detailed event editor.
String	getEventWindowStyle()	Deprecated. in favor of eventStyleName
String	getEventWindowStyleField()	Deprecated. in favor of eventStyleNameField
Boolean	getExportAll()	Setting exportAll to true prevents the component from passing its list of fields to the &#010 export call.
String[]	getExportFields()	The list of field-names to export.
Boolean	getExportIncludeSummaries()	If Summary rows exist for this component, whether to include them when exporting client data.
String	getFetchOperation()	Operation ID this component should use when performing fetch operations.
Alignment[]	getFieldAlignments()	Returna an array of field alignments for this grid
int	getFieldCount()	Return the number of fields.
JavaScriptObject[]	getFieldsAsJavaScriptObjects()	Return the fields as JavaScriptObjects rather than as SmartGWT Java wrappers of the field class type (e.g.
Integer	getFirstDayOfWeek()	The numeric day (0-6, Sunday-Saturday) which the calendar should consider as the first day of the week in multi-day views, and in the popup DateChooser.
String	getHeaderHoverHTML(CalendarView view, HeaderLevel headerLevel, Date startDate, Date endDate, String defaultValue)	Returns the hover HTML to show in a hover when the mouse moves over the header area.
HeaderLevel[]	getHeaderLevels()	Configures the levels of headers shown above the event area, and their time units.
Boolean	getHideUnusedLanes()	When set to true, hides any lane that doesn't have any active events in the current dataset.
String	getHiliteProperty()	Marker that can be set on a record to flag that record as hilited.
Hilite[]	getHilites()	Return the set of hilite-objects currently applied to this DataBoundComponent.
String	getHiliteState()	Get the current hilites encoded as a String, for saving.
Criteria	getImplicitCriteria()	Criteria that are never shown to or edited by the user and are cumulative with any criteria provided via DataBoundComponent.initialCriteria, DataBoundComponent.setCriteria() etc.
Boolean	getIncludeRangeCriteria()	When set to true, the default, the fetches issued by navigating around in the various views are limited to the accessible date-range in the current view - as you change the current date-range, a fetch is only issued if the new range is not entirely within the previous range.
IndicatorCanvas	getIndicatorCanvas()	Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists.
String	getIndicatorCanvasStyle(CalendarEvent indicator)	Returns the styleName to use for the passed indicator, in the passed view.
String	getIndicatorCanvasStyle(CalendarEvent indicator, CalendarView view)	Returns the styleName to use for the passed indicator, in the passed view.
String	getIndicatorHoverHTML(CalendarEvent indicator, IndicatorCanvas indicatorCanvas, CalendarView view, String defaultValue)	Gets the hover HTML for an indicator being hovered over.
CalendarEvent[]	getIndicators()	An array of CalendarEvent instances representing instants in time, to be highlighted in timeline views.
String	getIndicatorStyleName()	CSS style to apply to the canvases created for each specified indicator.
Criteria	getInitialCriteria()	Criteria to use when DataBoundComponent.setAutoFetchData(Boolean) is used.
String	getInvalidDateMessage()	The message to display in the eventEditor when the 'To' date is greater than the 'From' date and a save is attempted.
Lane	getLane(String lane)	Returns the lane with the passed name, in the passed view
Lane	getLane(String lane, CalendarView view)	Returns the lane with the passed name, in the passed view
Integer	getLaneEventPadding()	The pixel space to leave between events and the edges of the lane or sublane they appear in.
CalendarEvent[]	getLaneEvents(Lane lane)	For views that support lanes, returns the array of events in the current dataset that apply to the passed lane in the passed or current view.
CalendarEvent[]	getLaneEvents(Lane lane, CalendarView view)	For views that support lanes, returns the array of events in the current dataset that apply to the passed lane in the passed or current view.
CalendarEvent[]	getLaneEvents(String lane)	For views that support lanes, returns the array of events in the current dataset that apply to the passed lane in the passed or current view.
ListGridField[]	getLaneFields()	Field definitions for the frozen area of the timelineView, which shows data about the timeline lanes.
Lane	getLaneFromPoint()	Returns the Lane at the passed co-ordinates.
Lane	getLaneFromPoint(Integer x)
Lane	getLaneFromPoint(Integer x, Integer y)
Lane	getLaneFromPoint(Integer x, Integer y, CalendarView view)	Returns the Lane at the passed co-ordinates.
String	getLaneGroupByField()	For timelines with canGroupLanes set to true, this is a field name or array of field names on which to group the lanes in a timeline.
String[]	getLaneGroupByFieldAsString()	Deprecated. in favor of getLaneGroupByFieldAsStringArray().
String[]	getLaneGroupByFieldAsStringArray()	For timelines with canGroupLanes set to true, this is a field name or array of field names on which to group the lanes in a timeline.
String	getLaneNameField()	The name of the field which will determine the lane in which a given event will be displayed in Timelines and in the day view, if showDayLanes is true.
Integer	getLanePadding()	For views that support lanes, returns the padding to apply to events rendered in lanes in the passed or current view.
Integer	getLanePadding(CalendarView view)	For views that support lanes, returns the padding to apply to events rendered in lanes in the passed or current view.
Lane[]	getLanes()	An array of Lane definitions that represent the rows of the timelineView, or the columns of the dayView if showDayLanes is true.
String	getLeadingDateField()	The name of the leading date field for each event.
Boolean	getLimitToWorkday()	When showWorkday is true, this attribute prevents the user from scrolling vertical views beyond the specified workday start and end hours.
LogicalStructureObject	getLogicalStructure()	Getter implementing the LogicalStructure interface, which supports Eclipse's logical structure debugging facility.
TabSet	getMainView()	TabSet for managing calendar views when multiple views are available (eg, day and month).
boolean	getMinimalUI()	A boolean value controlling whether the Calendar shows tabs for available calendar views.
Integer	getMinimumDayHeight()	In the month view when showDayHeaders is true, this is the minimum height applied to a day cell and its header combined.
Integer	getMinLaneWidth()	When showing vertical lanes in the dayView, this attribute sets the minimum width of each column or field.
int	getMinRowHeight()	The minimum height of time-rows in vertical calendar views.
Integer	getMinutesPerRow()	The number of minutes per row in day and week views.
NavigationButton	getMonthButton()	A NavigationButton that appears to the left of other navigation controls in the controls bar on Handset devices.
String	getMonthButtonIconSrc()	The icon to show next to the month-name in the month button, used for showing and hiding the month view on Handsets.
String	getMonthButtonTitle()	The title of the month button, used for showing and hiding the month view on Handsets.
String	getMonthMoreEventsLinkTitle()	The title of the link shown in a cell of a month view when there are too many events to be displayed at once.
Menu	getMonthMoreEventsMenu()	AutoChild Menu, shown when a user clicks the more events link in a cell of the monthView.
CalendarView	getMonthView()	CalendarView used to display events that pertain to a given month.
String	getMonthViewHoverHTML(Date date, CalendarEvent... events)	This method returns the hover HTML to be displayed when the user hovers over a cell displayed in the calendar month view tab.
String	getMonthViewTitle()	The title for the month view.
String	getNameField()	The name of the name field on a CalendarEvent.
String	getNewEventWindowTitle()	The title-text displayed in the popup event dialog/editor for new events.
ImgButton	getNextButton()	An ImgButton that appears above the week/day/month views of the calendar and allows the user to move the calendar forwards in time.
String	getNextButtonHoverText()	The text to be displayed when a user hovers over the next toolbar button
static Calendar	getOrCreateRef(JavaScriptObject jsObj)
String	getOtherDayBlankStyle()	The CSS style applied to both the header and body of days from other months in the month view, when showOtherDays is false.
String	getOtherDayBodyBaseStyle()	The base name for the CSS class applied to the day body of the month view of the calendar.
Boolean	getOtherDayClickNavigation()	When showOtherDays is true, this attribute determines whether the month-view should change month when cells representing days in the previous or following month are clicked.
String	getOtherDayHeaderBaseStyle()	The base name for the CSS class applied to the day headers of the month view.
SortSpecifier[]	getOverlapSortSpecifiers()	A set of sort-specifiers for customizing the render order of events that overlap.
Date	getPeriodEndDate()	Returns the end of the period selected in the passed, or current, calendar view.
Date	getPeriodEndDate(CalendarView view)	Returns the end of the period selected in the passed, or current, calendar view.
Date	getPeriodStartDate()	Returns the start of the selected week or month depending on the current calendar view.
Date	getPeriodStartDate(CalendarView view)	Returns the start of the selected week or month depending on the current calendar view.
Boolean	getPreventDuplicates()	If set, detect and prevent duplicate records from being transferred to this component, either via&#010 drag and drop or via DataBoundComponent.transferSelectedData(com.smartgwt.client.widgets.DataBoundComponent).
ImgButton	getPreviousButton()	An ImgButton that appears above the week/day/month views of the calendar and allows the user to move the calendar backwards in time.
String	getPreviousButtonHoverText()	The text to be displayed when a user hovers over the previous toolbar button.
Boolean	getProgressiveLoading()	Indicates whether or not this component will load its data progressively
int	getRecordIndex(Record record)	Get the index of the provided record.&#010
RecordList	getRecordList()	Return the underlying data of this DataBoundComponent as a RecordList.
IButton	getRemoveButton()	An com.smartgwt.client.types.AutoChild of type IButton, used to permanently remove an event from the eventEditor.
String	getRemoveButtonTitle()	The title for the Remove button in the event editor.
String	getRemoveOperation()	operationId this component should use when performing remove operations.
boolean	getRenderEventsOnDemand()	When set to true, the default, each event is rendered as it appears in the viewport.
ResultSet	getResultSet()	Return the underlying data of this DataBoundComponent as a ResultSet.
int	getRowHeight()	The height of time-slots in the calendar.
Integer	getRowTitleFrequency()	A minute value that indicates which rows should show times in vertical views, like day and week.
IButton	getSaveButton()	An com.smartgwt.client.types.AutoChild of type IButton, used to save an event from the eventEditor.
String	getSaveButtonTitle()	The title for the Save button in the quick event dialog and the event editor.
String	getSavedSearchId()	Optional identifier for saved searches that should be applied to this component.
Boolean	getScrollToWorkday()	If set, and showWorkday is true, automatically scrolls the day and week views to the start of the workday when the calendar is first displayed and whenever the user changes to a different day or week.
Boolean	getSelectChosenDate()	When true, shows the current chosenDate in a selected style in the month view.
String	getSelectedCellStyle()	The base name for the CSS class applied to a cell that is selected via a mouse drag.
CalendarEvent	getSelectedEvent()	Returns the currently selected event, or the first one if more than one is selected.
CalendarEvent[]	getSelectedEvents()	Returns the currently selected list of events.
CalendarView	getSelectedView()	Returns the currently selected view.
Boolean	getShowAddEventButton()	Set to false to hide the Add Event button.
Boolean	getShowCellHovers()	When showViewHovers is true, dictates whether to display hover prompts when the mouse rolls over the normal cells in the body of CalendarViews.
Boolean	getShowColumnLayouts()	When true, causes layouts to be added to each column in vertical views.
Boolean	getShowComplexFields()	Whether to show fields of non-atomic types when a DataBoundComponent is given a&#010 DataSource but no component.fields.&#010
Boolean	getShowControlsBar()	If false the controls bar at the top of the calendar will not be displayed - this means that the controlsBar will be hidden, so the autoChildren (previousButton, dateLabel, nextButton, addEventButton, and datePickerButton) will not be created or shown.
Boolean	getShowDateChooser()	Determines whether the dateChooser is displayed.
Boolean	getShowDatePickerButton()	Set to false to hide the datePickerButton that allows selecting a new base date for this Calendar.
Boolean	getShowDayHeaders()	If true, the default, show a header cell for each day cell in the month view, with both cells having a minimum combined height of minimumDayHeight.
Boolean	getShowDayLanes()	If set to true, the day view uses lanes to render multiple vertical "lanes" within the day, very much like a vertical Timeline.
Boolean	getShowDayView()	Whether to show the Day view.
Boolean	getShowDetailFields()	Whether to show fields marked detail:true when a DataBoundComponent is given a DataSource but no component.fields.
Boolean	getShowDragHovers()	When showViewHovers is true, dictates whether to display hover prompts when an event is being dragged with the mouse.
boolean	getShowEventCanvasComponents()	Whether event-canvases should show a custom widget as content, rather than the default header and body HTML.
boolean	getShowEventDescriptions()	When rendering the canvas for an event, whether to show the body area, typically containing brief details of the event - by default, its description.
boolean	getShowEventHeaders()	When rendering the canvas for an event, whether to show the header area, typically containing suitable title text - by default, the event's name.
Boolean	getShowEventHovers()	When showViewHovers is true, dictates whether to display hover prompts when the mouse moves over an event canvas in a calendarView.
Boolean	getShowHeaderHovers()	When showViewHovers is true, dictates whether to display hover prompts when the mouse rolls over the header levels in a CalendarView.
Boolean	getShowHiddenFields()	Whether to show fields marked hidden:true when a DataBoundComponent is given a&#010 DataSource but no component.fields.&#010
Boolean	getShowIndicators()	Set to true to render any defined indicators into timeline views.
boolean	getShowIndicatorsInFront()	In indicator lines are showing, this attribute affects where in the z-order their canvases will be rendered: either in front of, or behind normal calendar events.
boolean	getShowLabelColumn()	When set to false, hides the frozen Label-Column in vertical CalendarViews.
Boolean	getShowLaneFieldHovers()	When showViewHovers is true, dictates whether to display hover prompts when the mouse moves over the cells in a laneField.
Boolean	getShowLaneRollOver()	When set to true, causes Timelines to highlight the Lane under the mouse with the "Over" style.
Boolean	getShowMonthButton()	Set to false to prevent the Month button from displaying on Handset devices.
Boolean	getShowMonthView()	Whether to show the Month view.
Boolean	getShowNextButton()	Set to false to hide the Next button.
Boolean	getShowOtherDays()	If set to true, in the month view, days that fall in an adjacent month are still shown with a header and body area, and are interactive.
Boolean	getShowPreviousButton()	Set to false to hide the Previous button.
Boolean	getShowQuickEventDialog()	Determines whether the quick event dialog is displayed when a time is clicked.
boolean	getShowSavedSearchesByDS()	Whether to associate saved searches by default with the current DataSource of a component when a savedSearchId is not provided.
Boolean	getShowTimelineView()	If set to true, show the Timeline view.
Boolean	getShowViewHovers()	When set to true, the default value, causes the Calendar to show customizable hovers when the mouse moves over various areas of a CalendarView.
Boolean	getShowWeekends()	Suppresses the display of weekend days in the week, month and timeline views, and disallows the creation of events on weekends.
Boolean	getShowWeekView()	Whether to show the Week view.
Boolean	getShowWorkday()	When set to true, this setting enables various features related to cells that fall within the workday (as defined by workdayStart and workdayEnd) in vertical calendar views (day and week).
Boolean	getShowZoneHovers()	When showViewHovers is true, dictates whether to display hover prompts when the mouse moves over a zone in a calendarView.
Boolean	getShowZones()	Set to true to render any defined zones into timeline views.
Boolean	getSizeEventsToGrid()	If true, events will be sized to the grid, even if they start and/or end at times between grid cells.
Boolean	getSizeToWorkday()	When showWorkday is true, attempt to resize rows in the day and week views so that the workday hours fill the visible viewport-height, and the whole workday is visible without scrolling.
SortSpecifier[]	getSort()	Returns the current SortSpecifiers for this component.
Boolean	getSparseFieldState()	If true, ListGrid.getFieldState() and ListGrid.setFieldState(java.lang.String) will omit state information for hidden fields by default.
Date	getStartDate()	The start date of the calendar timeline view.
String	getStartDateField()	The name of the start date field on a CalendarEvent.
Boolean	getStyleWorkday()	When showWorkday is true, applies the workdayBaseStyle to cells that fall within the workday (as defined by workdayStart and workdayEnd), in both the dayView and weekView.
Lane	getSublane(String lane, String sublane)	Returns the sublane with the passed name, from the lane with the passed name, in the passed view.
Lane	getSublane(String lane, String sublane, CalendarView view)	Returns the sublane with the passed name, from the lane with the passed name, in the passed view.
CalendarEvent[]	getSublaneEvents(Lane lane, Lane sublane)	For views that support lanes and allow sublanes, returns the array of events in the current dataset that apply to the passed lane and sublane in the passed or current view.
CalendarEvent[]	getSublaneEvents(Lane lane, Lane sublane, CalendarView view)	For views that support lanes and allow sublanes, returns the array of events in the current dataset that apply to the passed lane and sublane in the passed or current view.
Lane	getSublaneFromPoint()	Returns the sublane at the passed co-ordinates.
Lane	getSublaneFromPoint(Integer x)
Lane	getSublaneFromPoint(Integer x, Integer y)
Lane	getSublaneFromPoint(Integer x, Integer y, CalendarView view)	Returns the sublane at the passed co-ordinates.
String	getSublaneNameField()	The name of the field which will determine the sublane in which this event will be displayed, within its parent Lane, in Timelines and in the day view, if showDayLanes is true.
TimeDisplayFormat	getTimeFormatter()	Display format to use for the time portion of events' date information.
TimeUnit	getTimelineGranularity()	The granularity in which the timelineView will display events.
int	getTimelineUnitsPerColumn()	How many units of timelineGranularity each cell represents.
CalendarView	getTimelineView()	CalendarView used to display events in lanes in a horizontal Timeline view.
String	getTimelineViewTitle()	The title for the timeline view.
String	getTitleField()	Method to return the fieldName which represents the "title" for records in this&#010 Component. &#010 If this.titleField is explicitly specified it will always be used.&#010 Otherwise, default implementation will check titleField for databound&#010 components. &#010 For non databound components returns the first defined field name of "title", &#010 "name", or "id".
String	getTitleFieldValue(Record record)	Get the value of the titleField for the passed record&#010
String	getTodayBackgroundColor()	The background color for cells that represent today in all CalendarViews.
String	getTrailingDateField()	The name of the trailing date field for each event.
Boolean	getTwentyFourHourTime()	Dictates whether times throughout the widget are formatted and edited as 24-hour values.
String	getUpdateOperation()	operationId this component should use when performing update operations.
Boolean	getUseAllDataSourceFields()	If true, the set of fields given by the "default binding" (see &#010 fields) is used, with any fields specified in&#010 component.fields acting as overrides that can suppress or modify the&#010 display of individual fields, without having to list the entire set of fields that&#010 should be shown.&#010
boolean	getUseEventCanvasRolloverControls()	By default, the close buttons and the horizontal and vertical resizer widgets for event canvases are shown only when the mouse is over a given event.
Boolean	getUseFlatFields()	The useFlatFields flag causes all simple type fields anywhere in a nested&#010 set of DataSources to be exposed as a flat list for form binding.
Boolean	getUseSublanes()	When set to true, causes lanes to be sub-divided according to their set of sublanes.
CalendarView	getView(ViewName viewName)	Returns the view with the passed name.
Date	getVisibleEndDate()	Returns the last visible date in the passed, or currently selected, calendar view.
Date	getVisibleEndDate(CalendarView view)	Returns the last visible date in the passed, or currently selected, calendar view.
Date	getVisibleStartDate()	Returns the first visible date in the passed, or currently selected, calendar view.
Date	getVisibleStartDate(CalendarView view)	Returns the first visible date in the passed, or currently selected, calendar view.
int[]	getWeekendDays()	An array of integer day-numbers that should be considered to be weekend days by this Calendar instance.
Boolean	getWeekEventBorderOverlap()	Augments the width of week event windows slightly to avoid duplicate adjacent borders between events.
String	getWeekPrefix()	The text to appear before the week number in the title of week-based HeaderLevels when this calendar is showing a timeline.
CalendarView	getWeekView()	CalendarView used to display events that pertain to a given week.
String	getWeekViewTitle()	The title for the week view.
String	getWorkdayBaseStyle()	If showWorkday is set, this is the style used for cells that are within the workday, as defined by workdayStart and workdayEnd, or by a date-specific range provided in getWorkdayStart() and getWorkdayEnd() implementations.
String	getWorkdayEnd(Date date)	See getWorkdayEnd(Date,String).
String	getWorkdayEnd(Date date, String laneName)	When using showWorkday:true, workdayStart and workdayEnd specify the time of day when the workday starts and ends, specified as a String acceptable to String.
String	getWorkdayStart(Date date)	See getWorkdayStart(Date,String).
String	getWorkdayStart(Date date, String laneName)	When using showWorkday:true, workdayStart and workdayEnd specify the time of day when the workday starts and ends, specified as a String acceptable to String.
ZoneCanvas	getZoneCanvas()	Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists.
String	getZoneCanvasStyle(CalendarEvent zone)	Returns the styleName to use for the passed zone, in the passed view.
String	getZoneCanvasStyle(CalendarEvent zone, CalendarView view)	Returns the styleName to use for the passed zone, in the passed view.
String	getZoneHoverHTML(CalendarEvent zone, ZoneCanvas zoneCanvas, CalendarView view, String defaultValue)	Gets the hover HTML for a zone being hovered over.
CalendarEvent[]	getZones()	An array of CalendarEvent instances representing pre-defined periods of time to be highlighted in timeline views.
String	getZoneStyleName()	CSS style to apply to the canvases created for each specified zone.
VerticalAlignment	getZoneTitleOrientation()	The vertical alignment of the header-text in each zone.
void	groupLanesBy(String groupFieldName)	When canGroupLanes is true, this method allows the grouping in timelines to be altered at runtime.
void	groupLanesBy(String... groupFieldName)	When canGroupLanes is true, this method allows the grouping in timelines to be altered at runtime.
void	invalidateCache()	Invalidate the current data cache for this databound component via a call to the dataset's invalidateCache() method, for example, ResultSet.invalidateCache().
void	moveToEvent(CalendarEvent event)	Deprecated. in favor of scrollToEvent().
void	next()	Move to the next day, week, or month, depending on which tab is selected.
protected void	onInit()
protected void	onInit_Calendar()
void	previous()	Move to the previous day, week, month, or timeline range depending on which tab is selected.
void	refreshEvent(CalendarEvent event)	Refreshes the passed event in the current view.
void	removeEvent(CalendarEvent event)	Remove an event from this calendar.
void	removeIndicator(CalendarEvent indicator)	Removes a indicator from the calendar.
void	removeIndicator(String indicator)	Removes a indicator from the calendar.
void	removeLane(Lane lane)	Removes a lane from the calendar in timelineView mode.
void	removeLane(String laneName)	Removes a lane from the calendar in timelineView mode.
void	removeZone(CalendarEvent zone)	Removes a zone from the calendar.
void	removeZone(String zone)	Removes a zone from the calendar.
void	scrollToEnd()	Move the viewport of a CalendarView to the end of its scrollable range.
void	scrollToEnd(CalendarView view)	Move the viewport of a CalendarView to the end of its scrollable range.
void	scrollToEvent(CalendarEvent event)	Scrolls the current view so the passed event is visible.
void	scrollToEvent(CalendarEvent event, boolean canReload)	Scrolls the current view so the passed event is visible.
void	scrollToStart()	Move the viewport of a CalendarView to the start of it's scrollable range.
void	scrollToStart(CalendarView view)	Move the viewport of a CalendarView to the start of it's scrollable range.
void	scrollToTime(String time)	Scrolls Calendar day or week views to the time represented by the time parameter.
void	selectAllRecords()	Select all records&#010&#010
Boolean	selectEvent(CalendarEvent event)	Adds an event to the list of selected events in the current view, showing it in a selected style.
Boolean	selectEvents(CalendarEvent... events)	Adds one or more events to the list of selected events in the current view, showing them in a selected style.
void	selectRecord(int record)	Select/deselect a Record passed in explicitly, or by index.
void	selectRecord(int record, boolean newState)	Select/deselect a Record passed in explicitly, or by index.
void	selectRecord(Record record)	Select/deselect a Record passed in explicitly, or by index.
void	selectRecord(Record record, boolean newState)	Select/deselect a Record passed in explicitly, or by index.
void	selectRecords(int[] records)	Select/deselect a list of Records passed in explicitly, or by index.
void	selectRecords(int[] records, boolean newState)	Select/deselect a list of Records passed in explicitly, or by index.
void	selectRecords(Record[] records)	Select/deselect a list of Records passed in explicitly, or by index.
void	selectRecords(Record[] records, boolean newState)	Select/deselect a list of Records passed in explicitly, or by index.
Boolean	selectSingleEvent(CalendarEvent event)	Selects a single event in the current view, showing it in a selected style and deselecting any other selected events.
void	selectTab(int tabnum)	Selects the calendar view in the passed tab number.
Calendar	setAddDropValues(Boolean addDropValues)	Indicates whether to add "drop values" to items dropped on this component, if both the source and target widgets are databound, either to the same DataSource or to different DataSources that are related via a foreign key.
Calendar	setAddEventButtonHoverText(String addEventButtonHoverText)	The text to be displayed when a user hovers over the add event toolbar button
Calendar	setAddFormulaFieldText(String addFormulaFieldText)	Text for a menu item allowing users to add a formula field
Calendar	setAddOperation(String addOperation)	operationId this component should use when performing add operations.
Calendar	setAddSummaryFieldText(String addSummaryFieldText)	Text for a menu item allowing users to add a formula field
Calendar	setAllowDurationEvents(Boolean allowDurationEvents)	When set to true, allows events to be managed by duration, as well as by end date.
Calendar	setAlternateLaneStyles(Boolean alternateLaneStyles)	When showing a Timeline, or a day view when showDayLanes is true, whether to make lane boundaries more obvious by showing alternate lanes in a different color.
Calendar	setAlwaysShowEventHovers(Boolean alwaysShowEventHovers)	By default, EventCanvases show their content in hovers.
Calendar	setAutoFetchAsFilter(Boolean autoFetchAsFilter)	If DataBoundComponent.setAutoFetchData(Boolean) is true, this attribute determines whether the initial fetch operation should be performed via DataBoundComponent.fetchData() or DataBoundComponent.filterData()
Calendar	setAutoFetchData(Boolean autoFetchData)	If true, when this component is first drawn, automatically call DataBoundComponent.fetchData() or DataBoundComponent.filterData() depending on DataBoundComponent.getAutoFetchAsFilter() .
Calendar	setAutoFetchTextMatchStyle(TextMatchStyle autoFetchTextMatchStyle)	If autoFetchData is true, this attribute allows the developer to specify a textMatchStyle for the initial DataBoundComponent.fetchData() call.
Calendar	setBackButtonIconSrc(String backButtonIconSrc)	The icon to show in the month-button on Handsets when the month view is the current visible view.
Calendar	setBackButtonTitle(String backButtonTitle)	The title of the month on Handsets when the month view is the current visible view.
Calendar	setBaseStyle(String baseStyle)	The base name for the CSS class applied to the grid cells of the day and week views of the calendar.
Calendar	setBringEventsToFront(Boolean bringEventsToFront)	If set to true, clicking an event will bring it to the front of the zorder.
Calendar	setCalMonthEventLinkStyle(String calMonthEventLinkStyle)	The base name for the CSS class applied to the links rendered by getDayBodyHTML().
Calendar	setCanAddFormulaFields(Boolean canAddFormulaFields)	Adds an item to the header context menu allowing users to launch a dialog to define a new&#010 field based on values present in other fields, using the {@link com.smartgwt.client..FormulaBuilder}.&#010
Calendar	setCanAddSummaryFields(Boolean canAddSummaryFields)	Adds an item to the header context menu allowing users to launch a dialog to define a new&#010 text field that can contain both user-defined text and the formatted values present in other &#010 fields, using the {@link com.smartgwt.client..SummaryBuilder}.&#010
Calendar	setCancelButtonTitle(String cancelButtonTitle)	The title for the Cancel button in the event editor.
Calendar	setCanCreateEvents(Boolean canCreateEvents)	If true, users can create new events.
Calendar	setCanCreateOtherDayEvents(Boolean canCreateOtherDayEvents)	When showOtherDays is true, determines whether clicking in a Month-view body-cell that represents a date outside the selected month will open the event-editor window at the cell's location.
Calendar	setCanDeleteEvents(Boolean canDeleteEvents)	Deprecated. in favor of canRemoveEvents
Calendar	setCanDragCreateEvents(Boolean canDragCreateEvents)	A boolean value controlling whether new events of varying length can be created by dragging the cursor.
Calendar	setCanDragEventField(String canDragEventField)	Name of the field on each CalendarEvent that determines whether an EventCanvas can be moved or resized by dragging with the mouse.
Calendar	setCanDragEvents(Boolean canDragEvents)	A boolean value controlling whether users can drag-reposition events.
Calendar	setCanEditEvents(Boolean canEditEvents)	If true, users can edit existing events.
Calendar	setCanEditField(String canEditField)	Name of the field on each CalendarEvent that determines whether it can be edited in the event editor.
Calendar	setCanEditLane(Boolean canEditLane)	Can events be moved between lanes? If so, the event can be dragged to a different lane, and the event quick dialog and editor allow a lane to be selected with a drop-down chooser.
Calendar	setCanEditLaneField(String canEditLaneField)	Name of the field on each CalendarEvent that determines whether that event can be moved between lanes.
Calendar	setCanEditSublane(Boolean canEditSublane)	Can events be moved between sublanes?
Calendar	setCanEditSublaneField(String canEditSublaneField)	Name of the field on each CalendarEvent that determines whether that event can be moved between individual sublanes in a Lane.
Calendar	setCanGroupLanes(Boolean canGroupLanes)	If true, allows the lanes in a Timeline to be grouped by providing a value for laneGroupByField.
Calendar	setCanRemoveEvents(Boolean canRemoveEvents)	If true, users can remove existing events.
Calendar	setCanRemoveField(String canRemoveField)	Name of the field on each CalendarEvent that determines whether an event shows a remove button.
Calendar	setCanReorderLanes(Boolean canReorderLanes)	If true, lanes can be reordered by dragging their laneFields with the mouse.
Calendar	setCanResizeEventField(String canResizeEventField)	Name of the field on each CalendarEvent that determines whether an event can be resized by dragging.
Calendar	setCanResizeEvents(Boolean canResizeEvents)	Can events be resized by dragging appropriate edges of the canvas? Only has an effect when both canEditEvents and canDragEvents are true.
Calendar	setCanResizeTimelineEvents(Boolean canResizeTimelineEvents)	Deprecated. in favor of canResizeEvents;
Calendar	setCanSelectEvents(Boolean canSelectEvents)	When set to true, makes individual event canvases selectable.
void	setCellHoverCustomizer(CellHoverCustomizer customizer)	Customize the Hover text to display when the mouse hovers over cells in a CalendarView
Calendar	setChosenDate(Date chosenDate)	The date for which events are displayed in the day, week, and month tabs of the calendar.
Calendar	setColumnsPerPage(Integer columnsPerPage)	When using the Next and Previous arrows to scroll a Timeline, this is the number of columns of the timelineGranularity to scroll by.
Calendar	setControlBarIconBaseStyle(String controlBarIconBaseStyle)	A CSS style to apply to icons in the controlsBar.
Calendar	setControlBarIconSize(Integer controlBarIconSize)	The size of the various icons displayed in the controlsBar of this Calendar.
Calendar	setControlsBarHeight(Integer controlsBarHeight)	Default height of the controlsBar shown above the main Calendar grid.
Calendar	setCurrentViewName(ViewName currentViewName)	The name of the view that should be visible initially by default.
void	setData(Record[] data)	An array of Record objects, specifying the data to be used to populate the DataBoundComponent.
void	setData(RecordList data)	An List of Record objects, specifying the data to be used to populate the DataBoundComponent.
Calendar	setData(CalendarEvent... data)	A List of CalendarEvent objects, specifying the data to be used to populate the calendar.
Calendar	setDataFetchMode(FetchMode dataFetchMode)	How to fetch and manage records retrieve from the server.
Calendar	setDataPageSize(int dataPageSize)	When using data paging, how many records to fetch at a time.
Calendar	setDataSource(DataSource dataSource)	The DataSource that this component should bind to for default fields and for performing DataSource requests.
Calendar	setDataSource(String dataSource)	The DataSource that this component should bind to for default fields and for performing DataSource requests.
void	setDateCellAlignCustomizer(DateCellAlignCustomizer customizer)	This method installs a customizer that returns the horizontsal Alignment to display in the passed date-cell when rendered in the passed view
void	setDateCellVAlignCustomizer(DateCellVAlignCustomizer customizer)	This method installs a customizer that returns the VerticalAlignment to display in the passed date-cell when rendered in the passed view
void	setDateCSSTextCustomizer(DateCSSTextCustomizer customizer)	This method returns the CSS class name for the passed event when rendered in the passed view
Calendar	setDateEditingStyle(DateEditingStyle dateEditingStyle)	Indicates the type of controls to use in event-windows.
Calendar	setDateFormatter(DateDisplayFormat dateFormatter)	Date formatter for displaying events.
void	setDateHeaderCustomizer(DateHeaderCustomizer customizer)	This method installs a customizer to determine the HTML to be displayed in the header for a given date column in a CalendarView
void	setDateHTMLCustomizer(DateHTMLCustomizer customizer)	This method installs a customizer that returns the HTML to display in the passed date-cell when rendered in the passed view
Calendar	setDatePickerHoverText(String datePickerHoverText)	The text to be displayed when a user hovers over the date picker toolbar button
void	setDateStyleCustomizer(DateStyleCustomizer customizer)	This method installs a customizer that returns the CSS class name for the passed date-cell when rendered in the passed view
Calendar	setDayBodyBaseStyle(String dayBodyBaseStyle)	The base name for the CSS class applied to the day body of the month view of the calendar.
Calendar	setDayHeaderBaseStyle(String dayHeaderBaseStyle)	The base name for the CSS class applied to the day headers of the month view.
Calendar	setDayViewTitle(String dayViewTitle)	The title for the day view.
Calendar	setDeepCloneOnEdit(Boolean deepCloneOnEdit)	Before we start editing values in this DataBoundComponent, should we perform a deep clone of the underlying values.
static void	setDefaultProperties(Calendar calendarProperties)	Class level method to set the default properties of this class.
Calendar	setDefaultTimelineColumnSpan(int defaultTimelineColumnSpan)	The number of columns of the timelineGranularity to give the timeline by default if no endDate is provided.
Calendar	setDescriptionField(String descriptionField)	The name of the description field on a CalendarEvent.
Calendar	setDetailsButtonTitle(String detailsButtonTitle)	The title for the edit button in the quick quick event dialog.
void	setDisableDateCustomizer(DisableDateCustomizer customizer)	Return true from the customizer to have the passed event considered disabled in the passed view
Calendar	setDisableWeekends(Boolean disableWeekends)	If true, weekend days appear in a disabled style and events cannot be created on weekends.
Calendar	setDragDataAction(DragDataAction dragDataAction)	Indicates what to do with data dragged into another DataBoundComponent.
Calendar	setDragDataCustomizer(DragDataCustomizer customizer)	During a drag-and-drop interaction, this method returns the set of records being dragged out of the component.
void	setDragHoverCustomizer(DragHoverCustomizer customizer)	Customize the Hover text to display during a drag operation
Calendar	setDragTrackerStyle(String dragTrackerStyle)	CSS Style to apply to the drag tracker when dragging occurs on this component.
Calendar	setDropValues(Map dropValues)	When an item is dropped on this component, and addDropValues is true and both the source and target widgets are databound, either to the same DataSource or to different DataSources that are related via a foreign key, this object provides the "drop values" that Smart GWT will apply to the dropped object before updating it.
Calendar	setDuplicateDragMessage(String duplicateDragMessage)	Message to show when a user attempts to transfer duplicate records into this component, and&#010 preventDuplicates is enabled.
Calendar	setDurationField(String durationField)	The name of the duration field on a CalendarEvent.
Calendar	setDurationUnitField(String durationUnitField)	The name of the durationUnit field on a CalendarEvent.
Calendar	setEditFormulaFieldText(String editFormulaFieldText)	Text for a menu item allowing users to edit a formula field
Calendar	setEditSummaryFieldText(String editSummaryFieldText)	Text for a menu item allowing users to edit the formatter for a field
Calendar	setEndDate(Date endDate)	The end date of the calendar timeline view.
Calendar	setEndDateField(String endDateField)	The name of the end date field on a CalendarEvent.
Calendar	setEventAutoArrange(Boolean eventAutoArrange)	If set to true, enables the auto-arrangement of events that share time in the calendar.
void	setEventBodyHTMLCustomizer(EventBodyHTMLCustomizer customizer)	This method installs a customizer that returns the HTML to be used as the body/description for the passed event.
Calendar	setEventCanvasCloseButtonSize(Integer eventCanvasCloseButtonSize)	The size of the close-button that snaps to the top-right of an event canvas on rollover and shows allows an event to be removed from a CalendarView.
Calendar	setEventCanvasCloseIconSize(Integer eventCanvasCloseIconSize)	The size of the icon in the close-button floated over events on rollover.
void	setEventCanvasComponentCustomizer(EventCanvasComponentCustomizer customizer)	This method sets the customizer for EventCanvasComponent methods
void	setEventCanvasGripperIconCustomizer(EventCanvasGripperIconCustomizer customizer)	This method returns the SCImgURL for the icon to use as the gripper for a given EventCanvas
void	setEventCanvasHoverHTMLCustomizer(EventCanvasHoverHTMLCustomizer customizer)	This method returns the hover HTML to be displayed when the user hovers over an eventCanvas
void	setEventCanvasMenuCustomizer(EventCanvasMenuCustomizer customizer)	Customizer called whenever the Calender needs to show a context-menu for a given EventCanvas
Calendar	setEventDescriptionFieldTitle(String eventDescriptionFieldTitle)	The title for the descriptionField field in the quick event dialog and the detailed editor.
void	setEventDialogCustomizer(EventDialogCustomizer customizer)	Customizer called whenever the Calender needs to show an EventDialog, to edit or view a CalendarEvent
void	setEventDialogFields(FormItem... eventDialogFields)	The set of fields for the eventDialog.
Calendar	setEventDragGap(Integer eventDragGap)	The number of pixels to leave to the right of events so overlapping events can still be added using the mouse.
Calendar	setEventDurationFieldTitle(String eventDurationFieldTitle)	The title for the duration field in the quick event dialog and the detailed editor.
Calendar	setEventDurationUnitFieldTitle(String eventDurationUnitFieldTitle)	The title for the duration unit field in the quick event dialog and the detailed editor.
Calendar	setEventEditorButtons(Object... eventEditorButtons)	The list of buttons to include in the eventEditor.
void	setEventEditorCustomizer(EventEditorCustomizer customizer)	Customizer called whenever the Calender needs to show an EventEditor, to edit or create a CalendarEvent
Calendar	setEventEditorDateFieldTitle(String eventEditorDateFieldTitle)	The title for the Date-field in the eventEditor that allows for changing the logical start-date of an event, along with its start and end times, when editing events in the day and week views.
void	setEventEditorFields(FormItem... eventEditorFields)	The set of fields for the eventEditor.
Calendar	setEventEndDateFieldTitle(String eventEndDateFieldTitle)	The title for the endDateField in the quick event dialog and the detailed editor.
Calendar	setEventHeaderHeight(int eventHeaderHeight)	When eventHeaderWrap is false and showEventDescriptions is true, this is the fixed height for the header area in event canvases.
void	setEventHeaderHTMLCustomizer(EventHeaderHTMLCustomizer customizer)	This method returns the HTML to be used as the header/title for the passed event.
Calendar	setEventHeaderWrap(boolean eventHeaderWrap)	When rendering the canvas for an event, whether to allow the content of the header area to wrap to multiple lines.
Calendar	setEventLaneFieldTitle(String eventLaneFieldTitle)	The title for the laneNameField in the quick event dialog and the detailed editor.
Calendar	setEventNameFieldTitle(String eventNameFieldTitle)	The title for the nameField in the quick event dialog and the detailed editor.
Calendar	setEventOverlap(Boolean eventOverlap)	When eventAutoArrange is true, setting eventOverlap to true causes events that share timeslots to overlap each other by a percentage of their width, specified by eventOverlapPercent.
Calendar	setEventOverlapIdenticalStartTimes(Boolean eventOverlapIdenticalStartTimes)	When set to true, events that start at the same time will not overlap each other to prevent events having their close button hidden.
Calendar	setEventOverlapPercent(int eventOverlapPercent)	The size of the overlap, presented as a percentage of the width of events sharing timeslots.
Calendar	setEventScreen(String eventScreen)	Screen to create (via createScreen()) in lieu of calling createEventCanvasComponent().
Calendar	setEventSnapGap(Integer eventSnapGap)	The number of minutes that determines the positions to which events will snap when rendered, and when moved or resized with the mouse.
Calendar	setEventStartDateFieldTitle(String eventStartDateFieldTitle)	The title for the startDateField in the quick event dialog and the detailed editor.
void	setEventStyle(CalendarEvent event, String styleName)	Update the styleName for the passed event.
Calendar	setEventStyleName(String eventStyleName)	The base name for the CSS class applied to events when they're rendered in calendar views.
Calendar	setEventStyleNameField(String eventStyleNameField)	The name of the field used to override eventStyleName for an individual CalendarEvent.styleName.
Calendar	setEventSublaneFieldTitle(String eventSublaneFieldTitle)	The title for the sublaneNameField in the quick event dialog and the detailed event editor.
Calendar	setEventWindowStyle(String eventWindowStyle)	Deprecated. in favor of eventStyleName
Calendar	setEventWindowStyleField(String eventWindowStyleField)	Deprecated. in favor of eventStyleNameField
Calendar	setExportAll(Boolean exportAll)	Setting exportAll to true prevents the component from passing its list of fields to the &#010 export call.
Calendar	setExportFields(String[] exportFields)	The list of field-names to export.
Calendar	setExportIncludeSummaries(Boolean exportIncludeSummaries)	If Summary rows exist for this component, whether to include them when exporting client data.
Calendar	setFetchOperation(String fetchOperation)	Operation ID this component should use when performing fetch operations.
Calendar	setFields(JavaScriptObject... fields)	Field setter variant (alternative to setFields(FormItem...), setFields(ListGridField...), etc.) that will accept an array of JavaScriptObject, rather than an array of SmartGWT Java wrappers of the field class type (e.g.
Calendar	setFirstDayOfWeek(Integer firstDayOfWeek)	The numeric day (0-6, Sunday-Saturday) which the calendar should consider as the first day of the week in multi-day views, and in the popup DateChooser.
void	setHeaderHoverCustomizer(HeaderLevelHoverCustomizer customizer)	Customize the Hover text for a given span in a HeaderLevel.
Calendar	setHeaderLevels(HeaderLevel... headerLevels)	Configures the levels of headers shown above the event area, and their time units.
Calendar	setHideUnusedLanes(Boolean hideUnusedLanes)	When set to true, hides any lane that doesn't have any active events in the current dataset.
Calendar	setHiliteProperty(String hiliteProperty)	Marker that can be set on a record to flag that record as hilited.
Calendar	setHilites(Hilite[] hilites)	Accepts an array of hilite objects and applies them to this DataBoundComponent.
Calendar	setHiliteState(String hiliteState)	Set the current hilites based on a hiliteState String previously returned from getHilitesState.
Calendar	setImplicitCriteria(Criteria implicitCriteria)	Criteria that are never shown to or edited by the user and are cumulative with any criteria provided via DataBoundComponent.initialCriteria, DataBoundComponent.setCriteria() etc.
Boolean	setImplicitCriteria(Criteria implicitCriteria, DSCallback callback)
Boolean	setImplicitCriteria(Criteria criteria, DSCallback callback, Boolean initialFetch)
Calendar	setIncludeRangeCriteria(Boolean includeRangeCriteria)	When set to true, the default, the fetches issued by navigating around in the various views are limited to the accessible date-range in the current view - as you change the current date-range, a fetch is only issued if the new range is not entirely within the previous range.
void	setIndicatorHoverHTMLCustomizer(IndicatorHoverHTMLCustomizer indicatorHoverHTMLCustomizer)	This method returns the hover HTML to be displayed when the user hovers over an IndicatorCanvas
Calendar	setIndicators(CalendarEvent... indicators)	An array of CalendarEvent instances representing instants in time, to be highlighted in timeline views.
Calendar	setIndicatorStyleName(String indicatorStyleName)	CSS style to apply to the canvases created for each specified indicator.
Calendar	setInitialCriteria(Criteria initialCriteria)	Criteria to use when DataBoundComponent.setAutoFetchData(Boolean) is used.
Calendar	setInvalidDateMessage(String invalidDateMessage)	The message to display in the eventEditor when the 'To' date is greater than the 'From' date and a save is attempted.
Calendar	setLaneEventPadding(Integer laneEventPadding)	The pixel space to leave between events and the edges of the lane or sublane they appear in.
Calendar	setLaneFields(ListGridField... laneFields)	Field definitions for the frozen area of the timelineView, which shows data about the timeline lanes.
Calendar	setLaneGroupByField(String laneGroupByField)	For timelines with canGroupLanes set to true, this is a field name or array of field names on which to group the lanes in a timeline.
Calendar	setLaneGroupByField(String... laneGroupByField)	For timelines with canGroupLanes set to true, this is a field name or array of field names on which to group the lanes in a timeline.
void	setLaneGroupStartOpen(GroupStartOpen group)
void	setLaneGroupStartOpen(Object... groupValues)
Calendar	setLaneNameField(String laneNameField)	The name of the field which will determine the lane in which a given event will be displayed in Timelines and in the day view, if showDayLanes is true.
Calendar	setLanes(Lane... lanes)	An array of Lane definitions that represent the rows of the timelineView, or the columns of the dayView if showDayLanes is true.
boolean	setLaneTitle(String lane, String title)	For views that support lanes, updates the title for the passed lane.
Calendar	setLeadingDateField(String leadingDateField)	The name of the leading date field for each event.
Calendar	setLimitToWorkday(Boolean limitToWorkday)	When showWorkday is true, this attribute prevents the user from scrolling vertical views beyond the specified workday start and end hours.
LogicalStructureObject	setLogicalStructure(CalendarLogicalStructure s)	Setter implementing the LogicalStructure interface, which supports Eclipse's logical structure debugging facility.
Calendar	setMinimalUI(boolean minimalUI)	A boolean value controlling whether the Calendar shows tabs for available calendar views.
Calendar	setMinimumDayHeight(Integer minimumDayHeight)	In the month view when showDayHeaders is true, this is the minimum height applied to a day cell and its header combined.
Calendar	setMinLaneWidth(Integer minLaneWidth)	When showing vertical lanes in the dayView, this attribute sets the minimum width of each column or field.
Calendar	setMinRowHeight(int minRowHeight)	The minimum height of time-rows in vertical calendar views.
Calendar	setMinutesPerRow(Integer minutesPerRow)	The number of minutes per row in day and week views.
Calendar	setMonthButtonIconSrc(String monthButtonIconSrc)	The icon to show next to the month-name in the month button, used for showing and hiding the month view on Handsets.
Calendar	setMonthButtonTitle(String monthButtonTitle)	The title of the month button, used for showing and hiding the month view on Handsets.
Calendar	setMonthMoreEventsLinkTitle(String monthMoreEventsLinkTitle)	The title of the link shown in a cell of a month view when there are too many events to be displayed at once.
void	setMonthViewHoverHTMLCustomizer(MonthViewHoverHTMLCustomizer monthViewHoverHTMLCustomizer)	This method returns the hover HTML to be displayed when the user hovers over a cell displayed in the calendar month view tab.
Calendar	setMonthViewTitle(String monthViewTitle)	The title for the month view.
Calendar	setNameField(String nameField)	The name of the name field on a CalendarEvent.
Calendar	setNewEventWindowTitle(String newEventWindowTitle)	The title-text displayed in the popup event dialog/editor for new events.
Calendar	setNextButtonHoverText(String nextButtonHoverText)	The text to be displayed when a user hovers over the next toolbar button
Calendar	setOtherDayBlankStyle(String otherDayBlankStyle)	The CSS style applied to both the header and body of days from other months in the month view, when showOtherDays is false.
Calendar	setOtherDayBodyBaseStyle(String otherDayBodyBaseStyle)	The base name for the CSS class applied to the day body of the month view of the calendar.
Calendar	setOtherDayClickNavigation(Boolean otherDayClickNavigation)	When showOtherDays is true, this attribute determines whether the month-view should change month when cells representing days in the previous or following month are clicked.
Calendar	setOtherDayHeaderBaseStyle(String otherDayHeaderBaseStyle)	The base name for the CSS class applied to the day headers of the month view.
Calendar	setOverlapSortSpecifiers(SortSpecifier... overlapSortSpecifiers)	A set of sort-specifiers for customizing the render order of events that overlap.
Calendar	setPreventDuplicates(Boolean preventDuplicates)	If set, detect and prevent duplicate records from being transferred to this component, either via&#010 drag and drop or via DataBoundComponent.transferSelectedData(com.smartgwt.client.widgets.DataBoundComponent).
Calendar	setPreviousButtonHoverText(String previousButtonHoverText)	The text to be displayed when a user hovers over the previous toolbar button.
Calendar	setProgressiveLoading(Boolean progressiveLoading)	Indicates whether or not this component will load its data progressively
Calendar	setRemoveButtonTitle(String removeButtonTitle)	The title for the Remove button in the event editor.
Calendar	setRemoveOperation(String removeOperation)	operationId this component should use when performing remove operations.
Calendar	setRenderEventsOnDemand(boolean renderEventsOnDemand)	When set to true, the default, each event is rendered as it appears in the viewport.
void	setResolution(HeaderLevel[] headerLevels, TimeUnit unit, Integer unitCount)	Reset the resolution, the header levels and scrollable range, of the timeline view.
void	setResolution(HeaderLevel[] headerLevels, TimeUnit unit, Integer unitCount, Integer granularityPerColumn)	Reset the resolution, the header levels and scrollable range, of the timeline view.
Calendar	setRowHeight(int rowHeight)	The height of time-slots in the calendar.
Calendar	setRowTitleFrequency(Integer rowTitleFrequency)	A minute value that indicates which rows should show times in vertical views, like day and week.
Calendar	setSaveButtonTitle(String saveButtonTitle)	The title for the Save button in the quick event dialog and the event editor.
Calendar	setSavedSearchId(String savedSearchId)	Optional identifier for saved searches that should be applied to this component.
Calendar	setScrollToWorkday(Boolean scrollToWorkday)	If set, and showWorkday is true, automatically scrolls the day and week views to the start of the workday when the calendar is first displayed and whenever the user changes to a different day or week.
Calendar	setSelectChosenDate(Boolean selectChosenDate)	When true, shows the current chosenDate in a selected style in the month view.
Calendar	setSelectedCellStyle(String selectedCellStyle)	The base name for the CSS class applied to a cell that is selected via a mouse drag.
Calendar	setShowAddEventButton(Boolean showAddEventButton)	Set to false to hide the Add Event button.
Calendar	setShowCellHovers(Boolean showCellHovers)	When showViewHovers is true, dictates whether to display hover prompts when the mouse rolls over the normal cells in the body of CalendarViews.
Calendar	setShowColumnLayouts(Boolean showColumnLayouts)	When true, causes layouts to be added to each column in vertical views.
Calendar	setShowComplexFields(Boolean showComplexFields)	Whether to show fields of non-atomic types when a DataBoundComponent is given a&#010 DataSource but no component.fields.&#010
Calendar	setShowControlsBar(Boolean showControlsBar)	If false the controls bar at the top of the calendar will not be displayed - this means that the controlsBar will be hidden, so the autoChildren (previousButton, dateLabel, nextButton, addEventButton, and datePickerButton) will not be created or shown.
Calendar	setShowDateChooser(Boolean showDateChooser)	Determines whether the dateChooser is displayed.
void	setShowDateCustomizer(ShowDateCustomizer customizer)	This method is called during rendering for all events in the visible range - those which would be rendered by default.
Calendar	setShowDatePickerButton(Boolean showDatePickerButton)	Set to false to hide the datePickerButton that allows selecting a new base date for this Calendar.
Calendar	setShowDayHeaders(Boolean showDayHeaders)	If true, the default, show a header cell for each day cell in the month view, with both cells having a minimum combined height of minimumDayHeight.
Calendar	setShowDayLanes(Boolean showDayLanes)	If set to true, the day view uses lanes to render multiple vertical "lanes" within the day, very much like a vertical Timeline.
Calendar	setShowDayView(Boolean showDayView)	Whether to show the Day view.
Calendar	setShowDetailFields(Boolean showDetailFields)	Whether to show fields marked detail:true when a DataBoundComponent is given a DataSource but no component.fields.
Calendar	setShowDragHovers(Boolean showDragHovers)	When showViewHovers is true, dictates whether to display hover prompts when an event is being dragged with the mouse.
Calendar	setShowEventCanvasComponents(boolean showEventCanvasComponents)	Whether event-canvases should show a custom widget as content, rather than the default header and body HTML.
void	setShowEventCustomizer(ShowEventCustomizer customizer)	Return false from the customizer to prevent the passed CalendarEvent from being rendered in the passed view.
Calendar	setShowEventDescriptions(boolean showEventDescriptions)	When rendering the canvas for an event, whether to show the body area, typically containing brief details of the event - by default, its description.
Calendar	setShowEventHeaders(boolean showEventHeaders)	When rendering the canvas for an event, whether to show the header area, typically containing suitable title text - by default, the event's name.
Calendar	setShowEventHovers(Boolean showEventHovers)	When showViewHovers is true, dictates whether to display hover prompts when the mouse moves over an event canvas in a calendarView.
Calendar	setShowHeaderHovers(Boolean showHeaderHovers)	When showViewHovers is true, dictates whether to display hover prompts when the mouse rolls over the header levels in a CalendarView.
Calendar	setShowHiddenFields(Boolean showHiddenFields)	Whether to show fields marked hidden:true when a DataBoundComponent is given a&#010 DataSource but no component.fields.&#010
Calendar	setShowIndicators(Boolean showIndicators)	Set to true to render any defined indicators into timeline views.
Calendar	setShowIndicatorsInFront(boolean showIndicatorsInFront)	In indicator lines are showing, this attribute affects where in the z-order their canvases will be rendered: either in front of, or behind normal calendar events.
Calendar	setShowLabelColumn(boolean showLabelColumn)	When set to false, hides the frozen Label-Column in vertical CalendarViews.
void	setShowLaneCustomizer(ShowLaneCustomizer customizer)	Return false from the customizer to prevent the passed Lane from being rendered in the passed view.
Calendar	setShowLaneFieldHovers(Boolean showLaneFieldHovers)	When showViewHovers is true, dictates whether to display hover prompts when the mouse moves over the cells in a laneField.
Calendar	setShowLaneRollOver(Boolean showLaneRollOver)	When set to true, causes Timelines to highlight the Lane under the mouse with the "Over" style.
Calendar	setShowMonthButton(Boolean showMonthButton)	Set to false to prevent the Month button from displaying on Handset devices.
Calendar	setShowMonthView(Boolean showMonthView)	Whether to show the Month view.
Calendar	setShowNextButton(Boolean showNextButton)	Set to false to hide the Next button.
Calendar	setShowOtherDays(Boolean showOtherDays)	If set to true, in the month view, days that fall in an adjacent month are still shown with a header and body area, and are interactive.
Calendar	setShowPreviousButton(Boolean showPreviousButton)	Set to false to hide the Previous button.
Calendar	setShowQuickEventDialog(Boolean showQuickEventDialog)	Determines whether the quick event dialog is displayed when a time is clicked.
Calendar	setShowSavedSearchesByDS(boolean showSavedSearchesByDS)	Whether to associate saved searches by default with the current DataSource of a component when a savedSearchId is not provided.
Calendar	setShowTimelineView(Boolean showTimelineView)	If set to true, show the Timeline view.
Calendar	setShowViewHovers(Boolean showViewHovers)	When set to true, the default value, causes the Calendar to show customizable hovers when the mouse moves over various areas of a CalendarView.
Calendar	setShowWeekends(Boolean showWeekends)	Suppresses the display of weekend days in the week, month and timeline views, and disallows the creation of events on weekends.
Calendar	setShowWeekView(Boolean showWeekView)	Whether to show the Week view.
Calendar	setShowWorkday(Boolean showWorkday)	When set to true, this setting enables various features related to cells that fall within the workday (as defined by workdayStart and workdayEnd) in vertical calendar views (day and week).
Calendar	setShowZoneHovers(Boolean showZoneHovers)	When showViewHovers is true, dictates whether to display hover prompts when the mouse moves over a zone in a calendarView.
Calendar	setShowZones(Boolean showZones)	Set to true to render any defined zones into timeline views.
Calendar	setSizeEventsToGrid(Boolean sizeEventsToGrid)	If true, events will be sized to the grid, even if they start and/or end at times between grid cells.
Calendar	setSizeToWorkday(Boolean sizeToWorkday)	When showWorkday is true, attempt to resize rows in the day and week views so that the workday hours fill the visible viewport-height, and the whole workday is visible without scrolling.
Calendar	setSort(SortSpecifier... sortSpecifiers)	Sort the component on one or more fields.
Calendar	setSparseFieldState(Boolean sparseFieldState)	If true, ListGrid.getFieldState() and ListGrid.setFieldState(java.lang.String) will omit state information for hidden fields by default.
Calendar	setStartDate(Date startDate)	The start date of the calendar timeline view.
Calendar	setStartDateField(String startDateField)	The name of the start date field on a CalendarEvent.
Calendar	setStyleWorkday(Boolean styleWorkday)	When showWorkday is true, applies the workdayBaseStyle to cells that fall within the workday (as defined by workdayStart and workdayEnd), in both the dayView and weekView.
Calendar	setSublaneNameField(String sublaneNameField)	The name of the field which will determine the sublane in which this event will be displayed, within its parent Lane, in Timelines and in the day view, if showDayLanes is true.
void	setTimeFormatter(TimeDisplayFormat timeFormatter)	Display format to use for the time portion of events' date information.
void	setTimeFormatter(TimeFormatter timeFormatter)	Deprecated. use setTimeFormatter(TimeDisplayFormat) instead.
Calendar	setTimelineGranularity(TimeUnit timelineGranularity)	The granularity in which the timelineView will display events.
void	setTimelineRange(Date start)	Sets the range over which the timeline will display events.
void	setTimelineRange(Date start, Date end)	Sets the range over which the timeline will display events.
Calendar	setTimelineUnitsPerColumn(int timelineUnitsPerColumn)	How many units of timelineGranularity each cell represents.
Calendar	setTimelineViewTitle(String timelineViewTitle)	The title for the timeline view.
Calendar	setTitleField(String titleField)	Sets the best field to use for a user-visible title for an individual record from this component.
Calendar	setTodayBackgroundColor(String todayBackgroundColor)	The background color for cells that represent today in all CalendarViews.
Calendar	setTrailingDateField(String trailingDateField)	The name of the trailing date field for each event.
Calendar	setTwentyFourHourTime(Boolean twentyFourHourTime)	Dictates whether times throughout the widget are formatted and edited as 24-hour values.
Calendar	setUpdateOperation(String updateOperation)	operationId this component should use when performing update operations.
Calendar	setUseAllDataSourceFields(Boolean useAllDataSourceFields)	If true, the set of fields given by the "default binding" (see &#010 fields) is used, with any fields specified in&#010 component.fields acting as overrides that can suppress or modify the&#010 display of individual fields, without having to list the entire set of fields that&#010 should be shown.&#010
Calendar	setUseEventCanvasRolloverControls(boolean useEventCanvasRolloverControls)	By default, the close buttons and the horizontal and vertical resizer widgets for event canvases are shown only when the mouse is over a given event.
Calendar	setUseFlatFields(Boolean useFlatFields)	The useFlatFields flag causes all simple type fields anywhere in a nested&#010 set of DataSources to be exposed as a flat list for form binding.
Calendar	setUseSublanes(Boolean useSublanes)	When set to true, causes lanes to be sub-divided according to their set of sublanes.
Calendar	setWeekendDays(int... weekendDays)	An array of integer day-numbers that should be considered to be weekend days by this Calendar instance.
Calendar	setWeekEventBorderOverlap(Boolean weekEventBorderOverlap)	Augments the width of week event windows slightly to avoid duplicate adjacent borders between events.
Calendar	setWeekPrefix(String weekPrefix)	The text to appear before the week number in the title of week-based HeaderLevels when this calendar is showing a timeline.
Calendar	setWeekViewTitle(String weekViewTitle)	The title for the week view.
Calendar	setWorkdayBaseStyle(String workdayBaseStyle)	If showWorkday is set, this is the style used for cells that are within the workday, as defined by workdayStart and workdayEnd, or by a date-specific range provided in getWorkdayStart() and getWorkdayEnd() implementations.
Calendar	setWorkdayEnd(String workdayEnd)	When using showWorkday:true, workdayStart and workdayEnd specify the time of day when the workday starts and ends, specified as a String acceptable to String.
void	setWorkdays(int[] workdays)	Array of days that are considered workdays when showWorkday is true
Calendar	setWorkdayStart(String workdayStart)	When using showWorkday:true, workdayStart and workdayEnd specify the time of day when the workday starts and ends, specified as a String acceptable to String.
void	setZoneHoverHTMLCustomizer(ZoneHoverHTMLCustomizer zoneHoverHTMLCustomizer)	This method returns the hover HTML to be displayed when the user hovers over an ZoneCanvas
Calendar	setZones(CalendarEvent... zones)	An array of CalendarEvent instances representing pre-defined periods of time to be highlighted in timeline views.
Calendar	setZoneStyleName(String zoneStyleName)	CSS style to apply to the canvases created for each specified zone.
Calendar	setZoneTitleOrientation(VerticalAlignment zoneTitleOrientation)	The vertical alignment of the header-text in each zone.
boolean	shouldDisableDate(Date date)	Returns true if the passed date should be considered disabled.
boolean	shouldDisableDate(Date date, CalendarView view)	Returns true if the passed date should be considered disabled.
boolean	shouldShowDate(Date date)	Indicates whether the passed date should be visible in the passed CalendarView.
boolean	shouldShowDate(Date date, CalendarView view)	Indicates whether the passed date should be visible in the passed CalendarView.
boolean	shouldShowEvent(CalendarEvent event)	Indicates whether the passed event should be visible in the passed CalendarView.
boolean	shouldShowEvent(CalendarEvent event, CalendarView view)	Indicates whether the passed event should be visible in the passed CalendarView.
boolean	shouldShowLane(Lane lane)	Indicates whether the passed lane should be visible in the passed CalendarView.
boolean	shouldShowLane(Lane lane, CalendarView view)	Indicates whether the passed lane should be visible in the passed CalendarView.
boolean	shouldShowLane(String lane)	Indicates whether the passed lane should be visible in the passed CalendarView.
boolean	showEventCanvasComponent(EventCanvas canvas)	Should a component be applied to the passed canvas in the view in which it appears? Return false from this method to override the global value of showEventCanvasComponents for this canvas.
void	showEventDialog()	Open the Quick Event dialog showing minimal information about an existing event.
void	showEventDialog(CalendarEvent event)
void	showEventDialog(CalendarEvent event, Boolean isNewEvent)	Open the Quick Event dialog showing minimal information about an existing event.
void	showEventEditor()	Show an Event Editor for the passed event.
void	showEventEditor(CalendarEvent event)
void	showEventEditor(CalendarEvent event, Boolean isNewEvent)	Show an Event Editor for the passed event.
void	showNewEventDialog()	Open the Quick Event dialog to begin editing a new event.
void	showNewEventDialog(CalendarEvent event)	Open the Quick Event dialog to begin editing a new event.
void	showNewEventEditor()	Show an Event Editor for a new event.
void	showNewEventEditor(CalendarEvent event)	Show an Event Editor for a new event.
Boolean	timelineEventMoved(CalendarEvent event, Date startDate, Date endDate, Lane lane)	Deprecated. in favor of Calendar.eventRepositionStop()
Boolean	timelineEventResized(CalendarEvent event, Date startDate, Date endDate)	Deprecated. in favor of Calendar.eventResizeStop()
void	transferRecords(Record[] records, Record targetRecord, Integer index, Canvas sourceWidget, TransferRecordsCallback callback)	Transfer a list of Records from another component (does not have to be a databound component) into this component.
void	transferSelectedData(DataBoundComponent source)	Simulates a drag / drop type transfer of the selected records in some other component to this component, without requiring any user interaction.
void	transferSelectedData(DataBoundComponent source, int index)	Simulates a drag / drop type transfer of the selected records in some other component to this component, without requiring any user interaction.
void	updateCalendarEvent(CalendarEvent event, CalendarEvent newEvent, Map otherFields)	Save an event to this Calendar's ${isc.DocUtils.linkForRef('attr:Calendar.dataSource','dataSource) or \n data array').
void	updateEvent(CalendarEvent event, Date startDate, Date endDate, String name, String description)	update an event in this calendar.
void	updateEventCanvasComponent(EventCanvas canvas, Canvas component)	Called from EventCanvas.setEvent() when showEventCanvasComponents is true and the eventCanvas already has a component.

Methods inherited from class com.smartgwt.client.widgets.Canvas

addChild, addChild, addChild, addChild, addChild, addClearHandler, addClickHandler, addDoubleClickHandler, addDragMoveHandler, addDragRepositionMoveHandler, addDragRepositionStartHandler, addDragRepositionStopHandler, addDragResizeMoveHandler, addDragResizeStartHandler, addDragResizeStopHandler, addDragStartHandler, addDragStopHandler, addDropHandler, addDropMoveHandler, addDropOutHandler, addDropOverHandler, addFocusChangedHandler, addHoverHandler, addHoverHiddenHandler, addKeyDownHandler, addKeyPressHandler, addMouseDownHandler, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseStillDownHandler, addMouseUpHandler, addMouseWheelHandler, addMovedHandler, addParentMovedHandler, addPeer, addPeer, addPeer, addPeer, addResizedHandler, addRightMouseDownHandler, addRuleContextChangedHandler, addScrolledHandler, addShowContextMenuHandler, addSnapAlignCandidate, addStyleName, addVisibilityChangedHandler, adjustForContent, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateHide, animateHide, animateHide, animateHide, animateHide, animateHide, animateHide, animateMove, animateMove, animateMove, animateMove, animateRect, animateRect, animateRect, animateRect, animateResize, animateResize, animateResize, animateResize, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateShow, animateShow, animateShow, animateShow, animateShow, animateShow, animateShow, asSGWTComponent, blur, bringToFront, clear, clearExplicitTabIndex, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsEventTarget, containsFocus, containsPoint, containsPoint, dataContextChanged, deparent, depeer, disable, enable, encloses, focus, focusAfterGroup, focusAtEnd, focusInNextTabElement, focusInPreviousTabElement, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAdaptiveHeightPriority, getAdaptiveWidthPriority, getAlwaysManageFocusNavigation, getAlwaysShowScrollbars, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideEffect, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeLayoutMode, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaHandleID, getAriaRole, getAriaStateDefaults, getAutoMaskComponents, getAutoParent, getAutoPopulateData, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBorderRadius, getBottom, getById, getByJSObject, getByLocalId, getCanAcceptDrop, getCanAdaptHeight, getCanAdaptWidth, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanHover, getCanSelectText, getCanvasAutoChild, getCanvasItem, getChildren, getChildrenResizeSnapAlign, getChildrenSnapAlign, getChildrenSnapCenterAlign, getChildrenSnapEdgeAlign, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getChildTabPosition, getClassName, getComponentMask, getComponentMaskDefaults, getContentElement, getContents, getContextMenu, getCorrectZoomOverflow, getCursor, getDataContext, getDataPath, getDefaultHeight, getDefaultWidth, getDefiningProperty, getDefiningPropertyName, getDefiningPropertyNameOptions, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDisableTouchScrollingForDrag, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragMaskType, getDragMaxHeight, getDragMaxWidth, getDragMinHeight, getDragMinWidth, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragTargetAsString, getDragType, getDropTarget, getDropTargetAsString, getDropTypes, getDropTypesAsString, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getEditNode, getEditProxy, getEditProxyConstructor, getElement, getElement, getEnableWhen, getEndLine, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFloatingScrollbars, getFormItemAutoChild, getForwardSVGeventsToObject, getFullDataPath, getGroupBorderCSS, getGroupLabelBackgroundColor, getGroupLabelStyleName, getGroupPadding, getGroupTitle, getHeight, getHeightAsString, getHideUsingDisplayNone, getHoverAlign, getHoverAutoDestroy, getHoverAutoFitMaxWidth, getHoverAutoFitMaxWidthAsString, getHoverAutoFitWidth, getHoverComponent, getHoverDelay, getHoverFocusKey, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverPersist, getHoverScreen, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapPosition, getHSnapPosition, getHtmlElement, getHtmlElementAsString, getHtmlPosition, getImage, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getIsPrinting, getIsRuleScope, getIsSnapAlignCandidate, getKeepInParentRect, getLayoutAlign, getLeaveGroupLabelSpace, getLeavePageSpace, getLeft, getLeftAsString, getLocalId, getLocateByIDOnly, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getLocatorName, getMargin, getMasterCanvas, getMasterElement, getMatchElement, getMatchElementHeight, getMatchElementWidth, getMaxHeight, getMaxWidth, getMaxZoomOverflowError, getMenuConstructor, getMinHeight, getMinNonEdgeSize, getMinWidth, getMomentumScrollMinSpeed, getMouseStillDownDelay, getMouseStillDownInitialDelay, getName, getNativeAutoHideScrollbars, getNextZIndex, getNoDoubleClicks, getNoDropCursor, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOuterElement, getOverflow, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getPaletteDefaults, getPanelContainer, getParentCanvas, getParentElement, getPeers, getPendingMarkerStyle, getPendingMarkerVisible, getPercentBox, getPercentSource, getPersistentMatchElement, getPointerSettings, getPointerTarget, getPointerTargetAsString, getPosition, getPrefix, getPrintChildrenAbsolutelyPositioned, getPrintHTML, getPrintHTML, getPrintStyleName, getPrompt, getProportionalResizeModifiers, getProportionalResizing, getReceiveScrollbarEvents, getRect, getRedrawOnResize, getResizeBarTarget, getResizeFrom, getRight, getRuleContext, getRuleContext, getRuleScope, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowColor, getShadowDepth, getShadowHOffset, getShadowImage, getShadowOffset, getShadowSoftness, getShadowSpread, getShadowVOffset, getShouldPrint, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowHover, getShowHoverComponents, getShowPointer, getShowResizeBar, getShowShadow, getShowSnapGrid, getShrinkElementOnHide, getSizeMayChangeOnRedraw, getSkinImgDir, getSnapAlignCandidates, getSnapAlignCenterLineStyle, getSnapAlignEdgeLineStyle, getSnapAxis, getSnapEdge, getSnapGridLineProperties, getSnapGridStyle, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapPosition, getSnapPosition, getSnapResizeToAlign, getSnapResizeToGrid, getSnapTo, getSnapToAlign, getSnapToCenterAlign, getSnapToEdgeAlign, getSnapToGrid, getSnapVDirection, getSnapVGap, getStartLine, getStyleName, getTabIndex, getTestDataContext, getTestInstance, getTitle, getTooltip, getTop, getTopAsString, getTopElement, getUISummary, getUpdateTabPositionOnDraw, getUpdateTabPositionOnReparent, getUseBackMask, getUseCSSShadow, getUseDragMask, getUseImageForSVG, getUseNativeDrag, getUseOpacityFilter, getUseTouchScrolling, getValuesManager, getValuesManagerAsString, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWhen, getVisibleWidth, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getWorkflows, getZIndex, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideComponentMask, hideComponentMask, hideContextMenu, imgHTML, imgHTML, imgHTML, initComplete, intersects, isDirty, isDisabled, isFocused, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, markForDestroy, markForRedraw, markForRedraw, moveAbove, moveBelow, moveBy, moveTo, onAttach, onDetach, pageScrollDown, pageScrollUp, parentResized, placeNear, placeNear, placeNear, print, print, print, print, printComponents, provideRuleContext, provideRuleContext, redraw, redraw, registerFontScaledPaddingStyles, removeChild, removeChild, removePeer, removePeer, removeRuleContext, removeSnapAlignCandidate, resizeAutoChildAttributes, resizeBy, resizeControls, resizeControlsTo, resizeFonts, resizeFonts, resizeFonts, resizeFontsTo, resizeIcons, resizePadding, resizePadding, resizeTo, resizeTo, revealChild, revealChild, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollTo, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAdaptHeightByCustomizer, setAdaptiveHeightPriority, setAdaptiveWidthPriority, setAdaptWidthByCustomizer, setAlign, setAllowExternalFilters, setAlwaysManageFocusNavigation, setAlwaysShowScrollbars, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideEffect, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeLayoutMode, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAriaRole, setAriaState, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setAutoHeight, setAutoMaskComponents, setAutoParent, setAutoPopulateData, setAutoResizeAutoChildAttributes, setAutoResizeIcons, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBorderRadius, setBottom, setCanAcceptDrop, setCanAdaptHeight, setCanAdaptWidth, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setChildren, setChildrenResizeSnapAlign, setChildrenSnapAlign, setChildrenSnapCenterAlign, setChildrenSnapEdgeAlign, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setComponentMaskDefaults, setContents, setContextMenu, setCorrectZoomOverflow, setCursor, setDataContext, setDataPath, setDefaultHeight, setDefaultPageSpace, setDefaultProperties, setDefaultShowCustomScrollbars, setDefaultWidth, setDefiningProperty, setDefiningPropertyNameOptions, setDisabled, setDisabledCursor, setDisableTouchScrollingForDrag, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragMaskType, setDragMaxHeight, setDragMaxWidth, setDragMinHeight, setDragMinWidth, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragTarget, setDragType, setDropTarget, setDropTarget, setDropTypes, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setEditMode, setEditMode, setEditMode, setEditProxyConstructor, setElement, setEnableWhen, setEndLine, setExtraSpace, setFacetId, setFloatingScrollbars, setForwardSVGeventsToObject, setGroupBorderCSS, setGroupLabelBackgroundColor, setGroupLabelStyleName, setGroupPadding, setGroupTitle, setHeight, setHeight, setHeight, setHeight100, setHideUsingDisplayNone, setHoverAlign, setHoverAutoDestroy, setHoverAutoFitMaxWidth, setHoverAutoFitMaxWidth, setHoverAutoFitWidth, setHoverDelay, setHoverFocusKey, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverPersist, setHoverScreen, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlElement, setHtmlElement, setHtmlPosition, setImage, setImage, setInitHandler, setIsGroup, setIsRuleScope, setIsSnapAlignCandidate, setKeepInParentRect, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeaveGroupLabelSpace, setLeavePageSpace, setLeft, setLeft, setLocateByIDOnly, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLocatorName, setLocatorParent, setLocatorParent, setLogicalStructure, setMargin, setMatchElement, setMatchElementHeight, setMatchElementWidth, setMaxHeight, setMaxWidth, setMaxZoomOverflowError, setMenuConstructor, setMinHeight, setMinNonEdgeSize, setMinWidth, setMomentumScrollMinSpeed, setMouseStillDownDelay, setMouseStillDownInitialDelay, setName, setNativeAutoHideScrollbars, setNeverUseFilters, setNoDoubleClicks, setNoDropCursor, setOpacity, setOverflow, setPadding, setPageLeft, setPageTop, setPanelContainer, setParentCanvas, setParentElement, setPeers, setPendingMarkerStyle, setPendingMarkerVisible, setPercentBox, setPercentSource, setPersistentMatchElement, setPointerSettings, setPointerTarget, setPosition, setPrefix, setPrintChildrenAbsolutelyPositioned, setPrintStyleName, setPrompt, setProportionalResizeModifiers, setProportionalResizing, setReceiveScrollbarEvents, setRect, setRect, setRedrawOnResize, setRelativeTabPosition, setResizeBarTarget, setResizeFrom, setResizeFrom, setRight, setRuleScope, setScrollbarConstructor, setScrollbarSize, setShadowColor, setShadowDepth, setShadowHOffset, setShadowImage, setShadowOffset, setShadowSoftness, setShadowSpread, setShadowVOffset, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowHover, setShowHoverComponents, setShowPointer, setShowResizeBar, setShowShadow, setShowSnapGrid, setShrinkElementOnHide, setSizeMayChangeOnRedraw, setSkinImgDir, setSmoothFade, setSnapAlignCandidates, setSnapAlignCenterLineStyle, setSnapAlignEdgeLineStyle, setSnapAxis, setSnapEdge, setSnapGridLineProperties, setSnapGridStyle, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToAlign, setSnapResizeToGrid, setSnapTo, setSnapToAlign, setSnapToCenterAlign, setSnapToEdgeAlign, setSnapToGrid, setSnapVDirection, setSnapVGap, setStartLine, setStyleName, setTabIndex, setTestDataContext, setTitle, setTooltip, setTop, setTop, setUpdateTabPositionOnDraw, setUpdateTabPositionOnReparent, setUseBackMask, setUseCSSShadow, setUseDragMask, setUseImageForSVG, setUseNativeDrag, setUseOpacityFilter, setUseTouchScrolling, setValuesManager, setValuesManager, setVisibility, setVisible, setVisibleWhen, setWidth, setWidth, setWidth, setWidth100, setWorkflows, setZIndex, shouldDragScroll, show, showClickMask, showComponentMask, showComponentMask, showNextTo, showNextTo, showNextTo, showNextTo, showPendingMarker, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, startDebuggingOverflow, stopDebuggingOverflow, updateChildTabPosition, updateChildTabPositions, updateEditNode, updateHover, updateHover, updateShadow, updateTabPositionForDraw, visibleAtPoint, willAcceptDrop

Methods inherited from class com.smartgwt.client.widgets.BaseWidget

addDrawHandler, addDynamicProperty, addDynamicProperty, addDynamicProperty, addDynamicProperty, applyFactoryProperties, clearDynamicProperty, completeCreation, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hasAutoAssignedID, hasDynamicProperty, hashCode, initNativeObject, internalSetID, internalSetID, isConfigOnly, isCreated, isDrawn, isFactoryCreated, onBind, onDestroy, onDraw, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setDefaultProperties, setDragTracker, setFactoryCreated, setID, setJavaScriptObject, setLogicalStructure, setLogicalStructure, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setScClassName, toString

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.smartgwt.client.widgets.DataBoundComponent

getOrCreateJsObj

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Constructor Details

Calendar

public Calendar()

Calendar

public Calendar(JavaScriptObject jsObj)

Method Details

getOrCreateRef

public static Calendar getOrCreateRef(JavaScriptObject jsObj)

changeAutoChildDefaults

public static void changeAutoChildDefaults(String autoChildName,
 Canvas defaults)

Changes the defaults for Canvas AutoChildren named autoChildName.

Parameters:

autoChildName - name of an AutoChild to customize the defaults for.

defaults - Canvas defaults to apply. These defaults override any existing properties without destroying or wiping out non-overridden properties. For usage tips on this param, see SGWTProperties.

See Also:

• AutoChildUsage

changeAutoChildDefaults

public static void changeAutoChildDefaults(String autoChildName,
 FormItem defaults)

Changes the defaults for FormItem AutoChildren named autoChildName.

Parameters:

autoChildName - name of an AutoChild to customize the defaults for.

defaults - FormItem defaults to apply. These defaults override any existing properties without destroying or wiping out non-overridden properties. For usage tips on this param, see SGWTProperties.

See Also:

• AutoChildUsage

create

protected JavaScriptObject create()

Overrides:

create in class Canvas

getAddEventButton

public ImgButton getAddEventButton()
                            throws IllegalStateException

An ImgButton that appears in a Calendar's week/day/month views and offers an alternative way to create a new event.

This component is an AutoChild named "addEventButton". For an overview of how to use and configure AutoChildren, see Using AutoChildren.

Returns:

Current addEventButton value. Default value is null

Throws:

IllegalStateException - if this widget has not yet been rendered.

setAddEventButtonHoverText

public Calendar setAddEventButtonHoverText(String addEventButtonHoverText)
                                    throws IllegalStateException

The text to be displayed when a user hovers over the add event toolbar button

Parameters:

addEventButtonHoverText - New addEventButtonHoverText value. Default value is "Add an event"

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getAddEventButtonHoverText

public String getAddEventButtonHoverText()

The text to be displayed when a user hovers over the add event toolbar button

Returns:

Current addEventButtonHoverText value. Default value is "Add an event"

setAllowDurationEvents

public Calendar setAllowDurationEvents(Boolean allowDurationEvents)

When set to true, allows events to be managed by duration, as well as by end date. Values can be set for duration and duration unit on each event, and are then maintained, instead of the end date, when alterations are made to the event via editors or dragging with the mouse.

Parameters:

allowDurationEvents - New allowDurationEvents value. Default value is null

Returns:

Calendar instance, for chaining setter calls

See Also:

• CalendarEvent

getAllowDurationEvents

public Boolean getAllowDurationEvents()

When set to true, allows events to be managed by duration, as well as by end date. Values can be set for duration and duration unit on each event, and are then maintained, instead of the end date, when alterations are made to the event via editors or dragging with the mouse.

Returns:

Current allowDurationEvents value. Default value is null

See Also:

• CalendarEvent

setAlternateLaneStyles

public Calendar setAlternateLaneStyles(Boolean alternateLaneStyles)

When showing a Timeline, or a day view when showDayLanes is true, whether to make lane boundaries more obvious by showing alternate lanes in a different color.

Parameters:

alternateLaneStyles - New alternateLaneStyles value. Default value is null

Returns:

Calendar instance, for chaining setter calls

getAlternateLaneStyles

public Boolean getAlternateLaneStyles()

When showing a Timeline, or a day view when showDayLanes is true, whether to make lane boundaries more obvious by showing alternate lanes in a different color.

Returns:

Current alternateLaneStyles value. Default value is null

setAlwaysShowEventHovers

public Calendar setAlwaysShowEventHovers(Boolean alwaysShowEventHovers)

By default, EventCanvases show their content in hovers. If you set this attribute to false, hovers will only be shown if the content of the event-canvas is visually clipped.

Note - if you have custom hover-content/handling, you should leave this property set to true.

Parameters:

alwaysShowEventHovers - New alwaysShowEventHovers value. Default value is true

Returns:

Calendar instance, for chaining setter calls

getAlwaysShowEventHovers

public Boolean getAlwaysShowEventHovers()

By default, EventCanvases show their content in hovers. If you set this attribute to false, hovers will only be shown if the content of the event-canvas is visually clipped.

Note - if you have custom hover-content/handling, you should leave this property set to true.

Returns:

Current alwaysShowEventHovers value. Default value is true

setBackButtonIconSrc

public Calendar setBackButtonIconSrc(String backButtonIconSrc)
                              throws IllegalStateException

The icon to show in the month-button on Handsets when the month view is the current visible view.

Parameters:

backButtonIconSrc - New backButtonIconSrc value. Default value is "Chevron_Left"

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

• SCImgURL

getBackButtonIconSrc

public String getBackButtonIconSrc()

The icon to show in the month-button on Handsets when the month view is the current visible view.

Returns:

Current backButtonIconSrc value. Default value is "Chevron_Left"

See Also:

• SCImgURL

setBackButtonTitle

public Calendar setBackButtonTitle(String backButtonTitle)
                            throws IllegalStateException

The title of the month on Handsets when the month view is the current visible view.

When the month view is not the current visible view, the title for the month button is set according to the value of monthButtonTitle.

Parameters:

backButtonTitle - New backButtonTitle value. Default value is "Back"

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

• HTMLString

getBackButtonTitle

public String getBackButtonTitle()

The title of the month on Handsets when the month view is the current visible view.

When the month view is not the current visible view, the title for the month button is set according to the value of monthButtonTitle.

Returns:

Current backButtonTitle value. Default value is "Back"

See Also:

• HTMLString

setBaseStyle

public Calendar setBaseStyle(String baseStyle)

The base name for the CSS class applied to the grid cells of the day and week views of the calendar. This style will have "Dark", "Over", "Selected", or "Disabled" appended to it according to the state of the cell.

See CellStyleSuffixes for details on how stateful suffixes are combined with the base style to generate stateful cell styles.

Parameters:

baseStyle - New baseStyle value. Default value is "calendar"

Returns:

Calendar instance, for chaining setter calls

See Also:

• CSSStyleName
• Appearance overview and related methods

getBaseStyle

public String getBaseStyle()

The base name for the CSS class applied to the grid cells of the day and week views of the calendar. This style will have "Dark", "Over", "Selected", or "Disabled" appended to it according to the state of the cell.

See CellStyleSuffixes for details on how stateful suffixes are combined with the base style to generate stateful cell styles.

Returns:

Current baseStyle value. Default value is "calendar"

See Also:

• CSSStyleName
• Appearance overview and related methods

setBringEventsToFront

public Calendar setBringEventsToFront(Boolean bringEventsToFront)
                               throws IllegalStateException

If set to true, clicking an event will bring it to the front of the zorder.

Parameters:

bringEventsToFront - New bringEventsToFront value. Default value is null

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getBringEventsToFront

public Boolean getBringEventsToFront()

If set to true, clicking an event will bring it to the front of the zorder.

Returns:

Current bringEventsToFront value. Default value is null

setCalMonthEventLinkStyle

public Calendar setCalMonthEventLinkStyle(String calMonthEventLinkStyle)

The base name for the CSS class applied to the links rendered by getDayBodyHTML().

These links are rendered as plain HTML links using A elements, and the CSS style in the provided skins references the pseudo-classes :link, :visited, :active, :hover.
Even though it goes against the general policy of not exposing the HTML structures SC writes out and not relying on them for styling, applying style to these particular selectors is acceptable, as we're unlikely to use any other kind of HTML structure than a link.

Parameters:

calMonthEventLinkStyle - New calMonthEventLinkStyle value. Default value is "calMonthEventLink"

Returns:

Calendar instance, for chaining setter calls

See Also:

• CSSStyleName
• Appearance overview and related methods

getCalMonthEventLinkStyle

public String getCalMonthEventLinkStyle()

The base name for the CSS class applied to the links rendered by getDayBodyHTML().

These links are rendered as plain HTML links using A elements, and the CSS style in the provided skins references the pseudo-classes :link, :visited, :active, :hover.
Even though it goes against the general policy of not exposing the HTML structures SC writes out and not relying on them for styling, applying style to these particular selectors is acceptable, as we're unlikely to use any other kind of HTML structure than a link.

Returns:

Current calMonthEventLinkStyle value. Default value is "calMonthEventLink"

See Also:

• CSSStyleName
• Appearance overview and related methods

getCancelButton

public IButton getCancelButton()
                        throws IllegalStateException

An com.smartgwt.client.types.AutoChild of type IButton, used to cancel editing of an event and close the eventEditor.

This component is an AutoChild named "cancelButton". For an overview of how to use and configure AutoChildren, see Using AutoChildren.

Returns:

Current cancelButton value. Default value is null

Throws:

IllegalStateException - if this widget has not yet been rendered.

setCancelButtonTitle

public Calendar setCancelButtonTitle(String cancelButtonTitle)
                              throws IllegalStateException

The title for the Cancel button in the event editor.

Parameters:

cancelButtonTitle - New cancelButtonTitle value. Default value is "Cancel"

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

• HTMLString

getCancelButtonTitle

public String getCancelButtonTitle()

The title for the Cancel button in the event editor.

Returns:

Current cancelButtonTitle value. Default value is "Cancel"

See Also:

• HTMLString

setCanCreateEvents

public Calendar setCanCreateEvents(Boolean canCreateEvents)
                            throws IllegalStateException

If true, users can create new events.

Parameters:

canCreateEvents - New canCreateEvents value. Default value is true

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getCanCreateEvents

public Boolean getCanCreateEvents()

If true, users can create new events.

Returns:

Current canCreateEvents value. Default value is true

setCanCreateOtherDayEvents

public Calendar setCanCreateOtherDayEvents(Boolean canCreateOtherDayEvents)

When showOtherDays is true, determines whether clicking in a Month-view body-cell that represents a date outside the selected month will open the event-editor window at the cell's location.

Note that, when otherDayClickNavigation is also true, the Month-view first switches to the month of the clicked date before displaying the event-editor. This causes the editor to open in a different cell than the one clicked and may be unexpected to users.

Parameters:

canCreateOtherDayEvents - New canCreateOtherDayEvents value. Default value is false

Returns:

Calendar instance, for chaining setter calls

getCanCreateOtherDayEvents

public Boolean getCanCreateOtherDayEvents()

When showOtherDays is true, determines whether clicking in a Month-view body-cell that represents a date outside the selected month will open the event-editor window at the cell's location.

Note that, when otherDayClickNavigation is also true, the Month-view first switches to the month of the clicked date before displaying the event-editor. This causes the editor to open in a different cell than the one clicked and may be unexpected to users.

Returns:

Current canCreateOtherDayEvents value. Default value is false

setCanDeleteEvents

public Calendar setCanDeleteEvents(Boolean canDeleteEvents)
                            throws IllegalStateException

Deprecated.

in favor of canRemoveEvents

If true, users can delete existing events. Defaults to canEditEvents.

Parameters:

canDeleteEvents - New canDeleteEvents value. Default value is null

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getCanDeleteEvents

public Boolean getCanDeleteEvents()

Deprecated.

in favor of canRemoveEvents

If true, users can delete existing events. Defaults to canEditEvents.

Returns:

Current canDeleteEvents value. Default value is null

setCanDragCreateEvents

public Calendar setCanDragCreateEvents(Boolean canDragCreateEvents)

A boolean value controlling whether new events of varying length can be created by dragging the cursor. By default, this is false for Touch devices and true otherwise.

Parameters:

canDragCreateEvents - New canDragCreateEvents value. Default value is null

Returns:

Calendar instance, for chaining setter calls

getCanDragCreateEvents

public Boolean getCanDragCreateEvents()

A boolean value controlling whether new events of varying length can be created by dragging the cursor. By default, this is false for Touch devices and true otherwise.

Returns:

Current canDragCreateEvents value. Default value is null

setCanDragEventField

public Calendar setCanDragEventField(String canDragEventField)
                              throws IllegalStateException

Name of the field on each CalendarEvent that determines whether an EventCanvas can be moved or resized by dragging with the mouse. Note that canEditEvents must be true for dragging to be allowed.

Parameters:

canDragEventField - New canDragEventField value. Default value is "canDrag"

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

• CalendarEvent

getCanDragEventField

public String getCanDragEventField()

Name of the field on each CalendarEvent that determines whether an EventCanvas can be moved or resized by dragging with the mouse. Note that canEditEvents must be true for dragging to be allowed.

Returns:

Current canDragEventField value. Default value is "canDrag"

See Also:

• CalendarEvent

setCanDragEvents

public Calendar setCanDragEvents(Boolean canDragEvents)
                          throws IllegalStateException

A boolean value controlling whether users can drag-reposition events. By default, this is false for Touch devices, where drag gestures scroll the view, and true otherwise.

Only has an effect when canEditEvents is true.

Parameters:

canDragEvents - New canDragEvents value. Default value is null

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getCanDragEvents

public Boolean getCanDragEvents()

A boolean value controlling whether users can drag-reposition events. By default, this is false for Touch devices, where drag gestures scroll the view, and true otherwise.

Only has an effect when canEditEvents is true.

Returns:

Current canDragEvents value. Default value is null

setCanEditEvents

public Calendar setCanEditEvents(Boolean canEditEvents)
                          throws IllegalStateException

If true, users can edit existing events.

Parameters:

canEditEvents - New canEditEvents value. Default value is true

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getCanEditEvents

public Boolean getCanEditEvents()

If true, users can edit existing events.

Returns:

Current canEditEvents value. Default value is true

setCanEditField

public Calendar setCanEditField(String canEditField)
                         throws IllegalStateException

Name of the field on each CalendarEvent that determines whether it can be edited in the event editor. Note that an event with canEdit set to true can also have canDrag or canResize set to false, which would still allow editing, but not via drag operations.

Parameters:

canEditField - New canEditField value. Default value is "canEdit"

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

• CalendarEvent

getCanEditField

public String getCanEditField()

Name of the field on each CalendarEvent that determines whether it can be edited in the event editor. Note that an event with canEdit set to true can also have canDrag or canResize set to false, which would still allow editing, but not via drag operations.

Returns:

Current canEditField value. Default value is "canEdit"

See Also:

• CalendarEvent

setCanEditLane

public Calendar setCanEditLane(Boolean canEditLane)
                        throws IllegalStateException

Can events be moved between lanes? If so, the event can be dragged to a different lane, and the event quick dialog and editor allow a lane to be selected with a drop-down chooser.

In either case, the event's laneNameField is updated automatically.

If set to false, cross-lane dragging is disallowed and drop-down Lane-choosers are disabled when editing existng events. When creating new events, the Lane-chooser remains enabled so an initial Lane can be selected.

This setting can be overridden on each event.

Parameters:

canEditLane - New canEditLane value. Default value is null

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getCanEditLane

public Boolean getCanEditLane()

Can events be moved between lanes? If so, the event can be dragged to a different lane, and the event quick dialog and editor allow a lane to be selected with a drop-down chooser.

In either case, the event's laneNameField is updated automatically.

If set to false, cross-lane dragging is disallowed and drop-down Lane-choosers are disabled when editing existng events. When creating new events, the Lane-chooser remains enabled so an initial Lane can be selected.

This setting can be overridden on each event.

Returns:

Current canEditLane value. Default value is null

setCanEditLaneField

public Calendar setCanEditLaneField(String canEditLaneField)
                             throws IllegalStateException

Name of the field on each CalendarEvent that determines whether that event can be moved between lanes.

Parameters:

canEditLaneField - New canEditLaneField value. Default value is "canEditLane"

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

• CalendarEvent

getCanEditLaneField

public String getCanEditLaneField()

Name of the field on each CalendarEvent that determines whether that event can be moved between lanes.

Returns:

Current canEditLaneField value. Default value is "canEditLane"

See Also:

• CalendarEvent

setCanEditSublane

public Calendar setCanEditSublane(Boolean canEditSublane)
                           throws IllegalStateException

Can events be moved between sublanes?

If so, the event can be dragged to a different sublane within the same parent Lane and, when it's editor is shown, an additional drop-down widget is provided allowing the sublane to be altered.

If the sublane is locked, but the parent lane isn't, an update to the event's lane name will be allowed, assuming that the new Lane has an existing sublane with the same name.

In either case, the event's sublane is updated automatically.

This setting can be overridden on each event.

Parameters:

canEditSublane - New canEditSublane value. Default value is null

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getCanEditSublane

public Boolean getCanEditSublane()

Can events be moved between sublanes?

If so, the event can be dragged to a different sublane within the same parent Lane and, when it's editor is shown, an additional drop-down widget is provided allowing the sublane to be altered.

If the sublane is locked, but the parent lane isn't, an update to the event's lane name will be allowed, assuming that the new Lane has an existing sublane with the same name.

In either case, the event's sublane is updated automatically.

This setting can be overridden on each event.

Returns:

Current canEditSublane value. Default value is null

setCanEditSublaneField

public Calendar setCanEditSublaneField(String canEditSublaneField)
                                throws IllegalStateException

Name of the field on each CalendarEvent that determines whether that event can be moved between individual sublanes in a Lane.

Parameters:

canEditSublaneField - New canEditSublaneField value. Default value is "canEditSublane"

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

• CalendarEvent

getCanEditSublaneField

public String getCanEditSublaneField()

Name of the field on each CalendarEvent that determines whether that event can be moved between individual sublanes in a Lane.

Returns:

Current canEditSublaneField value. Default value is "canEditSublane"

See Also:

• CalendarEvent

setCanGroupLanes

public Calendar setCanGroupLanes(Boolean canGroupLanes)

If true, allows the lanes in a Timeline to be grouped by providing a value for laneGroupByField. The fields available for grouping on are those defined as lane fields. Since these are definitions for normal fields, you can choose to hide the field in the timeline, but still have it available for grouping.

Parameters:

canGroupLanes - New canGroupLanes value. Default value is null

Returns:

Calendar instance, for chaining setter calls

getCanGroupLanes

public Boolean getCanGroupLanes()

If true, allows the lanes in a Timeline to be grouped by providing a value for laneGroupByField. The fields available for grouping on are those defined as lane fields. Since these are definitions for normal fields, you can choose to hide the field in the timeline, but still have it available for grouping.

Returns:

Current canGroupLanes value. Default value is null

setCanRemoveEvents

public Calendar setCanRemoveEvents(Boolean canRemoveEvents)
                            throws IllegalStateException

If true, users can remove existing events. Defaults to canEditEvents.

Parameters:

canRemoveEvents - New canRemoveEvents value. Default value is true

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getCanRemoveEvents

public Boolean getCanRemoveEvents()

If true, users can remove existing events. Defaults to canEditEvents.

Returns:

Current canRemoveEvents value. Default value is true

setCanRemoveField

public Calendar setCanRemoveField(String canRemoveField)
                           throws IllegalStateException

Name of the field on each CalendarEvent that determines whether an event shows a remove button.

Parameters:

canRemoveField - New canRemoveField value. Default value is "canRemove"

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

• CalendarEvent

getCanRemoveField

public String getCanRemoveField()

Name of the field on each CalendarEvent that determines whether an event shows a remove button.

Returns:

Current canRemoveField value. Default value is "canRemove"

See Also:

• CalendarEvent

setCanReorderLanes

public Calendar setCanReorderLanes(Boolean canReorderLanes)
                            throws IllegalStateException

If true, lanes can be reordered by dragging their laneFields with the mouse.

Parameters:

canReorderLanes - New canReorderLanes value. Default value is null

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getCanReorderLanes

public Boolean getCanReorderLanes()

If true, lanes can be reordered by dragging their laneFields with the mouse.

Returns:

Current canReorderLanes value. Default value is null

setCanResizeEventField

public Calendar setCanResizeEventField(String canResizeEventField)
                                throws IllegalStateException

Name of the field on each CalendarEvent that determines whether an event can be resized by dragging.

Parameters:

canResizeEventField - New canResizeEventField value. Default value is "canResize"

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

• CalendarEvent

getCanResizeEventField

public String getCanResizeEventField()

Name of the field on each CalendarEvent that determines whether an event can be resized by dragging.

Returns:

Current canResizeEventField value. Default value is "canResize"

See Also:

• CalendarEvent

setCanResizeEvents

public Calendar setCanResizeEvents(Boolean canResizeEvents)
                            throws IllegalStateException

Can events be resized by dragging appropriate edges of the canvas? Only has an effect when both canEditEvents and canDragEvents are true. Set this attribute to false to disallow drag-resizing.

Always false when showColumnLayouts is true.

Parameters:

canResizeEvents - New canResizeEvents value. Default value is true

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getCanResizeEvents

public Boolean getCanResizeEvents()

Can events be resized by dragging appropriate edges of the canvas? Only has an effect when both canEditEvents and canDragEvents are true. Set this attribute to false to disallow drag-resizing.

Always false when showColumnLayouts is true.

Returns:

Current canResizeEvents value. Default value is true

setCanResizeTimelineEvents

public Calendar setCanResizeTimelineEvents(Boolean canResizeTimelineEvents)
                                    throws IllegalStateException

Deprecated.

in favor of canResizeEvents;

Can Timeline events be stretched by their left and right edges?

Parameters:

canResizeTimelineEvents - New canResizeTimelineEvents value. Default value is false

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getCanResizeTimelineEvents

public Boolean getCanResizeTimelineEvents()

Deprecated.

in favor of canResizeEvents;

Can Timeline events be stretched by their left and right edges?

Returns:

Current canResizeTimelineEvents value. Default value is false

setCanSelectEvents

public Calendar setCanSelectEvents(Boolean canSelectEvents)
                            throws IllegalStateException

When set to true, makes individual event canvases selectable. Events may be selected via a single click, as well as being included in the page's tab order. The current selected event is shown in a special style and pressing TAB or Shift-TAB will move the selection first among the events in the same lane, and then among those in the next or previous lane.

Pressing Enter while an editable event is selected will show either the event- dialog or editor. Pressing Delete will remove the event.

Note that when this property is false, single clicking the event canvas for an editable event will bring up an editing interface for that event. When true this is no longer the case - a user can double click to bring up the editing interface instead (a single click will simply select the event canvas).

Parameters:

canSelectEvents - New canSelectEvents value. Default value is null

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getCanSelectEvents

public Boolean getCanSelectEvents()

When set to true, makes individual event canvases selectable. Events may be selected via a single click, as well as being included in the page's tab order. The current selected event is shown in a special style and pressing TAB or Shift-TAB will move the selection first among the events in the same lane, and then among those in the next or previous lane.

Pressing Enter while an editable event is selected will show either the event- dialog or editor. Pressing Delete will remove the event.

Note that when this property is false, single clicking the event canvas for an editable event will bring up an editing interface for that event. When true this is no longer the case - a user can double click to bring up the editing interface instead (a single click will simply select the event canvas).

Returns:

Current canSelectEvents value. Default value is null

setChosenDate

public Calendar setChosenDate(Date chosenDate)

The date for which events are displayed in the day, week, and month tabs of the calendar. Default is today.

If this method is called after the component has been drawn/initialized: Set the current date for which the calendar will display events.

Parameters:

chosenDate - the new date to set as the current date. Default value is 'Today'

Returns:

Calendar instance, for chaining setter calls

getChosenDate

public Date getChosenDate()

The date for which events are displayed in the day, week, and month tabs of the calendar. Default is today.

Returns:

Current chosenDate value. Default value is 'Today'

getColumnLayout

public VLayout getColumnLayout()

Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists. See Using AutoChildren for details.

When showColumnLayouts is true, the layouts added to each column to stack events.

Returns:

null

setColumnsPerPage

public Calendar setColumnsPerPage(Integer columnsPerPage)
                           throws IllegalStateException

When using the Next and Previous arrows to scroll a Timeline, this is the number of columns of the timelineGranularity to scroll by. With the default value of null, the Timeline will scroll by its current length.

Parameters:

columnsPerPage - New columnsPerPage value. Default value is null

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getColumnsPerPage

public Integer getColumnsPerPage()

When using the Next and Previous arrows to scroll a Timeline, this is the number of columns of the timelineGranularity to scroll by. With the default value of null, the Timeline will scroll by its current length.

Returns:

Current columnsPerPage value. Default value is null

setControlBarIconBaseStyle

public Calendar setControlBarIconBaseStyle(String controlBarIconBaseStyle)
                                    throws IllegalStateException

A CSS style to apply to icons in the controlsBar. This is a base style supporting suffixes for states, specifically "Over", "Down" and "Disabled", which are applied when ImgButton settings like ImgButton.showRollOverIcon are applied to the icons.

Parameters:

controlBarIconBaseStyle - New controlBarIconBaseStyle value. Default value is "icon"

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

• CSSStyleName

getControlBarIconBaseStyle

public String getControlBarIconBaseStyle()

A CSS style to apply to icons in the controlsBar. This is a base style supporting suffixes for states, specifically "Over", "Down" and "Disabled", which are applied when ImgButton settings like ImgButton.showRollOverIcon are applied to the icons.

Returns:

Current controlBarIconBaseStyle value. Default value is "icon"

See Also:

• CSSStyleName

setControlBarIconSize

public Calendar setControlBarIconSize(Integer controlBarIconSize)
                               throws IllegalStateException

The size of the various icons displayed in the controlsBar of this Calendar.

Parameters:

controlBarIconSize - New controlBarIconSize value. Default value is 16

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getControlBarIconSize

public Integer getControlBarIconSize()

The size of the various icons displayed in the controlsBar of this Calendar.

Returns:

Current controlBarIconSize value. Default value is 16

getControlsBar

public HLayout getControlsBar()
                       throws IllegalStateException

An HLayout shown above the Calendar views and displaying a set of controls for interacting with the current view - namely, the next, previous and add buttons, the date label and the date-picker icon.

This component is an AutoChild named "controlsBar". For an overview of how to use and configure AutoChildren, see Using AutoChildren.

Returns:

Current controlsBar value. Default value is null

Throws:

IllegalStateException - if this widget has not yet been rendered.

setControlsBarHeight

public Calendar setControlsBarHeight(Integer controlsBarHeight)
                              throws IllegalStateException

Default height of the controlsBar shown above the main Calendar grid. When multiple views are available and tabs are visible, this value is modified to ensure that the content of the controlsBar is vertically-aligned with the text in the tabs.

Parameters:

controlsBarHeight - New controlsBarHeight value. Default value is 30

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getControlsBarHeight

public Integer getControlsBarHeight()

Default height of the controlsBar shown above the main Calendar grid. When multiple views are available and tabs are visible, this value is modified to ensure that the content of the controlsBar is vertically-aligned with the text in the tabs.

Returns:

Current controlsBarHeight value. Default value is 30

setCurrentViewName

public Calendar setCurrentViewName(ViewName currentViewName)

The name of the view that should be visible initially by default.

If this method is called after the component has been drawn/initialized: Sets the currently visible view.

Parameters:

currentViewName - The name of the view that should be made visible. Default value is null

Returns:

Calendar instance, for chaining setter calls

getCurrentViewName

public ViewName getCurrentViewName()

The name of the view that should be visible initially by default.

Returns:

Get the name of the visible view. Returns one of 'day', 'week', 'month' or 'timeline'. Default value is null

setData

public Calendar setData(CalendarEvent... data)

A List of CalendarEvent objects, specifying the data to be used to populate the calendar.

This property will typically not be explicitly specified for databound Calendars, where the data is returned from the server via databound component methods such as fetchData(). In this case the data objects will be set to a resultSet rather than a simple array.

If this method is called after the component has been drawn/initialized: Initialize the data object with the given array. Observes methods of the data object so that when the data changes, the calendar will redraw automatically.

Parameters:

data - data to show in the list. Default value is null

Returns:

Calendar instance, for chaining setter calls

See Also:

• CalendarEvent

getData

public CalendarEvent[] getData()

A List of CalendarEvent objects, specifying the data to be used to populate the calendar.

This property will typically not be explicitly specified for databound Calendars, where the data is returned from the server via databound component methods such as fetchData(). In this case the data objects will be set to a resultSet rather than a simple array.

Returns:

Current data value. Default value is null

See Also:

• CalendarEvent

setDataFetchMode

public Calendar setDataFetchMode(FetchMode dataFetchMode)

How to fetch and manage records retrieve from the server. See FetchMode.

This setting only applies to the ResultSet automatically created by calling fetchData(). If a pre-existing ResultSet is passed to setData() instead, it's existing setting for ResultSet.fetchMode applies.

Specified by:

setDataFetchMode in interface DataBoundComponent

Parameters:

dataFetchMode - New dataFetchMode value. Default value is "basic"

Returns:

Calendar instance, for chaining setter calls

See Also:

• DataBinding

getDataFetchMode

public FetchMode getDataFetchMode()

How to fetch and manage records retrieve from the server. See FetchMode.

This setting only applies to the ResultSet automatically created by calling fetchData(). If a pre-existing ResultSet is passed to setData() instead, it's existing setting for ResultSet.fetchMode applies.

Specified by:

getDataFetchMode in interface DataBoundComponent

Returns:

Current dataFetchMode value. Default value is "basic"

See Also:

• DataBinding

setDataSource

public Calendar setDataSource(DataSource dataSource)

The DataSource that this component should bind to for default fields and for performing DataSource requests.

Can be specified as either a DataSource instance or the String ID of a DataSource.

Specified by:

setDataSource in interface DataBoundComponent

Parameters:

dataSource - New dataSource value. Default value is null

Returns:

Calendar instance, for chaining setter calls

See Also:

• DataBinding
• DataSource fields Example

setDataSource

public Calendar setDataSource(String dataSource)

The DataSource that this component should bind to for default fields and for performing DataSource requests.

Can be specified as either a DataSource instance or the String ID of a DataSource.

Specified by:

setDataSource in interface DataBoundComponent

Parameters:

dataSource - New dataSource value. Default value is null

Returns:

Calendar instance, for chaining setter calls

See Also:

• DataBinding
• DataSource fields Example

getDateChooser

public DateChooser getDateChooser()
                           throws IllegalStateException

DateChooser used to select the date for which events will be displayed.

This component is an AutoChild named "dateChooser". For an overview of how to use and configure AutoChildren, see Using AutoChildren.

Returns:

Current dateChooser value. Default value is null

Throws:

IllegalStateException - if this widget has not yet been rendered.

setDateEditingStyle

public Calendar setDateEditingStyle(DateEditingStyle dateEditingStyle)
                             throws IllegalStateException

Indicates the type of controls to use in event-windows. Valid values are those in the DateEditingStyle type.

If unset, the editing style will be set to the field-type on the DataSource, if there is one. If there's no DataSource, it will be set to "date" if the granularity is "day" or larger and "time" if granularity is "minute" or smaller, otherwise "datetime".

Parameters:

dateEditingStyle - New dateEditingStyle value. Default value is null

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getDateEditingStyle

public DateEditingStyle getDateEditingStyle()

Indicates the type of controls to use in event-windows. Valid values are those in the DateEditingStyle type.

If unset, the editing style will be set to the field-type on the DataSource, if there is one. If there's no DataSource, it will be set to "date" if the granularity is "day" or larger and "time" if granularity is "minute" or smaller, otherwise "datetime".

Returns:

Current dateEditingStyle value. Default value is null

setDateFormatter

public Calendar setDateFormatter(DateDisplayFormat dateFormatter)

Date formatter for displaying events. Default is to use the system-wide default short date format, configured via DateUtil.setShortDisplayFormat(). Specify any valid DateDisplayFormat.

Parameters:

dateFormatter - New dateFormatter value. Default value is null

Returns:

Calendar instance, for chaining setter calls

getDateFormatter

public DateDisplayFormat getDateFormatter()

Date formatter for displaying events. Default is to use the system-wide default short date format, configured via DateUtil.setShortDisplayFormat(). Specify any valid DateDisplayFormat.

Returns:

Current dateFormatter value. Default value is null

getDateLabel

public Label getDateLabel()
                   throws IllegalStateException

The com.smartgwt.client.types.AutoChild Label used to display the current date or range above the selected calendar view.

This component is an AutoChild named "dateLabel". For an overview of how to use and configure AutoChildren, see Using AutoChildren.

Returns:

Current dateLabel value. Default value is null

Throws:

IllegalStateException - if this widget has not yet been rendered.

getDatePickerButton

public ImgButton getDatePickerButton()
                              throws IllegalStateException

An ImgButton that appears above the various views of the calendar and offers alternative access to a DateChooser to pick the current day.

This component is an AutoChild named "datePickerButton". For an overview of how to use and configure AutoChildren, see Using AutoChildren.

Returns:

Current datePickerButton value. Default value is null

Throws:

IllegalStateException - if this widget has not yet been rendered.

setDatePickerHoverText

public Calendar setDatePickerHoverText(String datePickerHoverText)
                                throws IllegalStateException

The text to be displayed when a user hovers over the date picker toolbar button

Parameters:

datePickerHoverText - New datePickerHoverText value. Default value is "Choose a date"

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getDatePickerHoverText

public String getDatePickerHoverText()

The text to be displayed when a user hovers over the date picker toolbar button

Returns:

Current datePickerHoverText value. Default value is "Choose a date"

setDayBodyBaseStyle

public Calendar setDayBodyBaseStyle(String dayBodyBaseStyle)

The base name for the CSS class applied to the day body of the month view of the calendar. This style will have "Dark", "Over", "Selected", or "Disabled" appended to it according to the state of the cell.

See CellStyleSuffixes for details on how stateful suffixes are combined with the base style to generate stateful cell styles.

Parameters:

dayBodyBaseStyle - New dayBodyBaseStyle value. Default value is "calMonthDayBody"

Returns:

Calendar instance, for chaining setter calls

See Also:

• CSSStyleName
• Appearance overview and related methods

getDayBodyBaseStyle

public String getDayBodyBaseStyle()

The base name for the CSS class applied to the day body of the month view of the calendar. This style will have "Dark", "Over", "Selected", or "Disabled" appended to it according to the state of the cell.

See CellStyleSuffixes for details on how stateful suffixes are combined with the base style to generate stateful cell styles.

Returns:

Current dayBodyBaseStyle value. Default value is "calMonthDayBody"

See Also:

• CSSStyleName
• Appearance overview and related methods

setDayHeaderBaseStyle

public Calendar setDayHeaderBaseStyle(String dayHeaderBaseStyle)

The base name for the CSS class applied to the day headers of the month view. This style will have "Dark", "Over", "Selected", or "Disabled" appended to it according to the state of the cell.

See CellStyleSuffixes for details on how stateful suffixes are combined with the base style to generate stateful cell styles.

Parameters:

dayHeaderBaseStyle - New dayHeaderBaseStyle value. Default value is "calMonthDayHeader"

Returns:

Calendar instance, for chaining setter calls

See Also:

• CSSStyleName
• Appearance overview and related methods

getDayHeaderBaseStyle

public String getDayHeaderBaseStyle()

The base name for the CSS class applied to the day headers of the month view. This style will have "Dark", "Over", "Selected", or "Disabled" appended to it according to the state of the cell.

See CellStyleSuffixes for details on how stateful suffixes are combined with the base style to generate stateful cell styles.

Returns:

Current dayHeaderBaseStyle value. Default value is "calMonthDayHeader"

See Also:

• CSSStyleName
• Appearance overview and related methods

getDayView

public CalendarView getDayView()
                        throws IllegalStateException

CalendarView used to display events that pertain to a given day.

This component is an AutoChild named "dayView". For an overview of how to use and configure AutoChildren, see Using AutoChildren.

Returns:

Current dayView value. Default value is null

Throws:

IllegalStateException - if this widget has not yet been rendered.

setDayViewTitle

public Calendar setDayViewTitle(String dayViewTitle)
                         throws IllegalStateException

The title for the day view.

Parameters:

dayViewTitle - New dayViewTitle value. Default value is "Day"

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getDayViewTitle

public String getDayViewTitle()

The title for the day view.

Returns:

Current dayViewTitle value. Default value is "Day"

setDefaultTimelineColumnSpan

public Calendar setDefaultTimelineColumnSpan(int defaultTimelineColumnSpan)
                                      throws IllegalStateException

The number of columns of the timelineGranularity to give the timeline by default if no endDate is provided. The default is 20.

Parameters:

defaultTimelineColumnSpan - New defaultTimelineColumnSpan value. Default value is 20

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getDefaultTimelineColumnSpan

public int getDefaultTimelineColumnSpan()

The number of columns of the timelineGranularity to give the timeline by default if no endDate is provided. The default is 20.

Returns:

Current defaultTimelineColumnSpan value. Default value is 20

setDescriptionField

public Calendar setDescriptionField(String descriptionField)
                             throws IllegalStateException

The name of the description field on a CalendarEvent.

Parameters:

descriptionField - New descriptionField value. Default value is "description"

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getDescriptionField

public String getDescriptionField()

The name of the description field on a CalendarEvent.

Returns:

Current descriptionField value. Default value is "description"

setDetailsButtonTitle

public Calendar setDetailsButtonTitle(String detailsButtonTitle)
                               throws IllegalStateException

The title for the edit button in the quick quick event dialog.

Parameters:

detailsButtonTitle - New detailsButtonTitle value. Default value is "Edit Details"

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

• HTMLString

getDetailsButtonTitle

public String getDetailsButtonTitle()

The title for the edit button in the quick quick event dialog.

Returns:

Current detailsButtonTitle value. Default value is "Edit Details"

See Also:

• HTMLString

setDisableWeekends

public Calendar setDisableWeekends(Boolean disableWeekends)

If true, weekend days appear in a disabled style and events cannot be created on weekends. Which days are considered weekends is controlled by weekendDays.

Parameters:

disableWeekends - New disableWeekends value. Default value is true

Returns:

Calendar instance, for chaining setter calls

See Also:

• Visibility overview and related methods

getDisableWeekends

public Boolean getDisableWeekends()

If true, weekend days appear in a disabled style and events cannot be created on weekends. Which days are considered weekends is controlled by weekendDays.

Returns:

Current disableWeekends value. Default value is true

See Also:

• Visibility overview and related methods

setDurationField

public Calendar setDurationField(String durationField)
                          throws IllegalStateException

The name of the duration field on a CalendarEvent.

Parameters:

durationField - New durationField value. Default value is "duration"

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

• CalendarEvent

getDurationField

public String getDurationField()

The name of the duration field on a CalendarEvent.

Returns:

Current durationField value. Default value is "duration"

See Also:

• CalendarEvent

setDurationUnitField

public Calendar setDurationUnitField(String durationUnitField)
                              throws IllegalStateException

The name of the durationUnit field on a CalendarEvent.

Parameters:

durationUnitField - New durationUnitField value. Default value is "durationUnit"

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

• CalendarEvent

getDurationUnitField

public String getDurationUnitField()

The name of the durationUnit field on a CalendarEvent.

Returns:

Current durationUnitField value. Default value is "durationUnit"

See Also:

• CalendarEvent

setEndDate

public Calendar setEndDate(Date endDate)
                    throws IllegalStateException

The end date of the calendar timeline view. Has no effect in other views.

To set different start and end dates after initial draw, see setTimelineRange.

Note that the value you provide may be automatically altered if showing header-levels, to fit to header boundaries.

Parameters:

endDate - New endDate value. Default value is null

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getEndDate

public Date getEndDate()

The end date of the calendar timeline view. Has no effect in other views.

To set different start and end dates after initial draw, see setTimelineRange.

Note that the value you provide may be automatically altered if showing header-levels, to fit to header boundaries.

Returns:

Current endDate value. Default value is null

setEndDateField

public Calendar setEndDateField(String endDateField)
                         throws IllegalStateException

The name of the end date field on a CalendarEvent.

Parameters:

endDateField - New endDateField value. Default value is "endDate"

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

• CalendarEvent

getEndDateField

public String getEndDateField()

The name of the end date field on a CalendarEvent.

Returns:

Current endDateField value. Default value is "endDate"

See Also:

• CalendarEvent

setEventAutoArrange

public Calendar setEventAutoArrange(Boolean eventAutoArrange)
                             throws IllegalStateException

If set to true, enables the auto-arrangement of events that share time in the calendar. The default is true.

Parameters:

eventAutoArrange - New eventAutoArrange value. Default value is true

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getEventAutoArrange

public Boolean getEventAutoArrange()

If set to true, enables the auto-arrangement of events that share time in the calendar. The default is true.

Returns:

Current eventAutoArrange value. Default value is true

getEventCanvas

public EventCanvas getEventCanvas()

Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists. See Using AutoChildren for details.

To display events in day, week and timeline views, the Calendar creates instances of EventCanvas for each event. Use the com.smartgwt.client.types.AutoChild system to customize these canvases.

Returns:

null

getEventCanvasButtonLayout

public HLayout getEventCanvasButtonLayout()
                                   throws IllegalStateException

HLayout that snaps to the top-right of an event canvas on rollover and contains the close and/or context buttons.

This component is an AutoChild named "eventCanvasButtonLayout". For an overview of how to use and configure AutoChildren, see Using AutoChildren.

Returns:

Current eventCanvasButtonLayout value. Default value is null

Throws:

IllegalStateException - if this widget has not yet been rendered.

getEventCanvasCloseButton

public ImgButton getEventCanvasCloseButton()
                                    throws IllegalStateException

The close button that snaps to the top-right of an event canvas on rollover and allows an event to be removed from a CalendarView.

This component is an AutoChild named "eventCanvasCloseButton". For an overview of how to use and configure AutoChildren, see Using AutoChildren.

Returns:

Current eventCanvasCloseButton value. Default value is null

Throws:

IllegalStateException - if this widget has not yet been rendered.

setEventCanvasCloseButtonSize

public Calendar setEventCanvasCloseButtonSize(Integer eventCanvasCloseButtonSize)
                                       throws IllegalStateException

The size of the close-button that snaps to the top-right of an event canvas on rollover and shows allows an event to be removed from a CalendarView.

Parameters:

eventCanvasCloseButtonSize - New eventCanvasCloseButtonSize value. Default value is 16

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getEventCanvasCloseButtonSize

public Integer getEventCanvasCloseButtonSize()

The size of the close-button that snaps to the top-right of an event canvas on rollover and shows allows an event to be removed from a CalendarView.

Returns:

Current eventCanvasCloseButtonSize value. Default value is 16

setEventCanvasCloseIconSize

public Calendar setEventCanvasCloseIconSize(Integer eventCanvasCloseIconSize)
                                     throws IllegalStateException

The size of the icon in the close-button floated over events on rollover.

Parameters:

eventCanvasCloseIconSize - New eventCanvasCloseIconSize value. Default value is 13

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getEventCanvasCloseIconSize

public Integer getEventCanvasCloseIconSize()

The size of the icon in the close-button floated over events on rollover.

Returns:

Current eventCanvasCloseIconSize value. Default value is 13

getEventCanvasComponent

public Canvas getEventCanvasComponent()

Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists. See Using AutoChildren for details.

Multi-AutoChild component, created as a space-filling member in individual event-canvases, when showEventCanvasComponents is true.

Returns:

null

See Also:

• getShowEventCanvasComponents()
• createEventCanvasComponent(com.smartgwt.client.widgets.calendar.EventCanvas)
• updateEventCanvasComponent(com.smartgwt.client.widgets.calendar.EventCanvas, com.smartgwt.client.widgets.Canvas)

getEventCanvasContextButton

public ImgButton getEventCanvasContextButton()
                                      throws IllegalStateException

The context button that snaps to the top-right of an event canvas on rollover and shows a custom context menu when clicked.

This component is an AutoChild named "eventCanvasContextButton". For an overview of how to use and configure AutoChildren, see Using AutoChildren.

Returns:

Current eventCanvasContextButton value. Default value is null

Throws:

IllegalStateException - if this widget has not yet been rendered.

getEventCanvasContextMenu

public Menu getEventCanvasContextMenu()
                               throws IllegalStateException

Context menu displayed when an event canvas is right-clicked, or when the rollover context button is clicked. The context button, and the menu itself, will only be displayed if getEventCanvasMenuItems returns an array of appropriate items for the event.

This component is an AutoChild named "eventCanvasContextMenu". For an overview of how to use and configure AutoChildren, see Using AutoChildren.

Returns:

Current eventCanvasContextMenu value. Default value is null

Throws:

IllegalStateException - if this widget has not yet been rendered.

getEventCanvasGripper

public Img getEventCanvasGripper()

Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists. See Using AutoChildren for details.

The "gripper" widget that snaps to the top of an event canvas and allows an event to be dragged with the mouse.

Returns:

null

getEventCanvasHResizer

public Img getEventCanvasHResizer()

Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists. See Using AutoChildren for details.

The resizer image that snaps to the left and right edges of an editable event canvas in a Timeline, allowing it to be resized horizontally by dragging with the mouse.

Returns:

null

getEventCanvasLabel

public Label getEventCanvasLabel()

Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists. See Using AutoChildren for details.

Returns:

null

getEventCanvasVResizer

public Img getEventCanvasVResizer()

Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists. See Using AutoChildren for details.

The resizer image that snaps to the bottom of event canvases in day and week views, allowing them to be resized vertically by dragging with the mouse.

Returns:

null

setEventDescriptionFieldTitle

public Calendar setEventDescriptionFieldTitle(String eventDescriptionFieldTitle)
                                       throws IllegalStateException

The title for the descriptionField field in the quick event dialog and the detailed editor.

Parameters:

eventDescriptionFieldTitle - New eventDescriptionFieldTitle value. Default value is "Description"

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

• HTMLString

getEventDescriptionFieldTitle

public String getEventDescriptionFieldTitle()

The title for the descriptionField field in the quick event dialog and the detailed editor.

Returns:

Current eventDescriptionFieldTitle value. Default value is "Description"

See Also:

• HTMLString

getEventDialog

public Window getEventDialog()
                      throws IllegalStateException

An com.smartgwt.client.types.AutoChild of type Window that displays a quick event entry form in a popup window.

This component is an AutoChild named "eventDialog". For an overview of how to use and configure AutoChildren, see Using AutoChildren.

Returns:

Current eventDialog value. Default value is null

Throws:

IllegalStateException - if this widget has not yet been rendered.

setEventDragGap

public Calendar setEventDragGap(Integer eventDragGap)

The number of pixels to leave to the right of events so overlapping events can still be added using the mouse.

Parameters:

eventDragGap - New eventDragGap value. Default value is 10

Returns:

Calendar instance, for chaining setter calls

getEventDragGap

public Integer getEventDragGap()

The number of pixels to leave to the right of events so overlapping events can still be added using the mouse.

Returns:

Current eventDragGap value. Default value is 10

setEventDurationFieldTitle

public Calendar setEventDurationFieldTitle(String eventDurationFieldTitle)
                                    throws IllegalStateException

The title for the duration field in the quick event dialog and the detailed editor.

Parameters:

eventDurationFieldTitle - New eventDurationFieldTitle value. Default value is "Duration"

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

• HTMLString

getEventDurationFieldTitle

public String getEventDurationFieldTitle()

The title for the duration field in the quick event dialog and the detailed editor.

Returns:

Current eventDurationFieldTitle value. Default value is "Duration"

See Also:

• HTMLString

setEventDurationUnitFieldTitle

public Calendar setEventDurationUnitFieldTitle(String eventDurationUnitFieldTitle)
                                        throws IllegalStateException

The title for the duration unit field in the quick event dialog and the detailed editor.

Parameters:

eventDurationUnitFieldTitle - New eventDurationUnitFieldTitle value. Default value is " "

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

• HTMLString

getEventDurationUnitFieldTitle

public String getEventDurationUnitFieldTitle()

The title for the duration unit field in the quick event dialog and the detailed editor.

Returns:

Current eventDurationUnitFieldTitle value. Default value is " "

See Also:

• HTMLString

getEventEditor

public DynamicForm getEventEditor()
                           throws IllegalStateException

An com.smartgwt.client.types.AutoChild of type DynamicForm which displays event data. This form is created within the event editor layout

This component is an AutoChild named "eventEditor". For an overview of how to use and configure AutoChildren, see Using AutoChildren.

Returns:

Current eventEditor value. Default value is null

Throws:

IllegalStateException - if this widget has not yet been rendered.

getEventEditorButtonLayout

public HLayout getEventEditorButtonLayout()
                                   throws IllegalStateException

An com.smartgwt.client.types.AutoChild of type HLayout which houses the Save, Remove and Cancel buttons in the eventEditor.

This component is an AutoChild named "eventEditorButtonLayout". For an overview of how to use and configure AutoChildren, see Using AutoChildren.

Returns:

Current eventEditorButtonLayout value. Default value is null

Throws:

IllegalStateException - if this widget has not yet been rendered.

setEventEditorButtons

public Calendar setEventEditorButtons(Object... eventEditorButtons)
                               throws IllegalStateException

The list of buttons to include in the eventEditor. Entries can be the names of the builtin buttons, saveButton, removeButton and cancelButton, or the names of custom autoChildren that have been defined on the Calendar instance, or widget instances that already exist.

The default is to show the builtin buttons.

Parameters:

eventEditorButtons - New eventEditorButtons value. Default value is (see below)

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getEventEditorButtons

public Object[] getEventEditorButtons()

The list of buttons to include in the eventEditor. Entries can be the names of the builtin buttons, saveButton, removeButton and cancelButton, or the names of custom autoChildren that have been defined on the Calendar instance, or widget instances that already exist.

The default is to show the builtin buttons.

Returns:

Current eventEditorButtons value. Default value is (see below)

setEventEditorDateFieldTitle

public Calendar setEventEditorDateFieldTitle(String eventEditorDateFieldTitle)
                                      throws IllegalStateException

The title for the Date-field in the eventEditor that allows for changing the logical start-date of an event, along with its start and end times, when editing events in the day and week views.

Parameters:

eventEditorDateFieldTitle - New eventEditorDateFieldTitle value. Default value is "Date"

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

• HTMLString
• Grid Editing

getEventEditorDateFieldTitle

public String getEventEditorDateFieldTitle()

The title for the Date-field in the eventEditor that allows for changing the logical start-date of an event, along with its start and end times, when editing events in the day and week views.

Returns:

Current eventEditorDateFieldTitle value. Default value is "Date"

See Also:

• HTMLString
• Grid Editing

getEventEditorLayout

public Window getEventEditorLayout()
                            throws IllegalStateException

An com.smartgwt.client.types.AutoChild of type Window that displays the full event editor

This component is an AutoChild named "eventEditorLayout". For an overview of how to use and configure AutoChildren, see Using AutoChildren.

Returns:

Current eventEditorLayout value. Default value is null

Throws:

IllegalStateException - if this widget has not yet been rendered.

setEventEndDateFieldTitle

public Calendar setEventEndDateFieldTitle(String eventEndDateFieldTitle)
                                   throws IllegalStateException

The title for the endDateField in the quick event dialog and the detailed editor.

Parameters:

eventEndDateFieldTitle - New eventEndDateFieldTitle value. Default value is "To"

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

• HTMLString

getEventEndDateFieldTitle

public String getEventEndDateFieldTitle()

The title for the endDateField in the quick event dialog and the detailed editor.

Returns:

Current eventEndDateFieldTitle value. Default value is "To"

See Also:

• HTMLString

setEventHeaderHeight

public Calendar setEventHeaderHeight(int eventHeaderHeight)
                              throws IllegalStateException

When eventHeaderWrap is false and showEventDescriptions is true, this is the fixed height for the header area in event canvases.

Parameters:

eventHeaderHeight - New eventHeaderHeight value. Default value is 14

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getEventHeaderHeight

public int getEventHeaderHeight()

When eventHeaderWrap is false and showEventDescriptions is true, this is the fixed height for the header area in event canvases.

Returns:

Current eventHeaderHeight value. Default value is 14

setEventHeaderWrap

public Calendar setEventHeaderWrap(boolean eventHeaderWrap)
                            throws IllegalStateException

When rendering the canvas for an event, whether to allow the content of the header area to wrap to multiple lines.

The default is true - if set to false, the header area is fixed, unless showEventDescriptions is false, in which case the header area fills the canvas.

Parameters:

eventHeaderWrap - New eventHeaderWrap value. Default value is true

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getEventHeaderWrap

public boolean getEventHeaderWrap()

When rendering the canvas for an event, whether to allow the content of the header area to wrap to multiple lines.

The default is true - if set to false, the header area is fixed, unless showEventDescriptions is false, in which case the header area fills the canvas.

Returns:

Current eventHeaderWrap value. Default value is true

setEventLaneFieldTitle

public Calendar setEventLaneFieldTitle(String eventLaneFieldTitle)
                                throws IllegalStateException

The title for the laneNameField in the quick event dialog and the detailed editor.

Parameters:

eventLaneFieldTitle - New eventLaneFieldTitle value. Default value is "Lane"

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

• HTMLString

getEventLaneFieldTitle

public String getEventLaneFieldTitle()

The title for the laneNameField in the quick event dialog and the detailed editor.

Returns:

Current eventLaneFieldTitle value. Default value is "Lane"

See Also:

• HTMLString

setEventNameFieldTitle

public Calendar setEventNameFieldTitle(String eventNameFieldTitle)
                                throws IllegalStateException

The title for the nameField in the quick event dialog and the detailed editor.

Parameters:

eventNameFieldTitle - New eventNameFieldTitle value. Default value is "Event Name"

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

• HTMLString

getEventNameFieldTitle

public String getEventNameFieldTitle()

The title for the nameField in the quick event dialog and the detailed editor.

Returns:

Current eventNameFieldTitle value. Default value is "Event Name"

See Also:

• HTMLString

setEventOverlap

public Calendar setEventOverlap(Boolean eventOverlap)
                         throws IllegalStateException

When eventAutoArrange is true, setting eventOverlap to true causes events that share timeslots to overlap each other by a percentage of their width, specified by eventOverlapPercent. The default is true for Calendars and false for Timelines.

Parameters:

eventOverlap - New eventOverlap value. Default value is true

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getEventOverlap

public Boolean getEventOverlap()

When eventAutoArrange is true, setting eventOverlap to true causes events that share timeslots to overlap each other by a percentage of their width, specified by eventOverlapPercent. The default is true for Calendars and false for Timelines.

Returns:

Current eventOverlap value. Default value is true

setEventOverlapIdenticalStartTimes

public Calendar setEventOverlapIdenticalStartTimes(Boolean eventOverlapIdenticalStartTimes)
                                            throws IllegalStateException

When set to true, events that start at the same time will not overlap each other to prevent events having their close button hidden.

Parameters:

eventOverlapIdenticalStartTimes - New eventOverlapIdenticalStartTimes value. Default value is false

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getEventOverlapIdenticalStartTimes

public Boolean getEventOverlapIdenticalStartTimes()

When set to true, events that start at the same time will not overlap each other to prevent events having their close button hidden.

Returns:

Current eventOverlapIdenticalStartTimes value. Default value is false

setEventOverlapPercent

public Calendar setEventOverlapPercent(int eventOverlapPercent)
                                throws IllegalStateException

The size of the overlap, presented as a percentage of the width of events sharing timeslots.

Parameters:

eventOverlapPercent - New eventOverlapPercent value. Default value is 10

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getEventOverlapPercent

public int getEventOverlapPercent()

The size of the overlap, presented as a percentage of the width of events sharing timeslots.

Returns:

Current eventOverlapPercent value. Default value is 10

setEventScreen

public Calendar setEventScreen(String eventScreen)
                        throws IllegalStateException

Screen to create (via createScreen()) in lieu of calling createEventCanvasComponent().

If this calendar has a dataSource, the created screen is provided with a Canvas.dataContext that includes the event being shown. Be sure the event screen meets these requirements to utilize the dataContext.

Parameters:

eventScreen - New eventScreen value. Default value is null

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

getEventScreen

public String getEventScreen()

Screen to create (via createScreen()) in lieu of calling createEventCanvasComponent().

If this calendar has a dataSource, the created screen is provided with a Canvas.dataContext that includes the event being shown. Be sure the event screen meets these requirements to utilize the dataContext.

Returns:

Current eventScreen value. Default value is null

setEventSnapGap

public Calendar setEventSnapGap(Integer eventSnapGap)

The number of minutes that determines the positions to which events will snap when rendered, and when moved or resized with the mouse.

If unset (the default), all views will snap to each cell boundary; 30 minutes in a default vertical view, or one column in a default Timeline.

If set to zero, views will snap to one of a set of known "sensible" defaults: for a default vertical, this will be 5 minutes. For timelines, the eventSnapGap is automatic depending on the current timelineGranularity. If timelineUnitsPerColumn is greater than 1, the snapGap is set to one unit of the current granularity. So, a cell-resolution of 15 minutes would snap to every minute, assuming there are at least 15 pixels per column. Otherwise, the snapGap is either 15 minutes, 1 hour, one day or one month, depending on granularity.

If any other value is specified, it is used where possible.

If the specified or calculated value is less than the time covered by a single pixel in the current view, then it can't be represented. In this case, it is rounded up to the lowest of a set of "sensible" time-spans that can be represented: one of [1, 5, 10, 15, 20, 30, 60, 120, 240, 360, 480, 720, 1440].

For example - a Timeline showing "day" columns cannot support an eventSnapGap of 1 minute, unless each column is at least 1440 pixels wide - if the columns were only 150px wide, then each pixel would represent around 9.6 minutes, which would result in unpleasant and unexpected time-offsets when dragging events. So, the calculated eventSnapGap will be rounded up to the nearest "sensible" time-span - in this case, 10 minutes. If the columns were only 60px wide, it would be 30 minutes.

Parameters:

eventSnapGap - New eventSnapGap value. Default value is null

Returns:

Calendar instance, for chaining setter calls

See Also:

• Grid Editing

getEventSnapGap

public Integer getEventSnapGap()

The number of minutes that determines the positions to which events will snap when rendered, and when moved or resized with the mouse.

If unset (the default), all views will snap to each cell boundary; 30 minutes in a default vertical view, or one column in a default Timeline.

If set to zero, views will snap to one of a set of known "sensible" defaults: for a default vertical, this will be 5 minutes. For timelines, the eventSnapGap is automatic depending on the current timelineGranularity. If timelineUnitsPerColumn is greater than 1, the snapGap is set to one unit of the current granularity. So, a cell-resolution of 15 minutes would snap to every minute, assuming there are at least 15 pixels per column. Otherwise, the snapGap is either 15 minutes, 1 hour, one day or one month, depending on granularity.

If any other value is specified, it is used where possible.

If the specified or calculated value is less than the time covered by a single pixel in the current view, then it can't be represented. In this case, it is rounded up to the lowest of a set of "sensible" time-spans that can be represented: one of [1, 5, 10, 15, 20, 30, 60, 120, 240, 360, 480, 720, 1440].

For example - a Timeline showing "day" columns cannot support an eventSnapGap of 1 minute, unless each column is at least 1440 pixels wide - if the columns were only 150px wide, then each pixel would represent around 9.6 minutes, which would result in unpleasant and unexpected time-offsets when dragging events. So, the calculated eventSnapGap will be rounded up to the nearest "sensible" time-span - in this case, 10 minutes. If the columns were only 60px wide, it would be 30 minutes.

Returns:

Current eventSnapGap value. Default value is null

See Also:

• Grid Editing

setEventStartDateFieldTitle

public Calendar setEventStartDateFieldTitle(String eventStartDateFieldTitle)
                                     throws IllegalStateException

The title for the startDateField in the quick event dialog and the detailed editor.

Parameters:

eventStartDateFieldTitle - New eventStartDateFieldTitle value. Default value is "From"

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

• HTMLString

getEventStartDateFieldTitle

public String getEventStartDateFieldTitle()

The title for the startDateField in the quick event dialog and the detailed editor.

Returns:

Current eventStartDateFieldTitle value. Default value is "From"

See Also:

• HTMLString

setEventStyleName

public Calendar setEventStyleName(String eventStyleName)

The base name for the CSS class applied to events when they're rendered in calendar views. This style will have "Header" and "Body" appended to it, according to which part of the event window is being styled. For example, to style the header, define a CSS class called 'eventWindowHeader'.

Parameters:

eventStyleName - New eventStyleName value. Default value is "eventWindow"

Returns:

Calendar instance, for chaining setter calls

See Also:

• CSSStyleName
• Appearance overview and related methods

getEventStyleName

public String getEventStyleName()

The base name for the CSS class applied to events when they're rendered in calendar views. This style will have "Header" and "Body" appended to it, according to which part of the event window is being styled. For example, to style the header, define a CSS class called 'eventWindowHeader'.

Returns:

Current eventStyleName value. Default value is "eventWindow"

See Also:

• CSSStyleName
• Appearance overview and related methods

setEventStyleNameField

public Calendar setEventStyleNameField(String eventStyleNameField)
                                throws IllegalStateException

The name of the field used to override eventStyleName for an individual CalendarEvent.styleName.

Parameters:

eventStyleNameField - New eventStyleNameField value. Default value is "styleName"

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

• Appearance overview and related methods

getEventStyleNameField

public String getEventStyleNameField()

The name of the field used to override eventStyleName for an individual CalendarEvent.styleName.

Returns:

Current eventStyleNameField value. Default value is "styleName"

See Also:

• Appearance overview and related methods

setEventSublaneFieldTitle

public Calendar setEventSublaneFieldTitle(String eventSublaneFieldTitle)
                                   throws IllegalStateException

The title for the sublaneNameField in the quick event dialog and the detailed event editor.

Parameters:

eventSublaneFieldTitle - New eventSublaneFieldTitle value. Default value is "Sublane"

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

• HTMLString

getEventSublaneFieldTitle

public String getEventSublaneFieldTitle()

The title for the sublaneNameField in the quick event dialog and the detailed event editor.

Returns:

Current eventSublaneFieldTitle value. Default value is "Sublane"

See Also:

• HTMLString

setEventWindowStyle

public Calendar setEventWindowStyle(String eventWindowStyle)

Deprecated.

in favor of eventStyleName

The base name for the CSS class applied to event windows within calendars. This style will have "Header", "HeaderLabel", and "Body" appended to it, according to which part of the event window is being styled. For example, to style the header, define a CSS class called 'eventWindowHeader'.

Parameters:

eventWindowStyle - New eventWindowStyle value. Default value is null

Returns:

Calendar instance, for chaining setter calls

See Also:

• CSSStyleName
• Appearance overview and related methods

getEventWindowStyle

public String getEventWindowStyle()

Deprecated.

in favor of eventStyleName

The base name for the CSS class applied to event windows within calendars. This style will have "Header", "HeaderLabel", and "Body" appended to it, according to which part of the event window is being styled. For example, to style the header, define a CSS class called 'eventWindowHeader'.

Returns:

Current eventWindowStyle value. Default value is null

See Also:

• CSSStyleName
• Appearance overview and related methods

setEventWindowStyleField

public Calendar setEventWindowStyleField(String eventWindowStyleField)
                                  throws IllegalStateException

Deprecated.

in favor of eventStyleNameField

The name of the field used to override eventWindowStyle for an individual CalendarEvent. See CalendarEvent.eventWindowStyle.

Parameters:

eventWindowStyleField - New eventWindowStyleField value. Default value is "eventWindowStyle"

Returns:

Calendar instance, for chaining setter calls

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

• Appearance overview and related methods

getEventWindowStyleField

public String getEventWindowStyleField()

Deprecated.

in favor of eventStyleNameField

The name of the field used to override eventWindowStyle for an individual CalendarEvent. See CalendarEvent.eventWindowStyle.

Returns:

Current eventWindowStyleField value. Default value is "eventWindowStyle"

See Also:

• Appearance overview and related methods

setFirstDayOfWeek

public Calendar setFirstDayOfWeek(Integer firstDayOfWeek)

The numeric day (0-6, Sunday-Saturday) which the calendar should consider as the first day of the week in multi-day views, and in the popup DateChooser.

If unset, the default is taken from the current locale.

Parameters:

firstDayOfWeek - New firstDayOfWeek value. Default value is null

Returns:

Calendar instance, for chaining setter calls

getFirstDayOfWeek

public Integer getFirstDayOfWeek()

The numeric day (0-6, Sunday-Saturday) which the calendar should consider as the first day of the week in multi-day views, and in the popup DateChooser.

If unset, the default is taken from the current locale.

Returns:

Current firstDayOfWeek value. Default value is null

setHeaderLevels

public Calendar setHeaderLevels(HeaderLevel... headerLevels)

Configures the levels of headers shown above the event area, and their time units.

Header levels are provided from the top down, so the first header level should be the largest time unit and the last one the smallest. The smallest is then used for the actual field-headers.

If this method is called after the component has been drawn/initialized: For Timelines, configures the levels of headers shown above the event area, and their time units, after initialization.

Parameters:

headerLevels - the array of HeaderLevels to set. Default value is null

Returns:

Calendar instance, for chaining setter calls

getHeaderLevels

public HeaderLevel[] getHeaderLevels()

Configures the levels of headers shown above the event area, and their time units.

Header levels are provided from the top down, so the first header level should be the largest time unit and the last one the smallest. The smallest is then used for the actual field-headers.

Returns:

Current headerLevels value. Default value is null

setHideUnusedLanes

public Calendar setHideUnusedLanes(Boolean hideUnusedLanes)

When set to true, hides any lane that doesn't have any active events in the current dataset.

If this method is called after the component has been drawn/initialized: Setter for updating hideUnusedLanes after creation.

Parameters:

hideUnusedLanes - whether to hide unused lanes. Default value is null

Returns:

Calendar instance, for chaining setter calls

getHideUnusedLanes

public Boolean getHideUnusedLanes()

When set to true, hides any lane that doesn't have any active events in the current dataset.

Returns:

Current hideUnusedLanes value. Default value is null

setIncludeRangeCriteria

public Calendar setIncludeRangeCriteria(Boolean includeRangeCriteria)
                                 throws IllegalStateException

When set to true, the default, the fetches issued by navigating around in the various views are limited to the accessible date-range in the current view - as you change the current date-range, a fetch is only issued if the new range is not entirely within the previous range.

For example, navigating i