Class Calendar

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

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

CalendarEvents

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

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

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

Navigation

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

Event Manipulation

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

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

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

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

  • Constructor Details

    • Calendar

      public Calendar()
    • Calendar

      public Calendar(JavaScriptObject jsObj)
  • Method Details

    • getOrCreateRef

      public static Calendar getOrCreateRef(JavaScriptObject jsObj)
    • changeAutoChildDefaults

      public static void changeAutoChildDefaults(String autoChildName, Canvas defaults)
      Changes the defaults for Canvas AutoChildren named autoChildName.
      Parameters:
      autoChildName - name of an AutoChild to customize the defaults for.
      defaults - Canvas defaults to apply. These defaults override any existing properties without destroying or wiping out non-overridden properties. For usage tips on this param, see SGWTProperties.
      See Also:
    • changeAutoChildDefaults

      public static void changeAutoChildDefaults(String autoChildName, FormItem defaults)
      Changes the defaults for FormItem AutoChildren named autoChildName.
      Parameters:
      autoChildName - name of an AutoChild to customize the defaults for.
      defaults - FormItem defaults to apply. These defaults override any existing properties without destroying or wiping out non-overridden properties. For usage tips on this param, see SGWTProperties.
      See Also:
    • create

      protected JavaScriptObject create()
      Overrides:
      create in class Canvas
    • getAddEventButton

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

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

      Returns:
      Current addEventButton value. Default value is null
      Throws:
      IllegalStateException - if this widget has not yet been rendered.
    • setAddEventButtonHoverText

      public Calendar setAddEventButtonHoverText(String addEventButtonHoverText) throws IllegalStateException
      The text to be displayed when a user hovers over the add event toolbar button
      Parameters:
      addEventButtonHoverText - New addEventButtonHoverText value. Default value is "Add an event"
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
    • getAddEventButtonHoverText

      public String getAddEventButtonHoverText()
      The text to be displayed when a user hovers over the add event toolbar button
      Returns:
      Current addEventButtonHoverText value. Default value is "Add an event"
    • setAllowDurationEvents

      public Calendar setAllowDurationEvents(Boolean allowDurationEvents)
      When set to true, allows events to be managed by duration, as well as by end date. Values can be set for duration and duration unit on each event, and are then maintained, instead of the end date, when alterations are made to the event via editors or dragging with the mouse.
      Parameters:
      allowDurationEvents - New allowDurationEvents value. Default value is null
      Returns:
      Calendar instance, for chaining setter calls
      See Also:
    • getAllowDurationEvents

      public Boolean getAllowDurationEvents()
      When set to true, allows events to be managed by duration, as well as by end date. Values can be set for duration and duration unit on each event, and are then maintained, instead of the end date, when alterations are made to the event via editors or dragging with the mouse.
      Returns:
      Current allowDurationEvents value. Default value is null
      See Also:
    • setAlternateLaneStyles

      public Calendar setAlternateLaneStyles(Boolean alternateLaneStyles)
      When showing a Timeline, or a day view when showDayLanes is true, whether to make lane boundaries more obvious by showing alternate lanes in a different color.
      Parameters:
      alternateLaneStyles - New alternateLaneStyles value. Default value is null
      Returns:
      Calendar instance, for chaining setter calls
    • getAlternateLaneStyles

      public Boolean getAlternateLaneStyles()
      When showing a Timeline, or a day view when showDayLanes is true, whether to make lane boundaries more obvious by showing alternate lanes in a different color.
      Returns:
      Current alternateLaneStyles value. Default value is null
    • setAlwaysShowEventHovers

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

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

      Parameters:
      alwaysShowEventHovers - New alwaysShowEventHovers value. Default value is true
      Returns:
      Calendar instance, for chaining setter calls
    • getAlwaysShowEventHovers

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

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

      Returns:
      Current alwaysShowEventHovers value. Default value is true
    • setBackButtonIconSrc

      public Calendar setBackButtonIconSrc(String backButtonIconSrc) throws IllegalStateException
      The icon to show in the month-button on Handsets when the month view is the current visible view.
      Parameters:
      backButtonIconSrc - New backButtonIconSrc value. Default value is "Chevron_Left"
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
      See Also:
    • getBackButtonIconSrc

      public String getBackButtonIconSrc()
      The icon to show in the month-button on Handsets when the month view is the current visible view.
      Returns:
      Current backButtonIconSrc value. Default value is "Chevron_Left"
      See Also:
    • setBackButtonTitle

      public Calendar setBackButtonTitle(String backButtonTitle) throws IllegalStateException
      The title of the month on Handsets when the month view is the current visible view.

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

      Parameters:
      backButtonTitle - New backButtonTitle value. Default value is "Back"
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
      See Also:
    • getBackButtonTitle

      public String getBackButtonTitle()
      The title of the month on Handsets when the month view is the current visible view.

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

      Returns:
      Current backButtonTitle value. Default value is "Back"
      See Also:
    • setBaseStyle

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

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

      Parameters:
      baseStyle - New baseStyle value. Default value is "calendar"
      Returns:
      Calendar instance, for chaining setter calls
      See Also:
    • getBaseStyle

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

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

      Returns:
      Current baseStyle value. Default value is "calendar"
      See Also:
    • setBringEventsToFront

      public Calendar setBringEventsToFront(Boolean bringEventsToFront) throws IllegalStateException
      If set to true, clicking an event will bring it to the front of the zorder.
      Parameters:
      bringEventsToFront - New bringEventsToFront value. Default value is null
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
    • getBringEventsToFront

      public Boolean getBringEventsToFront()
      If set to true, clicking an event will bring it to the front of the zorder.
      Returns:
      Current bringEventsToFront value. Default value is null
    • setCalMonthEventLinkStyle

      public Calendar setCalMonthEventLinkStyle(String calMonthEventLinkStyle)
      The base name for the CSS class applied to the links rendered by getDayBodyHTML().

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

      Parameters:
      calMonthEventLinkStyle - New calMonthEventLinkStyle value. Default value is "calMonthEventLink"
      Returns:
      Calendar instance, for chaining setter calls
      See Also:
    • getCalMonthEventLinkStyle

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

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

      Returns:
      Current calMonthEventLinkStyle value. Default value is "calMonthEventLink"
      See Also:
    • getCancelButton

      public IButton getCancelButton() throws IllegalStateException
      An com.smartgwt.client.types.AutoChild of type IButton, used to cancel editing of an event and close the eventEditor.

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

      Returns:
      Current cancelButton value. Default value is null
      Throws:
      IllegalStateException - if this widget has not yet been rendered.
    • setCancelButtonTitle

      public Calendar setCancelButtonTitle(String cancelButtonTitle) throws IllegalStateException
      The title for the Cancel button in the event editor.
      Parameters:
      cancelButtonTitle - New cancelButtonTitle value. Default value is "Cancel"
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
      See Also:
    • getCancelButtonTitle

      public String getCancelButtonTitle()
      The title for the Cancel button in the event editor.
      Returns:
      Current cancelButtonTitle value. Default value is "Cancel"
      See Also:
    • setCanCreateEvents

      public Calendar setCanCreateEvents(Boolean canCreateEvents) throws IllegalStateException
      If true, users can create new events.
      Parameters:
      canCreateEvents - New canCreateEvents value. Default value is true
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
    • getCanCreateEvents

      public Boolean getCanCreateEvents()
      If true, users can create new events.
      Returns:
      Current canCreateEvents value. Default value is true
    • setCanCreateOtherDayEvents

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

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

      Parameters:
      canCreateOtherDayEvents - New canCreateOtherDayEvents value. Default value is false
      Returns:
      Calendar instance, for chaining setter calls
    • getCanCreateOtherDayEvents

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

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

      Returns:
      Current canCreateOtherDayEvents value. Default value is false
    • setCanDeleteEvents

      public Calendar setCanDeleteEvents(Boolean canDeleteEvents) throws IllegalStateException
      Deprecated.
      in favor of canRemoveEvents
      If true, users can delete existing events. Defaults to canEditEvents.
      Parameters:
      canDeleteEvents - New canDeleteEvents value. Default value is null
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
    • getCanDeleteEvents

      public Boolean getCanDeleteEvents()
      Deprecated.
      in favor of canRemoveEvents
      If true, users can delete existing events. Defaults to canEditEvents.
      Returns:
      Current canDeleteEvents value. Default value is null
    • setCanDragCreateEvents

      public Calendar setCanDragCreateEvents(Boolean canDragCreateEvents)
      A boolean value controlling whether new events of varying length can be created by dragging the cursor. By default, this is false for Touch devices and true otherwise.
      Parameters:
      canDragCreateEvents - New canDragCreateEvents value. Default value is null
      Returns:
      Calendar instance, for chaining setter calls
    • getCanDragCreateEvents

      public Boolean getCanDragCreateEvents()
      A boolean value controlling whether new events of varying length can be created by dragging the cursor. By default, this is false for Touch devices and true otherwise.
      Returns:
      Current canDragCreateEvents value. Default value is null
    • setCanDragEventField

      public Calendar setCanDragEventField(String canDragEventField) throws IllegalStateException
      Name of the field on each CalendarEvent that determines whether an EventCanvas can be moved or resized by dragging with the mouse. Note that canEditEvents must be true for dragging to be allowed.
      Parameters:
      canDragEventField - New canDragEventField value. Default value is "canDrag"
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
      See Also:
    • getCanDragEventField

      public String getCanDragEventField()
      Name of the field on each CalendarEvent that determines whether an EventCanvas can be moved or resized by dragging with the mouse. Note that canEditEvents must be true for dragging to be allowed.
      Returns:
      Current canDragEventField value. Default value is "canDrag"
      See Also:
    • setCanDragEvents

      public Calendar setCanDragEvents(Boolean canDragEvents) throws IllegalStateException
      A boolean value controlling whether users can drag-reposition events. By default, this is false for Touch devices, where drag gestures scroll the view, and true otherwise.

      Only has an effect when canEditEvents is true.

      Parameters:
      canDragEvents - New canDragEvents value. Default value is null
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
    • getCanDragEvents

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

      Only has an effect when canEditEvents is true.

      Returns:
      Current canDragEvents value. Default value is null
    • setCanEditEvents

      public Calendar setCanEditEvents(Boolean canEditEvents) throws IllegalStateException
      If true, users can edit existing events.
      Parameters:
      canEditEvents - New canEditEvents value. Default value is true
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
    • getCanEditEvents

      public Boolean getCanEditEvents()
      If true, users can edit existing events.
      Returns:
      Current canEditEvents value. Default value is true
    • setCanEditField

      public Calendar setCanEditField(String canEditField) throws IllegalStateException
      Name of the field on each CalendarEvent that determines whether it can be edited in the event editor. Note that an event with canEdit set to true can also have canDrag or canResize set to false, which would still allow editing, but not via drag operations.
      Parameters:
      canEditField - New canEditField value. Default value is "canEdit"
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
      See Also:
    • getCanEditField

      public String getCanEditField()
      Name of the field on each CalendarEvent that determines whether it can be edited in the event editor. Note that an event with canEdit set to true can also have canDrag or canResize set to false, which would still allow editing, but not via drag operations.
      Returns:
      Current canEditField value. Default value is "canEdit"
      See Also:
    • setCanEditLane

      public Calendar setCanEditLane(Boolean canEditLane) throws IllegalStateException
      Can events be moved between lanes? If so, the event can be dragged to a different lane, and the event quick dialog and editor allow a lane to be selected with a drop-down chooser.

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

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

      This setting can be overridden on each event.

      Parameters:
      canEditLane - New canEditLane value. Default value is null
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
    • getCanEditLane

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

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

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

      This setting can be overridden on each event.

      Returns:
      Current canEditLane value. Default value is null
    • setCanEditLaneField

      public Calendar setCanEditLaneField(String canEditLaneField) throws IllegalStateException
      Name of the field on each CalendarEvent that determines whether that event can be moved between lanes.
      Parameters:
      canEditLaneField - New canEditLaneField value. Default value is "canEditLane"
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
      See Also:
    • getCanEditLaneField

      public String getCanEditLaneField()
      Name of the field on each CalendarEvent that determines whether that event can be moved between lanes.
      Returns:
      Current canEditLaneField value. Default value is "canEditLane"
      See Also:
    • setCanEditSublane

      public Calendar setCanEditSublane(Boolean canEditSublane) throws IllegalStateException
      Can events be moved between sublanes?

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

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

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

      This setting can be overridden on each event.

      Parameters:
      canEditSublane - New canEditSublane value. Default value is null
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
    • getCanEditSublane

      public Boolean getCanEditSublane()
      Can events be moved between sublanes?

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

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

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

      This setting can be overridden on each event.

      Returns:
      Current canEditSublane value. Default value is null
    • setCanEditSublaneField

      public Calendar setCanEditSublaneField(String canEditSublaneField) throws IllegalStateException
      Name of the field on each CalendarEvent that determines whether that event can be moved between individual sublanes in a Lane.
      Parameters:
      canEditSublaneField - New canEditSublaneField value. Default value is "canEditSublane"
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
      See Also:
    • getCanEditSublaneField

      public String getCanEditSublaneField()
      Name of the field on each CalendarEvent that determines whether that event can be moved between individual sublanes in a Lane.
      Returns:
      Current canEditSublaneField value. Default value is "canEditSublane"
      See Also:
    • setCanGroupLanes

      public Calendar setCanGroupLanes(Boolean canGroupLanes)
      If true, allows the lanes in a Timeline to be grouped by providing a value for laneGroupByField. The fields available for grouping on are those defined as lane fields. Since these are definitions for normal fields, you can choose to hide the field in the timeline, but still have it available for grouping.
      Parameters:
      canGroupLanes - New canGroupLanes value. Default value is null
      Returns:
      Calendar instance, for chaining setter calls
    • getCanGroupLanes

      public Boolean getCanGroupLanes()
      If true, allows the lanes in a Timeline to be grouped by providing a value for laneGroupByField. The fields available for grouping on are those defined as lane fields. Since these are definitions for normal fields, you can choose to hide the field in the timeline, but still have it available for grouping.
      Returns:
      Current canGroupLanes value. Default value is null
    • setCanRemoveEvents

      public Calendar setCanRemoveEvents(Boolean canRemoveEvents) throws IllegalStateException
      If true, users can remove existing events. Defaults to canEditEvents.
      Parameters:
      canRemoveEvents - New canRemoveEvents value. Default value is true
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
    • getCanRemoveEvents

      public Boolean getCanRemoveEvents()
      If true, users can remove existing events. Defaults to canEditEvents.
      Returns:
      Current canRemoveEvents value. Default value is true
    • setCanRemoveField

      public Calendar setCanRemoveField(String canRemoveField) throws IllegalStateException
      Name of the field on each CalendarEvent that determines whether an event shows a remove button.
      Parameters:
      canRemoveField - New canRemoveField value. Default value is "canRemove"
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
      See Also:
    • getCanRemoveField

      public String getCanRemoveField()
      Name of the field on each CalendarEvent that determines whether an event shows a remove button.
      Returns:
      Current canRemoveField value. Default value is "canRemove"
      See Also:
    • setCanReorderLanes

      public Calendar setCanReorderLanes(Boolean canReorderLanes) throws IllegalStateException
      If true, lanes can be reordered by dragging their laneFields with the mouse.
      Parameters:
      canReorderLanes - New canReorderLanes value. Default value is null
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
    • getCanReorderLanes

      public Boolean getCanReorderLanes()
      If true, lanes can be reordered by dragging their laneFields with the mouse.
      Returns:
      Current canReorderLanes value. Default value is null
    • setCanResizeEventField

      public Calendar setCanResizeEventField(String canResizeEventField) throws IllegalStateException
      Name of the field on each CalendarEvent that determines whether an event can be resized by dragging.
      Parameters:
      canResizeEventField - New canResizeEventField value. Default value is "canResize"
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
      See Also:
    • getCanResizeEventField

      public String getCanResizeEventField()
      Name of the field on each CalendarEvent that determines whether an event can be resized by dragging.
      Returns:
      Current canResizeEventField value. Default value is "canResize"
      See Also:
    • setCanResizeEvents

      public Calendar setCanResizeEvents(Boolean canResizeEvents) throws IllegalStateException
      Can events be resized by dragging appropriate edges of the canvas? Only has an effect when both canEditEvents and canDragEvents are true. Set this attribute to false to disallow drag-resizing.

      Always false when showColumnLayouts is true.

      Parameters:
      canResizeEvents - New canResizeEvents value. Default value is true
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
    • getCanResizeEvents

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

      Always false when showColumnLayouts is true.

      Returns:
      Current canResizeEvents value. Default value is true
    • setCanResizeTimelineEvents

      public Calendar setCanResizeTimelineEvents(Boolean canResizeTimelineEvents) throws IllegalStateException
      Deprecated.
      in favor of canResizeEvents;
      Can Timeline events be stretched by their left and right edges?
      Parameters:
      canResizeTimelineEvents - New canResizeTimelineEvents value. Default value is false
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
    • getCanResizeTimelineEvents

      public Boolean getCanResizeTimelineEvents()
      Deprecated.
      in favor of canResizeEvents;
      Can Timeline events be stretched by their left and right edges?
      Returns:
      Current canResizeTimelineEvents value. Default value is false
    • setCanSelectEvents

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

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

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

      Parameters:
      canSelectEvents - New canSelectEvents value. Default value is null
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
    • getCanSelectEvents

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

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

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

      Returns:
      Current canSelectEvents value. Default value is null
    • setChosenDate

      public Calendar setChosenDate(Date chosenDate)
      The date for which events are displayed in the day, week, and month tabs of the calendar. Default is today.

      If this method is called after the component has been drawn/initialized: Set the current date for which the calendar will display events.
      Parameters:
      chosenDate - the new date to set as the current date. Default value is 'Today'
      Returns:
      Calendar instance, for chaining setter calls
    • getChosenDate

      public Date getChosenDate()
      The date for which events are displayed in the day, week, and month tabs of the calendar. Default is today.
      Returns:
      Current chosenDate value. Default value is 'Today'
    • getColumnLayout

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

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

      Returns:
      null
    • setColumnsPerPage

      public Calendar setColumnsPerPage(Integer columnsPerPage) throws IllegalStateException
      When using the Next and Previous arrows to scroll a Timeline, this is the number of columns of the timelineGranularity to scroll by. With the default value of null, the Timeline will scroll by its current length.
      Parameters:
      columnsPerPage - New columnsPerPage value. Default value is null
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
    • getColumnsPerPage

      public Integer getColumnsPerPage()
      When using the Next and Previous arrows to scroll a Timeline, this is the number of columns of the timelineGranularity to scroll by. With the default value of null, the Timeline will scroll by its current length.
      Returns:
      Current columnsPerPage value. Default value is null
    • setControlBarIconBaseStyle

      public Calendar setControlBarIconBaseStyle(String controlBarIconBaseStyle) throws IllegalStateException
      A CSS style to apply to icons in the controlsBar. This is a base style supporting suffixes for states, specifically "Over", "Down" and "Disabled", which are applied when ImgButton settings like ImgButton.showRollOverIcon are applied to the icons.
      Parameters:
      controlBarIconBaseStyle - New controlBarIconBaseStyle value. Default value is "icon"
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
      See Also:
    • getControlBarIconBaseStyle

      public String getControlBarIconBaseStyle()
      A CSS style to apply to icons in the controlsBar. This is a base style supporting suffixes for states, specifically "Over", "Down" and "Disabled", which are applied when ImgButton settings like ImgButton.showRollOverIcon are applied to the icons.
      Returns:
      Current controlBarIconBaseStyle value. Default value is "icon"
      See Also:
    • setControlBarIconSize

      public Calendar setControlBarIconSize(Integer controlBarIconSize) throws IllegalStateException
      The size of the various icons displayed in the controlsBar of this Calendar.
      Parameters:
      controlBarIconSize - New controlBarIconSize value. Default value is 16
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
    • getControlBarIconSize

      public Integer getControlBarIconSize()
      The size of the various icons displayed in the controlsBar of this Calendar.
      Returns:
      Current controlBarIconSize value. Default value is 16
    • getControlsBar

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

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

      Returns:
      Current controlsBar value. Default value is null
      Throws:
      IllegalStateException - if this widget has not yet been rendered.
    • setControlsBarHeight

      public Calendar setControlsBarHeight(Integer controlsBarHeight) throws IllegalStateException
      Default height of the controlsBar shown above the main Calendar grid. When multiple views are available and tabs are visible, this value is modified to ensure that the content of the controlsBar is vertically-aligned with the text in the tabs.
      Parameters:
      controlsBarHeight - New controlsBarHeight value. Default value is 30
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
    • getControlsBarHeight

      public Integer getControlsBarHeight()
      Default height of the controlsBar shown above the main Calendar grid. When multiple views are available and tabs are visible, this value is modified to ensure that the content of the controlsBar is vertically-aligned with the text in the tabs.
      Returns:
      Current controlsBarHeight value. Default value is 30
    • setCurrentViewName

      public Calendar setCurrentViewName(ViewName currentViewName)
      The name of the view that should be visible initially by default.

      If this method is called after the component has been drawn/initialized: Sets the currently visible view.
      Parameters:
      currentViewName - The name of the view that should be made visible. Default value is null
      Returns:
      Calendar instance, for chaining setter calls
    • getCurrentViewName

      public ViewName getCurrentViewName()
      The name of the view that should be visible initially by default.
      Returns:
      Get the name of the visible view. Returns one of 'day', 'week', 'month' or 'timeline'. Default value is null
    • setData

      public Calendar setData(CalendarEvent... data)
      A List of CalendarEvent objects, specifying the data to be used to populate the calendar.

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

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

      Parameters:
      data - data to show in the list. Default value is null
      Returns:
      Calendar instance, for chaining setter calls
      See Also:
    • getData

      public CalendarEvent[] getData()
      A List of CalendarEvent objects, specifying the data to be used to populate the calendar.

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

      Returns:
      Current data value. Default value is null
      See Also:
    • setDataFetchMode

      public Calendar setDataFetchMode(FetchMode dataFetchMode)
      How to fetch and manage records retrieve from the server. See FetchMode.

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

      Specified by:
      setDataFetchMode in interface DataBoundComponent
      Parameters:
      dataFetchMode - New dataFetchMode value. Default value is "basic"
      Returns:
      Calendar instance, for chaining setter calls
      See Also:
    • getDataFetchMode

      public FetchMode getDataFetchMode()
      How to fetch and manage records retrieve from the server. See FetchMode.

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

      Specified by:
      getDataFetchMode in interface DataBoundComponent
      Returns:
      Current dataFetchMode value. Default value is "basic"
      See Also:
    • setDataSource

      public Calendar setDataSource(DataSource dataSource)
      The DataSource that this component should bind to for default fields and for performing DataSource requests.

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

      Specified by:
      setDataSource in interface DataBoundComponent
      Parameters:
      dataSource - New dataSource value. Default value is null
      Returns:
      Calendar instance, for chaining setter calls
      See Also:
    • setDataSource

      public Calendar setDataSource(String dataSource)
      The DataSource that this component should bind to for default fields and for performing DataSource requests.

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

      Specified by:
      setDataSource in interface DataBoundComponent
      Parameters:
      dataSource - New dataSource value. Default value is null
      Returns:
      Calendar instance, for chaining setter calls
      See Also:
    • getDateChooser

      public DateChooser getDateChooser() throws IllegalStateException
      DateChooser used to select the date for which events will be displayed.

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

      Returns:
      Current dateChooser value. Default value is null
      Throws:
      IllegalStateException - if this widget has not yet been rendered.
    • setDateEditingStyle

      public Calendar setDateEditingStyle(DateEditingStyle dateEditingStyle) throws IllegalStateException
      Indicates the type of controls to use in event-windows. Valid values are those in the DateEditingStyle type.

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

      Parameters:
      dateEditingStyle - New dateEditingStyle value. Default value is null
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
    • getDateEditingStyle

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

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

      Returns:
      Current dateEditingStyle value. Default value is null
    • setDateFormatter

      public Calendar setDateFormatter(DateDisplayFormat dateFormatter)
      Date formatter for displaying events. Default is to use the system-wide default short date format, configured via DateUtil.setShortDisplayFormat(). Specify any valid DateDisplayFormat.
      Parameters:
      dateFormatter - New dateFormatter value. Default value is null
      Returns:
      Calendar instance, for chaining setter calls
    • getDateFormatter

      public DateDisplayFormat getDateFormatter()
      Date formatter for displaying events. Default is to use the system-wide default short date format, configured via DateUtil.setShortDisplayFormat(). Specify any valid DateDisplayFormat.
      Returns:
      Current dateFormatter value. Default value is null
    • getDateLabel

      public Label getDateLabel() throws IllegalStateException
      The com.smartgwt.client.types.AutoChild Label used to display the current date or range above the selected calendar view.

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

      Returns:
      Current dateLabel value. Default value is null
      Throws:
      IllegalStateException - if this widget has not yet been rendered.
    • getDatePickerButton

      public ImgButton getDatePickerButton() throws IllegalStateException
      An ImgButton that appears above the various views of the calendar and offers alternative access to a DateChooser to pick the current day.

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

      Returns:
      Current datePickerButton value. Default value is null
      Throws:
      IllegalStateException - if this widget has not yet been rendered.
    • setDatePickerHoverText

      public Calendar setDatePickerHoverText(String datePickerHoverText) throws IllegalStateException
      The text to be displayed when a user hovers over the date picker toolbar button
      Parameters:
      datePickerHoverText - New datePickerHoverText value. Default value is "Choose a date"
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
    • getDatePickerHoverText

      public String getDatePickerHoverText()
      The text to be displayed when a user hovers over the date picker toolbar button
      Returns:
      Current datePickerHoverText value. Default value is "Choose a date"
    • setDayBodyBaseStyle

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

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

      Parameters:
      dayBodyBaseStyle - New dayBodyBaseStyle value. Default value is "calMonthDayBody"
      Returns:
      Calendar instance, for chaining setter calls
      See Also:
    • getDayBodyBaseStyle

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

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

      Returns:
      Current dayBodyBaseStyle value. Default value is "calMonthDayBody"
      See Also:
    • setDayHeaderBaseStyle

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

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

      Parameters:
      dayHeaderBaseStyle - New dayHeaderBaseStyle value. Default value is "calMonthDayHeader"
      Returns:
      Calendar instance, for chaining setter calls
      See Also:
    • getDayHeaderBaseStyle

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

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

      Returns:
      Current dayHeaderBaseStyle value. Default value is "calMonthDayHeader"
      See Also:
    • getDayView

      public CalendarView getDayView() throws IllegalStateException
      CalendarView used to display events that pertain to a given day.

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

      Returns:
      Current dayView value. Default value is null
      Throws:
      IllegalStateException - if this widget has not yet been rendered.
    • setDayViewTitle

      public Calendar setDayViewTitle(String dayViewTitle) throws IllegalStateException
      The title for the day view.
      Parameters:
      dayViewTitle - New dayViewTitle value. Default value is "Day"
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
    • getDayViewTitle

      public String getDayViewTitle()
      The title for the day view.
      Returns:
      Current dayViewTitle value. Default value is "Day"
    • setDefaultTimelineColumnSpan

      public Calendar setDefaultTimelineColumnSpan(int defaultTimelineColumnSpan) throws IllegalStateException
      The number of columns of the timelineGranularity to give the timeline by default if no endDate is provided. The default is 20.
      Parameters:
      defaultTimelineColumnSpan - New defaultTimelineColumnSpan value. Default value is 20
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
    • getDefaultTimelineColumnSpan

      public int getDefaultTimelineColumnSpan()
      The number of columns of the timelineGranularity to give the timeline by default if no endDate is provided. The default is 20.
      Returns:
      Current defaultTimelineColumnSpan value. Default value is 20
    • setDescriptionField

      public Calendar setDescriptionField(String descriptionField) throws IllegalStateException
      The name of the description field on a CalendarEvent.
      Parameters:
      descriptionField - New descriptionField value. Default value is "description"
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
    • getDescriptionField

      public String getDescriptionField()
      The name of the description field on a CalendarEvent.
      Returns:
      Current descriptionField value. Default value is "description"
    • setDetailsButtonTitle

      public Calendar setDetailsButtonTitle(String detailsButtonTitle) throws IllegalStateException
      The title for the edit button in the quick quick event dialog.
      Parameters:
      detailsButtonTitle - New detailsButtonTitle value. Default value is "Edit Details"
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
      See Also:
    • getDetailsButtonTitle

      public String getDetailsButtonTitle()
      The title for the edit button in the quick quick event dialog.
      Returns:
      Current detailsButtonTitle value. Default value is "Edit Details"
      See Also:
    • setDisableWeekends

      public Calendar setDisableWeekends(Boolean disableWeekends)
      If true, weekend days appear in a disabled style and events cannot be created on weekends. Which days are considered weekends is controlled by weekendDays.
      Parameters:
      disableWeekends - New disableWeekends value. Default value is true
      Returns:
      Calendar instance, for chaining setter calls
      See Also:
    • getDisableWeekends

      public Boolean getDisableWeekends()
      If true, weekend days appear in a disabled style and events cannot be created on weekends. Which days are considered weekends is controlled by weekendDays.
      Returns:
      Current disableWeekends value. Default value is true
      See Also:
    • setDurationField

      public Calendar setDurationField(String durationField) throws IllegalStateException
      The name of the duration field on a CalendarEvent.
      Parameters:
      durationField - New durationField value. Default value is "duration"
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
      See Also:
    • getDurationField

      public String getDurationField()
      The name of the duration field on a CalendarEvent.
      Returns:
      Current durationField value. Default value is "duration"
      See Also:
    • setDurationUnitField

      public Calendar setDurationUnitField(String durationUnitField) throws IllegalStateException
      The name of the durationUnit field on a CalendarEvent.
      Parameters:
      durationUnitField - New durationUnitField value. Default value is "durationUnit"
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
      See Also:
    • getDurationUnitField

      public String getDurationUnitField()
      The name of the durationUnit field on a CalendarEvent.
      Returns:
      Current durationUnitField value. Default value is "durationUnit"
      See Also:
    • setEndDate

      public Calendar setEndDate(Date endDate) throws IllegalStateException
      The end date of the calendar timeline view. Has no effect in other views.

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

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

      Parameters:
      endDate - New endDate value. Default value is null
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
    • getEndDate

      public Date getEndDate()
      The end date of the calendar timeline view. Has no effect in other views.

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

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

      Returns:
      Current endDate value. Default value is null
    • setEndDateField

      public Calendar setEndDateField(String endDateField) throws IllegalStateException
      The name of the end date field on a CalendarEvent.
      Parameters:
      endDateField - New endDateField value. Default value is "endDate"
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
      See Also:
    • getEndDateField

      public String getEndDateField()
      The name of the end date field on a CalendarEvent.
      Returns:
      Current endDateField value. Default value is "endDate"
      See Also:
    • setEventAutoArrange

      public Calendar setEventAutoArrange(Boolean eventAutoArrange) throws IllegalStateException
      If set to true, enables the auto-arrangement of events that share time in the calendar. The default is true.
      Parameters:
      eventAutoArrange - New eventAutoArrange value. Default value is true
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
    • getEventAutoArrange

      public Boolean getEventAutoArrange()
      If set to true, enables the auto-arrangement of events that share time in the calendar. The default is true.
      Returns:
      Current eventAutoArrange value. Default value is true
    • getEventCanvas

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

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

      Returns:
      null
    • getEventCanvasButtonLayout

      public HLayout getEventCanvasButtonLayout() throws IllegalStateException
      HLayout that snaps to the top-right of an event canvas on rollover and contains the close and/or context buttons.

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

      Returns:
      Current eventCanvasButtonLayout value. Default value is null
      Throws:
      IllegalStateException - if this widget has not yet been rendered.
    • getEventCanvasCloseButton

      public ImgButton getEventCanvasCloseButton() throws IllegalStateException
      The close button that snaps to the top-right of an event canvas on rollover and allows an event to be removed from a CalendarView.

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

      Returns:
      Current eventCanvasCloseButton value. Default value is null
      Throws:
      IllegalStateException - if this widget has not yet been rendered.
    • setEventCanvasCloseButtonSize

      public Calendar setEventCanvasCloseButtonSize(Integer eventCanvasCloseButtonSize) throws IllegalStateException
      The size of the close-button that snaps to the top-right of an event canvas on rollover and shows allows an event to be removed from a CalendarView.
      Parameters:
      eventCanvasCloseButtonSize - New eventCanvasCloseButtonSize value. Default value is 16
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
    • getEventCanvasCloseButtonSize

      public Integer getEventCanvasCloseButtonSize()
      The size of the close-button that snaps to the top-right of an event canvas on rollover and shows allows an event to be removed from a CalendarView.
      Returns:
      Current eventCanvasCloseButtonSize value. Default value is 16
    • setEventCanvasCloseIconSize

      public Calendar setEventCanvasCloseIconSize(Integer eventCanvasCloseIconSize) throws IllegalStateException
      The size of the icon in the close-button floated over events on rollover.
      Parameters:
      eventCanvasCloseIconSize - New eventCanvasCloseIconSize value. Default value is 13
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
    • getEventCanvasCloseIconSize

      public Integer getEventCanvasCloseIconSize()
      The size of the icon in the close-button floated over events on rollover.
      Returns:
      Current eventCanvasCloseIconSize value. Default value is 13
    • getEventCanvasComponent

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

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

      Returns:
      null
      See Also:
    • getEventCanvasContextButton

      public ImgButton getEventCanvasContextButton() throws IllegalStateException
      The context button that snaps to the top-right of an event canvas on rollover and shows a custom context menu when clicked.

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

      Returns:
      Current eventCanvasContextButton value. Default value is null
      Throws:
      IllegalStateException - if this widget has not yet been rendered.
    • getEventCanvasContextMenu

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

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

      Returns:
      Current eventCanvasContextMenu value. Default value is null
      Throws:
      IllegalStateException - if this widget has not yet been rendered.
    • getEventCanvasGripper

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

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

      Returns:
      null
    • getEventCanvasHResizer

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

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

      Returns:
      null
    • getEventCanvasLabel

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

      Returns:
      null
    • getEventCanvasVResizer

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

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

      Returns:
      null
    • setEventDescriptionFieldTitle

      public Calendar setEventDescriptionFieldTitle(String eventDescriptionFieldTitle) throws IllegalStateException
      The title for the descriptionField field in the quick event dialog and the detailed editor.
      Parameters:
      eventDescriptionFieldTitle - New eventDescriptionFieldTitle value. Default value is "Description"
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
      See Also:
    • getEventDescriptionFieldTitle

      public String getEventDescriptionFieldTitle()
      The title for the descriptionField field in the quick event dialog and the detailed editor.
      Returns:
      Current eventDescriptionFieldTitle value. Default value is "Description"
      See Also:
    • getEventDialog

      public Window getEventDialog() throws IllegalStateException
      An com.smartgwt.client.types.AutoChild of type Window that displays a quick event entry form in a popup window.

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

      Returns:
      Current eventDialog value. Default value is null
      Throws:
      IllegalStateException - if this widget has not yet been rendered.
    • setEventDragGap

      public Calendar setEventDragGap(Integer eventDragGap)
      The number of pixels to leave to the right of events so overlapping events can still be added using the mouse.
      Parameters:
      eventDragGap - New eventDragGap value. Default value is 10
      Returns:
      Calendar instance, for chaining setter calls
    • getEventDragGap

      public Integer getEventDragGap()
      The number of pixels to leave to the right of events so overlapping events can still be added using the mouse.
      Returns:
      Current eventDragGap value. Default value is 10
    • setEventDurationFieldTitle

      public Calendar setEventDurationFieldTitle(String eventDurationFieldTitle) throws IllegalStateException
      The title for the duration field in the quick event dialog and the detailed editor.
      Parameters:
      eventDurationFieldTitle - New eventDurationFieldTitle value. Default value is "Duration"
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
      See Also:
    • getEventDurationFieldTitle

      public String getEventDurationFieldTitle()
      The title for the duration field in the quick event dialog and the detailed editor.
      Returns:
      Current eventDurationFieldTitle value. Default value is "Duration"
      See Also:
    • setEventDurationUnitFieldTitle

      public Calendar setEventDurationUnitFieldTitle(String eventDurationUnitFieldTitle) throws IllegalStateException
      The title for the duration unit field in the quick event dialog and the detailed editor.
      Parameters:
      eventDurationUnitFieldTitle - New eventDurationUnitFieldTitle value. Default value is " "
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
      See Also:
    • getEventDurationUnitFieldTitle

      public String getEventDurationUnitFieldTitle()
      The title for the duration unit field in the quick event dialog and the detailed editor.
      Returns:
      Current eventDurationUnitFieldTitle value. Default value is " "
      See Also:
    • getEventEditor

      public DynamicForm getEventEditor() throws IllegalStateException
      An com.smartgwt.client.types.AutoChild of type DynamicForm which displays event data. This form is created within the event editor layout

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

      Returns:
      Current eventEditor value. Default value is null
      Throws:
      IllegalStateException - if this widget has not yet been rendered.
    • getEventEditorButtonLayout

      public HLayout getEventEditorButtonLayout() throws IllegalStateException
      An com.smartgwt.client.types.AutoChild of type HLayout which houses the Save, Remove and Cancel buttons in the eventEditor.

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

      Returns:
      Current eventEditorButtonLayout value. Default value is null
      Throws:
      IllegalStateException - if this widget has not yet been rendered.
    • setEventEditorButtons

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

      The default is to show the builtin buttons.

      Parameters:
      eventEditorButtons - New eventEditorButtons value. Default value is (see below)
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
    • getEventEditorButtons

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

      The default is to show the builtin buttons.

      Returns:
      Current eventEditorButtons value. Default value is (see below)
    • setEventEditorDateFieldTitle

      public Calendar setEventEditorDateFieldTitle(String eventEditorDateFieldTitle) throws IllegalStateException
      The title for the Date-field in the eventEditor that allows for changing the logical start-date of an event, along with its start and end times, when editing events in the day and week views.
      Parameters:
      eventEditorDateFieldTitle - New eventEditorDateFieldTitle value. Default value is "Date"
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
      See Also:
    • getEventEditorDateFieldTitle

      public String getEventEditorDateFieldTitle()
      The title for the Date-field in the eventEditor that allows for changing the logical start-date of an event, along with its start and end times, when editing events in the day and week views.
      Returns:
      Current eventEditorDateFieldTitle value. Default value is "Date"
      See Also:
    • getEventEditorLayout

      public Window getEventEditorLayout() throws IllegalStateException
      An com.smartgwt.client.types.AutoChild of type Window that displays the full event editor

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

      Returns:
      Current eventEditorLayout value. Default value is null
      Throws:
      IllegalStateException - if this widget has not yet been rendered.
    • setEventEndDateFieldTitle

      public Calendar setEventEndDateFieldTitle(String eventEndDateFieldTitle) throws IllegalStateException
      The title for the endDateField in the quick event dialog and the detailed editor.
      Parameters:
      eventEndDateFieldTitle - New eventEndDateFieldTitle value. Default value is "To"
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
      See Also:
    • getEventEndDateFieldTitle

      public String getEventEndDateFieldTitle()
      The title for the endDateField in the quick event dialog and the detailed editor.
      Returns:
      Current eventEndDateFieldTitle value. Default value is "To"
      See Also:
    • setEventHeaderHeight

      public Calendar setEventHeaderHeight(int eventHeaderHeight) throws IllegalStateException
      When eventHeaderWrap is false and showEventDescriptions is true, this is the fixed height for the header area in event canvases.
      Parameters:
      eventHeaderHeight - New eventHeaderHeight value. Default value is 14
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
    • getEventHeaderHeight

      public int getEventHeaderHeight()
      When eventHeaderWrap is false and showEventDescriptions is true, this is the fixed height for the header area in event canvases.
      Returns:
      Current eventHeaderHeight value. Default value is 14
    • setEventHeaderWrap

      public Calendar setEventHeaderWrap(boolean eventHeaderWrap) throws IllegalStateException
      When rendering the canvas for an event, whether to allow the content of the header area to wrap to multiple lines.

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

      Parameters:
      eventHeaderWrap - New eventHeaderWrap value. Default value is true
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
    • getEventHeaderWrap

      public boolean getEventHeaderWrap()
      When rendering the canvas for an event, whether to allow the content of the header area to wrap to multiple lines.

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

      Returns:
      Current eventHeaderWrap value. Default value is true
    • setEventLaneFieldTitle

      public Calendar setEventLaneFieldTitle(String eventLaneFieldTitle) throws IllegalStateException
      The title for the laneNameField in the quick event dialog and the detailed editor.
      Parameters:
      eventLaneFieldTitle - New eventLaneFieldTitle value. Default value is "Lane"
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
      See Also:
    • getEventLaneFieldTitle

      public String getEventLaneFieldTitle()
      The title for the laneNameField in the quick event dialog and the detailed editor.
      Returns:
      Current eventLaneFieldTitle value. Default value is "Lane"
      See Also:
    • setEventNameFieldTitle

      public Calendar setEventNameFieldTitle(String eventNameFieldTitle) throws IllegalStateException
      The title for the nameField in the quick event dialog and the detailed editor.
      Parameters:
      eventNameFieldTitle - New eventNameFieldTitle value. Default value is "Event Name"
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
      See Also:
    • getEventNameFieldTitle

      public String getEventNameFieldTitle()
      The title for the nameField in the quick event dialog and the detailed editor.
      Returns:
      Current eventNameFieldTitle value. Default value is "Event Name"
      See Also:
    • setEventOverlap

      public Calendar setEventOverlap(Boolean eventOverlap) throws IllegalStateException
      When eventAutoArrange is true, setting eventOverlap to true causes events that share timeslots to overlap each other by a percentage of their width, specified by eventOverlapPercent. The default is true for Calendars and false for Timelines.
      Parameters:
      eventOverlap - New eventOverlap value. Default value is true
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
    • getEventOverlap

      public Boolean getEventOverlap()
      When eventAutoArrange is true, setting eventOverlap to true causes events that share timeslots to overlap each other by a percentage of their width, specified by eventOverlapPercent. The default is true for Calendars and false for Timelines.
      Returns:
      Current eventOverlap value. Default value is true
    • setEventOverlapIdenticalStartTimes

      public Calendar setEventOverlapIdenticalStartTimes(Boolean eventOverlapIdenticalStartTimes) throws IllegalStateException
      When set to true, events that start at the same time will not overlap each other to prevent events having their close button hidden.
      Parameters:
      eventOverlapIdenticalStartTimes - New eventOverlapIdenticalStartTimes value. Default value is false
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
    • getEventOverlapIdenticalStartTimes

      public Boolean getEventOverlapIdenticalStartTimes()
      When set to true, events that start at the same time will not overlap each other to prevent events having their close button hidden.
      Returns:
      Current eventOverlapIdenticalStartTimes value. Default value is false
    • setEventOverlapPercent

      public Calendar setEventOverlapPercent(int eventOverlapPercent) throws IllegalStateException
      The size of the overlap, presented as a percentage of the width of events sharing timeslots.
      Parameters:
      eventOverlapPercent - New eventOverlapPercent value. Default value is 10
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
    • getEventOverlapPercent

      public int getEventOverlapPercent()
      The size of the overlap, presented as a percentage of the width of events sharing timeslots.
      Returns:
      Current eventOverlapPercent value. Default value is 10
    • setEventScreen

      public Calendar setEventScreen(String eventScreen) throws IllegalStateException
      Screen to create (via createScreen()) in lieu of calling createEventCanvasComponent().

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

      Parameters:
      eventScreen - New eventScreen value. Default value is null
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
    • getEventScreen

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

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

      Returns:
      Current eventScreen value. Default value is null
    • setEventSnapGap

      public Calendar setEventSnapGap(Integer eventSnapGap)
      The number of minutes that determines the positions to which events will snap when rendered, and when moved or resized with the mouse.

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

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

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

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

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

      Parameters:
      eventSnapGap - New eventSnapGap value. Default value is null
      Returns:
      Calendar instance, for chaining setter calls
      See Also:
    • getEventSnapGap

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

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

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

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

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

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

      Returns:
      Current eventSnapGap value. Default value is null
      See Also:
    • setEventStartDateFieldTitle

      public Calendar setEventStartDateFieldTitle(String eventStartDateFieldTitle) throws IllegalStateException
      The title for the startDateField in the quick event dialog and the detailed editor.
      Parameters:
      eventStartDateFieldTitle - New eventStartDateFieldTitle value. Default value is "From"
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
      See Also:
    • getEventStartDateFieldTitle

      public String getEventStartDateFieldTitle()
      The title for the startDateField in the quick event dialog and the detailed editor.
      Returns:
      Current eventStartDateFieldTitle value. Default value is "From"
      See Also:
    • setEventStyleName

      public Calendar setEventStyleName(String eventStyleName)
      The base name for the CSS class applied to events when they're rendered in calendar views. This style will have "Header" and "Body" appended to it, according to which part of the event window is being styled. For example, to style the header, define a CSS class called 'eventWindowHeader'.
      Parameters:
      eventStyleName - New eventStyleName value. Default value is "eventWindow"
      Returns:
      Calendar instance, for chaining setter calls
      See Also:
    • getEventStyleName

      public String getEventStyleName()
      The base name for the CSS class applied to events when they're rendered in calendar views. This style will have "Header" and "Body" appended to it, according to which part of the event window is being styled. For example, to style the header, define a CSS class called 'eventWindowHeader'.
      Returns:
      Current eventStyleName value. Default value is "eventWindow"
      See Also:
    • setEventStyleNameField

      public Calendar setEventStyleNameField(String eventStyleNameField) throws IllegalStateException
      The name of the field used to override eventStyleName for an individual CalendarEvent.styleName.
      Parameters:
      eventStyleNameField - New eventStyleNameField value. Default value is "styleName"
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
      See Also:
    • getEventStyleNameField

      public String getEventStyleNameField()
      The name of the field used to override eventStyleName for an individual CalendarEvent.styleName.
      Returns:
      Current eventStyleNameField value. Default value is "styleName"
      See Also:
    • setEventSublaneFieldTitle

      public Calendar setEventSublaneFieldTitle(String eventSublaneFieldTitle) throws IllegalStateException
      The title for the sublaneNameField in the quick event dialog and the detailed event editor.
      Parameters:
      eventSublaneFieldTitle - New eventSublaneFieldTitle value. Default value is "Sublane"
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
      See Also:
    • getEventSublaneFieldTitle

      public String getEventSublaneFieldTitle()
      The title for the sublaneNameField in the quick event dialog and the detailed event editor.
      Returns:
      Current eventSublaneFieldTitle value. Default value is "Sublane"
      See Also:
    • setEventWindowStyle

      public Calendar setEventWindowStyle(String eventWindowStyle)
      Deprecated.
      in favor of eventStyleName
      The base name for the CSS class applied to event windows within calendars. This style will have "Header", "HeaderLabel", and "Body" appended to it, according to which part of the event window is being styled. For example, to style the header, define a CSS class called 'eventWindowHeader'.
      Parameters:
      eventWindowStyle - New eventWindowStyle value. Default value is null
      Returns:
      Calendar instance, for chaining setter calls
      See Also:
    • getEventWindowStyle

      public String getEventWindowStyle()
      Deprecated.
      in favor of eventStyleName
      The base name for the CSS class applied to event windows within calendars. This style will have "Header", "HeaderLabel", and "Body" appended to it, according to which part of the event window is being styled. For example, to style the header, define a CSS class called 'eventWindowHeader'.
      Returns:
      Current eventWindowStyle value. Default value is null
      See Also:
    • setEventWindowStyleField

      public Calendar setEventWindowStyleField(String eventWindowStyleField) throws IllegalStateException
      Deprecated.
      The name of the field used to override eventWindowStyle for an individual CalendarEvent. See CalendarEvent.eventWindowStyle.
      Parameters:
      eventWindowStyleField - New eventWindowStyleField value. Default value is "eventWindowStyle"
      Returns:
      Calendar instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
      See Also:
    • getEventWindowStyleField

      public String getEventWindowStyleField()
      Deprecated.
      The name of the field used to override eventWindowStyle for an individual CalendarEvent. See CalendarEvent.eventWindowStyle.
      Returns:
      Current eventWindowStyleField value. Default value is "eventWindowStyle"
      See Also:
    • setFirstDayOfWeek

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

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

      Parameters:
      firstDayOfWeek - New firstDayOfWeek value. Default value is null
      Returns:
      Calendar instance, for chaining setter calls
    • getFirstDayOfWeek

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

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

      Returns:
      Current firstDayOfWeek value. Default value is null
    • setHeaderLevels

      public Calendar setHeaderLevels(HeaderLevel... headerLevels)
      Configures the levels of headers shown above the event area, and their time units.

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

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

      Parameters:
      headerLevels - the array of HeaderLevels to set. Default value is null
      Returns:
      Calendar instance, for chaining setter calls
    • getHeaderLevels

      public HeaderLevel[] getHeaderLevels()
      Configures the levels of headers shown above the event area, and their time units.

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

      Returns:
      Current headerLevels value. Default value is null
    • setHideUnusedLanes

      public Calendar setHideUnusedLanes(Boolean hideUnusedLanes)
      When set to true, hides any lane that doesn't have any active events in the current dataset.

      If this method is called after the component has been drawn/initialized: Setter for updating hideUnusedLanes after creation.
      Parameters:
      hideUnusedLanes - whether to hide unused lanes. Default value is null
      Returns:
      Calendar instance, for chaining setter calls
    • getHideUnusedLanes

      public Boolean getHideUnusedLanes()
      When set to true, hides any lane that doesn't have any active events in the current dataset.
      Returns:
      Current hideUnusedLanes value. Default value is null
    • setIncludeRangeCriteria

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

      For example, navigating i