Search
Calendar Members
Constructors Methods
 


The Calendar control serves as a view in document-view architecture, where the document is implemented by the Schedule class. The Calendar provides several views modes, such as SingleMonth, List, Timetable, that present the scheduled events in different style, layout and resolution.

The following tables list the members exposed by the Calendar type.

 Public Constructors

  Name Description

Calendar

Overloaded. Initializes a new instance of the Calendar class.

 Public Methods

  Name Description

addCalendarListener

Adds a CalendarListener to the calendar.

applyTheme

Overloaded. Applies a theme to the calendar.

assignLanePriorities

 

beginInit

Call this method before making several consecutive changes to the control to suppress internal updates, but don't forget to invoke endInit at the end.

cancelModify

Cancels an interactive modification of an item, previously started by a call to startModify.

collapseResourceRow

Overloaded. Collapses the row associated with a specified resource or resources.

compactItemLanes

Overloaded. Reassigns new lane indices to items in order to remove empty spaces.

completeModify

Completes an interactive modification of an item, previously started by a call to startModify.

createImage

Overloaded.  

dispose

Disposes any resources used by this Calendar object.

endInit

Call this method to signal that object initialization started with beginInit is complete.

ensureVisible

Overloaded. Ensures that an item or a date is visible within the control.

expandResourceRow

Overloaded. Expands the row associated with a specified resource or resources.

getAllowAutoScroll

Gets a value indicating whether the control scrolls automatically its contents when users drag items near the edge of the client rectangle.

getAllowDrag

Gets a value indicating whether the user can initiate a drag operation within the component.

getAllowInplaceCreate

Gets a value indicating whether users are allowed to create items interactively.

getAllowInplaceEdit

Gets a value indicating whether users are allowed to edit items interactively.

getAllowMoveUnselectedItems

Gets a value indicating whether users are allowed to move unselected items.

getButtonOffset

Gets the offset of the navigation buttons, displayed in the views' headers.

getButtonSize

Gets the size of the navigation buttons, displayed in the views' headers.

getCalendarCursor

Gets the cursor that is displayed when the mouse pointer is over the calendar.

getColumnResizeCursorH

Gets the cursor that is displayed when a column can be resized or is being resized in a horizontal CalendarView.Timetable view.

getColumnResizeCursorV

Gets the cursor that is displayed when a column can be resized or is being resized in a vertical CalendarView.Timetable view.

getContactAt

Overloaded. Gets the Contact object associated with the calendar element at a specified position.

getContactNameFormat

Gets how to format and display contact names.

getContacts

Gets the contacts whose schedule to display in the component when getGroupType is GroupType.GroupByContacts.

getControlAppearance

Gets the visual style of the calendar child controls.

getControlStyle

Gets a ControlStyle object that allows customizing the visualization of the calendar child controls.

getCurrentTime

Gets the current time.

getCurrentView

Gets the type of the calendar view.

getCustomDraw

Gets which UI elements of the calendar should be custom drawn.

getCustomGroupType

Gets a runtime type of the resources to group by.

getCustomSecondaryGroupType

Gets a runtime type of the secondary resources to group by.

getCustomTheme

Gets the custom theme applied to the component.

getDate

Gets the date currently displayed in the calendar.

getDateAt

Overloaded. Returns the date of the calendar element located at a specified position.

getDateTimeInfo

Gets a DateTimeInfo object that specifies how to format and display all dates within the calendar.

getDayOfWeekStyles

Gets a collection of DayOfWeekStyle objects that allow customizing the appearance of specific days of the week in the calendar.

getDayStyles

Gets a collection of DateStyle objects that allow customizing the appearance of specific days in the calendar.

getDefaultSize

Gets the default size of the component.

getDelayInplaceEdit

Gets a value indicating whether the in-place editing of an item is delayed for a second when the item is clicked.

getDragFeedBackType

Gets the type of feedback to provide during drag-and-drop from ItemListView.

getDragItemsOnDisabledAreas

Gets a value indicating whether to update the position of items dragged over areas which do not allow items.

getElementBounds

Gets the bounding rectangle of a particular calendar element.

getEnableDragCreate

Gets a value indicating whether items are created merely by dragging in the control.

getEnableKeyboard

Gets a value indicating whether the selection can be manipulated through the keyboard.

getEndDate

Gets the last date displayed in the calendar.

getEnsureVisibleSelection

Gets a value indicating whether interactively selected cells should be automatically brought into view.

getExactDateAt

Overloaded. Returns the date located at a specified position.

getFirstDate

Gets the first date of the time range displayed in the calendar.

getFirstVisibleDate

Determines which is the first visible date in the current view.

getFirstVisibleResource

Determines which is the first visible resource in the current view.

getGroupType

Gets the grouping criteria for the CalendarView.Timetable, CalendarView.WeekRange, CalendarView.List and CalendarView.ResourceView views.

getHiddenItemsCursor

Gets the cursor that is displayed when the mouse pointer is over the hidden items cue icon.

getHScrollerSmallChange

Gets the small step for the horizontal scroll bar.

getHScrollerVisible

Gets a value indicating whether the horizontal scrollbar should always be visible, always hidden or visible only when it is needed.

getHScrollPos

Gets the current horizontal scroll position.

getImageList

Gets the image list associated with the calendar.

getInteractiveItemType

Gets the type of item that should be created when a user starts typing while the calendar control has the keyboard focus.

getItemAt

Overloaded. Gets the Item displayed at a specified position.

getItemBounds

Retrieves the bounding rectangle of the specified item.

getItemChangeResourceKey

Gets the modifier key, which lets users drag items between different contacts, resources, locations or tasks in a grouped view.

getItemCloneKey

Gets the modifier key, which when pressed allows users to interactively clone items.

getItemDragCursor

Gets the cursor that is displayed when an item is being dragged.

getItemDragKey

Gets the modifier key that lets users start a drag-and-drop operation when they drag an item.

getItemEffects

Gets a collection with all effects applied to the elements of this calendar.

getItemHResizeCursor

Gets the cursor that is displayed when the mouse pointer is over the horizontal resize area of an item.

getItemListLane

Gets the index of the lane of the specified item within a List view with ListViewSettings.setFreeDrag set to true.

getItemModificationStyle

Gets a value indicating the way items are processed when modified interactively.

getItemMoveCursor

Gets the cursor that is displayed when the mouse pointer is over the move area of an item.

getItemNoDragCursor

Gets the cursor that is displayed when an item is dragged over a location that cannot contain items.

getItemScroll

Gets the current scroll position in a List view with ListViewSettings.setEnableVirtualItemSpace set to true.

getItemSelection

Gets a list of all selected items.

getItemSettings

Gets the ItemSettings object used to customize the visualization of schedule items in all calendar views.

getItemTooltipFormat

Gets the format of item tooltips.

getItemVResizeCursor

Gets the cursor that is displayed when the mouse pointer is over the vertical resize area of an item.

getKeepItemSelection

Gets a value indicating whether the item selection is preserved when an item from the selection is clicked.

getLastDate

Gets the last date of the time range displayed in the calendar.

getLastVisibleDate

Determines which is the last visible date in the current view.

getLastVisibleResource

Determines which is the last visible resource in the current view.

getListLaneAt

Retrieves the index of the CalendarView.List view lane at the specified point, expressed in client coordinates.

getListViewSettings

Gets the ListViewSettings object used to customize the visualization of the CalendarView.List view.

getLocale

Gets the Locale object used to format and display time information in the calendar.

getLocationAt

Overloaded. Gets the Location object associated with the calendar element at a specified position.

getLocations

Gets the locations whose schedule to display in the control when getGroupType is GroupType.GroupByLocations.

getMinItemLength

Gets the minimal length of interactively created items, expressed in minutes.

getMonthRangeSettings

Gets the MonthRangeSettings object used to customize the visualization of a month range in the CalendarView.MonthRange view.

getMonthSettings

Gets the MonthSettings object used to customize the visualization of months in the CalendarView.MonthRange and CalendarView.SingleMonth views.

getMonthsInYear

Returns the number of months in the specified year according to the calendar settings.

getMonthStyles

Gets a collection of DateStyle objects that allow customizing the appearance of specific months in the calendar.

getPrintOptions

Gets a PrintOptions object that allows customizing various aspects of printing.

getRescheduleRecurrenceKey

Gets the modifier key, which when pressed allows users to interactively reschedule recurrent items.

getResourceAt

Overloaded. Gets the Resource object associated with the calendar element at a specified position.

getResources

Gets the resources whose schedule to display in the control when getGroupType is GroupType.GroupByResources.

getResourceViewSettings

Gets the ResourceViewSettings object used to customize the visualization of a CalendarView.ResourceView view.

getRightToLeft

Gets a value indicating whether control's elements are laid out from right to left.

getRowHeaderResizeCursor

Gets the cursor that is displayed when a row header can be resized or is being resized in a CalendarView.ResourceView view.

getSchedule

Gets the schedule whose information should be displayed inside the calendar component.

getScrollPosition

Gets the current scroll position.

getSecondaryGroupType

Gets the secondary grouping criteria for the CalendarView.ResourceView view.

getSelection

Gets a Selection object representing the current selection in the calendar.

getShowToolTips

Gets a value indicating whether the calendar displays tooltips.

getStartEditAfterModify

Gets a value indicating whether in-place editing of items should automatically start after they are modified interactively.

getTaskAt

Overloaded. Gets the Task object associated with the calendar element at a specified position.

getTasks

Gets the tasks whose schedule to display in the control when getGroupType is GroupType.GroupByTasks.

getTheme

Gets the theme applied to the calendar control UI elements.

getTimetableSettings

Gets the TimetableSettings object used to customize the visualization of days and hours in CalendarView.Timetable view.

getVisibleItems

Retrieves a collection with all currently visible items.

getVScrollerSmallChange

Gets the small step for the vertical scroll bar.

getVScrollerVisible

Gets a value indicating whether the vertical scrollbar should always be visible, always hidden or visible only when it is needed.

getVScrollPos

Gets the current vertical scroll position.

getWeekRangeSettings

Gets the WeekRangeSettings object used to customize the visualization of weeks in a CalendarView.WeekRange view.

invalidate

Overloaded.  

isResourceRowExpanded

Overloaded. Checks whether the row associated with a specified resource or resources in a Resource view is expanded.

onNavigationKeyPress

 

print

Overloaded. Prints the calendar.

printPreview

Overloaded. Displays a print preview of the calendar.

removeCalendarListener

Removes the specified CalendarListener from the calendar.

resetDrag

If there is a mouse drag operation in progress, it is canceled.

resumeDrag

Resumes the previously paused mouse drag operation.

setAllowAutoScroll

Sets a value indicating whether the control scrolls automatically its contents when users drag items near the edge of the client rectangle.

setAllowDrag

Sets a value indicating whether the user can initiate a drag operation within the component.

setAllowInplaceCreate

Sets a value indicating whether users are allowed to create items interactively.

setAllowInplaceEdit

Sets a value indicating whether users are allowed to edit items interactively.

setAllowMoveUnselectedItems

Sets a value indicating whether users are allowed to move unselected items.

setButtonOffset

Sets the offset of the navigation buttons, displayed in the views' headers.

setButtonSize

Sets the size of the navigation buttons, displayed in the views' headers.

setCalendarCursor

Sets the cursor that is displayed when the mouse pointer is over the calendar.

setColumnResizeCursorH

Sets the cursor that is displayed when a column can be resized or is being resized in a horizontal CalendarView.Timetable view.

setColumnResizeCursorV

Sets the cursor that is displayed when a column can be resized or is being resized in a vertical CalendarView.Timetable view.

setComponentOrientation

Component.setComponentOrientation override.

setContactNameFormat

Sets how to format and display contact names.

setControlAppearance

Gets the visual style of the calendar child controls.

setCurrentTime

Sets the current time.

setCurrentView

Sets the type of the calendar view.

setCustomDraw

Sets which UI elements of the calendar should be custom drawn.

setCustomGroupType

Sets a runtime type of the resources to group by.

setCustomSecondaryGroupType

Sets a runtime type of the secondary resources to group by.

setCustomTheme

Sets the custom theme applied to the component.

setDate

Sets the date currently displayed in the calendar.

setDateTimeFormat

Sets a DateTimeInfo object that specifies how to format and display all dates within the calendar.

setDelayInplaceEdit

Sets a value indicating whether the in-place editing of an item is delayed for a second when the item is clicked.

setDragFeedBackType

Sets the type of feedback to provide during drag-and-drop from ItemListView.

setDragItemsOnDisabledAreas

Sets a value indicating whether to update the position of items dragged over areas which do not allow items.

setEnableDragCreate

Sets a value indicating whether items are created merely by dragging in the control.

setEnableKeyboard

Sets a value indicating whether the selection can be manipulated through the keyboard.

setEndDate

Sets the last date displayed in the calendar.

setEnsureVisibleSelection

Sets a value indicating whether interactively selected cells should be automatically brought into view.

setGroupType

Sets the grouping criteria for the CalendarView.Timetable, CalendarView.WeekRange, CalendarView.List and CalendarView.ResourceView views.

setHiddenItemsCursor

Sets the cursor that is displayed when the mouse pointer is over the hidden items cue icon.

setHScrollerSmallChange

Sets the small step for the horizontal scroll bar.

setHScrollerVisible

Sets a value indicating whether the horizontal scrollbar should always be visible, always hidden or visible only when it is needed.

setHScrollPos

Sets the current horizontal scroll position.

setImageList

Sets the image list associated with the calendar.

setInteractiveItemType

Sets the type of item that should be created when a user starts typing while the calendar control has the keyboard focus.

setItemChangeResourceKey

Sets the modifier key, which lets users drag items between different contacts, resources, locations or tasks in a grouped view.

setItemCloneKey

Sets the modifier key, which when pressed allows users to interactively clone items.

setItemDragCursor

Sets the cursor that is displayed when an item is being dragged.

setItemDragKey

Sets the modifier key that lets users start a drag-and-drop operation when they drag an item.

setItemHResizeCursor

Sets the cursor that is displayed when the mouse pointer is over the horizontal resize area of an item.

setItemListLane

Sets the lane index for the specified item within a List view with ListViewSettings.setFreeDrag set to true.

setItemModificationStyle

Sets a value indicating the way items are processed when modified interactively.

setItemMoveCursor

Sets the cursor that is displayed when the mouse pointer is over the move area of an item.

setItemNoDragCursor

Sets the cursor that is displayed when an item is dragged over a location that cannot contain items.

setItemScroll

Sets the current scroll position in a List view with ListViewSettings.setEnableVirtualItemSpace set to true.

setItemTooltipFormat

Gets the format of item tooltips.

setItemVResizeCursor

Sets the cursor that is displayed when the mouse pointer is over the vertical resize area of an item.

setKeepItemSelection

Sets a value indicating whether the item selection is preserved when an item from the selection is clicked.

setLicenseKey

Sets the license key of the control.

setLocale

Sets the Locale object used to format and display time information in the calendar.

setMinItemLength

Gets the minimal length of interactively created items, expressed in minutes.

setRescheduleRecurrenceKey

Sets the modifier key, which when pressed allows users to interactively reschedule recurrent items.

setRightToLeft

Sets a value indicating whether control's elements are laid out from right to left.

setRowHeaderResizeCursor

Sets the cursor that is displayed when a row header can be resized or is being resized in a CalendarView.ResourceView view.

setSchedule

Sets the schedule whose information should be displayed inside the calendar component.

setScrollPosition

Sets the current scroll position.

setSecondaryGroupType

Sets the secondary grouping criteria for the CalendarView.ResourceView view.

setShowToolTips

Sets a value indicating whether the calendar displays tooltips.

setStartEditAfterModify

Sets a value indicating whether in-place editing of items should automatically start after they are modified interactively.

setTheme

Sets the theme applied to the calendar control UI elements.

setViewport

Sets the displayed time interval to the specified range, optionally changing the view resolution. If the interval is outside of the view range, the view range is expanded to include the interval.

setVScrollerSmallChange

Sets the small step for the vertical scroll bar.

setVScrollerVisible

Sets a value indicating whether the vertical scrollbar should always be visible, always hidden or visible only when it is needed.

setVScrollPos

Sets the current vertical scroll position.

snapInResourceView

Returns a new date representing the the specified date when snapped according to the current Resource View settings.

startInplaceEdit

Starts in-place editing mode for the specified item to let users edit the item's text.

startModify

Initiates interactive modification on the specified item.

suspendDrag

Temporarily pauses the current mouse drag operation.

update

Forces an update of the control.

updateLayout

Updates the position of the calendar's child controls such as buttons and scrollbars.

updateModify

Updates an interactive modification of an item, previously started by a call to startModify.

 Protected Methods

  Name Description

onBeginItemDrawing

Raises the CalendarListener.beginItemDrawing event.

onCustomizeGrouping

Raises the CalendarListener.customizeGrouping event.

onCustomizeText

Raises the CalendarListener.customizeText event.

onDateClick

Raises the CalendarListener.dateClick event.

onDraw

Raises the CalendarListener.draw event.

onDrawing

Raises the CalendarListener.drawing event.

onEndItemDrawing

Raises the CalendarListener.endItemDrawing event.

onHiddenItemClick

Raises the CalendarListener.hiddenItemClick event.

onHScroll

Raises the CalendarListener.hScroll event.

onItemClick

Raises the CalendarListener.itemClick event.

onItemCloned

Raises the CalendarListener.itemCloned event.

onItemCloning

Raises the CalendarListener.itemCloning event.

onItemCreated

Raises the CalendarListener.itemCreated event.

onItemCreating

Raises the CalendarListener.itemCreating event.

onItemCreationCanceled

Raises the CalendarListener.itemCreationCanceled event.

onItemDeleted

Raises the CalendarListener.itemDeleted event.

onItemDeleting

Raises the CalendarListener.itemDeleting event.

onItemDeselecting

Raises the CalendarListener.itemDeselecting event.

onItemDrawing

Raises the CalendarListener.itemDrawing event.

onItemInplaceEdited

Raises the CalendarListener.itemInplaceEdited event.

onItemInplaceEditEnding

Raises the CalendarListener.itemInplaceEditEnding event.

onItemInplaceEditStarting

Raises the CalendarListener.itemInplaceEditStarting event.

onItemListLaneChanged

Raises the CalendarListener.itemListLaneChanged event.

onItemModificationCanceled

Raises the CalendarListener.itemModificationCanceled event.

onItemModified

Raises the CalendarListener.itemModified event.

onItemModifying

Raises the CalendarListener.itemModifying event.

onItemSelecting

Raises the CalendarListener.itemSelecting event.

onItemSelectionChanged

Raises the CalendarListener.itemSelectionChanged event.

onItemSelectionComplete

Raises the CalendarListener.itemSelectionComplete event.

onItemsModified

Raises the CalendarListener.itemsModified event.

onItemTooltipDisplaying

Raises the CalendarListener.itemTooltipDisplaying event.

onListViewHeaderClick

Raises the CalendarListener.listViewHeaderClick event.

onMonthCellClick

Raises the CalendarListener.monthCellClick event.

onMonthHeaderClick

Raises the CalendarListener.monthHeaderClick event.

onMonthRangeHeaderClick

Raises the CalendarListener.monthRangeHeaderClick event.

onMonthWeekHeaderClick

Raises the CalendarListener.monthWeekHeaderClick event.

onRecurringItemDeleting

Raises the CalendarListener.recurringItemDeleting event.

onResourceViewBottomTimelineClick

Raises the CalendarListener.resourceViewBottomTimelineClick event.

onResourceViewMiddleTimelineClick

Raises the CalendarListener.resourceViewMiddleTimelineClick event.

onResourceViewRowHeaderClick

Raises the CalendarListener.resourceViewRowHeaderClick event.

onResourceViewTopTimelineClick

Raises the CalendarListener.resourceViewTopTimelineClick event.

onScroll

Raises the CalendarListener.scroll event.

onTimetableColumnHeaderClick

Raises the CalendarListener.timetableColumnHeaderClick event.

onTooltipDisplaying

Raises the CalendarListener.tooltipDisplaying event.

onVisibleDateChanged

Raises the CalendarListener.visibleDateChanged event.

onVScroll

Raises the CalendarListener.vScroll event.

onWeekRangeHeaderClick

Raises the CalendarListener.weekRangeHeaderClick event.

paintComponent

JComponent.paintComponent override.

raiseTimelineUnitsChanged

Raises the CalendarListener.timeLineUnitsChanged event.

 See Also