public class Calendar
extends javax.swing.JComponent
implements java.awt.print.Printable, javax.swing.Scrollable, javax.swing.event.AncestorListener, java.awt.datatransfer.ClipboardOwner, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.KeyListener, java.awt.event.ComponentListener
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.javax.swing.JComponent.AccessibleJComponent
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
Constructor and Description |
---|
Calendar()
Initializes a new instance of the
Calendar class using the default locale. |
Calendar(java.util.Locale locale)
Initializes a new instance of the
Calendar class using the specified Locale . |
Modifier and Type | Method and Description |
---|---|
void |
abortDelayedInplaceEdit()
If there is a delayed in-place editing requested,
which has not yet started, this method aborts it.
|
void |
addCalendarListener(CalendarListener listener)
Adds a
CalendarListener to the calendar. |
void |
ancestorAdded(javax.swing.event.AncestorEvent event) |
void |
ancestorMoved(javax.swing.event.AncestorEvent event) |
void |
ancestorRemoved(javax.swing.event.AncestorEvent event) |
void |
applyTheme(Theme theme)
Applies the specified theme to the calendar.
|
void |
applyTheme(Theme theme,
boolean reset)
Applies the specified theme to the calendar, optionally resetting all current settings.
|
void |
assignLanePriorities() |
void |
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. |
boolean |
cancelModify()
Cancels an interactive modification of an item, previously
started by a call to
startModify(com.mindfusion.scheduling.model.Item, java.awt.Point) . |
void |
collapseResourceRow(Resource resource)
|
void |
collapseResourceRow(Resource[] resources)
Collapses the row associated with the specified resources.
|
void |
compactItemLanes()
Reassigns new lane indices to schedule items in order to remove empty
spaces between items.
|
void |
compactItemLanes(java.util.List<Item> items)
Reassigns new lane indices to the specified schedule items in order
to remove empty spaces between the items and their neighbors.
|
boolean |
completeModify(java.awt.Point point)
Completes an interactive modification of an item, previously
started by a call to
startModify(com.mindfusion.scheduling.model.Item, java.awt.Point) . |
void |
componentHidden(java.awt.event.ComponentEvent e) |
void |
componentMoved(java.awt.event.ComponentEvent e) |
void |
componentResized(java.awt.event.ComponentEvent e) |
void |
componentShown(java.awt.event.ComponentEvent e) |
java.awt.image.BufferedImage |
createImage(boolean visibleOnly)
Creates a bitmap image of the current calendar view.
|
java.awt.image.BufferedImage |
createImage(boolean visibleOnly,
float scaleX,
float scaleY)
Creates a bitmap image of the current calendar view.
|
java.awt.image.BufferedImage |
createImage(boolean visibleOnly,
int desiredWidth,
int desiredHeight)
Creates a bitmap image of the current calendar view.
|
java.lang.Object |
createPrintRoot(java.awt.Rectangle bounds)
For internal use only.
|
void |
dispose()
Disposes any resources used by this
Calendar object. |
void |
endInit()
Call this method to signal that object initialization started with
beginInit() is complete. |
void |
endInplaceEdit(boolean accept)
Terminates a previously started in-place editing operation.
|
void |
ensureVisible(DateTime date)
Ensures that the specified date is visible within the control,
scrolling the contents of the control if necessary.
|
void |
ensureVisible(DateTime date,
Resource resource)
Ensures that the specified date is visible within the control, scrolling
the contents of the control if necessary.
|
void |
ensureVisible(Item item)
Ensures that the item is visible within the control,
scrolling the contents of the control if necessary.
|
void |
expandResourceRow(Resource resource)
|
void |
expandResourceRow(Resource[] resources)
Expands the row associated with the specified resources.
|
protected void |
finalize() |
boolean |
getAllowAutoScroll()
Gets a value indicating whether the control scrolls
automatically its contents when users drag items near the edge
of the client rectangle.
|
boolean |
getAllowDrag()
Gets a value indicating whether the user can initiate a
drag operation within the component.
|
boolean |
getAllowInplaceCreate()
Gets a value indicating whether users are allowed
to create items interactively.
|
boolean |
getAllowInplaceEdit()
Gets a value indicating whether users are allowed
to edit items interactively.
|
boolean |
getAllowMoveUnselectedItems()
Gets a value indicating whether users are allowed to move unselected items.
|
java.awt.Rectangle |
getBounds()
Gets the bounding rectangle of the component, in local coordinates.
|
int |
getButtonOffset()
Gets the offset of the navigation buttons, displayed in the views' headers.
|
int |
getButtonSize()
Gets the size of the navigation buttons, displayed in the views' headers.
|
Cursor |
getCalendarCursor()
Gets the cursor that is displayed when the mouse pointer is over the calendar.
|
Cursor |
getColumnResizeCursorH()
Gets the cursor that is displayed when a column can be resized or is being resized in a horizontal
Timetable view. |
Cursor |
getColumnResizeCursorV()
Gets the cursor that is displayed when a column can be resized or is being resized in a vertical
Timetable view. |
Contact |
getContactAt(int x,
int y)
Gets the
Contact object associated with
the calendar element at the specified point. |
Contact |
getContactAt(java.awt.Point point)
Gets the
Contact object associated with
the calendar element at the specified point. |
java.lang.String |
getContactNameFormat()
Gets how to format and display contact names.
|
ResourceList<Contact> |
getContacts()
Gets the contacts whose schedule to display in the component
when
getGroupType() is GroupType.GroupByContacts . |
ControlAppearance |
getControlAppearance()
Gets the visual style of the calendar child controls.
|
ControlStyle |
getControlStyle()
Gets a
ControlStyle object that allows customizing the
visualization of the calendar child controls. |
DateTime |
getCurrentTime()
Gets the current time.
|
CalendarView |
getCurrentView()
Gets the type of the calendar view.
|
java.util.EnumSet<CustomDrawElements> |
getCustomDraw()
Gets which UI elements of the calendar should be custom drawn.
|
java.lang.reflect.Type |
getCustomGroupType()
Gets a runtime type of the resources to group by.
|
java.lang.reflect.Type |
getCustomSecondaryGroupType()
Gets a runtime type of the secondary resources to group by.
|
Theme |
getCustomTheme()
Gets the custom theme applied to the component.
|
DateTime |
getDate()
Gets the date currently displayed in the calendar.
|
DateTime |
getDateAt(int x,
int y)
Returns the date of the calendar cell located at the specified coordinates.
|
DateTime |
getDateAt(int x,
int y,
ByRef<java.awt.Rectangle> bounds)
Returns the date of the calendar cell located at the specified position
and the bounding rectangle of the cell.
|
DateTime |
getDateAt(java.awt.Point point)
Returns the date of the calendar cell located at the specified position.
|
DateTime |
getDateAt(java.awt.Point point,
ByRef<java.awt.Rectangle> bounds)
Returns the date of the calendar cell located at the specified position
and the bounding rectangle of the cell.
|
DateTimeInfo |
getDateTimeInfo()
Gets a
DateTimeInfo object that specifies
how to format and display all dates within the calendar. |
DayOfWeekStyleList |
getDayOfWeekStyles()
Gets a collection of
DayOfWeekStyle objects that allow customizing
the appearance of specific days of the week in the calendar. |
DateStyleList |
getDayStyles()
Gets a collection of
DateStyle objects that allow customizing
the appearance of specific days in the calendar. |
java.awt.Dimension |
getDefaultSize()
Gets the default size of the component.
|
boolean |
getDelayInplaceEdit()
Gets a value indicating whether the in-place editing
of an item is delayed for a second when the item is clicked.
|
DragFeedBackType |
getDragFeedBackType()
Gets the type of feedback to provide during drag-and-drop from ItemListView.
|
boolean |
getDragItemsOnDisabledAreas()
Gets a value indicating whether to update the position
of items dragged over areas which do not allow items.
|
java.awt.Rectangle |
getElementBounds(CalendarElement element,
int index)
Gets the bounding rectangle of a particular calendar element.
|
boolean |
getEnableDragCreate()
Gets a value indicating whether items are created merely
by dragging in the control.
|
boolean |
getEnableKeyboard()
Gets a value indicating whether the selection can be
manipulated through the keyboard.
|
DateTime |
getEndDate()
Gets the last date displayed in the calendar.
|
boolean |
getEnsureVisibleSelection()
Gets a value indicating whether interactively selected cells
should be automatically brought into view.
|
DateTime |
getExactDateAt(int x,
int y)
Returns the date located at the specified coordinates.
|
DateTime |
getExactDateAt(java.awt.Point point)
Returns the date located at the specified position.
|
DateTime |
getFirstDate()
Gets the first date of the time range displayed in the calendar.
|
DateTime |
getFirstVisibleDate()
Determines which is the first visible date in the current view.
|
Resource |
getFirstVisibleResource()
Determines which is the first visible resource in the current view.
|
GroupType |
getGroupType()
|
Cursor |
getHiddenItemsCursor()
Gets the cursor that is displayed when the mouse pointer is over the hidden items cue icon.
|
int |
getHScrollerSmallChange()
Gets the small step for the horizontal scroll bar.
|
java.lang.Boolean |
getHScrollerVisible()
Gets a value indicating whether the horizontal scrollbar should
always be visible, always hidden or visible only when it is needed.
|
int |
getHScrollPos()
Gets the current horizontal scroll position.
|
java.awt.Image |
getImage(java.lang.String name) |
ImageList |
getImageList()
Gets the image list associated with the calendar.
|
boolean |
getInplaceAcceptOnEnter()
Gets whether to accept the changes when the user presses Enter during item in-place editing.
|
boolean |
getInplaceCancelOnEscape()
Gets whether to cancel the changes when the user presses Escape during item in-place editing.
|
java.lang.Class<? extends Item> |
getInteractiveItemType()
Gets the type of item that should be created when a user starts
typing while the calendar control has the keyboard focus.
|
boolean |
getIsVirtualListView()
Gets a value indicating whether the current view is
a
CalendarView.List view with enabled virtual item space. |
Item |
getItemAt(int x,
int y)
Gets the
Item object displayed at the specified coordinates. |
Item |
getItemAt(java.awt.Point point)
Gets the
Item object displayed at the specified coordinates. |
java.awt.Rectangle |
getItemBounds(Item item)
Retrieves the bounding rectangle of the specified item.
|
int |
getItemChangeResourceKey()
Gets the modifier key, which lets users drag items between
different contacts, resources, locations or tasks in a grouped view.
|
int |
getItemCloneKey()
Gets the modifier key, which when pressed allows users
to interactively clone items.
|
Cursor |
getItemDragCursor()
Gets the cursor that is displayed when an item is being dragged.
|
int |
getItemDragKey()
Gets the modifier key that lets users start a
drag-and-drop operation when they drag an item.
|
java.util.List<ItemEffect> |
getItemEffects()
Gets a collection with all effects applied to the elements of this calendar.
|
Cursor |
getItemHResizeCursor()
Gets the cursor that is displayed when the mouse pointer is over the horizontal resize area of an item.
|
int |
getItemListLane(Item item)
Gets the index of the lane of the specified item within a List view
with
setFreeDrag set to true. |
ItemModificationStyle |
getItemModificationStyle()
Gets a value indicating the way items are processed when modified interactively.
|
Cursor |
getItemMoveCursor()
Gets the cursor that is displayed when the mouse pointer is over the move area of an item.
|
Cursor |
getItemNoDragCursor()
Gets the cursor that is displayed when an item is dragged over a location that cannot contain items.
|
int |
getItemScroll()
Gets the current scroll position in a List view with
ListViewSettings.setEnableVirtualItemSpace(java.lang.Boolean) set to true. |
ItemSelection |
getItemSelection()
Gets a list of all selected items.
|
ItemSettings |
getItemSettings()
Gets the
ItemSettings object used to customize the
visualization of schedule items in all calendar views. |
java.lang.String |
getItemTooltipFormat()
Gets the format of item tooltips.
|
Cursor |
getItemVResizeCursor()
Gets the cursor that is displayed when the mouse pointer is over the vertical resize area of an item.
|
boolean |
getKeepItemSelection()
Gets a value indicating whether the item selection
is preserved when an item from the selection is clicked.
|
DateTime |
getLastDate()
Gets the last date of the time range displayed in the calendar.
|
DateTime |
getLastVisibleDate()
Determines which is the last visible date in the current view.
|
Resource |
getLastVisibleResource()
Determines which is the last visible resource in the current view.
|
int |
getListLaneAt(java.awt.Point point)
Retrieves the index of the
List view lane
at the specified point, expressed in client coordinates. |
ListViewSettings |
getListViewSettings()
Gets the
ListViewSettings object used to customize the
visualization of the List view. |
java.util.Locale |
getLocale()
Gets the
Locale object used to format and display
time information in the calendar. |
Location |
getLocationAt(int x,
int y)
Gets the
Location object associated with
the calendar element at the specified point. |
Location |
getLocationAt(java.awt.Point point)
Gets the
Location object associated with
the calendar element at the specified point. |
ResourceList<Location> |
getLocations()
Gets the locations whose schedule to display in the control
when
getGroupType() is GroupType.GroupByLocations . |
int |
getMaxListLane(DateTime start,
DateTime end)
Returns the maximum lane number from the current data of all
items in the specified interval.
|
int |
getMinItemLength()
Gets the minimal length of interactively
created items, expressed in minutes.
|
MonthRangeSettings |
getMonthRangeSettings()
Gets the
MonthRangeSettings object used to customize the
visualization of a month range in the MonthRange view. |
MonthSettings |
getMonthSettings()
Gets the
MonthSettings object used to customize the
visualization of months in the MonthRange and
SingleMonth views. |
int |
getMonthsInYear(int year)
Returns the number of months in the specified year
according to the calendar settings.
|
DateStyleList |
getMonthStyles()
Gets a collection of
DateStyle objects that allow customizing
the appearance of specific months in the calendar. |
java.awt.Dimension |
getPreferredScrollableViewportSize() |
java.awt.Dimension |
getPreferredSize() |
PrintOptions |
getPrintOptions()
Gets a
PrintOptions object that allows customizing various aspects of printing. |
int |
getRescheduleRecurrenceKey()
Gets the modifier key, which when pressed allows users
to interactively reschedule recurrent items.
|
Resource |
getResourceAt(int x,
int y)
Gets the
Resource object associated with
the calendar element at the specified point. |
Resource |
getResourceAt(java.awt.Point point)
Gets the
Resource object associated with
the calendar element at the specified point. |
ResourceList<Resource> |
getResources()
Gets the resources whose schedule to display in the control
when
getGroupType() is GroupType.GroupByResources . |
ResourceViewSettings |
getResourceViewSettings()
Gets the
ResourceViewSettings object used to customize the
visualization of a Resource view. |
boolean |
getRightToLeft()
Gets a value indicating whether control's elements are laid out from right to left.
|
java.awt.Point |
getRootScrollPosition()
For internal use only.
|
Cursor |
getRowHeaderResizeCursor()
Gets the cursor that is displayed when a row header can be resized
or is being resized in a
Resource view. |
Schedule |
getSchedule()
Gets the schedule whose information should be
displayed inside the calendar component.
|
int |
getScrollableBlockIncrement(java.awt.Rectangle visibleRect,
int orientation,
int direction) |
boolean |
getScrollableTracksViewportHeight() |
boolean |
getScrollableTracksViewportWidth() |
int |
getScrollableUnitIncrement(java.awt.Rectangle visibleRect,
int orientation,
int direction) |
java.awt.Point |
getScrollPosition()
Gets the current scroll position.
|
GroupType |
getSecondaryGroupType()
Gets the secondary grouping criteria for the
Resource view. |
Selection |
getSelection()
Gets a
Selection object representing the current selection in the calendar. |
boolean |
getShowToolTips()
Gets a value indicating whether the calendar displays tooltips.
|
boolean |
getStartEditAfterModify()
Gets a value indicating whether in-place editing of items
should automatically start after they are modified interactively.
|
Task |
getTaskAt(int x,
int y)
Gets the
Task object associated with
the calendar element at the specified point. |
Task |
getTaskAt(java.awt.Point point)
Gets the
Task object associated with
the calendar element at the specified point. |
ResourceList<Task> |
getTasks()
Gets the tasks whose schedule to display in the control
when
getGroupType() is GroupType.GroupByTasks . |
ThemeType |
getTheme()
Gets the theme applied to the calendar control UI elements.
|
TimetableSettings |
getTimetableSettings()
Gets the
TimetableSettings object used to customize the
visualization of days and hours in Timetable view. |
ItemList |
getVisibleItems()
Retrieves a collection with all currently visible items.
|
int |
getVScrollerSmallChange()
Gets the small step for the vertical scroll bar.
|
java.lang.Boolean |
getVScrollerVisible()
Gets a value indicating whether the vertical scrollbar should
always be visible, always hidden or visible only when it is needed.
|
int |
getVScrollPos()
Gets the current vertical scroll position.
|
WeekRangeSettings |
getWeekRangeSettings()
Gets the
WeekRangeSettings object used to customize the
visualization of weeks in a WeekRange view. |
void |
invalidate()
An auxiliary method that requests the component to be repainted.
|
void |
invalidate(int x,
int y,
int width,
int height)
An auxiliary method that requests a portion of the component to be repainted.
|
void |
invalidate(java.awt.Rectangle rect)
An auxiliary method that requests a portion of the component to be repainted.
|
boolean |
isResourceRowExpanded(Resource resource)
|
boolean |
isResourceRowExpanded(Resource[] resources)
Checks whether the row associated with the specified
resources in a Resource view is expanded.
|
void |
keyPressed(java.awt.event.KeyEvent e) |
void |
keyReleased(java.awt.event.KeyEvent e) |
void |
keyTyped(java.awt.event.KeyEvent e) |
void |
lostOwnership(java.awt.datatransfer.Clipboard clipboard,
java.awt.datatransfer.Transferable contents) |
void |
mouseClicked(java.awt.event.MouseEvent e) |
void |
mouseDragged(java.awt.event.MouseEvent arg) |
void |
mouseEntered(java.awt.event.MouseEvent e) |
void |
mouseExited(java.awt.event.MouseEvent e) |
void |
mouseMoved(java.awt.event.MouseEvent e) |
void |
mousePressed(java.awt.event.MouseEvent e) |
void |
mouseReleased(java.awt.event.MouseEvent e) |
protected void |
onBeginItemDrawing(java.util.EventObject e)
Raises the
CalendarListener.beginItemDrawing(java.util.EventObject) event. |
protected void |
onCustomizeGrouping(CustomizeGroupingEvent e)
|
protected void |
onCustomizeText(CalendarTextEvent e)
|
protected void |
onDateClick(ResourceDateEvent e)
Raises the
CalendarListener.dateClick(com.mindfusion.scheduling.ResourceDateEvent) event. |
protected void |
onDraw(CalendarDrawEvent e)
Raises the
CalendarListener.draw(com.mindfusion.scheduling.CalendarDrawEvent) event. |
protected void |
onDrawing(CalendarDrawEvent e)
Raises the
CalendarListener.drawing(com.mindfusion.scheduling.CalendarDrawEvent) event. |
protected void |
onEndItemDrawing(java.util.EventObject e)
Raises the
CalendarListener.endItemDrawing(java.util.EventObject) event. |
protected void |
onHiddenItemClick(DateEvent e)
Raises the
CalendarListener.hiddenItemClick(com.mindfusion.scheduling.DateEvent) event. |
protected void |
onHScroll(ScrollEvent e)
Raises the
CalendarListener.hScroll(com.mindfusion.common.ScrollEvent) event. |
protected void |
onItemClick(ItemMouseEvent e)
Raises the
CalendarListener.itemClick(com.mindfusion.scheduling.ItemMouseEvent) event. |
protected void |
onItemCloned(ItemEvent e)
Raises the
CalendarListener.itemCloned(com.mindfusion.scheduling.model.ItemEvent) event. |
protected void |
onItemCloning(ItemConfirmEvent e)
Raises the
CalendarListener.itemCloning(com.mindfusion.scheduling.ItemConfirmEvent) event. |
protected void |
onItemCreated(ItemEvent e)
Raises the
CalendarListener.itemCreated(com.mindfusion.scheduling.model.ItemEvent) event. |
protected void |
onItemCreating(ItemConfirmEvent e)
|
protected void |
onItemCreationCanceled(ItemEvent e)
|
protected void |
onItemDeleted(ItemEvent e)
Raises the
CalendarListener.itemDeleted(com.mindfusion.scheduling.model.ItemEvent) event. |
protected void |
onItemDeleting(ItemConfirmEvent e)
|
protected void |
onItemDeselecting(ItemConfirmEvent e)
|
protected void |
onItemDrawing(CalendarDrawEvent e)
|
protected void |
onItemInplaceEdited(ItemEvent e)
|
protected void |
onItemInplaceEditEnding(ItemEditConfirmEvent e)
|
protected void |
onItemInplaceEditStarting(ItemConfirmEvent e)
|
protected void |
onItemListLaneChanged(ItemListLaneChangedEvent e)
|
protected void |
onItemModificationCanceled(ItemEvent e)
|
protected void |
onItemModified(ItemModifiedEvent e)
|
protected void |
onItemModifying(ItemModifyConfirmEvent e)
|
protected void |
onItemSelecting(ItemConfirmEvent e)
|
protected void |
onItemSelectionChanged(ItemSelectionEvent e)
|
protected void |
onItemSelectionComplete(java.util.EventObject e)
Raises the
CalendarListener.itemSelectionComplete(java.util.EventObject) event. |
protected void |
onItemsModified(ItemsEvent e)
Raises the
CalendarListener.itemsModified(com.mindfusion.scheduling.ItemsEvent) event. |
protected void |
onItemTooltipDisplaying(ItemTooltipEvent e)
|
protected void |
onListViewHeaderClick(DateEvent e)
|
protected void |
onMonthCellClick(DateEvent e)
Raises the
CalendarListener.monthCellClick(com.mindfusion.scheduling.DateEvent) event. |
protected void |
onMonthHeaderClick(DateEvent e)
Raises the
CalendarListener.monthHeaderClick(com.mindfusion.scheduling.DateEvent) event. |
protected void |
onMonthRangeHeaderClick(DateEvent e)
|
protected void |
onMonthWeekHeaderClick(DateEvent e)
|
boolean |
onNavigationKeyPress(int keyData) |
protected void |
onRecurringItemDeleting(RecurringItemConfirmEvent e)
|
protected void |
onResourceViewBottomTimelineClick(DateEvent e)
|
protected void |
onResourceViewMiddleTimelineClick(DateEvent e)
|
protected void |
onResourceViewRowHeaderClick(ResourceDateEvent e)
|
protected void |
onResourceViewTopTimelineClick(DateEvent e)
|
protected void |
onScroll(java.util.EventObject e)
Raises the
CalendarListener.scroll(java.util.EventObject) event. |
protected void |
onTimetableColumnHeaderClick(DateEvent e)
|
protected void |
onTooltipDisplaying(TooltipEvent e)
|
protected void |
onVisibleDateChanged(DateChangedEvent e)
Raises the
visibleDateChanged event. |
protected void |
onVScroll(ScrollEvent e)
Raises the
CalendarListener.vScroll(com.mindfusion.common.ScrollEvent) event. |
protected void |
onWeekRangeHeaderClick(DateEvent e)
|
protected void |
paintComponent(java.awt.Graphics g) |
void |
print()
Prints the current calendar using the default format and printer.
|
int |
print(java.awt.Graphics graphics,
java.awt.print.PageFormat pageFormat,
int pageIndex)
Printable.print implementation. |
void |
print(java.awt.print.PageFormat pageFormat,
java.lang.String printer)
Prints the current calendar using the specified page format.
|
void |
print(java.lang.String printer)
Prints the current calendar using the default format.
|
void |
printPreview()
Displays a print preview window, that shows how the diagram would
look when printed on paper.
|
void |
printPreview(java.awt.print.PageFormat pageFormat)
Displays a print preview window, that shows how the diagram would
look when printed on paper.
|
protected void |
raiseTimelineUnitsChanged(java.util.EventObject e)
Raises the
CalendarListener.timeLineUnitsChanged(java.util.EventObject) event. |
void |
raiseVisibleDateChanged(DateTime prevDate,
DateTime newDate)
Invokes the
CalendarListener.visibleDateChanged(com.mindfusion.scheduling.DateChangedEvent) method from the outside. |
void |
removeCalendarListener(CalendarListener listener)
Removes the specified
CalendarListener from the calendar. |
void |
resetDrag()
If there is a mouse drag operation in progress, it is canceled.
|
void |
resumeDrag()
Resumes the previously paused mouse drag operation.
|
void |
setAllowAutoScroll(boolean value)
Sets a value indicating whether the control scrolls
automatically its contents when users drag items near the edge
of the client rectangle.
|
void |
setAllowDrag(boolean value)
Sets a value indicating whether the user can initiate a
drag operation within the component.
|
void |
setAllowInplaceCreate(boolean value)
Sets a value indicating whether users are allowed
to create items interactively.
|
void |
setAllowInplaceEdit(boolean value)
Sets a value indicating whether users are allowed
to edit items interactively.
|
void |
setAllowMoveUnselectedItems(boolean value)
Sets a value indicating whether users are allowed to move unselected items.
|
void |
setBounds(java.awt.Rectangle value)
Sets the bounding rectangle of the component, in local coordinates.
|
void |
setButtonOffset(int value)
Sets the offset of the navigation buttons, displayed in the views' headers.
|
void |
setButtonSize(int value)
Sets the size of the navigation buttons, displayed in the views' headers.
|
void |
setCalendarCursor(Cursor value)
Sets the cursor that is displayed when the mouse pointer is over the calendar.
|
void |
setColumnResizeCursorH(Cursor value)
Sets the cursor that is displayed when a column can be resized or is being resized in a horizontal
Timetable view. |
void |
setColumnResizeCursorV(Cursor value)
Sets the cursor that is displayed when a column can be resized or is being resized in a vertical
Timetable view. |
void |
setComponentOrientation(java.awt.ComponentOrientation o)
Component.setComponentOrientation override. |
void |
setContactNameFormat(java.lang.String value)
Sets how to format and display contact names.
|
void |
setControlAppearance(ControlAppearance value)
Gets the visual style of the calendar child controls.
|
void |
setCurrentTime(DateTime value)
Sets the current time.
|
void |
setCurrentView(CalendarView value)
Sets the type of the calendar view.
|
void |
setCustomDraw(java.util.EnumSet<CustomDrawElements> value)
Sets which UI elements of the calendar should be custom drawn.
|
void |
setCustomGroupType(java.lang.reflect.Type value)
Sets a runtime type of the resources to group by.
|
void |
setCustomSecondaryGroupType(java.lang.reflect.Type value)
Sets a runtime type of the secondary resources to group by.
|
void |
setCustomTheme(Theme value)
Sets the custom theme applied to the component.
|
void |
setDate(DateTime value)
Sets the date currently displayed in the calendar.
|
void |
setDateTimeFormat(DateTimeInfo value)
Sets a
DateTimeInfo object that specifies
how to format and display all dates within the calendar. |
void |
setDelayInplaceEdit(boolean value)
Sets a value indicating whether the in-place editing
of an item is delayed for a second when the item is clicked.
|
void |
setDragFeedBackType(DragFeedBackType type)
Sets the type of feedback to provide during drag-and-drop from ItemListView.
|
void |
setDragItemsOnDisabledAreas(boolean value)
Sets a value indicating whether to update the position
of items dragged over areas which do not allow items.
|
void |
setEnableDragCreate(boolean value)
Sets a value indicating whether items are created merely
by dragging in the control.
|
void |
setEnableKeyboard(boolean value)
Sets a value indicating whether the selection can be
manipulated through the keyboard.
|
void |
setEndDate(DateTime value)
Sets the last date displayed in the calendar.
|
void |
setEnsureVisibleSelection(boolean value)
Sets a value indicating whether interactively selected cells
should be automatically brought into view.
|
void |
setGroupType(GroupType value)
|
void |
setHiddenItemsCursor(Cursor value)
Sets the cursor that is displayed when the mouse pointer is over the hidden items cue icon.
|
void |
setHScrollerSmallChange(int value)
Sets the small step for the horizontal scroll bar.
|
void |
setHScrollerVisible(java.lang.Boolean value)
Sets a value indicating whether the horizontal scrollbar should
always be visible, always hidden or visible only when it is needed.
|
void |
setHScrollPos(int value)
Sets the current horizontal scroll position.
|
void |
setImageList(ImageList value)
Sets the image list associated with the calendar.
|
void |
setInteractiveItemType(java.lang.Class<? extends Item> value)
Sets the type of item that should be created when a user starts
typing while the calendar control has the keyboard focus.
|
void |
setItemChangeResourceKey(int value)
Sets the modifier key, which lets users drag items between
different contacts, resources, locations or tasks in a grouped view.
|
void |
setItemCloneKey(int value)
Sets the modifier key, which when pressed allows users
to interactively clone items.
|
void |
setItemDragCursor(Cursor value)
Sets the cursor that is displayed when an item is being dragged.
|
void |
setItemDragKey(int value)
Sets the modifier key that lets users start a
drag-and-drop operation when they drag an item.
|
void |
setItemHResizeCursor(Cursor value)
Sets the cursor that is displayed when the mouse pointer is over the horizontal resize area of an item.
|
void |
setItemListLane(Item item,
int lane)
Sets the lane index for the specified item within a List view
with
setFreeDrag set to true. |
void |
setItemModificationStyle(ItemModificationStyle value)
Sets a value indicating the way items are processed when modified interactively.
|
void |
setItemMoveCursor(Cursor value)
Sets the cursor that is displayed when the mouse pointer is over the move area of an item.
|
void |
setItemNoDragCursor(Cursor value)
Sets the cursor that is displayed when an item is dragged over a location that cannot contain items.
|
void |
setItemScroll(int value)
Sets the current scroll position in a List view with
ListViewSettings.setEnableVirtualItemSpace(java.lang.Boolean) set to true. |
void |
setItemTooltipFormat(java.lang.String value)
Gets the format of item tooltips.
|
void |
setItemVResizeCursor(Cursor value)
Sets the cursor that is displayed when the mouse pointer is over the vertical resize area of an item.
|
void |
setKeepItemSelection(boolean value)
Sets a value indicating whether the item selection
is preserved when an item from the selection is clicked.
|
static void |
setLicenseKey(java.lang.String licenseKey) |
void |
setLocale(java.util.Locale value)
Sets the
Locale object used to format and display
time information in the calendar. |
void |
setMinItemLength(int value)
Gets the minimal length of interactively created items, expressed in minutes.
|
void |
setRescheduleRecurrenceKey(int value)
Sets the modifier key, which when pressed allows users
to interactively reschedule recurrent items.
|
void |
setRightToLeft(boolean value)
Sets a value indicating whether control's elements are laid out from right to left.
|
void |
setRootScrollPosition(java.awt.Point value)
For internal use only.
|
void |
setRowHeaderResizeCursor(Cursor value)
Sets the cursor that is displayed when a row header can be resized
or is being resized in a
Resource view. |
void |
setSchedule(Schedule value)
Sets the schedule whose information should be
displayed inside the calendar component.
|
void |
setScrollPosition(java.awt.Point value)
Sets the current scroll position.
|
void |
setSecondaryGroupType(GroupType value)
Sets the secondary grouping criteria for the
Resource view. |
void |
setShowToolTips(boolean value)
Sets a value indicating whether the calendar displays tooltips.
|
void |
setStartEditAfterModify(boolean value)
Sets a value indicating whether in-place editing of items
should automatically start after they are modified interactively.
|
void |
setTheme(ThemeType value)
Sets the theme applied to the calendar control UI elements.
|
void |
setViewport(DateTime start,
DateTime end,
boolean adjustResolution)
Sets the displayed time interval to the specified range, optionally
changing the view resolution.
|
void |
setVScrollerSmallChange(int value)
Sets the small step for the vertical scroll bar.
|
void |
setVScrollerVisible(java.lang.Boolean value)
Sets a value indicating whether the vertical scrollbar should
always be visible, always hidden or visible only when it is needed.
|
void |
setVScrollPos(int value)
Sets the current vertical scroll position.
|
DateTime |
snapInResourceView(DateTime date)
Returns a new date representing the the specified date when snapped
according to the current Resource View settings.
|
void |
startInplaceEdit(Item item)
Starts in-place editing mode for the specified item to
let users edit the item's text.
|
boolean |
startModify(Item item,
java.awt.Point initial)
Initiates interactive modification on the specified item.
|
void |
suspendDrag()
Temporarily pauses the current mouse drag operation.
|
void |
update()
Forces an update of the control.
|
boolean |
updateLayout()
Updates the position of the calendar's child controls
such as buttons and scrollbars.
|
boolean |
updateModify(java.awt.Point point)
Updates an interactive modification of an item, previously
started by a call to
startModify(com.mindfusion.scheduling.model.Item, java.awt.Point) . |
void |
updateView()
Called when the view has changed to update the internal structures.
|
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getBackground, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
public Calendar()
Calendar
class using the default locale.public Calendar(java.util.Locale locale)
Calendar
class using the specified Locale
.locale
- A Locale
object providing information about formatting and displaying dates and times.protected void finalize() throws java.lang.Throwable
finalize
in class java.lang.Object
java.lang.Throwable
public void dispose()
public void beginInit()
endInit()
at the end.public void endInit()
beginInit()
is complete.public void applyTheme(Theme theme)
theme
- A Theme
object containing appearance settings.public void applyTheme(Theme theme, boolean reset)
theme
- A Theme
object containing appearance settings.reset
- Specifies whether to reset the settings.public java.awt.Dimension getPreferredScrollableViewportSize()
getPreferredScrollableViewportSize
in interface javax.swing.Scrollable
public int getScrollableBlockIncrement(java.awt.Rectangle visibleRect, int orientation, int direction)
getScrollableBlockIncrement
in interface javax.swing.Scrollable
public boolean getScrollableTracksViewportHeight()
getScrollableTracksViewportHeight
in interface javax.swing.Scrollable
public boolean getScrollableTracksViewportWidth()
getScrollableTracksViewportWidth
in interface javax.swing.Scrollable
public int getScrollableUnitIncrement(java.awt.Rectangle visibleRect, int orientation, int direction)
getScrollableUnitIncrement
in interface javax.swing.Scrollable
public void ancestorAdded(javax.swing.event.AncestorEvent event)
ancestorAdded
in interface javax.swing.event.AncestorListener
public void ancestorMoved(javax.swing.event.AncestorEvent event)
ancestorMoved
in interface javax.swing.event.AncestorListener
public void ancestorRemoved(javax.swing.event.AncestorEvent event)
ancestorRemoved
in interface javax.swing.event.AncestorListener
public void lostOwnership(java.awt.datatransfer.Clipboard clipboard, java.awt.datatransfer.Transferable contents)
lostOwnership
in interface java.awt.datatransfer.ClipboardOwner
public void mouseClicked(java.awt.event.MouseEvent e)
mouseClicked
in interface java.awt.event.MouseListener
public void mouseEntered(java.awt.event.MouseEvent e)
mouseEntered
in interface java.awt.event.MouseListener
public void mouseExited(java.awt.event.MouseEvent e)
mouseExited
in interface java.awt.event.MouseListener
public void mousePressed(java.awt.event.MouseEvent e)
mousePressed
in interface java.awt.event.MouseListener
public void mouseReleased(java.awt.event.MouseEvent e)
mouseReleased
in interface java.awt.event.MouseListener
public void keyPressed(java.awt.event.KeyEvent e)
keyPressed
in interface java.awt.event.KeyListener
public void keyReleased(java.awt.event.KeyEvent e)
keyReleased
in interface java.awt.event.KeyListener
public void keyTyped(java.awt.event.KeyEvent e)
keyTyped
in interface java.awt.event.KeyListener
public java.awt.Dimension getPreferredSize()
getPreferredSize
in class javax.swing.JComponent
public void mouseDragged(java.awt.event.MouseEvent arg)
mouseDragged
in interface java.awt.event.MouseMotionListener
public void mouseMoved(java.awt.event.MouseEvent e)
mouseMoved
in interface java.awt.event.MouseMotionListener
public void componentResized(java.awt.event.ComponentEvent e)
componentResized
in interface java.awt.event.ComponentListener
public void componentMoved(java.awt.event.ComponentEvent e)
componentMoved
in interface java.awt.event.ComponentListener
public void componentShown(java.awt.event.ComponentEvent e)
componentShown
in interface java.awt.event.ComponentListener
public void componentHidden(java.awt.event.ComponentEvent e)
componentHidden
in interface java.awt.event.ComponentListener
protected void paintComponent(java.awt.Graphics g)
paintComponent
in class javax.swing.JComponent
public void print()
public void print(java.lang.String printer)
printer
- The destination printer.public void print(java.awt.print.PageFormat pageFormat, java.lang.String printer)
pageFormat
- The size and orientation of each page to be printed.printer
- The destination printer.public void printPreview()
getPrintOptions()
. That
ensures uniform output of the printed document both on paper and in the
preview window. Print job settings include document title and several flags
that control whether images, shadows, headers, etc. are printed.public void printPreview(java.awt.print.PageFormat pageFormat)
getPrintOptions()
. That
ensures uniform output of the printed document both on paper and in the
preview window. Print job settings include document title and several flags
that control whether images, shadows, headers, etc. are printed.public int print(java.awt.Graphics graphics, java.awt.print.PageFormat pageFormat, int pageIndex)
Printable.print
implementation.print
in interface java.awt.print.Printable
public boolean startModify(Item item, java.awt.Point initial)
item
- The item to modify interactively.initial
- The initial point of the interactive modification.public boolean updateModify(java.awt.Point point)
startModify(com.mindfusion.scheduling.model.Item, java.awt.Point)
.point
- The current point of the interactive modification.public boolean cancelModify()
startModify(com.mindfusion.scheduling.model.Item, java.awt.Point)
.public boolean completeModify(java.awt.Point point)
startModify(com.mindfusion.scheduling.model.Item, java.awt.Point)
.point
- The final point of the interactive modification.public void update()
public boolean onNavigationKeyPress(int keyData)
public Resource getFirstVisibleResource()
Resource
object representing the first visible resource.public Resource getLastVisibleResource()
Resource
object representing the first visible resource.public DateTime getFirstVisibleDate()
DateTime
object indicating the first visible date.public DateTime getLastVisibleDate()
DateTime
object indicating the last visible date.public DateTime getFirstDate()
DateTime
instance indicating the first date.public DateTime getLastDate()
DateTime
instance indicating the last date.public DateTime getDateAt(int x, int y)
x
- The x-coordinate of the position at which to look for a date.y
- The y-coordinate of the position at which to look for a date.DateTime
instance indicating which date is displayed
at the specified position. If there is no date cell at
the specified position, the return value is DateTime.MinValue
.public DateTime getDateAt(java.awt.Point point)
point
- The position at which to look for a date.DateTime
instance indicating which date is displayed
at the specified position. If there is no date cell at
the specified point, the return value is DateTime.MinValue
.public DateTime getDateAt(int x, int y, ByRef<java.awt.Rectangle> bounds)
x
- The x-coordinate of the position at which to look for a date.y
- The y-coordinate of the position at which to look for a date.bounds
- The bounding rectangle of the cell at the specified position.DateTime
instance indicating which date is displayed
at the specified position. If there is no date cell at
the specified position, the return value is DateTime.MinValue
.public DateTime getDateAt(java.awt.Point point, ByRef<java.awt.Rectangle> bounds)
point
- The position at which to look for a date.bounds
- The bounding rectangle of the cell at the specified position.DateTime
instance indicating which date is displayed
at the specified position. If there is no date cell at
the specified position, the return value is DateTime.MinValue
.public DateTime snapInResourceView(DateTime date)
date
- The date to snap.DateTime
object representing the snapped date.public DateTime getExactDateAt(int x, int y)
The returned value represents the exact date located at
the specified position in contrast with getDateAt
, which
returns the start date of the cell, located at the specified
position. This method works only in a Timetable
view.
x
- The x-coordinate of the position at which to look for a date.y
- The y-coordinate of the position at which to look for a date.DateTime
instance indicating which date is displayed
at the specified position. If there is no date at the
specified position, the return value is DateTime.MinValue
.public DateTime getExactDateAt(java.awt.Point point)
The returned value represents the exact date located at
the specified position in contrast with getDateAt
, which
returns the start date of the cell, located at the specified
position. This method works only in a Timetable
view.
point
- The position at which to look for a date.DateTime
instance indicating which date is displayed
at the specified position. If there is no date cell at
the specified point, the return value is DateTime.MinValue
.public Contact getContactAt(int x, int y)
Contact
object associated with
the calendar element at the specified point.
This method can only be used in views that support grouping.
x
- The x-coordinate of the point to test.y
- The y-coordinate of the point to test.Contact
instance related to the calendar element
at the specified position.public Contact getContactAt(java.awt.Point point)
Contact
object associated with
the calendar element at the specified point.
This method can be only be used in views that support grouping.
point
- The point to test.Contact
instance related to the calendar element
at the specified position.public Resource getResourceAt(int x, int y)
Resource
object associated with
the calendar element at the specified point.
This method can be only be used in views that support grouping.
x
- The x-coordinate of the point to test.y
- The y-coordinate of the point to test.Resource
instance related to the calendar element
at the specified position.public Resource getResourceAt(java.awt.Point point)
Resource
object associated with
the calendar element at the specified point.
This method can be only be used in views that support grouping.
point
- The point to test.Resource
instance related to the calendar element
at the specified position.public Location getLocationAt(int x, int y)
Location
object associated with
the calendar element at the specified point.
This method can be only be used in views that support grouping.
x
- The x-coordinate of the point to test.y
- The y-coordinate of the point to test.Location
instance related to the calendar element
at the specified position.public Location getLocationAt(java.awt.Point point)
Location
object associated with
the calendar element at the specified point.
This method can be only be used in views that support grouping.
point
- The point to test.Location
instance related to the calendar element
at the specified position.public Task getTaskAt(int x, int y)
Task
object associated with
the calendar element at the specified point.
This method can be only be used in views that support grouping.
x
- The x-coordinate of the point to test.y
- The y-coordinate of the point to test.Task
instance related to the calendar element
at the specified position.public Task getTaskAt(java.awt.Point point)
Task
object associated with
the calendar element at the specified point.
This method can be only be used in views that support grouping.
point
- The point to test.Task
instance related to the calendar element
at the specified position.public int getMonthsInYear(int year)
public void ensureVisible(Item item)
This method does nothing if the item is not scheduled to occur in the time-period displayed in the current view.
item
- The schedule Item to scroll into view.public void ensureVisible(DateTime date)
This method does nothing if the specified date is not included in the time-period displayed in the current view.
date
- A DateTime
instance identifying the date to scroll into view.public void ensureVisible(DateTime date, Resource resource)
Task
, Location
, Contact
or Resource
for which to display the date in a view with enabled grouping.
This method does nothing if the specified date is not included in the time-period displayed in the current view.
public void setViewport(DateTime start, DateTime end, boolean adjustResolution)
This method operates only in Resource view. In addition, the resource view must not have hidden days or hours.
start
- The start of the interval to display.end
- The end of the interval to display.adjustResolution
- true
to change the view resolution if necessary;
false
to keep the current resolution and adjust only the scale.public void resetDrag()
Call this method if a message box or a modal dialog must be displayed in response to various Click events, to prevent the component from continuing tracking the mouse.
public void suspendDrag()
Use this method in conjunction with the resumeDrag()
method
to temporarily disable control response to user interactions.
The most common scenario where you would use these two methods
is when you want to display a modal dialog during user
interaction without terminating it.
public void resumeDrag()
Use this method in conjunction with the suspendDrag()
method
to temporarily disable control response to user interactions.
The most common scenario where you would use these two methods
is when you want to display a modal dialog during user
interaction without terminating it.
public java.awt.Rectangle getElementBounds(CalendarElement element, int index)
element
- The type of the element whose bounds to retrieve.index
- The index of the element, if there is more than one element
of the specified type.public java.awt.Rectangle getItemBounds(Item item)
item
- A reference to the item whose bounds to retrieve.public ItemList getVisibleItems()
ItemList
containing all items currently visible within
the control. The collection is empty if there are no visible items.public Item getItemAt(int x, int y)
Item
object displayed at the specified coordinates.x
- The x-coordinate of the point to test.y
- The y-coordinate of the point to test.public Item getItemAt(java.awt.Point point)
Item
object displayed at the specified coordinates.point
- The point to test.public DragFeedBackType getDragFeedBackType()
DragFeedBackType
enumeration.public void setDragFeedBackType(DragFeedBackType type)
type
- A member of the DragFeedBackType
enumeration.public void expandResourceRow(Resource resource)
public void collapseResourceRow(Resource resource)
public boolean isResourceRowExpanded(Resource resource)
public void expandResourceRow(Resource[] resources)
ResourceView
, nothing happens.resources
- A list with Resource
objects defining the row to expand.public void collapseResourceRow(Resource[] resources)
ResourceView
, nothing happens.resources
- A list with Resource
objects defining the row to collapse.public boolean isResourceRowExpanded(Resource[] resources)
resources
- A list with Resource
objects defining the row to check.ResourceView
.public void compactItemLanes()
public void compactItemLanes(java.util.List<Item> items)
items
- The items to compact.public int getItemListLane(Item item)
setFreeDrag
set to true.item
- A reference to the Item
whose lane index to retrieve.public void setItemListLane(Item item, int lane)
setFreeDrag
set to true.item
- A reference to the Item
whose lane index to set.lane
- The zero-based index of the new item lane.public void assignLanePriorities()
public int getListLaneAt(java.awt.Point point)
List
view lane
at the specified point, expressed in client coordinates.point
- The point to test, expressed in client coordinates.public void startInplaceEdit(Item item)
The itemInplaceEditStarting
event
is raised to validate the operation, even if entering in-place edit mode programmatically.
item
- Specifies which Item
should be edited in place.public java.awt.image.BufferedImage createImage(boolean visibleOnly, int desiredWidth, int desiredHeight)
visibleOnly
- Specifies whether to create an image only of the calendar area that is currently visible on screen.desiredWidth
- The width of exported image.desiredHeight
- The height of exported image.public java.awt.image.BufferedImage createImage(boolean visibleOnly, float scaleX, float scaleY)
visibleOnly
- Specifies whether to create an image only of the calendar area that is currently visible on screen.scaleX
- The horizontal scale of exported image.scaleY
- The vertical scale of exported image.public java.awt.image.BufferedImage createImage(boolean visibleOnly)
visibleOnly
- Specifies whether to create an image only of the calendar area that is currently visible on screen.public boolean updateLayout()
public void updateView()
public void abortDelayedInplaceEdit()
public void endInplaceEdit(boolean accept)
public int getMaxListLane(DateTime start, DateTime end)
public void raiseVisibleDateChanged(DateTime prevDate, DateTime newDate)
CalendarListener.visibleDateChanged(com.mindfusion.scheduling.DateChangedEvent)
method from the outside.protected void onVisibleDateChanged(DateChangedEvent e)
visibleDateChanged
event.e
- An object, containing the event data.protected void onScroll(java.util.EventObject e)
CalendarListener.scroll(java.util.EventObject)
event.e
- An object, containing the event data.protected void onDateClick(ResourceDateEvent e)
CalendarListener.dateClick(com.mindfusion.scheduling.ResourceDateEvent)
event.e
- An object, containing the event data.protected void onMonthCellClick(DateEvent e)
CalendarListener.monthCellClick(com.mindfusion.scheduling.DateEvent)
event.e
- An object, containing the event data.protected void onHiddenItemClick(DateEvent e)
CalendarListener.hiddenItemClick(com.mindfusion.scheduling.DateEvent)
event.e
- An object, containing the event data.protected void onItemClick(ItemMouseEvent e)
CalendarListener.itemClick(com.mindfusion.scheduling.ItemMouseEvent)
event.e
- An object, containing the event data.protected void onItemDeleting(ItemConfirmEvent e)
e
- An object, containing the event data.protected void onRecurringItemDeleting(RecurringItemConfirmEvent e)
CalendarListener.recurringItemDeleting(com.mindfusion.scheduling.RecurringItemConfirmEvent)
event.e
- An object, containing the event data.protected void onItemDeleted(ItemEvent e)
CalendarListener.itemDeleted(com.mindfusion.scheduling.model.ItemEvent)
event.e
- An object, containing the event data.protected void onItemInplaceEditStarting(ItemConfirmEvent e)
CalendarListener.itemInplaceEditStarting(com.mindfusion.scheduling.ItemConfirmEvent)
event.e
- An object, containing the event data.protected void onItemInplaceEditEnding(ItemEditConfirmEvent e)
CalendarListener.itemInplaceEditEnding(com.mindfusion.scheduling.ItemEditConfirmEvent)
event.e
- An object, containing the event data.protected void onItemInplaceEdited(ItemEvent e)
e
- An object, containing the event data.protected void onItemCreating(ItemConfirmEvent e)
e
- An object, containing the event data.protected void onItemCreated(ItemEvent e)
CalendarListener.itemCreated(com.mindfusion.scheduling.model.ItemEvent)
event.e
- An object, containing the event data.protected void onItemCloning(ItemConfirmEvent e)
CalendarListener.itemCloning(com.mindfusion.scheduling.ItemConfirmEvent)
event.e
- An object, containing the event data.protected void onItemCloned(ItemEvent e)
CalendarListener.itemCloned(com.mindfusion.scheduling.model.ItemEvent)
event.e
- An object, containing the event data.protected void onItemModifying(ItemModifyConfirmEvent e)
e
- An object, containing the event data.protected void onItemModified(ItemModifiedEvent e)
e
- An object, containing the event data.protected void onItemModificationCanceled(ItemEvent e)
CalendarListener.itemModificationCanceled(com.mindfusion.scheduling.model.ItemEvent)
event.e
- An object, containing the event data.protected void onItemCreationCanceled(ItemEvent e)
e
- An object, containing the event data.protected void onMonthHeaderClick(DateEvent e)
CalendarListener.monthHeaderClick(com.mindfusion.scheduling.DateEvent)
event.e
- An object, containing the event data.protected void onMonthWeekHeaderClick(DateEvent e)
e
- An object, containing the event data.protected void onMonthRangeHeaderClick(DateEvent e)
e
- An object, containing the event data.protected void onListViewHeaderClick(DateEvent e)
e
- An object, containing the event data.protected void onWeekRangeHeaderClick(DateEvent e)
e
- An object, containing the event data.protected void onTimetableColumnHeaderClick(DateEvent e)
e
- An object, containing the event data.protected void onItemDrawing(CalendarDrawEvent e)
e
- An object, containing the event data.protected void onBeginItemDrawing(java.util.EventObject e)
CalendarListener.beginItemDrawing(java.util.EventObject)
event.e
- An object, containing the event data.protected void onEndItemDrawing(java.util.EventObject e)
CalendarListener.endItemDrawing(java.util.EventObject)
event.e
- An object, containing the event data.protected void onDrawing(CalendarDrawEvent e)
CalendarListener.drawing(com.mindfusion.scheduling.CalendarDrawEvent)
event.e
- An object, containing the event data.protected void onDraw(CalendarDrawEvent e)
CalendarListener.draw(com.mindfusion.scheduling.CalendarDrawEvent)
event.e
- An object, containing the event data.protected void onCustomizeText(CalendarTextEvent e)
e
- An object, containing the event data.protected void onItemTooltipDisplaying(ItemTooltipEvent e)
CalendarListener.itemTooltipDisplaying(com.mindfusion.scheduling.ItemTooltipEvent)
event.e
- An object, containing the event data.protected void onTooltipDisplaying(TooltipEvent e)
e
- An object, containing the event data.protected void onResourceViewTopTimelineClick(DateEvent e)
CalendarListener.resourceViewTopTimelineClick(com.mindfusion.scheduling.DateEvent)
event.e
- An object, containing the event data.protected void onResourceViewMiddleTimelineClick(DateEvent e)
CalendarListener.resourceViewMiddleTimelineClick(com.mindfusion.scheduling.DateEvent)
event.e
- An object, containing the event data.protected void onResourceViewBottomTimelineClick(DateEvent e)
CalendarListener.resourceViewBottomTimelineClick(com.mindfusion.scheduling.DateEvent)
event.e
- An object, containing the event data.protected void onResourceViewRowHeaderClick(ResourceDateEvent e)
CalendarListener.resourceViewRowHeaderClick(com.mindfusion.scheduling.ResourceDateEvent)
event.e
- An object, containing the event data.protected void onItemSelectionChanged(ItemSelectionEvent e)
CalendarListener.itemSelectionChanged(com.mindfusion.scheduling.ItemSelectionEvent)
event.e
- An object, containing the event data.protected void onItemSelectionComplete(java.util.EventObject e)
CalendarListener.itemSelectionComplete(java.util.EventObject)
event.e
- An object, containing the event data.protected void onItemSelecting(ItemConfirmEvent e)
e
- An object, containing the event data.protected void onItemDeselecting(ItemConfirmEvent e)
e
- An object, containing the event data.protected void onHScroll(ScrollEvent e)
CalendarListener.hScroll(com.mindfusion.common.ScrollEvent)
event.e
- An object, containing the event data.protected void onVScroll(ScrollEvent e)
CalendarListener.vScroll(com.mindfusion.common.ScrollEvent)
event.e
- An object, containing the event data.protected void raiseTimelineUnitsChanged(java.util.EventObject e)
CalendarListener.timeLineUnitsChanged(java.util.EventObject)
event.e
- An object, containing the event data.protected void onItemListLaneChanged(ItemListLaneChangedEvent e)
CalendarListener.itemListLaneChanged(com.mindfusion.scheduling.ItemListLaneChangedEvent)
event.e
- An object, containing the event data.protected void onItemsModified(ItemsEvent e)
CalendarListener.itemsModified(com.mindfusion.scheduling.ItemsEvent)
event.e
- An object, containing the event data.protected void onCustomizeGrouping(CustomizeGroupingEvent e)
CalendarListener.customizeGrouping(com.mindfusion.scheduling.CustomizeGroupingEvent)
event.e
- An object, containing the event data.public java.awt.Point getRootScrollPosition()
public void setRootScrollPosition(java.awt.Point value)
public java.lang.Object createPrintRoot(java.awt.Rectangle bounds)
public java.awt.Image getImage(java.lang.String name)
public void invalidate()
invalidate
in class java.awt.Container
public void invalidate(int x, int y, int width, int height)
public void invalidate(java.awt.Rectangle rect)
public java.awt.Rectangle getBounds()
getBounds
in class java.awt.Component
public void setBounds(java.awt.Rectangle value)
setBounds
in class java.awt.Component
public java.awt.Dimension getDefaultSize()
public java.util.Locale getLocale()
Locale
object used to format and display
time information in the calendar.getLocale
in class java.awt.Component
Locale
instance.public void setLocale(java.util.Locale value)
Locale
object used to format and display
time information in the calendar.
Setting the culture info results in reinitialization of all culture-specific properties, such as day and month names, first day of the week, and so on.
setLocale
in class java.awt.Component
value
- A Locale
instance.public java.awt.Point getScrollPosition()
public void setScrollPosition(java.awt.Point value)
value
- A Point object specifying the scroll position.public CalendarView getCurrentView()
CalendarView
constants.
The default is SingleMonth
.public void setCurrentView(CalendarView value)
The component can display the schedule data in several different types of views. This method allows changing the current view and can be used to implement drill down into the schedule data by switching from more general to more specialized views.
value
- One of the CalendarView
constants.public ImageList getImageList()
The value of Style.getImageIndex()
is an index within this list.
ImageList
class. The default is null.public void setImageList(ImageList value)
The value of Style.getImageIndex()
is an index within this list.
value
- An instance of the ImageList
class.public Schedule getSchedule()
Schedule
object providing the schedule data displayed in the calendar view.public void setSchedule(Schedule value)
You can easily substitute the schedule being displayed by
the control at any time by simply assigning a new Schedule
object using this method. You can also make two or more
Calendar
components display the same schedule.
value
- A Schedule
object providing the schedule data displayed in the calendar view.public int getItemScroll()
ListViewSettings.setEnableVirtualItemSpace(java.lang.Boolean)
set to true.public void setItemScroll(int value)
ListViewSettings.setEnableVirtualItemSpace(java.lang.Boolean)
set to true.value
- An integer value specifying the current scroll bar position.public int getVScrollPos()
public void setVScrollPos(int value)
value
- An integer value specifying the current vertical scroll position.public int getVScrollerSmallChange()
public void setVScrollerSmallChange(int value)
value
- An integer value representing the small step of the vertical scroll bar.public int getHScrollPos()
public void setHScrollPos(int value)
value
- An integer value specifying the current horizontal scroll position.public int getHScrollerSmallChange()
public void setHScrollerSmallChange(int value)
value
- An integer value representing the small step of the horizontal scroll bar.public MonthRangeSettings getMonthRangeSettings()
MonthRangeSettings
object used to customize the
visualization of a month range in the MonthRange
view.MonthRangeSettings
class.public MonthSettings getMonthSettings()
MonthSettings
object used to customize the
visualization of months in the MonthRange
and
SingleMonth
views.MonthSettings
class.public ListViewSettings getListViewSettings()
ListViewSettings
object used to customize the
visualization of the List
view.ListViewSettings
class.public WeekRangeSettings getWeekRangeSettings()
WeekRangeSettings
object used to customize the
visualization of weeks in a WeekRange
view.WeekRangeSettings
class.public TimetableSettings getTimetableSettings()
TimetableSettings
object used to customize the
visualization of days and hours in Timetable
view.TimetableSettings
class.public ResourceViewSettings getResourceViewSettings()
ResourceViewSettings
object used to customize the
visualization of a Resource
view.ResourceViewSettings
class.public ItemSettings getItemSettings()
ItemSettings
object used to customize the
visualization of schedule items in all calendar views.ItemSettings
class.public DateTime getDate()
DateTime
object. The initial value is DateTime.today()
.public void setDate(DateTime value)
This value is not used in a timetable view. To specify the dates
displayed in timetable view, use TimetableSettings.getDates()
.
value
- A DateTime
object..public DateTime getEndDate()
public void setEndDate(DateTime value)
value
- A DateTime
object.public Selection getSelection()
Selection
object representing the current selection in the calendar.
Use getItemSelection()
to get the selected items.
Selection
class representing the selection of time cells.public ItemSelection getItemSelection()
Use getSelection()
to get the collection of all selected time cells.
ItemSelection
class representing the currently selected items.public DateStyleList getDayStyles()
DateStyle
objects that allow customizing
the appearance of specific days in the calendar.
Use this collection to assign a distinct style to a day or a
range of days, overriding the default style of the current view.
If there are several styles defined for the same day, the one
with highest getPriority
is used.
DateStyleList
class.public DateStyleList getMonthStyles()
DateStyle
objects that allow customizing
the appearance of specific months in the calendar.
Use this collection to assign a distinct style to a month or a
range of months, overriding the default style of the current
view. If there are several styles defined for the same month,
the one with highest getPriority
is used.
DateStyleList
class.public DayOfWeekStyleList getDayOfWeekStyles()
DayOfWeekStyle
objects that allow customizing
the appearance of specific days of the week in the calendar.
Add DayOfWeekStyle
objects to this collection to specify a
distinct style for a day of the week. If several styles are
defined for the same day, the one having the highest
getPriority
is used.
DayOfWeekStyleList
class.public boolean getShowToolTips()
Tooltips can be displayed for schedule items and for the headers of the timetable view.
public void setShowToolTips(boolean value)
Tooltips can be displayed for schedule items and for the headers of the timetable view.
value
- true to display tooltips; otherwise, false.public boolean getAllowInplaceEdit()
public void setAllowInplaceEdit(boolean value)
If this method is invoked with false, users cannot edit items' text
interactively. Controlling the editing of item text can be
done by handling the CalendarListener.itemInplaceEditStarting(com.mindfusion.scheduling.ItemConfirmEvent)
and CalendarListener.itemInplaceEditEnding(com.mindfusion.scheduling.ItemEditConfirmEvent)
events.
value
- true to allow users to edit schedule items; otherwise, false.public boolean getAllowInplaceCreate()
public void setAllowInplaceCreate(boolean value)
If this property is disabled, users cannot create items
interactively. If it is enabled and getInteractiveItemType()
is not null, a new schedule item of the specified type is
created when users start typing in a time cell. This raises
the CalendarListener.itemCreating(com.mindfusion.scheduling.ItemConfirmEvent)
event, which lets
the client application validate the operation or cancel it.
value
- true to allow users to create schedule items; otherwise, false.public boolean getAllowAutoScroll()
public void setAllowAutoScroll(boolean value)
Automatic scrolling starts when a schedule item or a selection of items is dragged near the borders of the calendar contents rectangle. The contents rectangle is the part of a calendar view that contains all time cells and excludes the headers. If the mouse is moved outside the contents rectangle, the scrolling stops.
value
- true to enable automatic scrolling; otherwise, false.public Cursor getCalendarCursor()
Cursor
constants. The default is Cursor.Default
.public void setCalendarCursor(Cursor value)
value
- One of the Cursor
constants.public Cursor getHiddenItemsCursor()
The hidden items cue icon is shown if ItemSettings.getShowMoreItemsCue()
is enabled and there are schedule items that are not
currently visible because of insufficient space.
Cursor
constants. The default is Cursor.Hand
.public void setHiddenItemsCursor(Cursor value)
The hidden items cue icon is shown if ItemSettings.getShowMoreItemsCue()
is enabled and there are schedule items that are not
currently visible because of insufficient space.
value
- On of the Cursor
constants.public Cursor getItemMoveCursor()
Cursor
constants. The default is Cursor.SizeAll
.public void setItemMoveCursor(Cursor value)
value
- One of the Cursor
constants.public Cursor getItemHResizeCursor()
Cursor
constants. The default is Cursor.SizeWE
.public void setItemHResizeCursor(Cursor value)
value
- One of the Cursor
constants.public Cursor getItemVResizeCursor()
Cursor
constants. The default is Cursor.SizeNS
.public void setItemVResizeCursor(Cursor value)
value
- One of the Cursor
constants.public Cursor getItemDragCursor()
Cursor
constants. The default is Cursor.Arrow
.public void setItemDragCursor(Cursor value)
value
- One of the Cursor
constants.public Cursor getItemNoDragCursor()
public void setItemNoDragCursor(Cursor value)
value
- One of the Cursor
constants.public Cursor getColumnResizeCursorV()
Timetable
view.
To let users resize the columns in a timetable view, set
TimetableSettings.setAllowResizeColumns(java.lang.Boolean)
to true.
Cursor
constants. The default is Cursor.VSplit
.public void setColumnResizeCursorV(Cursor value)
Timetable
view.
To let users resize the columns in a timetable view, set
TimetableSettings.setAllowResizeColumns(java.lang.Boolean)
to true.
value
- One of the Cursor
constants.public Cursor getColumnResizeCursorH()
Timetable
view.
To let users resize the columns in a timetable view, set
TimetableSettings.setAllowResizeColumns(java.lang.Boolean)
to true.
Cursor
constants. The default is Cursor.HSplit
.public void setColumnResizeCursorH(Cursor value)
Timetable
view.
To let users resize the columns in a timetable view, set
TimetableSettings.setAllowResizeColumns(java.lang.Boolean)
to true.
value
- One of the Cursor
constants.public Cursor getRowHeaderResizeCursor()
Resource
view.
To let users resize the row header in a resource view, set
AllowResizeRowHeaders
to true.
Cursor
constants. The default is Cursor.VSplit
.public void setRowHeaderResizeCursor(Cursor value)
Resource
view.
To let users resize the row header in a resource view, set
AllowResizeRowHeaders
to true.
value
- One of the Cursor
constants.public DateTimeInfo getDateTimeInfo()
DateTimeInfo
object that specifies
how to format and display all dates within the calendar.
If this property is not set, the calendar uses a
DateTimeInfo
from the associated Locale
.
DateTimeInfo
class.public void setDateTimeFormat(DateTimeInfo value)
DateTimeInfo
object that specifies
how to format and display all dates within the calendar.
If this property is not set, the calendar uses a
DateTimeInfo
from the associated Locale
.
value
- An instance of the DateTimeInfo
class.public java.lang.Class<? extends Item> getInteractiveItemType()
Class
specifying what type of items
to create when a user starts typing. The default is Appointment
.public void setInteractiveItemType(java.lang.Class<? extends Item> value)
If set to null, users cannot create items interactively.
value
- An instance of Class
specifying what type of items
to create when a user starts typing. The default is Appointment
.public java.util.EnumSet<CustomDrawElements> getCustomDraw()
CustomDrawElements
constants.
The default is an empty set.public void setCustomDraw(java.util.EnumSet<CustomDrawElements> value)
Use the bitwise or operation to combine members of CustomDrawElements
specifying which elements of the view must be custom drawn. Handle the
CalendarListener.draw(com.mindfusion.scheduling.CalendarDrawEvent)
event to perform custom drawing.
value
- A combination of CustomDrawElements
constants.public int getButtonOffset()
public void setButtonOffset(int value)
The buttons get smaller if the value of this property is increased.
value
- An integer value specifying how many pixels there are between
a button and header edges.public int getButtonSize()
List
, SingleMonth
,
MonthRange
and Timetable
views.
The default is 0.public void setButtonSize(int value)
value
- An integer value specifying the size of the navigation buttons
displayed in the List
, SingleMonth
,
MonthRange
and Timetable
views.public ThemeType getTheme()
ThemeType
constants. The default is ThemeType.Standard
.public void setTheme(ThemeType value)
You cannot specify the value ThemeType.Custom
for this property.
In order to apply a custom theme, either assign the theme using the
setCustomTheme(com.mindfusion.scheduling.Theme)
method of the Calendar
component or
pass it as an argument to the applyTheme(com.mindfusion.scheduling.Theme)
method.
value
- One of the ThemeType
constants.public Theme getCustomTheme()
Theme
object specifying the user-defined theme
currently applied to the component. The default is null.public void setCustomTheme(Theme value)
value
- A Theme
object specifying the user-defined theme
currently applied to the component.public boolean getDelayInplaceEdit()
public void setDelayInplaceEdit(boolean value)
value
- true to delay in-place editing; otherwise, false.public ResourceList<Contact> getContacts()
getGroupType()
is GroupType.GroupByContacts
.ResourceList
class specifying which
contacts are displayed in timetable, week range and resource views.public ResourceList<Resource> getResources()
getGroupType()
is GroupType.GroupByResources
.ResourceList
class specifying which
resources are displayed in timetable, week range and resource views.public ResourceList<Location> getLocations()
getGroupType()
is GroupType.GroupByLocations
.public ResourceList<Task> getTasks()
getGroupType()
is GroupType.GroupByTasks
.public GroupType getGroupType()
GroupType
constants. The default is GroupType.None
.public void setGroupType(GroupType value)
value
- One of the GroupType
constants.public java.lang.reflect.Type getCustomGroupType()
public void setCustomGroupType(java.lang.reflect.Type value)
value
- A Type object.public GroupType getSecondaryGroupType()
Resource
view.GroupType
constants. The default is GroupType.None
.public void setSecondaryGroupType(GroupType value)
Resource
view.value
- One of the GroupType
constants.public java.lang.reflect.Type getCustomSecondaryGroupType()
public void setCustomSecondaryGroupType(java.lang.reflect.Type value)
value
- A Type object.public java.lang.String getContactNameFormat()
public void setContactNameFormat(java.lang.String value)
Use the capital letters F, M and L as placeholders for the First, Middle and Last names. Any other character will be displayed unchanged.
value
- A string specifying the name format.public boolean getAllowDrag()
public void setAllowDrag(boolean value)
value
- true, to enable dragging within the component; otherwise, false.public int getItemDragKey()
public void setItemDragKey(int value)
value
- One of the KeyEvent constants.public int getItemChangeResourceKey()
By default an item dragged in a grouped view can be dropped only into a column associated with the original contact, location or task of the item. This behavior can be overridden by pressing a modifier key while dragging. That allows dropping the item into a column of a different contact, location or task, thus changing the original contact, location or task.
public void setItemChangeResourceKey(int value)
By default an item dragged in a grouped view can be dropped only into a column associated with the original contact, location or task of the item. This behavior can be overridden by pressing a modifier key while dragging. That allows dropping the item into a column of a different contact, location or task, thus changing the original contact, location or task.
value
- One of the KeyEvent constants.public int getItemCloneKey()
If the user starts dragging an item (or items) when the key specified as a value of this property is pressed, an exact duplicate of the dragged item is created and the user continues dragging the newly created item instead of the original one.
public void setItemCloneKey(int value)
If the user starts dragging an item (or items) when the key specified as a value of this property is pressed, an exact duplicate of the dragged item is created and the user continues dragging the newly created item instead of the original one.
value
- One of the KeyEvent constants. The default is VK_SHIFT.public int getRescheduleRecurrenceKey()
If the user drags a recurrent item when the key specified as a value of this property is pressed, the recurrence is automatically adjusted to match the new item location. Recurrence rescheduling is not recorded in the undo history.
public void setRescheduleRecurrenceKey(int value)
If the user drags a recurrent item when the key specified as a value of this property is pressed, the recurrence is automatically adjusted to match the new item location. Recurrence rescheduling is not recorded in the undo history.
value
- One of the KeyEvent constants.public java.lang.String getItemTooltipFormat()
public void setItemTooltipFormat(java.lang.String value)
value
- A string specifying the item's tooltip format.public int getMinItemLength()
public void setMinItemLength(int value)
Specify 0 for no item length restrictions.
value
- A non-negative integer value.public void setComponentOrientation(java.awt.ComponentOrientation o)
Component.setComponentOrientation
override.setComponentOrientation
in class java.awt.Component
public boolean getRightToLeft()
public void setRightToLeft(boolean value)
value
- true to specify that the calendar should layout its components from right
to left; otherwise, false.public ControlAppearance getControlAppearance()
ControlAppearance
constants.public void setControlAppearance(ControlAppearance value)
value
- One of the ControlAppearance
constants.
Set to null to use the corresponding value from the current theme.public ControlStyle getControlStyle()
ControlStyle
object that allows customizing the
visualization of the calendar child controls.
Members of the ControlStyle
class let you customize the appearance
of the button and scrollbar child controls contained in the calendar control.
This property is ignored if getControlAppearance()
is set to
System
.
ControlStyle
class.public boolean getEnsureVisibleSelection()
public void setEnsureVisibleSelection(boolean value)
value
- A boolean value specifying whether the component should
automatically scroll when the user selects cells outside of the
current viewport (by using the keyboard for example).public boolean getKeepItemSelection()
public void setKeepItemSelection(boolean value)
If the property is set to false, only the clicked item is selected.
value
- true to preserve the selection when an item from the selection
is clicked or false to deselect all items except the one that is clicked.public boolean getEnableKeyboard()
public void setEnableKeyboard(boolean value)
value
- A boolean value specifying whether the selection can be modified
through the keyboard. The default is true.public boolean getEnableDragCreate()
public void setEnableDragCreate(boolean value)
By default, the items are created interactively by selecting a time range in the current view and typing. Invoking this method and passing true as an argument overrides this behavior and enables users to create items by clicking and dragging.
value
- true to enable interactive item creation when the users clicks
and drags in the control; false to disable it. The default is false.public boolean getStartEditAfterModify()
public void setStartEditAfterModify(boolean value)
value
- true to enable automatic in-place editing after item modification;
false to disable it.public boolean getInplaceAcceptOnEnter()
public boolean getInplaceCancelOnEscape()
public java.lang.Boolean getHScrollerVisible()
Boolean
value specifying the visibility state of the horizontal scrollbar.public void setHScrollerVisible(java.lang.Boolean value)
Specify false for this method to always hide the scrollbar,
true, to always show it and null to let the Calendar
component decide when to show the scrollbar.
value
- A Boolean
value specifying the visibility state of the horizontal
scrollbar.public java.lang.Boolean getVScrollerVisible()
Boolean
value specifying the visibility state of the vertical scrollbar.public void setVScrollerVisible(java.lang.Boolean value)
Specify false for this method to always hide the scrollbar,
true, to always show it and null to let the Calendar
component decide when to show the scrollbar.
value
- A Boolean
value specifying the visibility state of the vertical
scrollbar.public DateTime getCurrentTime()
When this property is set to null, the actual system time is returned.
DateTime
object representing the time to use as current.public void setCurrentTime(DateTime value)
When this property is set to null, the actual system time is returned.
value
- A DateTime
object representing the time to use as current.public boolean getDragItemsOnDisabledAreas()
public void setDragItemsOnDisabledAreas(boolean value)
value
- true to indicate that the modified items will follow the
cursor over areas which do not allow items; otherwise, false.public ItemModificationStyle getItemModificationStyle()
ItemModificationStyle
constants.
The default is InPlace
.public void setItemModificationStyle(ItemModificationStyle value)
value
- One of the ItemModificationStyle
constants.
The default is InPlace
.public boolean getIsVirtualListView()
CalendarView.List
view with enabled virtual item space.public static void setLicenseKey(java.lang.String licenseKey)
public java.util.List<ItemEffect> getItemEffects()
public PrintOptions getPrintOptions()
PrintOptions
object that allows customizing various aspects of printing.
Use the PrintOptions
members to customize the print output,
used both when printing and when displaying print preview.
PrintOptions
class.public boolean getAllowMoveUnselectedItems()
public void setAllowMoveUnselectedItems(boolean value)
value
- true if users are allowed to move unselected items, or false otherwise.public void addCalendarListener(CalendarListener listener)
CalendarListener
to the calendar.listener
- The CalendarListener
to be added.public void removeCalendarListener(CalendarListener listener)
CalendarListener
from the calendar.listener
- The listener to be removed.