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
CalendarEvents
Events are
represented as ordinary JavaScript Objects (see CalendarEvent
). The
Calendar expects to be able to read and write a basic set of properties on events: name, startDate, endDate,
description, etc, which can be stored under configurable property names (see eg startDateField
).
Much like a ListGrid
manages it's ListGridRecords, the Calendar can either be passed an ordinary
Array of CalendarEvents or can fetch data from a DataSource. When this is the case, if the DataSource does not
contain fields with the configured property names, an attempt is made to auto-detect likely-looking fields from those
that are present. To see logs indicating that this has happened, switch default logging preferences to INFO level in
the Developer Console.
If the calendar is bound to a DataSource, event changes by user action or by calling methods will be saved to the DataSource.
Navigation
The calendar supports a number of views by default: day
, week
, month
and timeline
. The user can navigate using back and forward
buttons or via an attached DateChooser
.
Event Manipulation
Events can be created by clicking directly onto one of the views, or via the Add Event
button. In the day, week and timeline views,
the user may click and drag to create an event of a specific duration.
Creating an event via click or click and
drag pops up the EventDialog
, which provides a
simple form for quick event entry (for normal events, only the description is required by default - for events that
are shown in a lane
, that field is also required).
A
separate editor called the EventEditor
provides an
interface for editing all possible properties of an event, including custom properties. The EventEditor is used
whenever a pre-existing event is being edited, and can also be invoked by the user wherever the simpler EventDialog
appears.
Events can also be programmatically added
, removed
, or updated
.
-
Nested Class Summary
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled
-
Field Summary
Fields inherited from class com.smartgwt.client.widgets.BaseWidget
config, configOnly, factoryCreated, factoryProperties, id, nativeObject, scClassName
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionAdd a backgroundClick handler.Add a backgroundMouseDown handler.Add a backgroundMouseUp handler.void
addCalendarEvent
(CalendarEvent event) Create a new event in this calendar.void
addCalendarEvent
(CalendarEvent event, Map customValues) Create a new event in this calendar.Add a currentViewChanged handler.addDateChangedHandler
(DateChangedHandler handler) Add a dateChanged handler.Add a dayBodyClick handler.Add a dayHeaderClick handler.Add acom.smartgwt.client.widgets.DragCompleteHandler
.Add acom.smartgwt.client.widgets.DropCompleteHandler
.void
Create a new event in this calendar instance.void
Create a new event in this calendar instance.addEventAddedHandler
(EventAddedHandler handler) Add a eventAdded handler.Add a eventChanged handler.addEventClickHandler
(EventClickHandler handler) Add a eventClick handler.Add a eventRemoveClick handler.Add a eventRemoved handler.Add a eventRepositionMove handler.Add a eventRepositionStop handler.Add a eventResizeMove handler.Add a eventResizeStop handler.Add a eventSaveError handler.Add a eventsRendered handler.addFetchDataHandler
(FetchDataHandler handler) Add a fetchData handler.void
Convenience method to display a {@link com.smartgwt.client..FormulaBuilder} to create a new Formula Field.void
addIndicator
(CalendarEvent indicator) Adds a newindicator
to the calendar.Add a indicatorClick handler.void
Adds a newLane
to the calendar, for display in thetimeline view
, and in theday view
ifshowDayLanes
is true.void
addLaneEvent
(Lane laneName, Date startDate) Deprecated.void
addLaneEvent
(Lane laneName, Date startDate, Date endDate) void
addLaneEvent
(Lane laneName, Date startDate, Date endDate, String name) void
void
addLaneEvent
(Lane laneName, Date startDate, Date endDate, String name, String description, Object otherFields) Deprecated.in favor ofaddCalendarEvent()
void
Convenience method to display a {@link com.smartgwt.client..SummaryBuilder} to create a new Summary Field.void
addZone
(CalendarEvent zone) Adds a newzone
to the calendar.addZoneClickHandler
(ZoneClickHandler handler) Add a zoneClick handler.Whether at least one item is selected
static boolean
Static method indicating whether the optional Calendar module is loaded for the page.void
Cancels the current edit-session, closing the builtin eventdialog
oreditor
and clearing any visible edit-selection from thecurrent CalendarView
.static void
changeAutoChildDefaults
(String autoChildName, Canvas defaults) Changes the defaults for Canvas AutoChildren namedautoChildName
.static void
changeAutoChildDefaults
(String autoChildName, FormItem defaults) Changes the defaults for FormItem AutoChildren namedautoChildName
.protected JavaScriptObject
create()
Called fromEventCanvas.setEvent()
whenshowEventCanvasComponents
is true and an eventCanvas needs a component.boolean
dateIsWorkday
(Date date) boolean
dateIsWorkday
(Date date, String laneName) Should the parameter date be considered a workday? By default this method tries to find the parameter date day inworkdays
, and returns true if found.void

 Deselect all records

deselectEvent
(CalendarEvent event) Removes an event from the list of selected events in the current view, clearing its selected style.deselectEvents
(CalendarEvent... events) Removes one or more events from the list of selected events in the current view, clearing their selected styles.void
deselectRecord
(int record) Deselect aRecord
passed in explicitly, or by index.void
deselectRecord
(Record record) Deselect aRecord
passed in explicitly, or by index.void
deselectRecords
(int[] records) Deselect a list ofRecord
s passed in explicitly, or by index.void
deselectRecords
(Record[] records) Deselect a list ofRecord
s passed in explicitly, or by index.void
disableHilite
(String hiliteID) Disable a hilite

void
Disable all hilites.

void
Shows a FieldPicker interface allowing end-users to rearrange the order and visibiility of the fields in the associated DataBoundComponent.void
Shows a HiliteEditor interface allowing end-users to edit the data-hilites currently in use by this DataBoundComponent.void
enableHilite
(String hiliteID) Enable / disable ahilites


void
enableHilite
(String hiliteID, boolean enable) Enable / disable ahilites


void
Enable all hilites.

void
enableHiliting
(boolean enable) Enable all hilites.

boolean
eventMoved
(Date newDate, CalendarEvent event, String newLane) Deprecated.in favor ofCalendar.eventRepositionStop()
Notification fired when a user drags an EventCanvas.boolean
eventResized
(Date newDate, CalendarEvent event) Deprecated.in favor ofCalendar.eventResizeStop()
void
void
exportData
(DSRequest requestProperties) void
exportData
(DSRequest requestProperties, RPCCallback callback) Uses a "fetch" operation on the currentDataSource
to retrieve data that matches the current filter and sort criteria for this component, then exports the resulting data to a file or window in the requested format.void
Retrieves data from the DataSource that matches the specified criteria.void
Retrieves data from the DataSource that matches the specified criteria.void
fetchData
(Criteria criteria, DSCallback callback) Retrieves data from the DataSource that matches the specified criteria.void
fetchData
(Criteria criteria, DSCallback callback, DSRequest requestProperties) Retrieves data from the DataSource that matches the specified criteria.void
Retrieves data that matches the provided criteria and displays the matching data in this component.void
filterData
(Criteria criteria) Retrieves data that matches the provided criteria and displays the matching data in this component.void
filterData
(Criteria criteria, DSCallback callback) Retrieves data that matches the provided criteria and displays the matching data in this component.void
filterData
(Criteria criteria, DSCallback callback, DSRequest requestProperties) Retrieves data that matches the provided criteria and displays the matching data in this component.find
(AdvancedCriteria adCriteria) Filters all objects according to the AdvancedCriteria passed and returns the first matching object or null if not foundRecord[]
findAll
(AdvancedCriteria adCriteria) Filters all objects according to the AdvancedCriteria passedint
findIndex
(AdvancedCriteria adCriteria) Finds the index of the first Record that matches with the AdvacendCriteria passed.int
findNextIndex
(int startIndex, AdvancedCriteria adCriteria) LikeRecordList.findIndex(java.util.Map)
, but considering the startIndex parameter.int
findNextIndex
(int startIndex, AdvancedCriteria adCriteria, int endIndex) LikeRecordList.findIndex(java.util.Map)
, but considering the startIndex and endIndex parameters.Gets the day of the week (0-6) that the mouse is currently over.Gets a date object representing the date over which the mouse is hovering for the current selected view.Indicates whether to add "drop values" to items dropped on this component, if both the source and target widgets are databound, either to the same DataSource or to different DataSources that are related via a foreign key.The text to be displayed when a user hovers over theadd event
toolbar buttonText for a menu item allowing users to add a formula fieldoperationId
this component should use when performing add operations.Text for a menu item allowing users to add a formula fieldWhen set to true, allows events to be managed by duration, as well as by end date.When showing aTimeline
, or aday view
whenshowDayLanes
is true, whether to make lane boundaries more obvious by showing alternate lanes in a different color.By default, EventCanvases show their content in hovers.IfDataBoundComponent.setAutoFetchData(Boolean)
is true, this attribute determines whether the initial fetch operation should be performed viaDataBoundComponent.fetchData()
orDataBoundComponent.filterData()
If true, when this component is first drawn, automatically callDataBoundComponent.fetchData()
orDataBoundComponent.filterData()
depending onDataBoundComponent.getAutoFetchAsFilter()
.IfautoFetchData
istrue
, this attribute allows the developer to specify a textMatchStyle for the initialDataBoundComponent.fetchData()
call.The icon to show in themonth-button
on Handsets when themonth view
is the current visible view.The title of themonth
on Handsets when themonth view
is the current visible view.The base name for the CSS class applied to the grid cells of the day and week views of the calendar.If set to true, clicking an event will bring it to the front of the zorder.The base name for the CSS class applied to the links rendered bygetDayBodyHTML()
.Adds an item to the header context menu allowing users to launch a dialog to define a new
 field based on values present in other fields, using the {@link com.smartgwt.client..FormulaBuilder}.
Adds an item to the header context menu allowing users to launch a dialog to define a new
 text field that can contain both user-defined text and the formatted values present in other 
 fields, using the {@link com.smartgwt.client..SummaryBuilder}.
Ancom.smartgwt.client.types.AutoChild
of typeIButton
, used to cancel editing of an event and close theeventEditor
.The title for theCancel button
in theevent editor
.If true, users can create new events.WhenshowOtherDays
is true, determines whether clicking in a Month-view body-cell that represents a date outside the selected month will open theevent-editor window
at the cell's location.Deprecated.in favor ofcanRemoveEvents
A boolean value controlling whether new events of varying length can be created by dragging the cursor.Name of the field on eachCalendarEvent
that determines whether anEventCanvas
can be moved or resized by dragging with the mouse.A boolean value controlling whether users can drag-reposition events.If true, users can edit existing events.Name of the field on eachCalendarEvent
that determines whether it can be edited in theevent editor
.Can events be moved between lanes? If so, the event can be dragged to a differentlane
, and the eventquick dialog
andeditor
allow a lane to be selected with a drop-down chooser.Name of the field on eachCalendarEvent
that determines whether that event can be moved between lanes.Can events be moved between sublanes?Name of the field on eachCalendarEvent
that determines whether that event can be moved between individualsublanes
in aLane
.If true, allows the lanes in a Timeline to be grouped by providing a value forlaneGroupByField
.If true, users can remove existing events.Name of the field on eachCalendarEvent
that determines whether an event shows a remove button.If true, lanes can be reordered by dragging theirlaneFields
with the mouse.Name of the field on eachCalendarEvent
that determines whether an event can be resized by dragging.Canevents
be resized by dragging appropriate edges of thecanvas
? Only has an effect when bothcanEditEvents
andcanDragEvents
are true.Deprecated.in favor ofcanResizeEvents
;When set to true, makes individualevent canvases
selectable.Return the Date instance associated with the passed co-ordinates in the passed or selected view.getCellDate
(Integer rowNum) getCellDate
(Integer rowNum, Integer colNum) getCellDate
(Integer rowNum, Integer colNum, CalendarView view) Return the Date instance associated with the passed co-ordinates in the passed or selected view.getCellHoverHTML
(CalendarView view, Record record, Integer rowNum, Integer colNum, Date date, String defaultValue) Returns the hover HTML for the cell at the passed co-ordinates in the passed view.The date for which events are displayed in the day, week, and month tabs of the calendar.Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists.When using the Next and Previous arrows to scroll a Timeline, this is the number of columns of thetimelineGranularity
to scroll by.A CSS style to apply to icons in thecontrolsBar
.The size of the various icons displayed in thecontrolsBar
of this Calendar.AnHLayout
shown above the Calendar views and displaying a set of controls for interacting with the current view - namely, thenext
,previous
andadd
buttons, thedate label
and thedate-picker
icon.Default height of thecontrolsBar
shown above the main Calendar grid.The name of the view that should be visible initially by default.getData()
A List of CalendarEvent objects, specifying the data to be used to populate the calendar.How to fetch and manage records retrieve from the server.int
When usingdata paging
, how many records to fetch at a time.The DataSource that this component should bind to for default fields and for performingDataSource requests
.getDateCellAlign
(Date date, Integer rowNum, Integer colNum, CalendarView view) WhengetDateHTML
returns a value, this method returns the horizontal alignment for that value in its cell, in the passed view.getDateCellVAlign
(Date date, Integer rowNum, Integer colNum, CalendarView view) WhengetDateHTML
returns a value, this method returns the vertical alignment for that value in its cell, in the passed view.DateChooser
used to select the date for which events will be displayed.getDateCSSText
(Date date, Integer rowNum, Integer colNum, CalendarView view) Return CSS text for styling the cell associated with the passed date and/or rowNum & colNum, which will be applied in addition to the CSS class for the cell, as overrides.Indicates the type of controls to use in event-windows.Date formatter for displaying events.Returns a Date instance representing the point at the passed offsets into the body of the current view.getDateFromPoint
(Integer x, Integer y) getDateFromPoint
(Integer x, Integer y, Boolean snapOffsets) getDateFromPoint
(Integer x, Integer y, Boolean snapOffsets, CalendarView view) Returns a Date instance representing the point at the passed offsets into the body of the current view.getDateHeaderTitle
(Date date, int dayOfWeek, String defaultValue, CalendarView view) Return the title text to display in the header-button of the ListGridField showing the passed date, in the passed view.getDateHTML
(Date date, Integer rowNum, Integer colNum, CalendarView view) Return the HTML to be displayed in the associated date-cell in the passed view.Thecom.smartgwt.client.types.AutoChild
Label
used to display the current date or range above the selected calendar view.getDateLabelText
(String viewName, Date startDate, Date endDate) Returns the text to display with the navigation buttons above the Calendar - indicates the visible date range.AnImgButton
that appears above the various views of the calendar and offers alternative access to aDateChooser
to pick the current day.The text to be displayed when a user hovers over thedate picker
toolbar buttongetDateStyle
(Date date, Integer rowNum, Integer colNum, CalendarView view) Return the CSS styleName for the associated date-cell in the passed view.The base name for the CSS class applied to the day body of the month view of the calendar.protected String
getDayBodyHTML
(Date date, CalendarEvent[] events, Calendar calendar, int rowNum, int colNum) Return the HTML to be shown in the body of a day in the month view.The base name for the CSS class applied to the day headers of the month view.CalendarView
used to display events that pertain to a given day.The title for theday view
.Before we start editing values in this DataBoundComponent, should we perform a deep clone of the underlying values.int
The number of columns of thetimelineGranularity
to give the timeline by default if noendDate
is provided.The name of the description field on aCalendarEvent
.The title for the edit button in the quickquick event dialog
.If true, weekend days appear in a disabled style and events cannot be created on weekends.Record[]
During a drag-and-drop interaction, this method returns the set of records being dragged out of the component.Indicates what to do with data dragged into another DataBoundComponent.getDragHoverHTML
(CalendarView view, CalendarEvent event, String defaultValue) Returns the HTML to show in a hover when an existing event is dragged, or when a new event is being created by dragging with the mouse.CSS Style to apply to the drag tracker when dragging occurs on this component.When an item is dropped on this component, andaddDropValues
is true and both the source and target widgets are databound, either to the same DataSource or to different DataSources that are related via a foreign key, this object provides the "drop values" that Smart GWT will apply to the dropped object before updating it.Message to show when a user attempts to transfer duplicate records into this component, and
preventDuplicates
is enabled.The name of theduration
field on aCalendarEvent
.The name of thedurationUnit
field on aCalendarEvent
.Text for a menu item allowing users to edit a formula fieldText for a menu item allowing users to edit the formatter for a fieldThe end date of the calendar timeline view.The name of the end date field on aCalendarEvent
.If set to true, enables the auto-arrangement of events that share time in the calendar.getEventBodyHTML
(CalendarEvent event) Returns the description text for the passed event, for display in the body area of an event canvas.getEventBodyHTML
(CalendarEvent event, CalendarView view) Returns the description text for the passed event, for display in the body area of an event canvas.Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists.The close button that snaps to the top-right of an event canvas on rollover and allows an event to be removed from aCalendarView
.The size of theclose-button
that snaps to the top-right of an event canvas on rollover and shows allows an event to be removed from aCalendarView
.The size of the icon in theclose-button
floated over events on rollover.Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists.The context button that snaps to the top-right of an event canvas on rollover and shows a customcontext menu
when clicked.Context menu displayed when anevent canvas
is right-clicked, or when the rollovercontext button
is clicked.Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists.Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists.Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists.getEventCanvasStyle
(CalendarEvent event) getEventCanvasStyle
(CalendarEvent event, CalendarView view) Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists.Ancom.smartgwt.client.types.AutoChild
of typeWindow
that displays a quick event entry form in a popup window.The number of pixels to leave to the right of events so overlapping events can still be added using the mouse.Ancom.smartgwt.client.types.AutoChild
of typeHLayout
which houses theSave
,Remove
andCancel
buttons in theeventEditor
.Object[]
The list of buttons to include in theeventEditor
.The title for the Date-field in theeventEditor
that allows for changing the logical start-date of an event, along with its start and end times, when editing events in theday
andweek
views.getEventEndDate
(CalendarEvent event) Returns theend date
of the passed event.int
WheneventHeaderWrap
is false andshowEventDescriptions
is true, this is the fixed height for theheader area
in event canvases.getEventHeaderHTML
(CalendarEvent event) Returns the title text for the passed event, which is displayed in the header area of an eventCanvas rendered in a vertical or horizontal view, or as a clickable link in a cell in aMonth view
.getEventHeaderHTML
(CalendarEvent event, CalendarView view) Returns the title text for the passed event, which is displayed in the header area of an eventCanvas rendered in a vertical or horizontal view, or as a clickable link in a cell in aMonth view
.boolean
When rendering thecanvas
for an event, whether to allow the content of theheader area
to wrap to multiple lines.getEventHoverHTML
(CalendarEvent event, EventCanvas eventCanvas, CalendarView view) Gets the hover HTML for an event being hovered over.getEventHoverHTML
(CalendarEvent event, EventCanvas eventCanvas, CalendarView view, String defaultValue) Gets the hover HTML for an event being hovered over.getEventLane
(CalendarEvent event) Returns thelane
associated with the passed event, in the passed viewgetEventLane
(CalendarEvent event, CalendarView view) Returns thelane
associated with the passed event, in the passed viewvoid
getEventLength
(CalendarEvent event) void
getEventLength
(CalendarEvent event, TimeUnit unit) WheneventAutoArrange
is true, setting eventOverlap to true causes events that share timeslots to overlap each other by a percentage of their width, specified byeventOverlapPercent
.When set to true, events that start at the same time will not overlap each other to prevent events having their close button hidden.int
The size of the overlap, presented as a percentage of the width of events sharing timeslots.Screen to create (viacreateScreen()
) in lieu of callingcreateEventCanvasComponent()
.The number of minutes that determines the positions to which events will snap when rendered, and when moved or resized with the mouse.getEventStartDate
(CalendarEvent event) Returns thestart date
of the passed event.The base name for the CSS class applied toevents
when they're rendered in calendar views.The name of the field used to overrideeventStyleName
for an individualCalendarEvent.styleName
.getEventSublane
(CalendarEvent event) Returns thesublane
associated with the passed event, in the passed viewgetEventSublane
(CalendarEvent event, CalendarView view) Returns thesublane
associated with the passed event, in the passed viewDeprecated.in favor ofeventStyleName
Deprecated.in favor ofeventStyleNameField
Setting exportAll to true prevents the component from passing its list of fields to the 
 export call.String[]
The list of field-names to export.If Summary rows exist for this component, whether to include them when exporting client data.Operation ID this component should use when performing fetch operations.Returna an array of field alignments for this gridint
Return the number of fields.Return the fields as JavaScriptObjects rather than as SmartGWT Java wrappers of the field class type (e.g.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 popupDateChooser
.getHeaderHoverHTML
(CalendarView view, HeaderLevel headerLevel, Date startDate, Date endDate, String defaultValue) Returns the hover HTML to show in a hover when the mouse moves over the header area.Configures the levels ofheaders
shown above the event area, and their time units.When set to true, hides anylane
that doesn't have any active events in the current dataset.Marker that can be set on a record to flag that record as hilited.Hilite[]
Return the set of hilite-objects currently applied to this DataBoundComponent.Get the current hilites encoded as a String, for saving.Criteria that are never shown to or edited by the user and are cumulative with any criteria provided viaDataBoundComponent.initialCriteria
,DataBoundComponent.setCriteria()
etc.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.Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists.getIndicatorCanvasStyle
(CalendarEvent indicator) getIndicatorCanvasStyle
(CalendarEvent indicator, CalendarView view) getIndicatorHoverHTML
(CalendarEvent indicator, IndicatorCanvas indicatorCanvas, CalendarView view, String defaultValue) Gets the hover HTML for anindicator
being hovered over.An array of CalendarEvent instances representing instants in time, to be highlighted intimeline views
.Criteria to use whenDataBoundComponent.setAutoFetchData(Boolean)
is used.The message to display in theeventEditor
when the 'To' date is greater than the 'From' date and a save is attempted.Returns thelane
with the passed name, in the passed viewgetLane
(String lane, CalendarView view) Returns thelane
with the passed name, in the passed viewgetLaneEvents
(Lane lane) For views that supportlanes
, returns the array of events in the current dataset that apply to the passed lane in the passed or current view.getLaneEvents
(Lane lane, CalendarView view) For views that supportlanes
, returns the array of events in the current dataset that apply to the passed lane in the passed or current view.getLaneEvents
(String lane) For views that supportlanes
, returns the array of events in the current dataset that apply to the passed lane in the passed or current view.Field definitions for the frozen area of thetimelineView
, which shows data about the timelinelanes
.Returns theLane
at the passed co-ordinates.getLaneFromPoint
(Integer x, Integer y) getLaneFromPoint
(Integer x, Integer y, CalendarView view) Returns theLane
at the passed co-ordinates.For timelines withcanGroupLanes
set to true, this is a field name or array of field names on which to group the lanes in a timeline.String[]
Deprecated.in favor ofgetLaneGroupByFieldAsStringArray()
.String[]
For timelines withcanGroupLanes
set to true, this is a field name or array of field names on which to group the lanes in a timeline.The name of the field which will determine thelane
in which a given event will be displayed inTimeline
s and in theday view
, ifshowDayLanes
is true.For views that supportlanes
, returns the padding to apply to events rendered in lanes in the passed or current view.getLanePadding
(CalendarView view) For views that supportlanes
, returns the padding to apply to events rendered in lanes in the passed or current view.Lane[]
getLanes()
An array ofLane
definitions that represent the rows of thetimelineView
, or the columns of thedayView
ifshowDayLanes
is true.The name of the leading date field for each event.WhenshowWorkday
is true, this attribute prevents the user from scrolling vertical views beyond the specified workdaystart
andend
hours.Getter implementing theLogicalStructure
interface, which supports Eclipse's logical structure debugging facility.boolean
A boolean value controlling whether the Calendar shows tabs for available calendar views.In themonth view
whenshowDayHeaders
is true, this is the minimum height applied to a day cell and its header combined.When showingvertical lanes
in thedayView
, this attribute sets the minimum width of each column or field.int
The minimum height of time-rows in vertical calendar views.ANavigationButton
that appears to the left of other navigation controls in thecontrols bar
on Handset devices.The icon to show next to the month-name in themonth button
, used for showing and hiding themonth view
on Handsets.The title of themonth button
, used for showing and hiding themonth view
on Handsets.The title of the link shown in a cell of amonth view
when there are too many events to be displayed at once.AutoChild Menu, shown when a user clicks themore events
link in a cell of themonthView
.CalendarView
used to display events that pertain to a given month.getMonthViewHoverHTML
(Date date, CalendarEvent... events) This method returns the hover HTML to be displayed when the user hovers over a cell displayed in the calendar month view tab.The title for themonth view
.The name of the name field on aCalendarEvent
.The title-text displayed in the popup event dialog/editor for new events.AnImgButton
that appears above the week/day/month views of the calendar and allows the user to move the calendar forwards in time.The text to be displayed when a user hovers over thenext
toolbar buttonstatic Calendar
getOrCreateRef
(JavaScriptObject jsObj) The CSS style applied to both the header and body of days from other months in themonth view
, whenshowOtherDays
is false.The base name for the CSS class applied to the day body of the month view of the calendar.WhenshowOtherDays
is true, this attribute determines whether the month-view should change month when cells representing days in the previous or following month are clicked.The base name for the CSS class applied to the day headers of the month view.A set ofsort-specifiers
for customizing the render order of events that overlap.Returns the end of the period selected in the passed, or current, calendar view.getPeriodEndDate
(CalendarView view) Returns the end of the period selected in the passed, or current, calendar view.Returns the start of the selected week or month depending on the current calendar view.Returns the start of the selected week or month depending on the current calendar view.If set, detect and prevent duplicate records from being transferred to this component, either via
 drag and drop or viaDataBoundComponent.transferSelectedData(com.smartgwt.client.widgets.DataBoundComponent)
.AnImgButton
that appears above the week/day/month views of the calendar and allows the user to move the calendar backwards in time.The text to be displayed when a user hovers over theprevious
toolbar button.Indicates whether or not this component will load its dataprogressively
int
getRecordIndex
(Record record) Get the index of the provided record.
Return the underlying data of this DataBoundComponent as aRecordList
.Ancom.smartgwt.client.types.AutoChild
of typeIButton
, used to permanently remove an event from theeventEditor
.The title for theRemove button
in theevent editor
.operationId
this component should use when performing remove operations.boolean
When set to true, the default, eachevent
is rendered as it appears in the viewport.Return the underlying data of this DataBoundComponent as aResultSet
.int
The height of time-slots in the calendar.Optional identifier for saved searches that should be applied to this component.If set, andshowWorkday
is true, automatically scrolls theday
andweek
views to the start of theworkday
when the calendar is first displayed and whenever the user changes to a different day or week.When true, shows the currentchosenDate
in a selected style in themonth view
.The base name for the CSS class applied to a cell that is selected via a mouse drag.Returns the currently selectedevent
, or the first one if more than one is selected.Returns the currently selected list ofevents
.Returns the currently selectedview
.Set to false to hide theAdd Event
button.WhenshowViewHovers
is true, dictates whether to display hover prompts when the mouse rolls over the normal cells in the body of CalendarViews.When true, causeslayouts
to be added to each column in vertical views.Whether to show fields of non-atomic types when a DataBoundComponent is given a
 DataSource but nocomponent.fields
.
If false the controls bar at the top of the calendar will not be displayed - this means that thecontrolsBar
will be hidden, so the autoChildren (previousButton
,dateLabel
,nextButton
,addEventButton
, anddatePickerButton
) will not be created or shown.Determines whether thedateChooser
is displayed.Set to false to hide thedatePickerButton
that allows selecting a new base date for this Calendar.If true, the default, show a header cell for each day cell in themonth view
, with both cells having a minimum combined height ofminimumDayHeight
.Whether to show the Day view.Whether to show fields markeddetail:true
when a DataBoundComponent is given a DataSource but nocomponent.fields
.WhenshowViewHovers
is true, dictates whether to display hover prompts when an event is being dragged with the mouse.boolean
Whetherevent-canvases
should show a custom widget as content, rather than the defaultheader
andbody
HTML.boolean
When rendering thecanvas
for an event, whether to show thebody area
, typically containing brief details of the event -by default
,its description
.boolean
When rendering thecanvas
for an event, whether to show theheader area
, typically containing suitable title text -by default
, the event'sname
.WhenshowViewHovers
is true, dictates whether to display hover prompts when the mouse moves over anevent canvas
in a calendarView.WhenshowViewHovers
is true, dictates whether to display hover prompts when the mouse rolls over theheader levels
in aCalendarView
.Whether to show fields markedhidden:true
when a DataBoundComponent is given a
 DataSource but nocomponent.fields
.
Set to true to render any definedindicators
intotimeline views
.boolean
Inindicator lines
are showing, this attribute affects where in the z-order their canvases will be rendered: either in front of, or behind normal calendar events.boolean
When set to false, hides the frozen Label-Column in verticalCalendarView
s.WhenshowViewHovers
is true, dictates whether to display hover prompts when the mouse moves over the cells in alaneField
.When set to true, causesTimelines
to highlight the Lane under the mouse with the "Over" style.Set to false to prevent theMonth
button from displaying on Handset devices.Whether to show the Month view.Set to false to hide theNext
button.If set to true, in themonth view
, days that fall in an adjacent month are still shown with a header and body area, and are interactive.Set to false to hide thePrevious
button.Determines whether the quick event dialog is displayed when a time is clicked.boolean
Whether to associate saved searches by default with the currentDataSource
of a component when asavedSearchId
is not provided.If set to true, show theTimeline view
.When set to true, the default value, causes the Calendar to show customizable hovers when the mouse moves over various areas of a CalendarView.Whether to show the Week view.When set to true, this setting enables various features related to cells that fall within the workday (as defined byworkdayStart
andworkdayEnd
) in vertical calendar views (day
andweek
).WhenshowViewHovers
is true, dictates whether to display hover prompts when the mouse moves over azone
in a calendarView.Set to true to render any definedzones
intotimeline views
.If true, events will be sized to the grid, even if they start and/or end at times between grid cells.WhenshowWorkday
is true, attempt to resize rows in the day and week views so that theworkday hours
fill the visible viewport-height, and the whole workday is visible without scrolling.getSort()
Returns the currentSortSpecifiers
for this component.If true,ListGrid.getFieldState()
andListGrid.setFieldState(java.lang.String)
will omit state information for hidden fields by default.The start date of the calendartimeline view
.The name of the start date field on aCalendarEvent
.WhenshowWorkday
is true, applies theworkdayBaseStyle
to cells that fall within the workday (as defined byworkdayStart
andworkdayEnd
), in both thedayView
andweekView
.getSublane
(String lane, String sublane) getSublane
(String lane, String sublane, CalendarView view) getSublaneEvents
(Lane lane, Lane sublane) getSublaneEvents
(Lane lane, Lane sublane, CalendarView view) Returns thesublane
at the passed co-ordinates.getSublaneFromPoint
(Integer x, Integer y, CalendarView view) Returns thesublane
at the passed co-ordinates.The name of the field which will determine thesublane
in which this event will be displayed, within its parent Lane, inTimeline
s and in theday view
, ifshowDayLanes
is true.Display format to use for the time portion of events' date information.The granularity in which thetimelineView
will display events.int
How many units oftimelineGranularity
each cell represents.CalendarView
used to display events in lanes in a horizontalTimeline
view.The title for thetimeline view
.Method to return the fieldName which represents the "title" for records in this
 Component.

 If this.titleField is explicitly specified it will always be used.
 Otherwise, default implementation will checktitleField
for databound
 components.

 For non databound components returns the first defined field name of"title"
, 
"name"
, or"id"
.getTitleFieldValue
(Record record) Get the value of the titleField for the passed record
The background color for cells that represent today in allCalendarView
s.The name of the trailing date field for each event.Dictates whether times throughout the widget are formatted and edited as 24-hour values.operationId
this component should use when performing update operations.If true, the set of fields given by the "default binding" (see 
fields
) is used, with any fields specified in
component.fields
acting as overrides that can suppress or modify the
 display of individual fields, without having to list the entire set of fields that
 should be shown.
boolean
By default, theclose buttons
and thehorizontal
andvertical
resizer widgets for event canvases are shown only when the mouse is over a given event.TheuseFlatFields
flag causes all simple type fields anywhere in a nested
 set of DataSources to be exposed as a flat list for form binding.Returns the last visible date in the passed, or currently selected, calendar view.Returns the last visible date in the passed, or currently selected, calendar view.Returns the first visible date in the passed, or currently selected, calendar view.Returns the first visible date in the passed, or currently selected, calendar view.int[]
An array of integer day-numbers that should be considered to be weekend days by this Calendar instance.Augments the width of week event windows slightly to avoid duplicate adjacent borders between events.The text to appear before the week number in the title ofweek-based
HeaderLevel
s when this calendar is showing a timeline.CalendarView
used to display events that pertain to a given week.The title for theweek view
.IfshowWorkday
is set, this is the style used for cells that are within the workday, as defined byworkdayStart
andworkdayEnd
, or by a date-specific range provided ingetWorkdayStart()
andgetWorkdayEnd()
implementations.getWorkdayEnd
(Date date) getWorkdayEnd
(Date date, String laneName) When usingshowWorkday
:true,workdayStart
andworkdayEnd
specify the time of day when the workday starts and ends, specified as a String acceptable to String.getWorkdayStart
(Date date) getWorkdayStart
(Date date, String laneName) When usingshowWorkday
:true,workdayStart
andworkdayEnd
specify the time of day when the workday starts and ends, specified as a String acceptable to String.Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists.getZoneCanvasStyle
(CalendarEvent zone, CalendarView view) getZoneHoverHTML
(CalendarEvent zone, ZoneCanvas zoneCanvas, CalendarView view, String defaultValue) Gets the hover HTML for azone
being hovered over.getZones()
An array of CalendarEvent instances representing pre-defined periods of time to be highlighted intimeline views
.The vertical alignment of the header-text in eachzone
.void
groupLanesBy
(String groupFieldName) WhencanGroupLanes
is true, this method allows the grouping intimeline
s to be altered at runtime.void
groupLanesBy
(String... groupFieldName) WhencanGroupLanes
is true, this method allows the grouping intimeline
s to be altered at runtime.void
Invalidate the current data cache for this databound component via a call to the dataset'sinvalidateCache()
method, for example,ResultSet.invalidateCache()
.void
moveToEvent
(CalendarEvent event) Deprecated.in favor ofscrollToEvent()
.void
next()
Move to the next day, week, or month, depending on which tab is selected.protected void
onInit()
protected void
void
previous()
Move to the previous day, week, month, or timeline range depending on which tab is selected.void
refreshEvent
(CalendarEvent event) Refreshes the passed event in the current view.void
removeEvent
(CalendarEvent event) Remove an event from this calendar.void
removeIndicator
(CalendarEvent indicator) Removes aindicator
from the calendar.void
removeIndicator
(String indicator) Removes aindicator
from the calendar.void
removeLane
(Lane lane) Removes a lane from the calendar intimelineView
mode.void
removeLane
(String laneName) Removes a lane from the calendar intimelineView
mode.void
removeZone
(CalendarEvent zone) Removes azone
from the calendar.void
removeZone
(String zone) Removes azone
from the calendar.void
Move the viewport of a CalendarView to the end of its scrollable range.void
scrollToEnd
(CalendarView view) Move the viewport of a CalendarView to the end of its scrollable range.void
scrollToEvent
(CalendarEvent event) Scrolls thecurrent view
so the passed event is visible.void
scrollToEvent
(CalendarEvent event, boolean canReload) Scrolls thecurrent view
so the passed event is visible.void
Move the viewport of a CalendarView to the start of it's scrollable range.void
scrollToStart
(CalendarView view) Move the viewport of a CalendarView to the start of it's scrollable range.void
scrollToTime
(String time) void
Select all records

selectEvent
(CalendarEvent event) Adds an event to the list of selected events in the current view, showing it in a selected style.selectEvents
(CalendarEvent... events) Adds one or more events to the list of selected events in the current view, showing them in a selected style.void
selectRecord
(int record) Select/deselect aRecord
passed in explicitly, or by index.void
selectRecord
(int record, boolean newState) Select/deselect aRecord
passed in explicitly, or by index.void
selectRecord
(Record record) Select/deselect aRecord
passed in explicitly, or by index.void
selectRecord
(Record record, boolean newState) Select/deselect aRecord
passed in explicitly, or by index.void
selectRecords
(int[] records) Select/deselect a list ofRecord
s passed in explicitly, or by index.void
selectRecords
(int[] records, boolean newState) Select/deselect a list ofRecord
s passed in explicitly, or by index.void
selectRecords
(Record[] records) Select/deselect a list ofRecord
s passed in explicitly, or by index.void
selectRecords
(Record[] records, boolean newState) Select/deselect a list ofRecord
s passed in explicitly, or by index.selectSingleEvent
(CalendarEvent event) Selects a single event in the current view, showing it in a selected style and deselecting any other selected events.void
selectTab
(int tabnum) Selects the calendar view in the passed tab number.setAddDropValues
(Boolean addDropValues) Indicates whether to add "drop values" to items dropped on this component, if both the source and target widgets are databound, either to the same DataSource or to different DataSources that are related via a foreign key.setAddEventButtonHoverText
(String addEventButtonHoverText) The text to be displayed when a user hovers over theadd event
toolbar buttonsetAddFormulaFieldText
(String addFormulaFieldText) Text for a menu item allowing users to add a formula fieldsetAddOperation
(String addOperation) operationId
this component should use when performing add operations.setAddSummaryFieldText
(String addSummaryFieldText) Text for a menu item allowing users to add a formula fieldsetAllowDurationEvents
(Boolean allowDurationEvents) When set to true, allows events to be managed by duration, as well as by end date.setAlternateLaneStyles
(Boolean alternateLaneStyles) When showing aTimeline
, or aday view
whenshowDayLanes
is true, whether to make lane boundaries more obvious by showing alternate lanes in a different color.setAlwaysShowEventHovers
(Boolean alwaysShowEventHovers) By default, EventCanvases show their content in hovers.setAutoFetchAsFilter
(Boolean autoFetchAsFilter) IfDataBoundComponent.setAutoFetchData(Boolean)
is true, this attribute determines whether the initial fetch operation should be performed viaDataBoundComponent.fetchData()
orDataBoundComponent.filterData()
setAutoFetchData
(Boolean autoFetchData) If true, when this component is first drawn, automatically callDataBoundComponent.fetchData()
orDataBoundComponent.filterData()
depending onDataBoundComponent.getAutoFetchAsFilter()
.setAutoFetchTextMatchStyle
(TextMatchStyle autoFetchTextMatchStyle) IfautoFetchData
istrue
, this attribute allows the developer to specify a textMatchStyle for the initialDataBoundComponent.fetchData()
call.setBackButtonIconSrc
(String backButtonIconSrc) The icon to show in themonth-button
on Handsets when themonth view
is the current visible view.setBackButtonTitle
(String backButtonTitle) The title of themonth
on Handsets when themonth view
is the current visible view.setBaseStyle
(String baseStyle) The base name for the CSS class applied to the grid cells of the day and week views of the calendar.setBringEventsToFront
(Boolean bringEventsToFront) If set to true, clicking an event will bring it to the front of the zorder.setCalMonthEventLinkStyle
(String calMonthEventLinkStyle) The base name for the CSS class applied to the links rendered bygetDayBodyHTML()
.setCanAddFormulaFields
(Boolean canAddFormulaFields) Adds an item to the header context menu allowing users to launch a dialog to define a new
 field based on values present in other fields, using the {@link com.smartgwt.client..FormulaBuilder}.
setCanAddSummaryFields
(Boolean canAddSummaryFields) Adds an item to the header context menu allowing users to launch a dialog to define a new
 text field that can contain both user-defined text and the formatted values present in other 
 fields, using the {@link com.smartgwt.client..SummaryBuilder}.
setCancelButtonTitle
(String cancelButtonTitle) The title for theCancel button
in theevent editor
.setCanCreateEvents
(Boolean canCreateEvents) If true, users can create new events.setCanCreateOtherDayEvents
(Boolean canCreateOtherDayEvents) WhenshowOtherDays
is true, determines whether clicking in a Month-view body-cell that represents a date outside the selected month will open theevent-editor window
at the cell's location.setCanDeleteEvents
(Boolean canDeleteEvents) Deprecated.in favor ofcanRemoveEvents
setCanDragCreateEvents
(Boolean canDragCreateEvents) A boolean value controlling whether new events of varying length can be created by dragging the cursor.setCanDragEventField
(String canDragEventField) Name of the field on eachCalendarEvent
that determines whether anEventCanvas
can be moved or resized by dragging with the mouse.setCanDragEvents
(Boolean canDragEvents) A boolean value controlling whether users can drag-reposition events.setCanEditEvents
(Boolean canEditEvents) If true, users can edit existing events.setCanEditField
(String canEditField) Name of the field on eachCalendarEvent
that determines whether it can be edited in theevent editor
.setCanEditLane
(Boolean canEditLane) Can events be moved between lanes? If so, the event can be dragged to a differentlane
, and the eventquick dialog
andeditor
allow a lane to be selected with a drop-down chooser.setCanEditLaneField
(String canEditLaneField) Name of the field on eachCalendarEvent
that determines whether that event can be moved between lanes.setCanEditSublane
(Boolean canEditSublane) Can events be moved between sublanes?setCanEditSublaneField
(String canEditSublaneField) Name of the field on eachCalendarEvent
that determines whether that event can be moved between individualsublanes
in aLane
.setCanGroupLanes
(Boolean canGroupLanes) If true, allows the lanes in a Timeline to be grouped by providing a value forlaneGroupByField
.setCanRemoveEvents
(Boolean canRemoveEvents) If true, users can remove existing events.setCanRemoveField
(String canRemoveField) Name of the field on eachCalendarEvent
that determines whether an event shows a remove button.setCanReorderLanes
(Boolean canReorderLanes) If true, lanes can be reordered by dragging theirlaneFields
with the mouse.setCanResizeEventField
(String canResizeEventField) Name of the field on eachCalendarEvent
that determines whether an event can be resized by dragging.setCanResizeEvents
(Boolean canResizeEvents) Canevents
be resized by dragging appropriate edges of thecanvas
? Only has an effect when bothcanEditEvents
andcanDragEvents
are true.setCanResizeTimelineEvents
(Boolean canResizeTimelineEvents) Deprecated.in favor ofcanResizeEvents
;setCanSelectEvents
(Boolean canSelectEvents) When set to true, makes individualevent canvases
selectable.void
setCellHoverCustomizer
(CellHoverCustomizer customizer) Customize the Hover text to display when the mouse hovers over cells in a CalendarViewsetChosenDate
(Date chosenDate) The date for which events are displayed in the day, week, and month tabs of the calendar.setColumnsPerPage
(Integer columnsPerPage) When using the Next and Previous arrows to scroll a Timeline, this is the number of columns of thetimelineGranularity
to scroll by.setControlBarIconBaseStyle
(String controlBarIconBaseStyle) A CSS style to apply to icons in thecontrolsBar
.setControlBarIconSize
(Integer controlBarIconSize) The size of the various icons displayed in thecontrolsBar
of this Calendar.setControlsBarHeight
(Integer controlsBarHeight) Default height of thecontrolsBar
shown above the main Calendar grid.setCurrentViewName
(ViewName currentViewName) The name of the view that should be visible initially by default.void
An array of Record objects, specifying the data to be used to populate the DataBoundComponent.void
setData
(RecordList data) An List of Record objects, specifying the data to be used to populate the DataBoundComponent.setData
(CalendarEvent... data) A List of CalendarEvent objects, specifying the data to be used to populate the calendar.setDataFetchMode
(FetchMode dataFetchMode) How to fetch and manage records retrieve from the server.setDataPageSize
(int dataPageSize) When usingdata paging
, how many records to fetch at a time.setDataSource
(DataSource dataSource) The DataSource that this component should bind to for default fields and for performingDataSource requests
.setDataSource
(String dataSource) The DataSource that this component should bind to for default fields and for performingDataSource requests
.void
setDateCellAlignCustomizer
(DateCellAlignCustomizer customizer) This method installs a customizer that returns the horizontsal Alignment to display in the passed date-cell when rendered in the passed viewvoid
setDateCellVAlignCustomizer
(DateCellVAlignCustomizer customizer) This method installs a customizer that returns the VerticalAlignment to display in the passed date-cell when rendered in the passed viewvoid
setDateCSSTextCustomizer
(DateCSSTextCustomizer customizer) This method returns the CSS class name for the passed event when rendered in the passed viewsetDateEditingStyle
(DateEditingStyle dateEditingStyle) Indicates the type of controls to use in event-windows.setDateFormatter
(DateDisplayFormat dateFormatter) Date formatter for displaying events.void
setDateHeaderCustomizer
(DateHeaderCustomizer customizer) This method installs a customizer to determine the HTML to be displayed in the header for a given date column in a CalendarViewvoid
setDateHTMLCustomizer
(DateHTMLCustomizer customizer) This method installs a customizer that returns the HTML to display in the passed date-cell when rendered in the passed viewsetDatePickerHoverText
(String datePickerHoverText) The text to be displayed when a user hovers over thedate picker
toolbar buttonvoid
setDateStyleCustomizer
(DateStyleCustomizer customizer) This method installs a customizer that returns the CSS class name for the passed date-cell when rendered in the passed viewsetDayBodyBaseStyle
(String dayBodyBaseStyle) The base name for the CSS class applied to the day body of the month view of the calendar.setDayHeaderBaseStyle
(String dayHeaderBaseStyle) The base name for the CSS class applied to the day headers of the month view.setDayViewTitle
(String dayViewTitle) The title for theday view
.setDeepCloneOnEdit
(Boolean deepCloneOnEdit) Before we start editing values in this DataBoundComponent, should we perform a deep clone of the underlying values.static void
setDefaultProperties
(Calendar calendarProperties) Class level method to set the default properties of this class.setDefaultTimelineColumnSpan
(int defaultTimelineColumnSpan) The number of columns of thetimelineGranularity
to give the timeline by default if noendDate
is provided.setDescriptionField
(String descriptionField) The name of the description field on aCalendarEvent
.setDetailsButtonTitle
(String detailsButtonTitle) The title for the edit button in the quickquick event dialog
.void
setDisableDateCustomizer
(DisableDateCustomizer customizer) Return true from the customizer to have the passed event considered disabled in the passed viewsetDisableWeekends
(Boolean disableWeekends) If true, weekend days appear in a disabled style and events cannot be created on weekends.setDragDataAction
(DragDataAction dragDataAction) Indicates what to do with data dragged into another DataBoundComponent.setDragDataCustomizer
(DragDataCustomizer customizer) During a drag-and-drop interaction, this method returns the set of records being dragged out of the component.void
setDragHoverCustomizer
(DragHoverCustomizer customizer) Customize the Hover text to display during a drag operationsetDragTrackerStyle
(String dragTrackerStyle) CSS Style to apply to the drag tracker when dragging occurs on this component.setDropValues
(Map dropValues) When an item is dropped on this component, andaddDropValues
is true and both the source and target widgets are databound, either to the same DataSource or to different DataSources that are related via a foreign key, this object provides the "drop values" that Smart GWT will apply to the dropped object before updating it.setDuplicateDragMessage
(String duplicateDragMessage) Message to show when a user attempts to transfer duplicate records into this component, and
preventDuplicates
is enabled.setDurationField
(String durationField) The name of theduration
field on aCalendarEvent
.setDurationUnitField
(String durationUnitField) The name of thedurationUnit
field on aCalendarEvent
.setEditFormulaFieldText
(String editFormulaFieldText) Text for a menu item allowing users to edit a formula fieldsetEditSummaryFieldText
(String editSummaryFieldText) Text for a menu item allowing users to edit the formatter for a fieldsetEndDate
(Date endDate) The end date of the calendar timeline view.setEndDateField
(String endDateField) The name of the end date field on aCalendarEvent
.setEventAutoArrange
(Boolean eventAutoArrange) If set to true, enables the auto-arrangement of events that share time in the calendar.void
setEventBodyHTMLCustomizer
(EventBodyHTMLCustomizer customizer) This method installs a customizer that returns the HTML to be used as the body/description for the passed event.setEventCanvasCloseButtonSize
(Integer eventCanvasCloseButtonSize) The size of theclose-button
that snaps to the top-right of an event canvas on rollover and shows allows an event to be removed from aCalendarView
.setEventCanvasCloseIconSize
(Integer eventCanvasCloseIconSize) The size of the icon in theclose-button
floated over events on rollover.void
This method sets the customizer for EventCanvasComponent methodsvoid
This method returns the SCImgURL for the icon to use as the gripper for a given EventCanvasvoid
This method returns the hover HTML to be displayed when the user hovers over an eventCanvasvoid
Customizer called whenever the Calender needs to show a context-menu for a given EventCanvassetEventDescriptionFieldTitle
(String eventDescriptionFieldTitle) void
setEventDialogCustomizer
(EventDialogCustomizer customizer) Customizer called whenever the Calender needs to show an EventDialog, to edit or view a CalendarEventvoid
setEventDialogFields
(FormItem... eventDialogFields) The set of fields for theeventDialog
.setEventDragGap
(Integer eventDragGap) The number of pixels to leave to the right of events so overlapping events can still be added using the mouse.setEventDurationFieldTitle
(String eventDurationFieldTitle) setEventDurationUnitFieldTitle
(String eventDurationUnitFieldTitle) setEventEditorButtons
(Object... eventEditorButtons) The list of buttons to include in theeventEditor
.void
setEventEditorCustomizer
(EventEditorCustomizer customizer) Customizer called whenever the Calender needs to show an EventEditor, to edit or create a CalendarEventsetEventEditorDateFieldTitle
(String eventEditorDateFieldTitle) The title for the Date-field in theeventEditor
that allows for changing the logical start-date of an event, along with its start and end times, when editing events in theday
andweek
views.void
setEventEditorFields
(FormItem... eventEditorFields) The set of fields for theeventEditor
.setEventEndDateFieldTitle
(String eventEndDateFieldTitle) setEventHeaderHeight
(int eventHeaderHeight) WheneventHeaderWrap
is false andshowEventDescriptions
is true, this is the fixed height for theheader area
in event canvases.void
This method returns the HTML to be used as the header/title for the passed event.setEventHeaderWrap
(boolean eventHeaderWrap) When rendering thecanvas
for an event, whether to allow the content of theheader area
to wrap to multiple lines.setEventLaneFieldTitle
(String eventLaneFieldTitle) setEventNameFieldTitle
(String eventNameFieldTitle) setEventOverlap
(Boolean eventOverlap) WheneventAutoArrange
is true, setting eventOverlap to true causes events that share timeslots to overlap each other by a percentage of their width, specified byeventOverlapPercent
.setEventOverlapIdenticalStartTimes
(Boolean eventOverlapIdenticalStartTimes) When set to true, events that start at the same time will not overlap each other to prevent events having their close button hidden.setEventOverlapPercent
(int eventOverlapPercent) The size of the overlap, presented as a percentage of the width of events sharing timeslots.setEventScreen
(String eventScreen) Screen to create (viacreateScreen()
) in lieu of callingcreateEventCanvasComponent()
.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.setEventStartDateFieldTitle
(String eventStartDateFieldTitle) void
setEventStyle
(CalendarEvent event, String styleName) Update the styleName for the passed event.setEventStyleName
(String eventStyleName) The base name for the CSS class applied toevents
when they're rendered in calendar views.setEventStyleNameField
(String eventStyleNameField) The name of the field used to overrideeventStyleName
for an individualCalendarEvent.styleName
.setEventSublaneFieldTitle
(String eventSublaneFieldTitle) setEventWindowStyle
(String eventWindowStyle) Deprecated.in favor ofeventStyleName
setEventWindowStyleField
(String eventWindowStyleField) Deprecated.in favor ofeventStyleNameField
setExportAll
(Boolean exportAll) Setting exportAll to true prevents the component from passing its list of fields to the 
 export call.setExportFields
(String[] exportFields) The list of field-names to export.setExportIncludeSummaries
(Boolean exportIncludeSummaries) If Summary rows exist for this component, whether to include them when exporting client data.setFetchOperation
(String fetchOperation) Operation ID this component should use when performing fetch operations.setFields
(JavaScriptObject... fields) Field setter variant (alternative tosetFields(FormItem...)
,setFields(ListGridField...)
, etc.) that will accept an array of JavaScriptObject, rather than an array of SmartGWT Java wrappers of the field class type (e.g.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 popupDateChooser
.void
setHeaderHoverCustomizer
(HeaderLevelHoverCustomizer customizer) Customize the Hover text for a given span in a HeaderLevel.setHeaderLevels
(HeaderLevel... headerLevels) Configures the levels ofheaders
shown above the event area, and their time units.setHideUnusedLanes
(Boolean hideUnusedLanes) When set to true, hides anylane
that doesn't have any active events in the current dataset.setHiliteProperty
(String hiliteProperty) Marker that can be set on a record to flag that record as hilited.setHilites
(Hilite[] hilites) Accepts an array of hilite objects and applies them to this DataBoundComponent.setHiliteState
(String hiliteState) Set the current hilites based on a hiliteState String previously returned from getHilitesState.setImplicitCriteria
(Criteria implicitCriteria) Criteria that are never shown to or edited by the user and are cumulative with any criteria provided viaDataBoundComponent.initialCriteria
,DataBoundComponent.setCriteria()
etc.setImplicitCriteria
(Criteria implicitCriteria, DSCallback callback) setImplicitCriteria
(Criteria criteria, DSCallback callback, Boolean initialFetch) setIncludeRangeCriteria
(Boolean includeRangeCriteria) When set to true, the default, the fetches issued by navigating around in the various views are limited to the accessible date-range in the current view - as you change the current date-range, a fetch is only issued if the new range is not entirely within the previous range.void
setIndicatorHoverHTMLCustomizer
(IndicatorHoverHTMLCustomizer indicatorHoverHTMLCustomizer) This method returns the hover HTML to be displayed when the user hovers over an IndicatorCanvassetIndicators
(CalendarEvent... indicators) An array of CalendarEvent instances representing instants in time, to be highlighted intimeline views
.setIndicatorStyleName
(String indicatorStyleName) setInitialCriteria
(Criteria initialCriteria) Criteria to use whenDataBoundComponent.setAutoFetchData(Boolean)
is used.setInvalidDateMessage
(String invalidDateMessage) The message to display in theeventEditor
when the 'To' date is greater than the 'From' date and a save is attempted.setLaneEventPadding
(Integer laneEventPadding) setLaneFields
(ListGridField... laneFields) Field definitions for the frozen area of thetimelineView
, which shows data about the timelinelanes
.setLaneGroupByField
(String laneGroupByField) For timelines withcanGroupLanes
set to true, this is a field name or array of field names on which to group the lanes in a timeline.setLaneGroupByField
(String... laneGroupByField) For timelines withcanGroupLanes
set to true, this is a field name or array of field names on which to group the lanes in a timeline.void
void
setLaneGroupStartOpen
(Object... groupValues) setLaneNameField
(String laneNameField) The name of the field which will determine thelane
in which a given event will be displayed inTimeline
s and in theday view
, ifshowDayLanes
is true.An array ofLane
definitions that represent the rows of thetimelineView
, or the columns of thedayView
ifshowDayLanes
is true.boolean
setLaneTitle
(String lane, String title) For views that supportlanes
, updates the title for the passed lane.setLeadingDateField
(String leadingDateField) The name of the leading date field for each event.setLimitToWorkday
(Boolean limitToWorkday) WhenshowWorkday
is true, this attribute prevents the user from scrolling vertical views beyond the specified workdaystart
andend
hours.Setter implementing theLogicalStructure
interface, which supports Eclipse's logical structure debugging facility.setMinimalUI
(boolean minimalUI) A boolean value controlling whether the Calendar shows tabs for available calendar views.setMinimumDayHeight
(Integer minimumDayHeight) In themonth view
whenshowDayHeaders
is true, this is the minimum height applied to a day cell and its header combined.setMinLaneWidth
(Integer minLaneWidth) When showingvertical lanes
in thedayView
, this attribute sets the minimum width of each column or field.setMinRowHeight
(int minRowHeight) The minimum height of time-rows in vertical calendar views.setMinutesPerRow
(Integer minutesPerRow) setMonthButtonIconSrc
(String monthButtonIconSrc) The icon to show next to the month-name in themonth button
, used for showing and hiding themonth view
on Handsets.setMonthButtonTitle
(String monthButtonTitle) The title of themonth button
, used for showing and hiding themonth view
on Handsets.setMonthMoreEventsLinkTitle
(String monthMoreEventsLinkTitle) The title of the link shown in a cell of amonth view
when there are too many events to be displayed at once.void
setMonthViewHoverHTMLCustomizer
(MonthViewHoverHTMLCustomizer monthViewHoverHTMLCustomizer) This method returns the hover HTML to be displayed when the user hovers over a cell displayed in the calendar month view tab.setMonthViewTitle
(String monthViewTitle) The title for themonth view
.setNameField
(String nameField) The name of the name field on aCalendarEvent
.setNewEventWindowTitle
(String newEventWindowTitle) The title-text displayed in the popup event dialog/editor for new events.setNextButtonHoverText
(String nextButtonHoverText) The text to be displayed when a user hovers over thenext
toolbar buttonsetOtherDayBlankStyle
(String otherDayBlankStyle) The CSS style applied to both the header and body of days from other months in themonth view
, whenshowOtherDays
is false.setOtherDayBodyBaseStyle
(String otherDayBodyBaseStyle) The base name for the CSS class applied to the day body of the month view of the calendar.setOtherDayClickNavigation
(Boolean otherDayClickNavigation) WhenshowOtherDays
is true, this attribute determines whether the month-view should change month when cells representing days in the previous or following month are clicked.setOtherDayHeaderBaseStyle
(String otherDayHeaderBaseStyle) The base name for the CSS class applied to the day headers of the month view.setOverlapSortSpecifiers
(SortSpecifier... overlapSortSpecifiers) A set ofsort-specifiers
for customizing the render order of events that overlap.setPreventDuplicates
(Boolean preventDuplicates) If set, detect and prevent duplicate records from being transferred to this component, either via
 drag and drop or viaDataBoundComponent.transferSelectedData(com.smartgwt.client.widgets.DataBoundComponent)
.setPreviousButtonHoverText
(String previousButtonHoverText) The text to be displayed when a user hovers over theprevious
toolbar button.setProgressiveLoading
(Boolean progressiveLoading) Indicates whether or not this component will load its dataprogressively
setRemoveButtonTitle
(String removeButtonTitle) The title for theRemove button
in theevent editor
.setRemoveOperation
(String removeOperation) operationId
this component should use when performing remove operations.setRenderEventsOnDemand
(boolean renderEventsOnDemand) When set to true, the default, eachevent
is rendered as it appears in the viewport.void
setResolution
(HeaderLevel[] headerLevels, TimeUnit unit, Integer unitCount) Reset the resolution, the header levels and scrollable range, of the timeline view.void
setResolution
(HeaderLevel[] headerLevels, TimeUnit unit, Integer unitCount, Integer granularityPerColumn) Reset the resolution, the header levels and scrollable range, of the timeline view.setRowHeight
(int rowHeight) The height of time-slots in the calendar.setRowTitleFrequency
(Integer rowTitleFrequency) setSaveButtonTitle
(String saveButtonTitle) setSavedSearchId
(String savedSearchId) Optional identifier for saved searches that should be applied to this component.setScrollToWorkday
(Boolean scrollToWorkday) If set, andshowWorkday
is true, automatically scrolls theday
andweek
views to the start of theworkday
when the calendar is first displayed and whenever the user changes to a different day or week.setSelectChosenDate
(Boolean selectChosenDate) When true, shows the currentchosenDate
in a selected style in themonth view
.setSelectedCellStyle
(String selectedCellStyle) The base name for the CSS class applied to a cell that is selected via a mouse drag.setShowAddEventButton
(Boolean showAddEventButton) Set to false to hide theAdd Event
button.setShowCellHovers
(Boolean showCellHovers) WhenshowViewHovers
is true, dictates whether to display hover prompts when the mouse rolls over the normal cells in the body of CalendarViews.setShowColumnLayouts
(Boolean showColumnLayouts) When true, causeslayouts
to be added to each column in vertical views.setShowComplexFields
(Boolean showComplexFields) Whether to show fields of non-atomic types when a DataBoundComponent is given a
 DataSource but nocomponent.fields
.
setShowControlsBar
(Boolean showControlsBar) If false the controls bar at the top of the calendar will not be displayed - this means that thecontrolsBar
will be hidden, so the autoChildren (previousButton
,dateLabel
,nextButton
,addEventButton
, anddatePickerButton
) will not be created or shown.setShowDateChooser
(Boolean showDateChooser) Determines whether thedateChooser
is displayed.void
setShowDateCustomizer
(ShowDateCustomizer customizer) This method is called during rendering for all events in the visible range - those which would be rendered by default.setShowDatePickerButton
(Boolean showDatePickerButton) Set to false to hide thedatePickerButton
that allows selecting a new base date for this Calendar.setShowDayHeaders
(Boolean showDayHeaders) If true, the default, show a header cell for each day cell in themonth view
, with both cells having a minimum combined height ofminimumDayHeight
.setShowDayLanes
(Boolean showDayLanes) setShowDayView
(Boolean showDayView) Whether to show the Day view.setShowDetailFields
(Boolean showDetailFields) Whether to show fields markeddetail:true
when a DataBoundComponent is given a DataSource but nocomponent.fields
.setShowDragHovers
(Boolean showDragHovers) WhenshowViewHovers
is true, dictates whether to display hover prompts when an event is being dragged with the mouse.setShowEventCanvasComponents
(boolean showEventCanvasComponents) Whetherevent-canvases
should show a custom widget as content, rather than the defaultheader
andbody
HTML.void
setShowEventCustomizer
(ShowEventCustomizer customizer) Return false from the customizer to prevent the passed CalendarEvent from being rendered in the passed view.setShowEventDescriptions
(boolean showEventDescriptions) When rendering thecanvas
for an event, whether to show thebody area
, typically containing brief details of the event -by default
,its description
.setShowEventHeaders
(boolean showEventHeaders) When rendering thecanvas
for an event, whether to show theheader area
, typically containing suitable title text -by default
, the event'sname
.setShowEventHovers
(Boolean showEventHovers) WhenshowViewHovers
is true, dictates whether to display hover prompts when the mouse moves over anevent canvas
in a calendarView.setShowHeaderHovers
(Boolean showHeaderHovers) WhenshowViewHovers
is true, dictates whether to display hover prompts when the mouse rolls over theheader levels
in aCalendarView
.setShowHiddenFields
(Boolean showHiddenFields) Whether to show fields markedhidden:true
when a DataBoundComponent is given a
 DataSource but nocomponent.fields
.
setShowIndicators
(Boolean showIndicators) Set to true to render any definedindicators
intotimeline views
.setShowIndicatorsInFront
(boolean showIndicatorsInFront) Inindicator lines
are showing, this attribute affects where in the z-order their canvases will be rendered: either in front of, or behind normal calendar events.setShowLabelColumn
(boolean showLabelColumn) When set to false, hides the frozen Label-Column in verticalCalendarView
s.void
setShowLaneCustomizer
(ShowLaneCustomizer customizer) Return false from the customizer to prevent the passed Lane from being rendered in the passed view.setShowLaneFieldHovers
(Boolean showLaneFieldHovers) WhenshowViewHovers
is true, dictates whether to display hover prompts when the mouse moves over the cells in alaneField
.setShowLaneRollOver
(Boolean showLaneRollOver) When set to true, causesTimelines
to highlight the Lane under the mouse with the "Over" style.setShowMonthButton
(Boolean showMonthButton) Set to false to prevent theMonth
button from displaying on Handset devices.setShowMonthView
(Boolean showMonthView) Whether to show the Month view.setShowNextButton
(Boolean showNextButton) Set to false to hide theNext
button.setShowOtherDays
(Boolean showOtherDays) If set to true, in themonth view
, days that fall in an adjacent month are still shown with a header and body area, and are interactive.setShowPreviousButton
(Boolean showPreviousButton) Set to false to hide thePrevious
button.setShowQuickEventDialog
(Boolean showQuickEventDialog) Determines whether the quick event dialog is displayed when a time is clicked.setShowSavedSearchesByDS
(boolean showSavedSearchesByDS) Whether to associate saved searches by default with the currentDataSource
of a component when asavedSearchId
is not provided.setShowTimelineView
(Boolean showTimelineView) If set to true, show theTimeline view
.setShowViewHovers
(Boolean showViewHovers) When set to true, the default value, causes the Calendar to show customizable hovers when the mouse moves over various areas of a CalendarView.setShowWeekends
(Boolean showWeekends) setShowWeekView
(Boolean showWeekView) Whether to show the Week view.setShowWorkday
(Boolean showWorkday) When set to true, this setting enables various features related to cells that fall within the workday (as defined byworkdayStart
andworkdayEnd
) in vertical calendar views (day
andweek
).setShowZoneHovers
(Boolean showZoneHovers) WhenshowViewHovers
is true, dictates whether to display hover prompts when the mouse moves over azone
in a calendarView.setShowZones
(Boolean showZones) Set to true to render any definedzones
intotimeline views
.setSizeEventsToGrid
(Boolean sizeEventsToGrid) If true, events will be sized to the grid, even if they start and/or end at times between grid cells.setSizeToWorkday
(Boolean sizeToWorkday) WhenshowWorkday
is true, attempt to resize rows in the day and week views so that theworkday hours
fill the visible viewport-height, and the whole workday is visible without scrolling.setSort
(SortSpecifier... sortSpecifiers) Sort the component on one or more fields.setSparseFieldState
(Boolean sparseFieldState) If true,ListGrid.getFieldState()
andListGrid.setFieldState(java.lang.String)
will omit state information for hidden fields by default.setStartDate
(Date startDate) The start date of the calendartimeline view
.setStartDateField
(String startDateField) The name of the start date field on aCalendarEvent
.setStyleWorkday
(Boolean styleWorkday) WhenshowWorkday
is true, applies theworkdayBaseStyle
to cells that fall within the workday (as defined byworkdayStart
andworkdayEnd
), in both thedayView
andweekView
.setSublaneNameField
(String sublaneNameField) The name of the field which will determine thesublane
in which this event will be displayed, within its parent Lane, inTimeline
s and in theday view
, ifshowDayLanes
is true.void
setTimeFormatter
(TimeDisplayFormat timeFormatter) Display format to use for the time portion of events' date information.void
setTimeFormatter
(TimeFormatter timeFormatter) Deprecated.usesetTimeFormatter(TimeDisplayFormat)
instead.setTimelineGranularity
(TimeUnit timelineGranularity) The granularity in which thetimelineView
will display events.void
setTimelineRange
(Date start) Sets the range over which the timeline will display events.void
setTimelineRange
(Date start, Date end) Sets the range over which the timeline will display events.setTimelineUnitsPerColumn
(int timelineUnitsPerColumn) How many units oftimelineGranularity
each cell represents.setTimelineViewTitle
(String timelineViewTitle) The title for thetimeline view
.setTitleField
(String titleField) Sets the best field to use for a user-visible title for an individual record from this component.setTodayBackgroundColor
(String todayBackgroundColor) The background color for cells that represent today in allCalendarView
s.setTrailingDateField
(String trailingDateField) The name of the trailing date field for each event.setTwentyFourHourTime
(Boolean twentyFourHourTime) Dictates whether times throughout the widget are formatted and edited as 24-hour values.setUpdateOperation
(String updateOperation) operationId
this component should use when performing update operations.setUseAllDataSourceFields
(Boolean useAllDataSourceFields) If true, the set of fields given by the "default binding" (see 
fields
) is used, with any fields specified in
component.fields
acting as overrides that can suppress or modify the
 display of individual fields, without having to list the entire set of fields that
 should be shown.
setUseEventCanvasRolloverControls
(boolean useEventCanvasRolloverControls) By default, theclose buttons
and thehorizontal
andvertical
resizer widgets for event canvases are shown only when the mouse is over a given event.setUseFlatFields
(Boolean useFlatFields) TheuseFlatFields
flag causes all simple type fields anywhere in a nested
 set of DataSources to be exposed as a flat list for form binding.setUseSublanes
(Boolean useSublanes) setWeekendDays
(int... weekendDays) An array of integer day-numbers that should be considered to be weekend days by this Calendar instance.setWeekEventBorderOverlap
(Boolean weekEventBorderOverlap) Augments the width of week event windows slightly to avoid duplicate adjacent borders between events.setWeekPrefix
(String weekPrefix) The text to appear before the week number in the title ofweek-based
HeaderLevel
s when this calendar is showing a timeline.setWeekViewTitle
(String weekViewTitle) The title for theweek view
.setWorkdayBaseStyle
(String workdayBaseStyle) IfshowWorkday
is set, this is the style used for cells that are within the workday, as defined byworkdayStart
andworkdayEnd
, or by a date-specific range provided ingetWorkdayStart()
andgetWorkdayEnd()
implementations.setWorkdayEnd
(String workdayEnd) When usingshowWorkday
:true,workdayStart
andworkdayEnd
specify the time of day when the workday starts and ends, specified as a String acceptable to String.void
setWorkdays
(int[] workdays) Array of days that are considered workdays whenshowWorkday
is truesetWorkdayStart
(String workdayStart) When usingshowWorkday
:true,workdayStart
andworkdayEnd
specify the time of day when the workday starts and ends, specified as a String acceptable to String.void
setZoneHoverHTMLCustomizer
(ZoneHoverHTMLCustomizer zoneHoverHTMLCustomizer) This method returns the hover HTML to be displayed when the user hovers over an ZoneCanvassetZones
(CalendarEvent... zones) An array of CalendarEvent instances representing pre-defined periods of time to be highlighted intimeline views
.setZoneStyleName
(String zoneStyleName) setZoneTitleOrientation
(VerticalAlignment zoneTitleOrientation) The vertical alignment of the header-text in eachzone
.boolean
shouldDisableDate
(Date date) Returns true if the passed date should be considered disabled.boolean
shouldDisableDate
(Date date, CalendarView view) Returns true if the passed date should be considered disabled.boolean
shouldShowDate
(Date date) Indicates whether the passed date should be visible in the passedCalendarView
.boolean
shouldShowDate
(Date date, CalendarView view) Indicates whether the passed date should be visible in the passedCalendarView
.boolean
shouldShowEvent
(CalendarEvent event) Indicates whether the passedevent
should be visible in the passedCalendarView
.boolean
shouldShowEvent
(CalendarEvent event, CalendarView view) Indicates whether the passedevent
should be visible in the passedCalendarView
.boolean
shouldShowLane
(Lane lane) Indicates whether the passedlane
should be visible in the passedCalendarView
.boolean
shouldShowLane
(Lane lane, CalendarView view) Indicates whether the passedlane
should be visible in the passedCalendarView
.boolean
shouldShowLane
(String lane) Indicates whether the passedlane
should be visible in the passedCalendarView
.boolean
showEventCanvasComponent
(EventCanvas canvas) Should a component be applied to the passedcanvas
in theview
in which it appears? Return false from this method to override the global value ofshowEventCanvasComponents
for this canvas.void
Open the Quick Event dialog showing minimal information about an existingevent
.void
showEventDialog
(CalendarEvent event) void
showEventDialog
(CalendarEvent event, Boolean isNewEvent) Open the Quick Event dialog showing minimal information about an existingevent
.void
Show an Event Editor for the passed event.void
showEventEditor
(CalendarEvent event) void
showEventEditor
(CalendarEvent event, Boolean isNewEvent) Show an Event Editor for the passed event.void
Open the Quick Event dialog to begin editing a newevent
.void
showNewEventDialog
(CalendarEvent event) Open the Quick Event dialog to begin editing a newevent
.void
Show an Event Editor for a new event.void
showNewEventEditor
(CalendarEvent event) Show an Event Editor for a new event.timelineEventMoved
(CalendarEvent event, Date startDate, Date endDate, Lane lane) Deprecated.in favor ofCalendar.eventRepositionStop()
timelineEventResized
(CalendarEvent event, Date startDate, Date endDate) Deprecated.in favor ofCalendar.eventResizeStop()
void
transferRecords
(Record[] records, Record targetRecord, Integer index, Canvas sourceWidget, TransferRecordsCallback callback) Transfer a list ofRecord
s from another component (does not have to be a databound component) into this component.void
Simulates a drag / drop type transfer of the selected records in some other component to this component, without requiring any user interaction.void
transferSelectedData
(DataBoundComponent source, int index) Simulates a drag / drop type transfer of the selected records in some other component to this component, without requiring any user interaction.void
updateCalendarEvent
(CalendarEvent event, CalendarEvent newEvent, Map otherFields) Save an event to this Calendar's ${isc.DocUtils.linkForRef('attr:Calendar.dataSource','dataSource) or \ndata array')
.void
updateEvent
(CalendarEvent event, Date startDate, Date endDate, String name, String description) update an event in this calendar.void
updateEventCanvasComponent
(EventCanvas canvas, Canvas component) Called fromEventCanvas.setEvent()
whenshowEventCanvasComponents
is true and the eventCanvas already has acomponent
.Methods inherited from class com.smartgwt.client.widgets.Canvas
addChild, addChild, addChild, addChild, addChild, addClearHandler, addClickHandler, addDoubleClickHandler, addDragMoveHandler, addDragRepositionMoveHandler, addDragRepositionStartHandler, addDragRepositionStopHandler, addDragResizeMoveHandler, addDragResizeStartHandler, addDragResizeStopHandler, addDragStartHandler, addDragStopHandler, addDropHandler, addDropMoveHandler, addDropOutHandler, addDropOverHandler, addFocusChangedHandler, addHoverHandler, addHoverHiddenHandler, addKeyDownHandler, addKeyPressHandler, addMouseDownHandler, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseStillDownHandler, addMouseUpHandler, addMouseWheelHandler, addMovedHandler, addParentMovedHandler, addPeer, addPeer, addPeer, addPeer, addResizedHandler, addRightMouseDownHandler, addRuleContextChangedHandler, addScrolledHandler, addShowContextMenuHandler, addSnapAlignCandidate, addStyleName, addVisibilityChangedHandler, adjustForContent, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateHide, animateHide, animateHide, animateHide, animateHide, animateHide, animateHide, animateMove, animateMove, animateMove, animateMove, animateRect, animateRect, animateRect, animateRect, animateResize, animateResize, animateResize, animateResize, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateShow, animateShow, animateShow, animateShow, animateShow, animateShow, animateShow, asSGWTComponent, blur, bringToFront, clear, clearExplicitTabIndex, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsEventTarget, containsFocus, containsPoint, containsPoint, dataContextChanged, deparent, depeer, disable, enable, encloses, focus, focusAfterGroup, focusAtEnd, focusInNextTabElement, focusInPreviousTabElement, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAdaptiveHeightPriority, getAdaptiveWidthPriority, getAlwaysManageFocusNavigation, getAlwaysShowScrollbars, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideEffect, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeLayoutMode, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaHandleID, getAriaRole, getAriaStateDefaults, getAutoMaskComponents, getAutoParent, getAutoPopulateData, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBorderRadius, getBottom, getById, getByJSObject, getByLocalId, getCanAcceptDrop, getCanAdaptHeight, getCanAdaptWidth, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanHover, getCanSelectText, getCanvasAutoChild, getCanvasItem, getChildren, getChildrenResizeSnapAlign, getChildrenSnapAlign, getChildrenSnapCenterAlign, getChildrenSnapEdgeAlign, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getChildTabPosition, getClassName, getComponentMask, getComponentMaskDefaults, getContentElement, getContents, getContextMenu, getCorrectZoomOverflow, getCursor, getDataContext, getDataPath, getDefaultHeight, getDefaultWidth, getDefiningProperty, getDefiningPropertyName, getDefiningPropertyNameOptions, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDisableTouchScrollingForDrag, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragMaskType, getDragMaxHeight, getDragMaxWidth, getDragMinHeight, getDragMinWidth, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragTargetAsString, getDragType, getDropTarget, getDropTargetAsString, getDropTypes, getDropTypesAsString, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getEditNode, getEditProxy, getEditProxyConstructor, getElement, getElement, getEnableWhen, getEndLine, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFloatingScrollbars, getFormItemAutoChild, getForwardSVGeventsToObject, getFullDataPath, getGroupBorderCSS, getGroupLabelBackgroundColor, getGroupLabelStyleName, getGroupPadding, getGroupTitle, getHeight, getHeightAsString, getHideUsingDisplayNone, getHoverAlign, getHoverAutoDestroy, getHoverAutoFitMaxWidth, getHoverAutoFitMaxWidthAsString, getHoverAutoFitWidth, getHoverComponent, getHoverDelay, getHoverFocusKey, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverPersist, getHoverScreen, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapPosition, getHSnapPosition, getHtmlElement, getHtmlElementAsString, getHtmlPosition, getImage, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getIsPrinting, getIsRuleScope, getIsSnapAlignCandidate, getKeepInParentRect, getLayoutAlign, getLeaveGroupLabelSpace, getLeavePageSpace, getLeft, getLeftAsString, getLocalId, getLocateByIDOnly, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getLocatorName, getMargin, getMasterCanvas, getMasterElement, getMatchElement, getMatchElementHeight, getMatchElementWidth, getMaxHeight, getMaxWidth, getMaxZoomOverflowError, getMenuConstructor, getMinHeight, getMinNonEdgeSize, getMinWidth, getMomentumScrollMinSpeed, getMouseStillDownDelay, getMouseStillDownInitialDelay, getName, getNativeAutoHideScrollbars, getNextZIndex, getNoDoubleClicks, getNoDropCursor, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOuterElement, getOverflow, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getPaletteDefaults, getPanelContainer, getParentCanvas, getParentElement, getPeers, getPendingMarkerStyle, getPendingMarkerVisible, getPercentBox, getPercentSource, getPersistentMatchElement, getPointerSettings, getPointerTarget, getPointerTargetAsString, getPosition, getPrefix, getPrintChildrenAbsolutelyPositioned, getPrintHTML, getPrintHTML, getPrintStyleName, getPrompt, getProportionalResizeModifiers, getProportionalResizing, getReceiveScrollbarEvents, getRect, getRedrawOnResize, getResizeBarTarget, getResizeFrom, getRight, getRuleContext, getRuleContext, getRuleScope, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowColor, getShadowDepth, getShadowHOffset, getShadowImage, getShadowOffset, getShadowSoftness, getShadowSpread, getShadowVOffset, getShouldPrint, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowHover, getShowHoverComponents, getShowPointer, getShowResizeBar, getShowShadow, getShowSnapGrid, getShrinkElementOnHide, getSizeMayChangeOnRedraw, getSkinImgDir, getSnapAlignCandidates, getSnapAlignCenterLineStyle, getSnapAlignEdgeLineStyle, getSnapAxis, getSnapEdge, getSnapGridLineProperties, getSnapGridStyle, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapPosition, getSnapPosition, getSnapResizeToAlign, getSnapResizeToGrid, getSnapTo, getSnapToAlign, getSnapToCenterAlign, getSnapToEdgeAlign, getSnapToGrid, getSnapVDirection, getSnapVGap, getStartLine, getStyleName, getTabIndex, getTestDataContext, getTestInstance, getTitle, getTooltip, getTop, getTopAsString, getTopElement, getUISummary, getUpdateTabPositionOnDraw, getUpdateTabPositionOnReparent, getUseBackMask, getUseCSSShadow, getUseDragMask, getUseImageForSVG, getUseNativeDrag, getUseOpacityFilter, getUseTouchScrolling, getValuesManager, getValuesManagerAsString, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWhen, getVisibleWidth, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getWorkflows, getZIndex, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideComponentMask, hideComponentMask, hideContextMenu, imgHTML, imgHTML, imgHTML, initComplete, intersects, isDirty, isDisabled, isFocused, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, markForDestroy, markForRedraw, markForRedraw, moveAbove, moveBelow, moveBy, moveTo, onAttach, onDetach, pageScrollDown, pageScrollUp, parentResized, placeNear, placeNear, placeNear, print, print, print, print, printComponents, provideRuleContext, provideRuleContext, redraw, redraw, registerFontScaledPaddingStyles, removeChild, removeChild, removePeer, removePeer, removeRuleContext, removeSnapAlignCandidate, resizeAutoChildAttributes, resizeBy, resizeControls, resizeControlsTo, resizeFonts, resizeFonts, resizeFonts, resizeFontsTo, resizeIcons, resizePadding, resizePadding, resizeTo, resizeTo, revealChild, revealChild, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollTo, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAdaptHeightByCustomizer, setAdaptiveHeightPriority, setAdaptiveWidthPriority, setAdaptWidthByCustomizer, setAlign, setAllowExternalFilters, setAlwaysManageFocusNavigation, setAlwaysShowScrollbars, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideEffect, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeLayoutMode, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAriaRole, setAriaState, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setAutoHeight, setAutoMaskComponents, setAutoParent, setAutoPopulateData, setAutoResizeAutoChildAttributes, setAutoResizeIcons, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBorderRadius, setBottom, setCanAcceptDrop, setCanAdaptHeight, setCanAdaptWidth, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setChildren, setChildrenResizeSnapAlign, setChildrenSnapAlign, setChildrenSnapCenterAlign, setChildrenSnapEdgeAlign, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setComponentMaskDefaults, setContents, setContextMenu, setCorrectZoomOverflow, setCursor, setDataContext, setDataPath, setDefaultHeight, setDefaultPageSpace, setDefaultProperties, setDefaultShowCustomScrollbars, setDefaultWidth, setDefiningProperty, setDefiningPropertyNameOptions, setDisabled, setDisabledCursor, setDisableTouchScrollingForDrag, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragMaskType, setDragMaxHeight, setDragMaxWidth, setDragMinHeight, setDragMinWidth, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragTarget, setDragType, setDropTarget, setDropTarget, setDropTypes, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setEditMode, setEditMode, setEditMode, setEditProxyConstructor, setElement, setEnableWhen, setEndLine, setExtraSpace, setFacetId, setFloatingScrollbars, setForwardSVGeventsToObject, setGroupBorderCSS, setGroupLabelBackgroundColor, setGroupLabelStyleName, setGroupPadding, setGroupTitle, setHeight, setHeight, setHeight, setHeight100, setHideUsingDisplayNone, setHoverAlign, setHoverAutoDestroy, setHoverAutoFitMaxWidth, setHoverAutoFitMaxWidth, setHoverAutoFitWidth, setHoverDelay, setHoverFocusKey, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverPersist, setHoverScreen, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlElement, setHtmlElement, setHtmlPosition, setImage, setImage, setInitHandler, setIsGroup, setIsRuleScope, setIsSnapAlignCandidate, setKeepInParentRect, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeaveGroupLabelSpace, setLeavePageSpace, setLeft, setLeft, setLocateByIDOnly, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLocatorName, setLocatorParent, setLocatorParent, setLogicalStructure, setMargin, setMatchElement, setMatchElementHeight, setMatchElementWidth, setMaxHeight, setMaxWidth, setMaxZoomOverflowError, setMenuConstructor, setMinHeight, setMinNonEdgeSize, setMinWidth, setMomentumScrollMinSpeed, setMouseStillDownDelay, setMouseStillDownInitialDelay, setName, setNativeAutoHideScrollbars, setNeverUseFilters, setNoDoubleClicks, setNoDropCursor, setOpacity, setOverflow, setPadding, setPageLeft, setPageTop, setPanelContainer, setParentCanvas, setParentElement, setPeers, setPendingMarkerStyle, setPendingMarkerVisible, setPercentBox, setPercentSource, setPersistentMatchElement, setPointerSettings, setPointerTarget, setPosition, setPrefix, setPrintChildrenAbsolutelyPositioned, setPrintStyleName, setPrompt, setProportionalResizeModifiers, setProportionalResizing, setReceiveScrollbarEvents, setRect, setRect, setRedrawOnResize, setRelativeTabPosition, setResizeBarTarget, setResizeFrom, setResizeFrom, setRight, setRuleScope, setScrollbarConstructor, setScrollbarSize, setShadowColor, setShadowDepth, setShadowHOffset, setShadowImage, setShadowOffset, setShadowSoftness, setShadowSpread, setShadowVOffset, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowHover, setShowHoverComponents, setShowPointer, setShowResizeBar, setShowShadow, setShowSnapGrid, setShrinkElementOnHide, setSizeMayChangeOnRedraw, setSkinImgDir, setSmoothFade, setSnapAlignCandidates, setSnapAlignCenterLineStyle, setSnapAlignEdgeLineStyle, setSnapAxis, setSnapEdge, setSnapGridLineProperties, setSnapGridStyle, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToAlign, setSnapResizeToGrid, setSnapTo, setSnapToAlign, setSnapToCenterAlign, setSnapToEdgeAlign, setSnapToGrid, setSnapVDirection, setSnapVGap, setStartLine, setStyleName, setTabIndex, setTestDataContext, setTitle, setTooltip, setTop, setTop, setUpdateTabPositionOnDraw, setUpdateTabPositionOnReparent, setUseBackMask, setUseCSSShadow, setUseDragMask, setUseImageForSVG, setUseNativeDrag, setUseOpacityFilter, setUseTouchScrolling, setValuesManager, setValuesManager, setVisibility, setVisible, setVisibleWhen, setWidth, setWidth, setWidth, setWidth100, setWorkflows, setZIndex, shouldDragScroll, show, showClickMask, showComponentMask, showComponentMask, showNextTo, showNextTo, showNextTo, showNextTo, showPendingMarker, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, startDebuggingOverflow, stopDebuggingOverflow, updateChildTabPosition, updateChildTabPositions, updateEditNode, updateHover, updateHover, updateShadow, updateTabPositionForDraw, visibleAtPoint, willAcceptDrop
Methods inherited from class com.smartgwt.client.widgets.BaseWidget
addDrawHandler, addDynamicProperty, addDynamicProperty, addDynamicProperty, addDynamicProperty, applyFactoryProperties, clearDynamicProperty, completeCreation, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hasAutoAssignedID, hasDynamicProperty, hashCode, initNativeObject, internalSetID, internalSetID, isConfigOnly, isCreated, isDrawn, isFactoryCreated, onBind, onDestroy, onDraw, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setDefaultProperties, setDragTracker, setFactoryCreated, setID, setJavaScriptObject, setLogicalStructure, setLogicalStructure, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setScClassName, toString
Methods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.smartgwt.client.widgets.DataBoundComponent
getOrCreateJsObj
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
-
Constructor Details
-
Calendar
public Calendar() -
Calendar
-
-
Method Details
-
getOrCreateRef
-
changeAutoChildDefaults
Changes the defaults for Canvas AutoChildren namedautoChildName
.- 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, seeSGWTProperties
.- See Also:
-
changeAutoChildDefaults
Changes the defaults for FormItem AutoChildren namedautoChildName
.- 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, seeSGWTProperties
.- See Also:
-
create
-
getAddEventButton
AnImgButton
that appears in a Calendar's week/day/month views and offers an alternative way to create a newevent
.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 theadd 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
The text to be displayed when a user hovers over theadd event
toolbar button- Returns:
- Current addEventButtonHoverText value. Default value is "Add an event"
-
setAllowDurationEvents
When set to true, allows events to be managed by duration, as well as by end date. Values can be set forduration
andduration 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
When set to true, allows events to be managed by duration, as well as by end date. Values can be set forduration
andduration 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
When showing aTimeline
, or aday view
whenshowDayLanes
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
When showing aTimeline
, or aday view
whenshowDayLanes
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
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
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
The icon to show in themonth-button
on Handsets when themonth 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
The icon to show in themonth-button
on Handsets when themonth view
is the current visible view.- Returns:
- Current backButtonIconSrc value. Default value is "Chevron_Left"
- See Also:
-
setBackButtonTitle
The title of themonth
on Handsets when themonth 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
The title of themonth
on Handsets when themonth 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
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
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
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
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
The base name for the CSS class applied to the links rendered bygetDayBodyHTML()
.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
The base name for the CSS class applied to the links rendered bygetDayBodyHTML()
.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
Ancom.smartgwt.client.types.AutoChild
of typeIButton
, used to cancel editing of an event and close theeventEditor
.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
The title for theCancel button
in theevent 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
The title for theCancel button
in theevent editor
.- Returns:
- Current cancelButtonTitle value. Default value is "Cancel"
- See Also:
-
setCanCreateEvents
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
If true, users can create new events.- Returns:
- Current canCreateEvents value. Default value is true
-
setCanCreateOtherDayEvents
WhenshowOtherDays
is true, determines whether clicking in a Month-view body-cell that represents a date outside the selected month will open theevent-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
WhenshowOtherDays
is true, determines whether clicking in a Month-view body-cell that represents a date outside the selected month will open theevent-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
Deprecated.in favor ofcanRemoveEvents
If true, users can delete existing events. Defaults tocanEditEvents
.- 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
Deprecated.in favor ofcanRemoveEvents
If true, users can delete existing events. Defaults tocanEditEvents
.- Returns:
- Current canDeleteEvents value. Default value is null
-
setCanDragCreateEvents
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
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
Name of the field on eachCalendarEvent
that determines whether anEventCanvas
can be moved or resized by dragging with the mouse. Note thatcanEditEvents
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
Name of the field on eachCalendarEvent
that determines whether anEventCanvas
can be moved or resized by dragging with the mouse. Note thatcanEditEvents
must be true for dragging to be allowed.- Returns:
- Current canDragEventField value. Default value is "canDrag"
- See Also:
-
setCanDragEvents
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
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
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
If true, users can edit existing events.- Returns:
- Current canEditEvents value. Default value is true
-
setCanEditField
Name of the field on eachCalendarEvent
that determines whether it can be edited in theevent editor
. Note that an event withcanEdit
set to true can also havecanDrag
orcanResize
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
Name of the field on eachCalendarEvent
that determines whether it can be edited in theevent editor
. Note that an event withcanEdit
set to true can also havecanDrag
orcanResize
set to false, which would still allow editing, but not via drag operations.- Returns:
- Current canEditField value. Default value is "canEdit"
- See Also:
-
setCanEditLane
Can events be moved between lanes? If so, the event can be dragged to a differentlane
, and the eventquick dialog
andeditor
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
Can events be moved between lanes? If so, the event can be dragged to a differentlane
, and the eventquick dialog
andeditor
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
Name of the field on eachCalendarEvent
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
Name of the field on eachCalendarEvent
that determines whether that event can be moved between lanes.- Returns:
- Current canEditLaneField value. Default value is "canEditLane"
- See Also:
-
setCanEditSublane
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'slane 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
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'slane 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
Name of the field on eachCalendarEvent
that determines whether that event can be moved between individualsublanes
in aLane
.- 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
Name of the field on eachCalendarEvent
that determines whether that event can be moved between individualsublanes
in aLane
.- Returns:
- Current canEditSublaneField value. Default value is "canEditSublane"
- See Also:
-
setCanGroupLanes
If true, allows the lanes in a Timeline to be grouped by providing a value forlaneGroupByField
. The fields available for grouping on are those defined aslane fields
. Since these are definitions fornormal fields
, you can choose tohide
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
If true, allows the lanes in a Timeline to be grouped by providing a value forlaneGroupByField
. The fields available for grouping on are those defined aslane fields
. Since these are definitions fornormal fields
, you can choose tohide
the field in the timeline, but still have it available for grouping.- Returns:
- Current canGroupLanes value. Default value is null
-
setCanRemoveEvents
If true, users can remove existing events. Defaults tocanEditEvents
.- 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
If true, users can remove existing events. Defaults tocanEditEvents
.- Returns:
- Current canRemoveEvents value. Default value is true
-
setCanRemoveField
Name of the field on eachCalendarEvent
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
Name of the field on eachCalendarEvent
that determines whether an event shows a remove button.- Returns:
- Current canRemoveField value. Default value is "canRemove"
- See Also:
-
setCanReorderLanes
If true, lanes can be reordered by dragging theirlaneFields
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
If true, lanes can be reordered by dragging theirlaneFields
with the mouse.- Returns:
- Current canReorderLanes value. Default value is null
-
setCanResizeEventField
Name of the field on eachCalendarEvent
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
Name of the field on eachCalendarEvent
that determines whether an event can be resized by dragging.- Returns:
- Current canResizeEventField value. Default value is "canResize"
- See Also:
-
setCanResizeEvents
Canevents
be resized by dragging appropriate edges of thecanvas
? Only has an effect when bothcanEditEvents
andcanDragEvents
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
Canevents
be resized by dragging appropriate edges of thecanvas
? Only has an effect when bothcanEditEvents
andcanDragEvents
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 ofcanResizeEvents
;CanTimeline
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
Deprecated.in favor ofcanResizeEvents
;CanTimeline
events be stretched by their left and right edges?- Returns:
- Current canResizeTimelineEvents value. Default value is false
-
setCanSelectEvents
When set to true, makes individualevent 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
oreditor
. 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
When set to true, makes individualevent 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
oreditor
. 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
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
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
Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists. SeeUsing AutoChildren
for details.When
showColumnLayouts
is true, the layouts added to each column to stack events.- Returns:
- null
-
setColumnsPerPage
When using the Next and Previous arrows to scroll a Timeline, this is the number of columns of thetimelineGranularity
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
When using the Next and Previous arrows to scroll a Timeline, this is the number of columns of thetimelineGranularity
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 thecontrolsBar
. This is a base style supporting suffixes for states, specifically "Over", "Down" and "Disabled", which are applied whenImgButton
settings likeImgButton.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
A CSS style to apply to icons in thecontrolsBar
. This is a base style supporting suffixes for states, specifically "Over", "Down" and "Disabled", which are applied whenImgButton
settings likeImgButton.showRollOverIcon
are applied to the icons.- Returns:
- Current controlBarIconBaseStyle value. Default value is "icon"
- See Also:
-
setControlBarIconSize
The size of the various icons displayed in thecontrolsBar
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
The size of the various icons displayed in thecontrolsBar
of this Calendar.- Returns:
- Current controlBarIconSize value. Default value is 16
-
getControlsBar
AnHLayout
shown above the Calendar views and displaying a set of controls for interacting with the current view - namely, thenext
,previous
andadd
buttons, thedate label
and thedate-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
Default height of thecontrolsBar
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 thecontrolsBar
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
Default height of thecontrolsBar
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 thecontrolsBar
is vertically-aligned with the text in the tabs.- Returns:
- Current controlsBarHeight value. Default value is 30
-
setCurrentViewName
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
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
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 aresultSet
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
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 aresultSet
rather than a simple array.- Returns:
- Current data value. Default value is null
- See Also:
-
setDataFetchMode
How to fetch and manage records retrieve from the server. SeeFetchMode
.This setting only applies to the
ResultSet
automatically created by callingfetchData()
. If a pre-existing ResultSet is passed to setData() instead, it's existing setting forResultSet.fetchMode
applies.- Specified by:
setDataFetchMode
in interfaceDataBoundComponent
- Parameters:
dataFetchMode
- New dataFetchMode value. Default value is "basic"- Returns:
Calendar
instance, for chaining setter calls- See Also:
-
getDataFetchMode
How to fetch and manage records retrieve from the server. SeeFetchMode
.This setting only applies to the
ResultSet
automatically created by callingfetchData()
. If a pre-existing ResultSet is passed to setData() instead, it's existing setting forResultSet.fetchMode
applies.- Specified by:
getDataFetchMode
in interfaceDataBoundComponent
- Returns:
- Current dataFetchMode value. Default value is "basic"
- See Also:
-
setDataSource
The DataSource that this component should bind to for default fields and for performingDataSource requests
.Can be specified as either a DataSource instance or the String ID of a DataSource.
- Specified by:
setDataSource
in interfaceDataBoundComponent
- Parameters:
dataSource
- New dataSource value. Default value is null- Returns:
Calendar
instance, for chaining setter calls- See Also:
-
setDataSource
The DataSource that this component should bind to for default fields and for performingDataSource requests
.Can be specified as either a DataSource instance or the String ID of a DataSource.
- Specified by:
setDataSource
in interfaceDataBoundComponent
- Parameters:
dataSource
- New dataSource value. Default value is null- Returns:
Calendar
instance, for chaining setter calls- See Also:
-
getDateChooser
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
Indicates the type of controls to use in event-windows. Valid values are those in theDateEditingStyle
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
Indicates the type of controls to use in event-windows. Valid values are those in theDateEditingStyle
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
Date formatter for displaying events. Default is to use the system-wide default short date format, configured viaDateUtil.setShortDisplayFormat()
. Specify any validDateDisplayFormat
.- Parameters:
dateFormatter
- New dateFormatter value. Default value is null- Returns:
Calendar
instance, for chaining setter calls
-
getDateFormatter
Date formatter for displaying events. Default is to use the system-wide default short date format, configured viaDateUtil.setShortDisplayFormat()
. Specify any validDateDisplayFormat
.- Returns:
- Current dateFormatter value. Default value is null
-
getDateLabel
Thecom.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
AnImgButton
that appears above the various views of the calendar and offers alternative access to aDateChooser
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
The text to be displayed when a user hovers over thedate 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
The text to be displayed when a user hovers over thedate picker
toolbar button- Returns:
- Current datePickerHoverText value. Default value is "Choose a date"
-
setDayBodyBaseStyle
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
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
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
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
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
The title for theday 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
The title for theday view
.- Returns:
- Current dayViewTitle value. Default value is "Day"
-
setDefaultTimelineColumnSpan
public Calendar setDefaultTimelineColumnSpan(int defaultTimelineColumnSpan) throws IllegalStateException The number of columns of thetimelineGranularity
to give the timeline by default if noendDate
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 thetimelineGranularity
to give the timeline by default if noendDate
is provided. The default is 20.- Returns:
- Current defaultTimelineColumnSpan value. Default value is 20
-
setDescriptionField
The name of the description field on aCalendarEvent
.- 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
The name of the description field on aCalendarEvent
.- Returns:
- Current descriptionField value. Default value is "description"
-
setDetailsButtonTitle
The title for the edit button in the quickquick 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
The title for the edit button in the quickquick event dialog
.- Returns:
- Current detailsButtonTitle value. Default value is "Edit Details"
- See Also:
-
setDisableWeekends
If true, weekend days appear in a disabled style and events cannot be created on weekends. Which days are considered weekends is controlled byweekendDays
.- Parameters:
disableWeekends
- New disableWeekends value. Default value is true- Returns:
Calendar
instance, for chaining setter calls- See Also:
-
getDisableWeekends
If true, weekend days appear in a disabled style and events cannot be created on weekends. Which days are considered weekends is controlled byweekendDays
.- Returns:
- Current disableWeekends value. Default value is true
- See Also:
-
setDurationField
The name of theduration
field on aCalendarEvent
.- 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
The name of theduration
field on aCalendarEvent
.- Returns:
- Current durationField value. Default value is "duration"
- See Also:
-
setDurationUnitField
The name of thedurationUnit
field on aCalendarEvent
.- 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
The name of thedurationUnit
field on aCalendarEvent
.- Returns:
- Current durationUnitField value. Default value is "durationUnit"
- See Also:
-
setEndDate
The end date of the calendar timeline view. Has no effect in other views.To set different
start
and end dates after initial draw, seesetTimelineRange
.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
The end date of the calendar timeline view. Has no effect in other views.To set different
start
and end dates after initial draw, seesetTimelineRange
.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
The name of the end date field on aCalendarEvent
.- 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
The name of the end date field on aCalendarEvent
.- Returns:
- Current endDateField value. Default value is "endDate"
- See Also:
-
setEventAutoArrange
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
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
Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists. SeeUsing AutoChildren
for details.To display events in
day
,week
andtimeline
views, the Calendar creates instances ofEventCanvas
for each event. Use thecom.smartgwt.client.types.AutoChild
system to customize these canvases.- Returns:
- null
-
getEventCanvasButtonLayout
HLayout that snaps to the top-right of an event canvas on rollover and contains theclose
and/orcontext
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
The close button that snaps to the top-right of an event canvas on rollover and allows an event to be removed from aCalendarView
.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 theclose-button
that snaps to the top-right of an event canvas on rollover and shows allows an event to be removed from aCalendarView
.- 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
The size of theclose-button
that snaps to the top-right of an event canvas on rollover and shows allows an event to be removed from aCalendarView
.- Returns:
- Current eventCanvasCloseButtonSize value. Default value is 16
-
setEventCanvasCloseIconSize
public Calendar setEventCanvasCloseIconSize(Integer eventCanvasCloseIconSize) throws IllegalStateException The size of the icon in theclose-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
The size of the icon in theclose-button
floated over events on rollover.- Returns:
- Current eventCanvasCloseIconSize value. Default value is 13
-
getEventCanvasComponent
Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists. SeeUsing AutoChildren
for details.Multi-AutoChild component, created as a space-filling member in individual
event-canvases
, whenshowEventCanvasComponents
is true. -
getEventCanvasContextButton
The context button that snaps to the top-right of an event canvas on rollover and shows a customcontext 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
Context menu displayed when anevent canvas
is right-clicked, or when the rollovercontext button
is clicked. The context button, and the menu itself, will only be displayed ifgetEventCanvasMenuItems
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
Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists. SeeUsing 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
Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists. SeeUsing 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
Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists. SeeUsing AutoChildren
for details.- Returns:
- null
-
getEventCanvasVResizer
Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists. SeeUsing AutoChildren
for details.The resizer image that snaps to the bottom of event canvases in
day
andweek
views, allowing them to be resized vertically by dragging with the mouse.- Returns:
- null
-
setEventDescriptionFieldTitle
public Calendar setEventDescriptionFieldTitle(String eventDescriptionFieldTitle) throws IllegalStateException - 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
- Returns:
- Current eventDescriptionFieldTitle value. Default value is "Description"
- See Also:
-
getEventDialog
Ancom.smartgwt.client.types.AutoChild
of typeWindow
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
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
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 - 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
- Returns:
- Current eventDurationFieldTitle value. Default value is "Duration"
- See Also:
-
setEventDurationUnitFieldTitle
public Calendar setEventDurationUnitFieldTitle(String eventDurationUnitFieldTitle) throws IllegalStateException - 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
- Returns:
- Current eventDurationUnitFieldTitle value. Default value is " "
- See Also:
-
getEventEditor
Ancom.smartgwt.client.types.AutoChild
of typeDynamicForm
which displaysevent data
. This form is created within theevent 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
Ancom.smartgwt.client.types.AutoChild
of typeHLayout
which houses theSave
,Remove
andCancel
buttons in theeventEditor
.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
The list of buttons to include in theeventEditor
. Entries can be the names of the builtin buttons,saveButton
,removeButton
andcancelButton
, or the names of customautoChildren
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
The list of buttons to include in theeventEditor
. Entries can be the names of the builtin buttons,saveButton
,removeButton
andcancelButton
, or the names of customautoChildren
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 theeventEditor
that allows for changing the logical start-date of an event, along with its start and end times, when editing events in theday
andweek
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
The title for the Date-field in theeventEditor
that allows for changing the logical start-date of an event, along with its start and end times, when editing events in theday
andweek
views.- Returns:
- Current eventEditorDateFieldTitle value. Default value is "Date"
- See Also:
-
getEventEditorLayout
Ancom.smartgwt.client.types.AutoChild
of typeWindow
that displays the fullevent 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 - 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
- Returns:
- Current eventEndDateFieldTitle value. Default value is "To"
- See Also:
-
setEventHeaderHeight
WheneventHeaderWrap
is false andshowEventDescriptions
is true, this is the fixed height for theheader 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()WheneventHeaderWrap
is false andshowEventDescriptions
is true, this is the fixed height for theheader area
in event canvases.- Returns:
- Current eventHeaderHeight value. Default value is 14
-
setEventHeaderWrap
When rendering thecanvas
for an event, whether to allow the content of theheader area
to wrap to multiple lines.The default is true - if set to false, the header area is
fixed
, unlessshowEventDescriptions
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 thecanvas
for an event, whether to allow the content of theheader area
to wrap to multiple lines.The default is true - if set to false, the header area is
fixed
, unlessshowEventDescriptions
is false, in which case the header area fills the canvas.- Returns:
- Current eventHeaderWrap value. Default value is true
-
setEventLaneFieldTitle
- 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
- Returns:
- Current eventLaneFieldTitle value. Default value is "Lane"
- See Also:
-
setEventNameFieldTitle
- 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
- Returns:
- Current eventNameFieldTitle value. Default value is "Event Name"
- See Also:
-
setEventOverlap
WheneventAutoArrange
is true, setting eventOverlap to true causes events that share timeslots to overlap each other by a percentage of their width, specified byeventOverlapPercent
. The default is true for Calendars and false forTimelines
.- 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
WheneventAutoArrange
is true, setting eventOverlap to true causes events that share timeslots to overlap each other by a percentage of their width, specified byeventOverlapPercent
. The default is true for Calendars and false forTimelines
.- 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
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
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
Screen to create (viacreateScreen()
) in lieu of callingcreateEventCanvasComponent()
.If this calendar has a
dataSource
, the created screen is provided with aCanvas.dataContext
that includes the event being shown. Be sure the event screen meets theserequirements
to utilize thedataContext
.- 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
Screen to create (viacreateScreen()
) in lieu of callingcreateEventCanvasComponent()
.If this calendar has a
dataSource
, the created screen is provided with aCanvas.dataContext
that includes the event being shown. Be sure the event screen meets theserequirements
to utilize thedataContext
.- Returns:
- Current eventScreen value. Default value is null
-
setEventSnapGap
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
. IftimelineUnitsPerColumn
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
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
. IftimelineUnitsPerColumn
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 - 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
- Returns:
- Current eventStartDateFieldTitle value. Default value is "From"
- See Also:
-
setEventStyleName
The base name for the CSS class applied toevents
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
The base name for the CSS class applied toevents
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
The name of the field used to overrideeventStyleName
for an individualCalendarEvent.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
The name of the field used to overrideeventStyleName
for an individualCalendarEvent.styleName
.- Returns:
- Current eventStyleNameField value. Default value is "styleName"
- See Also:
-
setEventSublaneFieldTitle
public Calendar setEventSublaneFieldTitle(String eventSublaneFieldTitle) throws IllegalStateException - 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
- Returns:
- Current eventSublaneFieldTitle value. Default value is "Sublane"
- See Also:
-
setEventWindowStyle
Deprecated.in favor ofeventStyleName
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
Deprecated.in favor ofeventStyleName
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
Deprecated.in favor ofeventStyleNameField
The name of the field used to overrideeventWindowStyle
for an individualCalendarEvent
. SeeCalendarEvent.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
Deprecated.in favor ofeventStyleNameField
The name of the field used to overrideeventWindowStyle
for an individualCalendarEvent
. SeeCalendarEvent.eventWindowStyle
.- Returns:
- Current eventWindowStyleField value. Default value is "eventWindowStyle"
- See Also:
-
setFirstDayOfWeek
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 popupDateChooser
.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
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 popupDateChooser
.If unset, the default is taken from the current locale.
- Returns:
- Current firstDayOfWeek value. Default value is null
-
setHeaderLevels
Configures the levels ofheaders
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: ForTimeline
s, configures the levels ofheaders
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
Configures the levels ofheaders
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
When set to true, hides anylane
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 updatinghideUnusedLanes
after creation.- Parameters:
hideUnusedLanes
- whether to hide unused lanes. Default value is null- Returns:
Calendar
instance, for chaining setter calls
-
getHideUnusedLanes
When set to true, hides anylane
that doesn't have any active events in the current dataset.- Returns:
- Current hideUnusedLanes value. Default value is null
-
setIncludeRangeCriteria
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
-
addCalendarEvent()