dojox.calendar
Legend: Array Boolean Constructor Date DomNode Error Function Namespace Number Object RegExp Singleton String

dojox.calendar.ViewBase

Object » dijit._WidgetBase » dojox.calendar.ViewBase

The dojox.calendar.ViewBase widget is the base of calendar view widgets.

dojox.calendar.StoreMixin

Property Summary

Method Summary

  • _autoScroll(gx, gy, orientation)
  • _computeItemEditingTimes(item, editKind, rendererKind, times, eventSource)
  • _computeVisibleItems(renderData) Computes the data items that are in the displayed interval.
  • _createItemEditEvent()
  • _createRenderData() Creates the object that contains all the data needed to render this widget.
  • _createRenderer(item, kind, rendererClass, cssClass) Creates an item renderer of the specified kind. A renderer is an object with the "container" and "instance" properties.
  • _createStructure(rd) Creates the HTML structure (grid, place holders, headers, etc)
  • _defaultItemToRendererKindFunc(item)
  • _destroyRenderer(renderer) Destroys the item renderer.
  • _destroyRenderersByKind(kind)
  • _dispatchCalendarEvt(e, name)
  • _doEndItemEditing(obj, eventSource)
  • _endItemEditing(eventSource, canceled) Leaves the item editing mode. item: Object The item that was edited.
  • _endItemEditingGesture(eventSource, e)
  • _ensureItemInView(item) If needed, moves the item to be entirely in view.
  • _findRenderItem(id, list)
  • _getFormatItemTimeFuncAttr()
  • _getSelectedItemAttr(value)
  • _getSelectedItemsAttr()
  • _getSelectionModeAttr(value)
  • _getStartEndRenderers(item) Returns an array that contains the first and last renderers of an item that are currently displayed. They could be the same renderer if only one renderer is used.
  • _getStoreAttr()
  • _initItems(items)
  • _isItemInView(item) Computes whether the specified item is entirely in the view or not.
  • _itemToRendererKind(item) returns String Associates a kind of renderer with a data item.
  • _layoutInterval(renderData, index, start, end, items) For each item in the items list: retrieve a renderer, compute its location and size and add it to the DOM.
  • _layoutPass1(layoutItem, lanes) First pass of the overlap layout. Find a lane where the item can be placed or create a new one.
  • _layoutRenderers(renderData) Renders the data items. This method will call the _layoutInterval() method.
  • _moveOrResizeItemGesture(dates, eventSource, e) Moves or resizes an item.
  • _onGridClick(e)
  • _onGridDoubleClick(e)
  • _onGridMouseDown(e)
  • _onGridMouseUp(e)
  • _onGridTouchEnd(e)
  • _onGridTouchMove(e)
  • _onGridTouchStart(e)
  • _onItemClick(e)
  • _onItemDoubleClick(e)
  • _onItemEditBegin(e)
  • _onItemEditBeginGesture(e)
  • _onItemEditEnd(e)
  • _onItemEditEndGesture(e)
  • _onItemEditMoveGesture(e)
  • _onItemEditResizeGesture(e)
  • _onRenderersLayoutDone(view)
  • _onScrollTimer_tick(pos)
  • _recycleItemRenderers(remove)
  • _recycleRenderer(renderer, remove) Recycles the item renderer to be reused in the future.
  • _refreshItemsRendering(renderData)
  • _setEditingProperties(props) Registers the editing properties used by the editing functions. This method should only be called by editing interaction mixins like Mouse, Keyboard and Touch.
  • _setHoveredItem(item, renderer)
  • _setItemsAttr(value)
  • _setSelectedItemAttr(value)
  • _setSelectedItemsAttr(value)
  • _setSelectionModeAttr(value)
  • _setStoreAttr(value)
  • _setText(node, text, allowHTML) Creates a text node under the parent node after having removed children nodes if any.
  • _sortItemsFunction(a, b)
  • _startAutoScroll(step)
  • _startItemEditing(item, eventSource) Configures the component, renderers to start one (mouse) of several (touch, keyboard) editing gestures.
  • _startItemEditingGesture(dates, editKind, eventSource, e) Starts the editing gesture. date: Date[] The reference dates (at least one).
  • _stopAutoScroll()
  • _updateEditingCapabilities(item, renderer)
  • _updateItems(object, previousIndex, newIndex)
  • _validateProperties() Validates the widget properties before the rendering pass. tags protected
  • _waDojoxAddIssue(d, unit, steps) Workaround an issue of dojox.date.XXXXX.date.add() function that does not support the subtraction of time correctly (normalization issues).
  • applyRendererZIndex(item, renderer, hovered, selected, edited, focused) Applies the z-index to the renderer based on the state of the item. This methods is setting a z-index of 20 is the item is selected or edited and the current lane value computed by the overlap layout (i.e. the renderers are stacked according to their lane).
  • computeOverlapping(layoutItems, func) Computes the overlap layout of a list of items. A lane and extent properties are added to each layout item.
  • computeProjectionOnDate(renderData, refDate, date, max) Computes the time to pixel projection in a day.
  • computeRangeOverlap(renderData, start1, end1, start2, end2, includeLimits) Computes the overlap time range of the time ranges. Returns a vector of Date with at index 0 the start time and at index 1 the end time.
  • constructor(args)
  • cssClassFunc() Optional function that returns a css class name to apply to item renderers that are displaying the specified item in parameter.
  • decodeDate() An optional function to transform store date into Date objects. Default is null.
  • destroy(preserveDom)
  • encodeDate() An optional function to transform Date objects into store date. Default is null.
  • ensureMinimalDuration(renderData, item, unit, steps, editKind) During the resize editing gesture, ensures that the item has the specified minimal duration.
  • ensureVisibility(start, end, margin, visibilityTarget, duration) Scrolls the view if the [start, end] time range is not visible or only partially visible.
  • floorDate(date, unit, steps, reuse) floors the date to the unit.
  • floorToDay(date, reuse) Floors the specified date to the start of day.
  • floorToMonth(date, reuse) Floors the specified date to the start of the date's month.
  • getIdentity(item)
  • getRenderers(item) Returns the renderers that are currently used to displayed the speficied item. Returns an array of objects that contains two properties: container: The DOM node that contains the renderer. renderer: The dojox.calendar._RendererMixin instance. Do not keep references on the renderers are they are recycled and reused for other items.
  • getTime(e, x, y, touchIndex) Returns the time displayed at the specified point by this component.
  • getWeekNumberLabel(date) Returns the week number string from dojo.date.locale.format() method as dojox.date.XXXX calendar are not supporting the "w" pattern.
  • invalidateLayout() trigger a re-layout of the renderers.
  • isAscendantHasClass(node, ancestor, className) Determines if a node has an ascendant node that has the css class specified.
  • isItemBeingEdited(item) Returns whether an item is being edited or not.
  • isItemEditable(item, rendererKind) Computes whether particular item renderer can be edited or not. By default it is using the editable property value.
  • isItemFocused(item) Returns whether the specified item is focused or not.
  • isItemHovered(item) Returns whether the specified item is hovered or not.
  • isItemMoveEnabled(item, rendererKind) Computes whether particular item renderer can be moved. By default it is using the moveEnabled property value.
  • isItemResizeEnabled(item, rendererKind) Computes whether particular item renderer can be resized. By default it is using the resizedEnabled property value.
  • isItemSelected(item)
  • isOverlapping(renderData, start1, end1, start2, end2, includeLimits) Computes if the first time range defined by the start1 and end1 parameters is overlapping the second time range defined by the start2 and end2 parameters.
  • isSameDay(date1, date2) Tests if the specified dates are in the same day.
  • isStartOfDay(d) Tests if the specified date represents the starts of day.
  • isToday(date) Returns whether the specified date is in the current day.
  • isWeekEnd(date) Determines whether the specified date is a week-end. This method is using dojo.date.locale.isWeekend() method as dojox.date.XXXX calendars are not supporting this method.
  • itemToRenderItem(item, store) Creates the render item based on the dojo.store item. It must be of the form: { id: Object, startTime: Date, endTime: Date, summary: String } By default it is building an object using the store id, the summaryAttr, startTimeAttr and endTimeAttr properties as well as decodeDate property if not null. Other fields or way to query fields can be used if needed.
  • itemToRendererKindFunc() An optional function to associate a kind of renderer ("horizontal", "label" or null) with the specified item. By default, if an item is lasting more that 24 hours an horizontal item is used, otherwise a label is used.
  • layoutPriorityFunction() An optional comparison function use to determine the order the item will be laid out The function is used to sort an array and must, as any sorting function, take two items as argument and must return an integer whose sign define order between arguments. By default, a comparison by start time then end time is used.
  • newDate(obj) Creates a new Date object.
  • renderItemToItem(renderItem, store) Create a store item based on the render item. It must be of the form: { id: Object startTime: Date, endTime: Date, summary: String } By default it is building an object using the summaryAttr, startTimeAttr and endTimeAttr properties and decodeDate property if not null.
  • resize()
  • scrollView(dir) If the view is scrollable, scrolls it to the specified direction.
  • selectFromEvent(e, item, renderer, dispatch)
  • setItemSelected(item, value)
  • updateRenderers(obj, stateOnly) Updates all the renderers that represents the specified item(s).

Event Summary

Attached Objects

Properties

_edProps
Overrides dijit._WidgetBase
_gridProps
Overrides dijit._WidgetBase
_scrollProps
Overrides dijit._WidgetBase
renderData
Overrides dijit._WidgetBase

Methods

_autoScroll
Overrides dijit._WidgetBase
ParameterTypeDescription
gx
gy
orientation
_computeItemEditingTimes
Overrides dijit._WidgetBase
ParameterTypeDescription
item
editKind
rendererKind
times
eventSource
_computeVisibleItems
Defined by dojox.calendar.StoreMixin
Computes the data items that are in the displayed interval.
ParameterTypeDescription
renderDataObjectThe renderData that contains the start and end time of the displayed interval.
_createItemEditEvent
Overrides dijit._WidgetBase
_createRenderData
Overrides dijit._WidgetBase
Creates the object that contains all the data needed to render this widget.
_createRenderer
Overrides dijit._WidgetBase
Object tags protected
Creates an item renderer of the specified kind. A renderer is an object with the "container" and "instance" properties.
ParameterTypeDescription
itemObjectThe data item.
kindStringThe kind of renderer.
rendererClassObjectThe class to instanciate to create the renderer.
cssClass
_createStructure
Overrides dijit._WidgetBase
Creates the HTML structure (grid, place holders, headers, etc)
ParameterTypeDescription
rdObject
_defaultItemToRendererKindFunc
Overrides dijit._WidgetBase
ParameterTypeDescription
item
_destroyRenderer
Overrides dijit._WidgetBase
Destroys the item renderer.
ParameterTypeDescription
rendererdojox.calendar._RendererMixinThe item renderer to destroy. tags protected
_destroyRenderersByKind
Overrides dijit._WidgetBase
ParameterTypeDescription
kind
_dispatchCalendarEvt
Overrides dijit._WidgetBase
ParameterTypeDescription
e
name
_doEndItemEditing
Overrides dijit._WidgetBase
ParameterTypeDescription
obj
eventSource
_endItemEditing
Overrides dijit._WidgetBase
Leaves the item editing mode. item: Object The item that was edited.
ParameterTypeDescription
eventSourceString"mouse", "keyboard", "touch"
canceledBoolean
_endItemEditingGesture
Overrides dijit._WidgetBase
ParameterTypeDescription
eventSourceString
eEvent
_ensureItemInView
Overrides dijit._WidgetBase
Boolean Whether the item has been moved to be in view or not.
If needed, moves the item to be entirely in view.
ParameterTypeDescription
itemObjectThe item to test
_findRenderItem
Overrides dijit._WidgetBase
ParameterTypeDescription
id
list
_getFormatItemTimeFuncAttr
Overrides dijit._WidgetBase
_getSelectedItemAttr
Overrides dijit._WidgetBase
ParameterTypeDescription
value
_getSelectedItemsAttr
Overrides dijit._WidgetBase
_getSelectionModeAttr
Overrides dijit._WidgetBase
ParameterTypeDescription
value
_getStartEndRenderers
Overrides dijit._WidgetBase
Returns an array that contains the first and last renderers of an item that are currently displayed. They could be the same renderer if only one renderer is used.
ParameterTypeDescription
itemObjectThe render item. retunrs: Object[]
_getStoreAttr
Overrides dijit._WidgetBase
_initItems
Defined by dojox.calendar.StoreMixin
ParameterTypeDescription
items
_isItemInView
Overrides dijit._WidgetBase
Boolean
Computes whether the specified item is entirely in the view or not.
ParameterTypeDescription
itemObjectThe item to test
_itemToRendererKind
Overrides dijit._WidgetBase
Returns String: String tags protected
Associates a kind of renderer with a data item.
ParameterTypeDescription
itemObjectThe data item.
_layoutInterval
Overrides dijit._WidgetBase
For each item in the items list: retrieve a renderer, compute its location and size and add it to the DOM.
ParameterTypeDescription
renderDataObjectThe render data.
indexIntegerThe index of the interval.
startDateThe start time of the displayed date interval.
endDateThe end time of the displayed date interval.
itemsObject[]The list of the items to represent. tags protected
_layoutPass1
Overrides dijit._WidgetBase
First pass of the overlap layout. Find a lane where the item can be placed or create a new one.
ParameterTypeDescription
layoutItemObjectAn object that contains a start and end properties at least.
lanesThearray of lanes. tags private
_layoutRenderers
Overrides dijit._WidgetBase
Renders the data items. This method will call the _layoutInterval() method.
ParameterTypeDescription
renderDataObjectThe render data. tags protected
_moveOrResizeItemGesture
Overrides dijit._WidgetBase
Moves or resizes an item.
ParameterTypeDescription
datesDate[]The reference dates. editKind: String Kind of edit: "resizeStart", "resizeEnd", "resizeBoth" or "move".
eventSourceString"mouse", "keyboard", "touch"
eEventThe event at the origin of the editing gesture.
_onGridClick
Overrides dijit._WidgetBase
ParameterTypeDescription
e
_onGridDoubleClick
Overrides dijit._WidgetBase
ParameterTypeDescription
e
_onGridMouseDown
Overrides dijit._WidgetBase
ParameterTypeDescription
e
_onGridMouseUp
Overrides dijit._WidgetBase
ParameterTypeDescription
e
_onGridTouchEnd
Overrides dijit._WidgetBase
ParameterTypeDescription
e
_onGridTouchMove
Overrides dijit._WidgetBase
ParameterTypeDescription
e
_onGridTouchStart
Overrides dijit._WidgetBase
ParameterTypeDescription
e
_onItemClick
Overrides dijit._WidgetBase
ParameterTypeDescription
e
_onItemDoubleClick
Overrides dijit._WidgetBase
ParameterTypeDescription
e
_onItemEditBegin
Overrides dijit._WidgetBase
ParameterTypeDescription
e
_onItemEditBeginGesture
Overrides dijit._WidgetBase
ParameterTypeDescription
e
_onItemEditEnd
Overrides dijit._WidgetBase
ParameterTypeDescription
e
_onItemEditEndGesture
Overrides dijit._WidgetBase
ParameterTypeDescription
e
_onItemEditMoveGesture
Overrides dijit._WidgetBase
ParameterTypeDescription
e
_onItemEditResizeGesture
Overrides dijit._WidgetBase
ParameterTypeDescription
e
_onRenderersLayoutDone
Overrides dijit._WidgetBase
ParameterTypeDescription
view
_onScrollTimer_tick
Overrides dijit._WidgetBase
ParameterTypeDescription
pos
_recycleItemRenderers
Overrides dijit._WidgetBase
ParameterTypeDescription
remove
_recycleRenderer
Overrides dijit._WidgetBase
Recycles the item renderer to be reused in the future.
ParameterTypeDescription
rendererdojox.calendar._RendererMixinThe item renderer to recycle. tags protected
remove
_refreshItemsRendering
Overrides dijit._WidgetBase, dojox.calendar.StoreMixin
ParameterTypeDescription
renderData
_setEditingProperties
Overrides dijit._WidgetBase
Registers the editing properties used by the editing functions. This method should only be called by editing interaction mixins like Mouse, Keyboard and Touch.
ParameterTypeDescription
props
_setHoveredItem
Overrides dijit._WidgetBase
ParameterTypeDescription
item
renderer
_setItemsAttr
Overrides dijit._WidgetBase
ParameterTypeDescription
value
_setSelectedItemAttr
Overrides dijit._WidgetBase
ParameterTypeDescription
value
_setSelectedItemsAttr
Overrides dijit._WidgetBase
ParameterTypeDescription
value
_setSelectionModeAttr
Overrides dijit._WidgetBase
ParameterTypeDescription
value
_setStoreAttr
Defined by dojox.calendar.StoreMixin
ParameterTypeDescription
value
_setText
Overrides dijit._WidgetBase
Creates a text node under the parent node after having removed children nodes if any.
ParameterTypeDescription
nodeNodeThe node that will contain the text node.
textStringThe text to set to the text node.
allowHTML
_sortItemsFunction
Overrides dijit._WidgetBase
ParameterTypeDescription
a
b
_startAutoScroll
Overrides dijit._WidgetBase
ParameterTypeDescription
step
_startItemEditing
Overrides dijit._WidgetBase
Configures the component, renderers to start one (mouse) of several (touch, keyboard) editing gestures.
ParameterTypeDescription
itemObjectThe item that will be edited.
eventSourceString"mouse", "keyboard", "touch"
_startItemEditingGesture
Overrides dijit._WidgetBase
Starts the editing gesture. date: Date[] The reference dates (at least one).
ParameterTypeDescription
dates
editKindStringKind of edit: "resizeBoth", "resizeStart", "resizeEnd" or "move".
eventSourceString"mouse", "keyboard", "touch"
eEventThe event at the origin of the editing gesture.
_stopAutoScroll
Overrides dijit._WidgetBase
_updateEditingCapabilities
Overrides dijit._WidgetBase
ParameterTypeDescription
item
renderer
_updateItems
Defined by dojox.calendar.StoreMixin
ParameterTypeDescription
object
previousIndex
newIndex
_validateProperties
Overrides dijit._WidgetBase
Validates the widget properties before the rendering pass. tags protected
_waDojoxAddIssue
Overrides dijit._WidgetBase
Workaround an issue of dojox.date.XXXXX.date.add() function that does not support the subtraction of time correctly (normalization issues).
ParameterTypeDescription
d
unit
steps
applyRendererZIndex
Overrides dijit._WidgetBase
Applies the z-index to the renderer based on the state of the item. This methods is setting a z-index of 20 is the item is selected or edited and the current lane value computed by the overlap layout (i.e. the renderers are stacked according to their lane).
ParameterTypeDescription
itemObjectThe render item.
rendererObjectA renderer associated with the render item.
hoveredBooleanWhether the item is hovered or not.
selectedBooleanWhether the item is selected or not.
editedBooleanWhether the item is being edited not not.
focusedBooleanWhether the item is focused not not.
computeOverlapping
Overrides dijit._WidgetBase
Object
Computes the overlap layout of a list of items. A lane and extent properties are added to each layout item.
ParameterTypeDescription
layoutItemsObject[]List of layout items, each item must have a start and end properties. addedPass: Function Whether computes the extent of each item renderer on free sibling lanes.
func
computeProjectionOnDate
Overrides dijit._WidgetBase
Number
Computes the time to pixel projection in a day.
ParameterTypeDescription
renderDataObjectThe render data.
refDateDateThe reference date that defines the destination date.
dateDateThe date to project.
maxIntegerThe size in pixels of the representation of a day.
computeRangeOverlap
Overrides dijit._WidgetBase
Date[]
Computes the overlap time range of the time ranges. Returns a vector of Date with at index 0 the start time and at index 1 the end time.
ParameterTypeDescription
renderDataObject.The render data.
start1DateThe start time of the first time range.
end1DateThe end time of the first time range.
start2DateThe start time of the second time range.
end2DateThe end time of the second time range.
includeLimitsBooleanWhether include the end time or not.
constructor
Overrides dijit._WidgetBase
ParameterTypeDescription
argsObject
cssClassFunc
Defined by dojox.calendar.StoreMixin
Optional function that returns a css class name to apply to item renderers that are displaying the specified item in parameter.
decodeDate
Defined by dojox.calendar.StoreMixin
An optional function to transform store date into Date objects. Default is null.
destroy
Overrides dijit._WidgetBase
ParameterTypeDescription
preserveDom
encodeDate
Defined by dojox.calendar.StoreMixin
An optional function to transform Date objects into store date. Default is null.
ensureMinimalDuration
Overrides dijit._WidgetBase
During the resize editing gesture, ensures that the item has the specified minimal duration.
ParameterTypeDescription
renderDataObjectThe render data.
itemObjectThe edited item.
unitStringThe unit used to define the minimal duration.
stepsIntegerThe number of time units.
editKindStringThe edit kind: "resizeStart" or "resizeEnd".
ensureVisibility
Overrides dijit._WidgetBase
Scrolls the view if the [start, end] time range is not visible or only partially visible.
ParameterTypeDescription
startDateStart time of the range of interest.
endDateEnd time of the range of interest.
marginintMargin in minutes around the time range.
visibilityTargetStringThe end(s) of the time range to make visible. Valid values are: "start", "end", "both".
durationNumberOptional, the maximum duration of the scroll animation.
floorDate
Overrides dijit._WidgetBase
Date
floors the date to the unit.
ParameterTypeDescription
dateDateThe date/time to floor.
unitStringThe unit. Valid values are "minute", "hour", "day".
stepsIntegerFor "day" only 1 is valid.
reuseBooleanWhether use the specified instance or create a new one. Default is false.
floorToDay
Overrides dijit._WidgetBase
Date
Floors the specified date to the start of day.
ParameterTypeDescription
dateDateThe date to floor.
reuseBooleanWhether use the specified instance or create a new one. Default is false.
floorToMonth
Overrides dijit._WidgetBase
Date
Floors the specified date to the start of the date's month.
ParameterTypeDescription
dateDateThe date to floor.
reuseBooleanWhether use the specified instance or create a new one. Default is false.
getIdentity
Overrides dijit._WidgetBase
ParameterTypeDescription
item
getRenderers
Overrides dijit._WidgetBase
Object[]
Returns the renderers that are currently used to displayed the speficied item. Returns an array of objects that contains two properties: container: The DOM node that contains the renderer. renderer: The dojox.calendar._RendererMixin instance. Do not keep references on the renderers are they are recycled and reused for other items.
ParameterTypeDescription
itemObjectThe data or render item.
getTime
Overrides dijit._WidgetBase
Date
Returns the time displayed at the specified point by this component.
ParameterTypeDescription
eEventOptional mouse event.
xNumberPosition along the x-axis with respect to the sheet container used if event is not defined.
yNumberPosition along the y-axis with respect to the sheet container (scroll included) used if event is not defined.
touchIndexIntegerIf parameter 'e' is not null and a touch event, the index of the touch to use.
getWeekNumberLabel
Overrides dijit._WidgetBase
Returns the week number string from dojo.date.locale.format() method as dojox.date.XXXX calendar are not supporting the "w" pattern.
ParameterTypeDescription
dateDateThe date to format.
invalidateLayout
Overrides dijit._WidgetBase
trigger a re-layout of the renderers.
isAscendantHasClass
Overrides dijit._WidgetBase
Boolean
Determines if a node has an ascendant node that has the css class specified.
ParameterTypeDescription
nodeNodeThe DOM node.
ancestorNodeThe ancestor node used to limit the search in hierarchy.
classNameStringThe css class name.
isItemBeingEdited
Overrides dijit._WidgetBase
Boolean
Returns whether an item is being edited or not.
ParameterTypeDescription
itemObjectThe item to test.
isItemEditable
Overrides dijit._WidgetBase
Boolean
Computes whether particular item renderer can be edited or not. By default it is using the editable property value.
ParameterTypeDescription
itemObjectThe item represented by the renderer.
rendererKindStringThe kind of renderer.
isItemFocused
Overrides dijit._WidgetBase
Boolean
Returns whether the specified item is focused or not.
ParameterTypeDescription
itemObjectThe item.
isItemHovered
Overrides dijit._WidgetBase
Boolean
Returns whether the specified item is hovered or not.
ParameterTypeDescription
itemObjectThe item.
isItemMoveEnabled
Overrides dijit._WidgetBase
Boolean
Computes whether particular item renderer can be moved. By default it is using the moveEnabled property value.
ParameterTypeDescription
itemObjectThe item represented by the renderer.
rendererKindStringThe kind of renderer.
isItemResizeEnabled
Overrides dijit._WidgetBase
Boolean
Computes whether particular item renderer can be resized. By default it is using the resizedEnabled property value.
ParameterTypeDescription
itemObjectThe item represented by the renderer.
rendererKindStringThe kind of renderer.
isItemSelected
Overrides dijit._WidgetBase
ParameterTypeDescription
item
isOverlapping
Overrides dijit._WidgetBase
Boolean
Computes if the first time range defined by the start1 and end1 parameters is overlapping the second time range defined by the start2 and end2 parameters.
ParameterTypeDescription
renderDataObjectThe render data.
start1DateThe start time of the first time range.
end1DateThe end time of the first time range.
start2DateThe start time of the second time range.
end2DateThe end time of the second time range.
includeLimitsBooleanWhether include the end time or not.
isSameDay
Overrides dijit._WidgetBase
Boolean
Tests if the specified dates are in the same day.
ParameterTypeDescription
date1DateThe first date.
date2DateThe second date.
isStartOfDay
Overrides dijit._WidgetBase
Boolean
Tests if the specified date represents the starts of day.
ParameterTypeDescription
dDateThe date to test.
isToday
Overrides dijit._WidgetBase
Boolean
Returns whether the specified date is in the current day.
ParameterTypeDescription
dateDateThe date to test. renderData: Object The current renderData
isWeekEnd
Overrides dijit._WidgetBase
Determines whether the specified date is a week-end. This method is using dojo.date.locale.isWeekend() method as dojox.date.XXXX calendars are not supporting this method.
ParameterTypeDescription
dateDateThe date to test.
itemToRenderItem
Defined by dojox.calendar.StoreMixin
Object
Creates the render item based on the dojo.store item. It must be of the form: { id: Object, startTime: Date, endTime: Date, summary: String } By default it is building an object using the store id, the summaryAttr, startTimeAttr and endTimeAttr properties as well as decodeDate property if not null. Other fields or way to query fields can be used if needed.
ParameterTypeDescription
itemObjectThe store item.
storedojo.store.api.StoreThe store.
itemToRendererKindFunc
Overrides dijit._WidgetBase
An optional function to associate a kind of renderer ("horizontal", "label" or null) with the specified item. By default, if an item is lasting more that 24 hours an horizontal item is used, otherwise a label is used.
layoutPriorityFunction
Overrides dijit._WidgetBase
An optional comparison function use to determine the order the item will be laid out The function is used to sort an array and must, as any sorting function, take two items as argument and must return an integer whose sign define order between arguments. By default, a comparison by start time then end time is used.
newDate
Overrides dijit._WidgetBase
Date
Creates a new Date object.
ParameterTypeDescription
objObjectThis object can have several values: the time in milliseconds since gregorian epoch. a Date instance
renderItemToItem
Defined by dojox.calendar.StoreMixin
Object
Create a store item based on the render item. It must be of the form: { id: Object startTime: Date, endTime: Date, summary: String } By default it is building an object using the summaryAttr, startTimeAttr and endTimeAttr properties and decodeDate property if not null.
ParameterTypeDescription
renderItemObjectThe render item.
storedojo.store.api.StoreThe store.
resize
Overrides dijit._WidgetBase
scrollView
Overrides dijit._WidgetBase
If the view is scrollable, scrolls it to the specified direction.
ParameterTypeDescription
dirIntegerDirection of the scroll. Valid values are -1 and 1.
selectFromEvent
Overrides dijit._WidgetBase
ParameterTypeDescription
e
item
renderer
dispatch
setItemSelected
Overrides dijit._WidgetBase
ParameterTypeDescription
item
value
updateRenderers
Overrides dijit._WidgetBase
Updates all the renderers that represents the specified item(s).
ParameterTypeDescription
objObjectA render item or an array of render items.
stateOnlyBooleanWhether only the state of the item has changed (selected, edited, edited, focused) or a more global change has occured.

Events

onGridClick
Overrides dijit._WidgetBase
Event dispatched when the grid has been clicked.
ParameterTypeDescription
e
onGridDoubleClick
Overrides dijit._WidgetBase
Event dispatched when the grid has been double-clicked.
ParameterTypeDescription
e
onItemClick
Overrides dijit._WidgetBase
Event dispatched when an item renderer has been clicked.
ParameterTypeDescription
e
onItemDoubleClick
Overrides dijit._WidgetBase
Event dispatched when an item renderer has been double-clicked.
ParameterTypeDescription
e
onItemEditBegin
Overrides dijit._WidgetBase
Event dispatched when the item is entering the editing mode.
ParameterTypeDescription
e
onItemEditBeginGesture
Overrides dijit._WidgetBase
Event dispatched when an editing gesture is beginning.
ParameterTypeDescription
e
onItemEditEnd
Overrides dijit._WidgetBase
Event dispatched when the item is leaving the editing mode.
ParameterTypeDescription
e
onItemEditEndGesture
Overrides dijit._WidgetBase
Event dispatched at the end of an editing gesture.
ParameterTypeDescription
e
onItemEditMoveGesture
Overrides dijit._WidgetBase
Event dispatched during a move editing gesture.
ParameterTypeDescription
e
onItemEditResizeGesture
Overrides dijit._WidgetBase
Event dispatched during a resize editing gesture.
ParameterTypeDescription
e
onRendererCreated
Overrides dijit._WidgetBase
Event dispatched when an item renderer has been created.
ParameterTypeDescription
renderer
onRendererDestroyed
Overrides dijit._WidgetBase
Event dispatched when an item renderer is destroyed.
ParameterTypeDescription
renderer
onRendererRecycled
Overrides dijit._WidgetBase
Event dispatched when an item renderer has been recycled.
ParameterTypeDescription
renderer
onRendererReused
Overrides dijit._WidgetBase
Event dispatched when an item renderer that was recycled is reused.
ParameterTypeDescription
renderer
onRenderersLayoutDone
Overrides dijit._WidgetBase
Event triggered when item renderers layout has been done.
ParameterTypeDescription
view