dojox/calendar/SimpleColumnView (version 1.10)

dojox/calendar/ViewBase, dijit/_TemplatedMixin

Summary

The simple column view is displaying a day per column. Each cell of a column is a time slot.

Usage

var foo = new SimpleColumnView();
dojox/calendar/SimpleColumnView

See the dojox/calendar/SimpleColumnView reference documentation for more information.

Property Summary

Method Summary

Event Summary

Properties

_attachEvents
Defined by: dijit/_AttachMixin

List of connections associated with data-dojo-attach-event=... in the template

_attachPoints
Defined by: dijit/_AttachMixin

List of widget attribute names associated with data-dojo-attach-point=... in the template, ex: ["containerNode", "labelNode"]

_attrPairNames
Defined by: dijit/_WidgetBase
_blankGif
Defined by: dijit/_WidgetBase

Path to a blank 1x1 image. Used by <img> nodes in templates that really get their image via CSS background-image.

_calendar
_columnHeaderHandlers
_cssDays
_DAY_IN_MILLISECONDS
_gridMouseDown
_hScrollNodes
_hscrollPos
_hScrollPos
_isEditing

Whether an item is being edited or not.

_layoutStep

The number of units displayed by a visual layout unit (i.e. a column or a row)

_layoutUnit
_rendered
Defined by: dijit/_TemplatedMixin

Not normally use, but this flag can be set by the app if the server has already rendered the template, i.e. already inlining the template for the widget into the main page. Reduces _TemplatedMixin to just function like _AttachMixin.

_scrollPos
_setClassAttr
Defined by: dijit/_WidgetBase
_setDirAttr
Defined by: dijit/_WidgetBase
_setIdAttr
Defined by: dijit/_WidgetBase
_setLangAttr
Defined by: dijit/_WidgetBase
_setTabIndexAttr
_setTypeAttr
Defined by: dijit/_WidgetBase
_showSecondarySheet
_skipNodeCache
Defined by: dijit/_TemplatedMixin
_started
Defined by: dijit/_WidgetBase

startup() has completed.

_tempIdCount
_tempItemsMap
_viewHandles
allDayAttr

The attribute of the store item that contains the all day state of the events represented by this item. Default is "allDay".

allowResizeLessThan24H
allowStartEndSwap
allowSubColumnMove

If several sub columns are displayed, indicated if the data item can be reassigned to another sub column by an editing gesture.

attachScope
Defined by: dijit/_AttachMixin

Object to which attach points and events will be scoped. Defaults to 'this'.

attributeMap
Defined by: dijit/_WidgetBase

Deprecated. Instead of attributeMap, widget should have a _setXXXAttr attribute for each XXX attribute to be mapped to the DOM.

attributeMap sets up a "binding" between attributes (aka properties) of the widget and the widget's DOM. Changes to widget attributes listed in attributeMap will be reflected into the DOM.

For example, calling set('title', 'hello') on a TitlePane will automatically cause the TitlePane's DOM to update with the new title.

attributeMap is a hash where the key is an attribute of the widget, and the value reflects a binding to a:

  • DOM node attribute

    focus: {node: "focusNode", type: "attribute"} Maps this.focus to this.focusNode.focus

  • DOM node innerHTML

    title: { node: "titleNode", type: "innerHTML" } Maps this.title to this.titleNode.innerHTML

  • DOM node innerText

    title: { node: "titleNode", type: "innerText" } Maps this.title to this.titleNode.innerText

  • DOM node CSS class

    myClass: { node: "domNode", type: "class" } Maps this.myClass to this.domNode.className

If the value is an array, then each element in the array matches one of the formats of the above list.

There are also some shorthands for backwards compatibility:

  • string --> { node: string, type: "attribute" }, for example:
"focusNode" ---> { node: "focusNode", type: "attribute" }
  • "" --> { node: "domNode", type: "attribute" }
autoScroll

Indicates whether the view can be scrolled automatically. Auto scrolling is used when moving focus to a non visible renderer using keyboard and while editing an item.

baseClass
class
Defined by: dijit/_WidgetBase
columnCount

The number of column to display (from the startDate).

columnHeaderDatePattern

Custom date/time pattern for column header labels to override default one coming from the CLDR. See dojo/date/locale documentation for format string.

containerNode
Defined by: dijit/_WidgetBase

Designates where children of the source DOM node will be placed. "Children" in this case refers to both DOM nodes and widgets. For example, for myWidget:

<div data-dojo-type=myWidget>
    <b> here's a plain DOM node
    <span data-dojo-type=subWidget>and a widget</span>
    <i> and another plain DOM node </i>
</div>

containerNode would point to:

<b> here's a plain DOM node
<span data-dojo-type=subWidget>and a widget</span>
<i> and another plain DOM node </i>

In templated widgets, "containerNode" is set via a data-dojo-attach-point assignment.

containerNode must be defined for any widget that accepts innerHTML (like ContentPane or BorderContainer or even Button), and conversely is null for widgets that don't, like TextBox.

createOnGridClick

Indicates whether the user can create new event by clicking and dragging the grid. A createItem function must be defined on the view or the calendar object.

cssClassFunc

Optional function that returns a css class name to apply to item renderers that are displaying the specified item in parameter.

datePackage

JavaScript namespace to find Calendar routines. Uses Gregorian Calendar routines at dojo.date by default.

decodeDate

An optional function to transform store date into Date objects. Default is null.

dir
Defined by: dijit/_WidgetBase

Bi-directional support, as defined by the HTML DIR attribute. Either left-to-right "ltr" or right-to-left "rtl". If undefined, widgets renders in page's default direction.

displayedItemsInvalidated

Whether the data items displayed must be recomputed, usually after the displayed time range has changed.

domNode
Defined by: dijit/_WidgetBase

This is our visible representation of the widget! Other DOM Nodes may by assigned to other properties, usually through the template system's data-dojo-attach-point syntax, but the domNode property is the canonical "top level" node in widget UI.

doubleTapDelay

The maximum delay between two taps needed to trigger an "itemDoubleClick" event, in touch context.

editable

A flag that indicates whether or not the user can edit items in the data provider. If true, the item renderers in the control are editable. The user can click on an item renderer, or use the keyboard or touch devices, to move or resize the associated event.

encodeDate

An optional function to transform Date objects into store date. Default is null.

endTimeAttr

The attribute of the store item that contains the end time of the events represented by this item. Default is "endTime".

focused
Defined by: dijit/_FocusMixin

This widget or a widget it contains has focus, or is "active" because it was recently clicked.

formatItemTimeFunc

Optional function to format the time of day of the item renderers. The function takes the date, the render data object, the view and the data item as arguments and returns a String.

horizontalGap

The number of pixels between two item renderers that are overlapping each other if the percentOverlap property is 0.

hourSize

The desired size in pixels of an hour on the screen. Note that the effective size may be different as the time slot size must be an integer.

hoveredItem

The currently hovered data item.

id
Defined by: dijit/_WidgetBase

A unique, opaque ID string that can be assigned by users or by the system. If the developer passes an ID which is known not to be unique, the specified ID is ignored and the system-generated ID is used instead.

invalidatingProperties
invalidRendering
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.

lang
Defined by: dijit/_WidgetBase

Rarely used. Overrides the default Dojo locale used to render this widget, as defined by the HTML LANG attribute. Value must be among the list of locales specified during by the Dojo bootstrap, formatted according to RFC 3066 (like en-us).

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.

liveLayout
maxHours

The maximum hour to be displayed. It must be in the [1,36] interval and must be greater than the minHours.

minColumnWidth

The minimum column width. If the number of columns and sub columns displayed makes the width of a column greater than this property, a horizontal scroll bar is displayed. If value <= 0, this constraint is ignored and the columns are using the available space.

minDurationSteps
minDurationUnit
minHours

The minimum hour to be displayed. It must be in the [0,23] interval and must be lower than the maxHours.

moveEnabled

A flag that indicates whether the user can move items displayed. If true, the user can move the items.

ownerDocument
Defined by: dijit/_WidgetBase

The document this widget belongs to. If not specified to constructor, will default to srcNodeRef.ownerDocument, or if no sourceRef specified, then to the document global

percentOverlap

The percentage of the renderer width used to superimpose one item renderer on another when two events are overlapping.

query

A query that can be passed to when querying the store.

queryOptions

Options to be applied when querying the store.

renderData

The render data is the object that contains all the properties needed to render the component.

resizeCursor

CSS value to apply to the cursor while resizing an item renderer.

resizeEnabled

A flag that indicates whether the items can be resized. If true, the control supports resizing of items.

rowHeaderFirstLabelOffset

Offset of the first row label from the top of the first row header cell in pixels.

rowHeaderGridSlotDuration

Duration of the time slot in minutes in the row header. Must be a divisor of 60 and a multiple/divisor of timeSlotDuration.

rowHeaderLabelOffset

Offset of the row label from the top of the row header cell in pixels.

rowHeaderLabelSlotDuration

Duration of the time slot in minutes in the row header labels. Must be a divisor of 60 and a multiple/divisor of timeSlotDuration.

rowHeaderTimePattern

Custom date/time pattern for the row header labels to override default one coming from the CLDR. See dojo/date/locale documentation for format string.

scrollable

Indicates whether the view can be scrolled or not.

scrollBarRTLPosition

Position of the scroll bar in right-to-left display. Valid values are "left" and "right", default value is "left".

scrollMethod

Method used to scroll the view, for example the scroll of column view. Valid value are:

  • "auto": let the view decide (default),
  • "css": use css 3d transform,
  • "dom": use the scrollTop property.
searchContainerNode
Defined by: dijit/_TemplatedMixin
selectedItem

In single selection mode, the selected item or in multiple selection mode the last selected item. Warning: Do not use this property directly, make sure to call set() or get() methods.

selectedItems

The list of selected items. Warning: Do not use this property directly, make sure to call set() or get() methods.

selectionMode

Valid values are:

  1. "none": No selection can be done.
  2. "single": Only one item can be selected at a time.
  3. "multiple": Several item can be selected using the control key modifier. Default value is "single".
showTimeIndicator

Whether show or not an indicator (default a red line) at the current time.

snapSteps
snapUnit
srcNodeRef
Defined by: dijit/_WidgetBase

pointer to original DOM node

startDate

The start date of the time interval displayed. If not set at initialization time, will be set to current day.

startTimeAttr

The attribute of the store item that contains the start time of the events represented by this item. Default is "startTime".

startTimeOfDay

First time (hour/minute) of day displayed, if reachable. An object containing "hours" and "minutes" properties.

stayInView
store

The store that contains the events to display.

style
Defined by: dijit/_WidgetBase

HTML style attributes as cssText string or name/value hash

styleGridCellFunc

Custom function to customize the appearance of a grid cell by installing custom CSS class on the node. The signature of the function must be the same then the styleGridCell one. By default the defaultStyleGridCell function is used.

subColumnAttr

The attribute of the store item that contains the sub column name of the events represented by this item. Default is "calendar".

subColumns
summaryAttr

The attribute of the store item that contains the summary of the events represented by this item. Default is "summary".

templatePath
Defined by: dijit/_TemplatedMixin

Path to template (HTML file) for this widget relative to dojo.baseUrl. Deprecated: use templateString with require([... "dojo/text!..."], ...) instead

templateString
timeIndicatorRefreshInterval

Maximal interval between two refreshes of time indicator, in milliseconds.

timeSlotDuration

Duration of the time slot in minutes. Must be a divisor of 60.

title
Defined by: dijit/_WidgetBase

HTML title attribute.

For form widgets this specifies a tooltip to display when hovering over the widget (just like the native HTML title attribute).

For TitlePane or for when this widget is a child of a TabContainer, AccordionContainer, etc., it's used to specify the tab label, accordion pane title, etc. In this case it's interpreted as HTML.

tooltip
Defined by: dijit/_WidgetBase

When this widget's title attribute is used to for a tab label, accordion pane title, etc., this specifies the tooltip to appear when the mouse is hovered over that text.

verticalDecorationRenderer

The class use to create decoration renderers.

verticalRenderer

The class use to create vertical renderers.

viewKind

Type of the view. Used by the calendar widget to determine how to configure the view. This view kind is "columns".

Methods

__fixEvt(e)
Parameter Type Description
e undefined
Returns:undefined
_addMinutesClasses(node,minutes)
Parameter Type Description
node undefined
minutes undefined
_applyAttributes()
Defined by dijit/_WidgetBase

Step during widget creation to copy widget attributes to the DOM according to attributeMap and _setXXXAttr objects, and also to call custom _setXXXAttr() methods.

Skips over blank/false attribute values, unless they were explicitly specified as parameters to the widget, since those are the default anyway, and setting tabIndex="" is different than not setting tabIndex at all.

For backwards-compatibility reasons attributeMap overrides _setXXXAttr when _setXXXAttr is a hash/string/array, but _setXXXAttr as a functions override attributeMap.

_attach(node,type,func)
Defined by dijit/_AttachMixin

Roughly corresponding to dojo/on, this is the default function for processing a data-dojo-attach-event. Meant to attach to DOMNodes, not to widgets.

Parameter Type Description
node DOMNode

The node to setup a listener on.

type String

Event name like "click".

func undefined
Returns:undefined
_attachTemplateNodes(rootNode)
Defined by dijit/_AttachMixin

Iterate through the dom nodes and attach functions and nodes accordingly.

Map widget properties and functions to the handlers specified in the dom node and it's descendants. This function iterates over all nodes and looks for these properties:

  • dojoAttachPoint/data-dojo-attach-point
  • dojoAttachEvent/data-dojo-attach-event
Parameter Type Description
rootNode DomNode

The node to search for properties. All descendants will be searched.

_attrToDom(attr,value,commands)
Defined by dijit/_WidgetBase

Reflect a widget attribute (title, tabIndex, duration etc.) to the widget DOM, as specified by commands parameter. If commands isn't specified then it's looked up from attributeMap. Note some attributes like "type" cannot be processed this way as they are not mutable.

Parameter Type Description
attr String

Name of member variable (ex: "focusNode" maps to this.focusNode) pointing to DOMNode inside the widget, or alternately pointing to a subwidget

value String
commands Object
Optional
_autoScroll(gx,gy,orientation)

Starts or stops the auto scroll according to the mouse cursor position during an item editing.

Parameter Type Description
gx Integer

The position of the mouse cursor along the x-axis.

gy Integer

The position of the mouse cursor along the y-axis.

orientation undefined
Returns:boolean
_beforeFillContent()
Defined by dijit/_AttachMixin
_buildColumnHeader(renderData,oldRenderData)

Creates incrementally the HTML structure of the column header and configures its content.

Parameter Type Description
renderData undefined

The render data to display.

oldRenderData undefined

The previously render data displayed, if any.

_buildGrid(renderData,oldRenderData)

Creates incrementally the HTML structure of the grid and configures its content.

Parameter Type Description
renderData undefined

The render data to display.

oldRenderData undefined

The previously render data displayed, if any.

_buildItemContainer(renderData,oldRenderData)

Creates the HTML structure of the item container and configures its content.

Parameter Type Description
renderData undefined

The render data to display.

oldRenderData undefined

The previously render data displayed, if any.

_buildRowHeader(renderData,oldRenderData)

Creates incrementally the HTML structure of the row header and configures its content.

Parameter Type Description
renderData undefined

The render data to display.

oldRenderData undefined

The previously render data displayed, if any.

_buildSubColumnHeader(renderData,oldRenderData)

Creates incrementally the HTML structure of the column header and configures its content.

Parameter Type Description
renderData undefined

The render data to display.

oldRenderData undefined

The previously render data displayed, if any.

_changeAttrValue(name,value)
Defined by dojo/Stateful

Internal helper for directly changing an attribute value.

Directly change the value of an attribute on an object, bypassing any accessor setter. Also handles the calling of watch and emitting events. It is designed to be used by descendant class when there are two values of attributes that are linked, but calling .set() is not appropriate.

Parameter Type Description
name String

The property to set.

value Mixed

The value to set in the property.

Returns:function

Internal helper for directly changing an attribute value.

_cleanItemStoreState(id)
Parameter Type Description
id undefined
_cleanupColumnHeader()
_columnHeaderClick(e)
Parameter Type Description
e undefined
_commitProperties(renderData)
Parameter Type Description
renderData undefined
_computeItemEditingTimes(item,editKind,rendererKind,times,eventSource)
Parameter Type Description
item undefined
editKind String

Kind of edit: "resizeStart", "resizeEnd", "resizeBoth" or "move".

rendererKind undefined
times undefined
eventSource undefined
Returns:undefined
_computeVisibleItems(renderData)

Computes the data items that are in the displayed interval.

Parameter Type Description
renderData Object

The renderData that contains the start and end time of the displayed interval.

Returns:undefined
_configureHScrollDomNodes(styleWidth)
Parameter Type Description
styleWidth undefined
_configureRowHeaderLabel(node,d,index,pos,renderData)

Configures the label of a row header cell.

Parameter Type Description
node DOMNode

The DOM node that is the parent of the label.

d Date

A date object that contains the hours and minutes displayed by this row header cell.

index Integer

The index of this row header cell

pos Integer

The computed position of the row header cell

renderData Object

The render data.

_configureScrollBar(renderData)

Sets the scroll bar size and position.

Parameter Type Description
renderData Object

The render data.

_configureVisibleParts(renderData)
Parameter Type Description
renderData undefined
_createItemEditEvent()
Returns:object
_createRenderData()
Returns:object
_createRenderer(item,kind,rendererClass,cssClass)

Creates an item renderer of the specified kind. A renderer is an object with the "container" and "instance" properties.

Parameter Type Description
item Object

The data item.

kind String

The kind of renderer.

rendererClass Object

The class to instantiate to create the renderer.

cssClass undefined
Returns:Object | undefined
_createRendering(renderData,oldRenderData)
Parameter Type Description
renderData Object
oldRenderData Object
_defaultItemToRendererKindFunc(item)
Parameter Type Description
item undefined
Returns:string
_destroyRenderer(renderer)

Destroys the item renderer.

Parameter Type Description
renderer dojox/calendar/_RendererMixin

The item renderer to destroy.

_destroyRenderersByKind(kind)
Parameter Type Description
kind undefined
_detachTemplateNodes()
Defined by dijit/_AttachMixin

Detach and clean up the attachments made in _attachtempalteNodes.

_dispatchCalendarEvt(e,name)

Adds view properties to event and enable bubbling at owner level.

Parameter Type Description
e Event

The dispatched event.

name String

The event name.

Returns:undefined
_doEndItemEditing(obj,eventSource)
Parameter Type Description
obj undefined
eventSource undefined
_endItemEditing(eventSource,canceled)

Leaves the item editing mode.

Parameter Type Description
eventSource String

"mouse", "keyboard", "touch"

canceled Boolean
_endItemEditingGesture(eventSource,e)
Parameter Type Description
eventSource String
e Event
_ensureItemInView(item)
Parameter Type Description
item undefined
Returns:boolean
_escapeValue(val)

Escape a value to be inserted into the template, either into an attribute value (ex: foo="${bar}") or as inner text of an element (ex: ${foo})

Parameter Type Description
val String
Returns:undefined
_fillContent(source)

Relocate source contents to templated container node. this.containerNode must be able to receive children, or exceptions will be thrown.

Parameter Type Description
source DomNode
_findRenderItem(id,list)
Parameter Type Description
id undefined
list undefined
Returns:undefined | null
_formatColumnHeaderLabel(d)

Computes the column header label for the specified date. By default a formatter is used, optionally the columnHeaderDatePattern property can be used to set a custom date pattern to the formatter.

Parameter Type Description
d Date

The date to format

Returns:undefined
_formatRowHeaderLabel(d)

Computes the row header label for the specified time of day. By default a formatter is used, optionally the rowHeaderTimePattern property can be used to set a custom time pattern to the formatter.

Parameter Type Description
d Date

The date to format

Returns:undefined
_get(name)
Defined by dijit/_WidgetBase

Helper function to get value for specified property stored by this._set(), i.e. for properties with custom setters. Used mainly by custom getters.

For example, CheckBox._getValueAttr() calls this._get("value").

Parameter Type Description
name String
Returns:undefined
_getAttrNames(name)
Defined by dijit/_WidgetBase

Helper function for get() and set(). Caches attribute name values so we don't do the string ops every time.

Parameter Type Description
name undefined
Returns:undefined | object
_getColumn(renderData,index,subIndex,itemsType)
Parameter Type Description
renderData undefined
index undefined
subIndex undefined
itemsType undefined
Returns:undefined
_getCreateItemFuncAttr()
Returns:undefined
_getCreateOnGridClickAttr()
Returns:undefined
_getDecorationStoreAttr()
Returns:undefined
_getEndTimeOfDay()

Returns the visible last time of day.

Returns:Integer[] | object
_getFormatItemTimeFuncAttr()
Returns:undefined
_getHScrollPosition()

Returns the horizontal scroll position (if the view is scrollable), using the scroll method defined.

Returns:undefined
_getItemStoreStateObj(item)
Parameter Type Description
item Object
Returns:undefined
_getNormalizedCoords(e,x,y,touchIndex)
Parameter Type Description
e undefined
x undefined
y undefined
touchIndex undefined
Returns:object
_getScrollPosition()

Returns the vertical scroll position (if the view is scrollable), using the scroll method defined.

Returns:undefined
_getSelectedItemAttr(value)
Parameter Type Description
value undefined
Returns:undefined
_getSelectedItemsAttr()
Returns:undefined
_getSelectionModeAttr(value)
Parameter Type Description
value undefined
Returns:undefined
_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.

Parameter Type Description
item Object

The render item.

Returns:Object[] | null | Array
_getStartTimeOfDay()

Returns the visible first time of day.

Returns:Object | object
_getStartTimeOfDayAttr()
Returns:undefined
_getStoreAttr()
Returns:undefined
_getTopOwner()

Returns the top owner: the calendar or the parent view.

Returns:undefined
_hscrollBar_onScroll(value)
Parameter Type Description
value undefined
_initItems(items)
Parameter Type Description
items undefined
Returns:undefined
_introspect()
Defined by dijit/_WidgetBase

Collect metadata about this widget (only once per class, not once per instance):

- list of attributes with custom setters, storing in this.constructor._setterAttrs
- generate this.constructor._onMap, mapping names like "mousedown" to functions like onMouseDown
_isItemInView(item)
Parameter Type Description
item undefined
Returns:boolean | undefined
_itemToRendererKind(item)

Associates a kind of renderer with a data item.

Parameter Type Description
item Object

The data item.

Returns:String | undefined
_layoutDecorationRenderers(renderData)
Parameter Type Description
renderData undefined
_layoutInterval(renderData,index,start,end,items,itemsType)
Parameter Type Description
renderData Object
index Integer
start Date
end Date
items Object[]
itemsType String
_layoutPass1(layoutItem,lanes)

First pass of the overlap layout. Find a lane where the item can be placed or create a new one.

Parameter Type Description
layoutItem Object

An object that contains a start and end properties at least.

lanes undefined

The array of lanes.

_layoutRenderers(renderData)
Parameter Type Description
renderData undefined
_layoutRenderersImpl(renderData,rendererManager,items,itemType)

Renders the data items. This method will call the _layoutInterval() method.

Parameter Type Description
renderData Object

The render data.

rendererManager undefined
items undefined
itemType undefined
_layoutRendererWithSubColumns(renderData,rendererKind,computeOverlap,index,start,end,items,itemsType)
Parameter Type Description
renderData undefined
rendererKind undefined
computeOverlap undefined
index undefined
start undefined
end undefined
items undefined
itemsType undefined
_layoutTimeIndicator(renderData)
Parameter Type Description
renderData undefined
_layoutVerticalItems(renderData,rendererKind,computeOverlap,index,subIndex,startTime,endTime,items,itemsType)
Parameter Type Description
renderData Object
rendererKind String
computeOverlap boolean
index Integer
subIndex Integer
startTime Date
endTime Date
items Object[]
itemsType String
_mouseWheelScrollHander(e)

Mouse wheel handler.

Parameter Type Description
e undefined
_moveOrResizeItemGesture(dates,eventSource,e,subColumn)

Moves or resizes an item.

Parameter Type Description
dates Date[]

The reference dates.

eventSource String

"mouse", "keyboard", "touch"

e Event

The event at the origin of the editing gesture.

subColumn String

The sub column value, if any, or null.

Returns:boolean
_overlapLayoutPass2(lanes)

Second pass of the overlap layout (optional). Compute the extent of each layout item.

Parameter Type Description
lanes undefined

The array of lanes.

_processTemplateNode(baseNode,getAttrFunc,attachFunc)
Defined by dijit/_AttachMixin

Process data-dojo-attach-point and data-dojo-attach-event for given node or widget. Returns true if caller should process baseNode's children too.

Parameter Type Description
baseNode DOMNode | Widget
getAttrFunc Function

Function to get the specified property for a given DomNode/Widget.

attachFunc Function
Optional

Attaches an event handler from the specified node/widget to specified function.

Returns:boolean
_recycleItemRenderers(remove)
Parameter Type Description
remove undefined
_recycleRenderer(renderer,remove)

Recycles the item renderer to be reused in the future.

Parameter Type Description
renderer dojox/calendar/_RendererMixin

The item renderer to recycle.

remove undefined
_refreshDecorationItemsRendering()
_refreshItemsRendering()
_removeRenderItem(id)
Parameter Type Description
id undefined
_resizeHandler(e,apply)

Refreshes the scroll bars after a resize of the widget.

Parameter Type Description
e Event

The resize event (optional)

apply Boolean

Whether apply the changes or wait for 100 ms

_scrollBar_onScroll(value)
Parameter Type Description
value undefined
_scrollToPosition(position,maxDuration,easing)

Scrolls the view to show the specified first time of day.

Parameter Type Description
position Integer

The position in pixels.

maxDuration Integer

The max duration of the scroll animation.

easing undefined
_set(name,value)
Defined by dijit/_WidgetBase

Helper function to set new value for specified property, and call handlers registered with watch() if the value has changed.

Parameter Type Description
name String
value anything
_setColumnCountAttr(value)
Parameter Type Description
value undefined
_setDecorationItemsAttr(value)
Parameter Type Description
value undefined
_setDecorationStoreAttr(value)
Parameter Type Description
value undefined
_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.

Parameter Type Description
props undefined
_setHoveredItem(item,renderer)

Sets the current hovered item.

Parameter Type Description
item Object

The data item.

renderer dojox/calendar/_RendererMixin

The item renderer.

_setHScrollPosition(pos)

Sets the horizontal scroll position (if the view is scrollable), using the scroll method defined.

Parameter Type Description
pos undefined
_setHScrollPositionImpl(pos,useDom,cssProp)
Parameter Type Description
pos undefined
useDom undefined
cssProp undefined
_setItemsAttr(value)
Parameter Type Description
value undefined
_setItemStoreState(item,state)
Parameter Type Description
item Object
state String
_setOwnerDocumentAttr(val)
Defined by dijit/_WidgetBase
Parameter Type Description
val undefined
_setScrollImpl(v)
Parameter Type Description
v undefined
_setScrollMethodAttr(value)
Parameter Type Description
value undefined
_setScrollPosition(pos)

Sets the verical scroll position (if the view is scrollable), using the scroll method defined.

Parameter Type Description
pos undefined
_setScrollPositionBase(pos,vertical)

Sets the scroll position (if the view is scrollable), using the scroll method defined.

Parameter Type Description
pos undefined
vertical undefined
_setSelectedItemAttr(value)
Parameter Type Description
value undefined
_setSelectedItemsAttr(value)
Parameter Type Description
value undefined
_setSelectionModeAttr(value)
Parameter Type Description
value undefined
_setShowTimeIndicatorAttr(value)
Parameter Type Description
value undefined
_setStartDateAttr(value)
Parameter Type Description
value undefined
_setStartTimeOfDay(hour,minutes,maxDuration,easing)

Scrolls the view to show the specified first time of day.

Parameter Type Description
hour Integer

The hour of the start time of day.

minutes Integer

The minutes part of the start time of day.

maxDuration Integer

The max duration of the scroll animation.

easing undefined
_setStartTimeOfDayAttr(value)
Parameter Type Description
value undefined
_setStoreAttr(value)
Parameter Type Description
value undefined
Returns:undefined
_setStyleAttr(value)
Defined by dijit/_WidgetBase

Sets the style attribute of the widget according to value, which is either a hash like {height: "5px", width: "3px"} or a plain string

Determines which node to set the style on based on style setting in attributeMap.

Parameter Type Description
value String | Object
_setText(node,text,allowHTML)

Creates a text node under the parent node after having removed children nodes if any.

Parameter Type Description
node Node

The node that will contain the text node.

text String

The text to set to the text node.

allowHTML undefined
_setVerticalRendererAttr(value)
Parameter Type Description
value undefined
_sortItemsFunction(a,b)
Parameter Type Description
a undefined
b undefined
Returns:number
_startAutoScroll(step)

Starts the auto scroll of the view (if it's scrollable). Used only during editing.

Parameter Type Description
step undefined
_startItemEditing(item,eventSource)

Configures the component, renderers to start one (mouse) of several (touch, keyboard) editing gestures.

Parameter Type Description
item Object

The item that was edited.

eventSource String

"mouse", "keyboard", "touch"

_startItemEditingGesture(dates,editKind,eventSource,e)

Starts the editing gesture.

Parameter Type Description
dates undefined
editKind String

Kind of edit: "resizeBoth", "resizeStart", "resizeEnd" or "move".

eventSource String

"mouse", "keyboard", "touch"

e Event

The event at the origin of the editing gesture.

_stopAutoScroll()

Stops the auto scroll of the view (if it's scrollable). Used only during editing.

_stringRepl(tmpl)

Does substitution of ${foo} type properties in template string

Parameter Type Description
tmpl undefined
Returns:undefined
_updateEditingCapabilities(item,renderer)

Update the moveEnabled and resizeEnabled properties of a renderer according to its event current editing state.

Parameter Type Description
item Object

The store data item.

renderer dojox/calendar/_RendererMixin

The item renderer.

_validateProperties()
_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).

Parameter Type Description
d Date

Reference date.

unit String

Unit to add.

steps Integer

Number of units to add.

Returns:undefined
addAndFloor(date,unit,steps)
Parameter Type Description
date undefined
unit undefined
steps undefined
Returns:undefined
addInvalidatingProperties(properties)

Add properties to the watched properties to trigger invalidation. This method must be called in the constructor. It is typically used by subclasses of a _Invalidating class to add more properties to watch for.

Parameter Type Description
properties String[]

The list of properties to watch for.

afterActivate()

Function invoked just after the view is displayed by the calendar.

afterDeactivate()

Function invoked just after the view is the view is hidden or removed by the calendar.

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).

Parameter Type Description
item Object

The render item.

renderer Object

A renderer associated with the render item.

hovered Boolean

Whether the item is hovered or not.

selected Boolean

Whether the item is selected or not.

edited Boolean

Whether the item is being edited not not.

focused Boolean

Whether the item is focused not not.

beforeActivate()

Function invoked just before the view is displayed by the calendar.

beforeDeactivate()
buildRendering()
computeOverlapping(layoutItems,func)

Computes the overlap layout of a list of items. A lane and extent properties are added to each layout item.

Parameter Type Description
layoutItems Object[]

List of layout items, each item must have a start and end properties.

func undefined
Returns:Object | object
computeProjectionOnDate(renderData,refDate,date,max)

Computes the time to pixel projection in a day.

Parameter Type Description
renderData Object

The render data.

refDate Date

The reference date that defines the destination date.

date Date[]

The reference dates (at least one).

max Integer

The size in pixels of the representation of a day.

Returns:Number | number | Integer

The size in pixels of the representation of 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.

Parameter Type Description
renderData Object.

The render data.

start1 Date

The start time of the first time range.

end1 Date

The end time of the first time range.

start2 Date

The start time of the second time range.

end2 Date

The end time of the second time range.

includeLimits Boolean

Whether include the end time or not.

Returns:Date[] | null | Array
connect(obj,event,method)
Defined by dijit/_WidgetBase

Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead.

Connects specified obj/event to specified method of this object and registers for disconnect() on widget destroy.

Provide widget-specific analog to dojo.connect, except with the implicit use of this widget as the target object. Events connected with this.connect are disconnected upon destruction.

Parameter Type Description
obj Object | null
event String | Function
method String | Function
Returns:any | undefined

A handle that can be passed to disconnect in order to disconnect before the widget is destroyed.

Examples

Example 1

var btn = new Button();
// when foo.bar() is called, call the listener we're going to
// provide in the scope of btn
btn.connect(foo, "bar", function(){
    console.debug(this.toString());
});
create(params,srcNodeRef)
Defined by dijit/_WidgetBase

Kick off the life-cycle of a widget

Create calls a number of widget methods (postMixInProperties, buildRendering, postCreate, etc.), some of which of you'll want to override. See http://dojotoolkit.org/reference-guide/dijit/_WidgetBase.html for a discussion of the widget creation lifecycle.

Of course, adventurous developers could override create entirely, but this should only be done as a last resort.

Parameter Type Description
params Object | null

Hash of initialization parameters for widget, including scalar values (like title, duration etc.) and functions, typically callbacks like onClick. The hash can contain any of the widget's properties, excluding read-only properties.

srcNodeRef DOMNode | String
Optional

If a srcNodeRef (DOM node) is specified:

  • use srcNodeRef.innerHTML as my contents
  • if this is a behavioral widget then apply behavior to that srcNodeRef
  • otherwise, replace srcNodeRef with my generated DOM tree
createItemFunc(view,d,e)

A user supplied function that creates a new event.

Parameter Type Description
view ViewBase

the current view,

d Date

the date at the clicked location.

e MouseEvemt

the mouse event (can be used to return null for example)

defaultStyleGridCell(node,date,hours,minutes,renderData)

Styles the CSS classes to the node that displays a cell. By default this method is setting: - "dojoxCalendarToday" class name if the date displayed is the current date, - "dojoxCalendarWeekend" if the date represents a weekend, - the CSS class corresponding of the displayed day of week ("Sun", "Mon" and so on), - the CSS classes corresponfing to the time of day (e.g. "H14" and "M30" for for 2:30pm).

Parameter Type Description
node Node

The DOM node that displays the cell in the grid.

date Date

The date displayed by this cell.

hours Integer

The hours part of time of day displayed by the start of this cell.

minutes Integer

The minutes part of time of day displayed by the start of this cell.

renderData Object

The render data object.

Returns:undefined
defer(fcn,delay)
Defined by dijit/_WidgetBase

Wrapper to setTimeout to avoid deferred functions executing after the originating widget has been destroyed. Returns an object handle with a remove method (that returns null) (replaces clearTimeout).

Parameter Type Description
fcn Function

Function reference.

delay Number
Optional

Delay, defaults to 0.

Returns:object
destroy(preserveDom)
Parameter Type Description
preserveDom undefined
destroyDescendants(preserveDom)
Defined by dijit/_WidgetBase

Recursively destroy the children of this widget and their descendants.

Parameter Type Description
preserveDom Boolean
Optional

If true, the preserveDom attribute is passed to all descendant widget's .destroy() method. Not for use with _Templated widgets.

destroyRecursive(preserveDom)
Defined by dijit/_WidgetBase

Destroy this widget and its descendants

This is the generic "destructor" function that all widget users should call to cleanly discard with a widget. Once a widget is destroyed, it is removed from the manager object.

Parameter Type Description
preserveDom Boolean
Optional

If true, this method will leave the original DOM structure alone of descendant Widgets. Note: This will NOT work with dijit._TemplatedMixin widgets.

destroyRendering(preserveDom)
Defined by dijit/_WidgetBase

Destroys the DOM nodes associated with this widget.

Parameter Type Description
preserveDom Boolean
Optional

If true, this method will leave the original DOM structure alone during tear-down. Note: this will not work with _Templated widgets yet.

disconnect(handle)
Defined by dijit/_WidgetBase

Deprecated, will be removed in 2.0, use handle.remove() instead.

Disconnects handle created by connect.

Parameter Type Description
handle undefined
dispatchChange(oldSelectedItem,newSelectedItem,renderer,triggerEvent)

Dispatch a selection change event.

Parameter Type Description
oldSelectedItem Object

The previously selectedItem.

newSelectedItem Object

The new selectedItem.

renderer Object

The visual renderer of the selected/deselected item.

triggerEvent Event

The event that lead to the selection of the item.

emit(type,eventObj,callbackArgs)
Defined by dijit/_WidgetBase

Used by widgets to signal that a synthetic event occurred, ex:

myWidget.emit("attrmodified-selectedChildWidget", {}).

Emits an event on this.domNode named type.toLowerCase(), based on eventObj. Also calls onType() method, if present, and returns value from that method. By default passes eventObj to callback, but will pass callbackArgs instead, if specified. Modifies eventObj by adding missing parameters (bubbles, cancelable, widget).

Parameter Type Description
type String
eventObj Object
Optional
callbackArgs Array
Optional
Returns:undefined
ensureMinimalDuration(renderData,item,unit,steps,editKind)

During the resize editing gesture, ensures that the item has the specified minimal duration.

Parameter Type Description
renderData Object

The render data.

item Object

The edited item.

unit String

The unit used to define the minimal duration.

steps Integer

The number of time units.

editKind String

The edit kind: "resizeStart" or "resizeEnd".

ensureVisibility(start,end,visibilityTarget,margin,duration)

Scrolls the view if the [start, end] time range is not visible or only partially visible.

Parameter Type Description
start Date

Start time of the range of interest.

end Date

End time of the range of interest.

visibilityTarget String

The end(s) of the time range to make visible. Valid values are: "start", "end", "both".

margin Integer

Margin in minutes around the time range.

duration Number

Optional, the maximum duration of the scroll animation.

floorDate(date,unit,steps,reuse)

floors the date to the unit.

Parameter Type Description
date Date

The date/time to floor.

unit String

The unit. Valid values are "minute", "hour", "day".

steps Integer

For "day" only 1 is valid.

reuse Boolean

Whether use the specified instance or create a new one. Default is false.

Returns:Date | undefined
floorToDay(date,reuse)

Floors the specified date to the start of day.

Parameter Type Description
date Date

The date to floor.

reuse Boolean

Whether use the specified instance or create a new one. Default is false.

Returns:Date | undefined
floorToMonth(date,reuse)

Floors the specified date to the start of the date's month.

Parameter Type Description
date Date

The date to floor.

reuse Boolean

Whether use the specified instance or create a new one. Default is false.

Returns:Date | undefined
get(name)
Defined by dijit/_WidgetBase

Get a property from a widget.

Get a named property from a widget. The property may potentially be retrieved via a getter method. If no getter is defined, this just retrieves the object's property.

For example, if the widget has properties foo and bar and a method named _getFooAttr(), calling: myWidget.get("foo") would be equivalent to calling widget._getFooAttr() and myWidget.get("bar") would be equivalent to the expression widget.bar2

Parameter Type Description
name undefined

The property to get.

Returns:undefined
getChildren()
Defined by dijit/_WidgetBase

Returns all direct children of this widget, i.e. all widgets underneath this.containerNode whose parent is this widget. Note that it does not return all descendants, but rather just direct children. Analogous to Node.childNodes, except containing widgets rather than DOMNodes.

The result intentionally excludes internally created widgets (a.k.a. supporting widgets) outside of this.containerNode.

Note that the array returned is a simple array. Application code should not assume existence of methods like forEach().

Returns:Array
getCSSPrefix()

Utility method that return the specific CSS prefix for non standard CSS properties. Ex: -moz-border-radius.

Returns:string
getIdentity(item)
Parameter Type Description
item undefined
Returns:undefined
getItemStoreState(item)

Returns the creation state of an item. This state is changing during the interactive creation of an item. Valid values are: - "unstored": The event is being interactively created. It is not in the store yet. - "storing": The creation gesture has ended, the event is being added to the store. - "stored": The event is not in the two previous states, and is assumed to be in the store (not checking because of performance reasons, use store API for testing existence in store). item: Object The item. returns: String

Parameter Type Description
item undefined
Returns:undefined
getParent()
Defined by dijit/_WidgetBase

Returns the parent widget of this widget.

Returns:undefined
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.

Parameter Type Description
item Object

The data or render item.

Returns:Object[] | undefined
getSubColumn(e,x,y,touchIndex)

Returns the sub column at the specified point by this component.

Parameter Type Description
e Event

Optional mouse event.

x Number

Position along the x-axis with respect to the sheet container used if event is not defined.

y Number

Position along the y-axis with respect to the sheet container (scroll included) used if event is not defined.

touchIndex Integer

If parameter 'e' is not null and a touch event, the index of the touch to use.

Returns:Object | null | undefined
getSubColumnIndex(value)

Returns the sub column index that has the specified value, if any. -1 otherwise.

Parameter Type Description
value String

The sub column index.

Returns:number
getTime(e,x,y,touchIndex)

Returns the time displayed at the specified point by this component.

Parameter Type Description
e Event

Optional mouse event.

x Number

Position along the x-axis with respect to the sheet container used if event is not defined.

y Number

Position along the y-axis with respect to the sheet container (scroll included) used if event is not defined.

touchIndex Integer

If parameter 'e' is not null and a touch event, the index of the touch to use.

Returns:Date | undefined
getTimeOfDay(pos,rd)

Return the time of day associated to the specified position.

Parameter Type Description
pos Integer

The position in pixels.

rd Object

The render data.

Returns:object
getWeekNumberLabel(date)

Returns the week number string from dojo.date.locale.format() method as dojox.date.XXXX calendar are not supporting the "w" pattern.

Parameter Type Description
date Date

The date to format.

Returns:undefined
invalidateLayout()

Triggers a re-layout of the renderers.

invalidateRendering()

Invalidating the rendering for the next executation frame.

isAscendantHasClass(node,ancestor,className)

Determines if a node has an ascendant node that has the css class specified.

Parameter Type Description
node Node

The DOM node.

ancestor Node

The ancestor node used to limit the search in hierarchy.

className String

The css class name.

Returns:Boolean | boolean
isFocusable()
Defined by dijit/_WidgetBase

Return true if this widget can currently be focused and false if not

Returns:undefined
isItemBeingEdited(item)

Returns whether an item is being edited or not.

Parameter Type Description
item Object

The item to test.

Returns:Boolean | undefined
isItemEditable(item,rendererKind)

Computes whether particular item renderer can be edited or not. By default it is using the editable property value.

Parameter Type Description
item Object

The item represented by the renderer.

rendererKind String

The kind of renderer.

Returns:Boolean | undefined
isItemFocused(item)

Returns whether the specified item is focused or not.

Parameter Type Description
item Object

The item.

Returns:Boolean | boolean
isItemHovered(item)

Returns whether the specified item is hovered or not.

Parameter Type Description
item Object

The item.

Returns:Boolean | boolean
isItemMoveEnabled(item,rendererKind)

Computes whether particular item renderer can be moved. By default it is using the moveEnabled property value.

Parameter Type Description
item Object

The item represented by the renderer.

rendererKind String

The kind of renderer.

Returns:Boolean | undefined
isItemResizeEnabled(item,rendererKind)

Computes whether particular item renderer can be resized. By default it is using the resizedEnabled property value.

Parameter Type Description
item Object

The item represented by the renderer.

rendererKind String

The kind of renderer.

Returns:Boolean | undefined
isItemSelected(item)
Parameter Type Description
item undefined
Returns:undefined
isLeftToRight()
Defined by dijit/_WidgetBase

Return this widget's explicit or implicit orientation (true for LTR, false for RTL)

Returns:undefined
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.

Parameter Type Description
renderData Object

The render data.

start1 Date

The start time of the first time range.

end1 Date

The end time of the first time range.

start2 Date

The start time of the second time range.

end2 Date

The end time of the second time range.

includeLimits Boolean

Whether include the end time or not.

Returns:Boolean | undefined
isSameDay(date1,date2)

Tests if the specified dates are in the same day.

Parameter Type Description
date1 Date

The first date.

date2 Date

The second date.

Returns:Boolean | boolean
isStartOfDay(d)

Tests if the specified date represents the starts of day.

Parameter Type Description
d Date

The date to test.

Returns:Boolean | undefined
isToday(date)

Returns whether the specified date is in the current day.

Parameter Type Description
date Date

The date to test.

Returns:Boolean | undefined
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.

Parameter Type Description
date Date

The date to test.

Returns:undefined
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.

Parameter Type Description
item Object

The store item.

store dojo.store.api.Store

The store.

Returns:Object | undefined | object
newDate(obj)

Creates a new Date object.

Parameter Type Description
obj Object

This object can have several values:

  • the time in milliseconds since gregorian epoch.
  • a Date instance
Returns:Date | undefined
on(type,func)
Defined by dijit/_WidgetBase

Call specified function when event occurs, ex: myWidget.on("click", function(){ ... }).

Call specified function when event type occurs, ex: myWidget.on("click", function(){ ... }). Note that the function is not run in any particular scope, so if (for example) you want it to run in the widget's scope you must do myWidget.on("click", lang.hitch(myWidget, func)).

Parameter Type Description
type String | Function

Name of event (ex: "click") or extension event like touch.press.

func Function
Returns:undefined
own()
Defined by dijit/Destroyable

Track specified handles and remove/destroy them when this instance is destroyed, unless they were already removed/destroyed manually.

Returns:any | undefined

The array of specified handles, so you can do for example:

var handle = this.own(on(...))[0];
placeAt(reference,position)
Defined by dijit/_WidgetBase

Place this widget somewhere in the DOM based on standard domConstruct.place() conventions.

A convenience function provided in all _Widgets, providing a simple shorthand mechanism to put an existing (or newly created) Widget somewhere in the dom, and allow chaining.

Parameter Type Description
reference String | DomNode | DocumentFragment | dijit/_WidgetBase

Widget, DOMNode, DocumentFragment, or id of widget or DOMNode

position String | Int
Optional

If reference is a widget (or id of widget), and that widget has an ".addChild" method, it will be called passing this widget instance into that method, supplying the optional position index passed. In this case position (if specified) should be an integer.

If reference is a DOMNode (or id matching a DOMNode but not a widget), the position argument can be a numeric index or a string "first", "last", "before", or "after", same as dojo/dom-construct::place().

Returns:dijit/_WidgetBase | function

Provides a useful return of the newly created dijit._Widget instance so you can "chain" this function by instantiating, placing, then saving the return value to a variable.

Examples

Example 1

// create a Button with no srcNodeRef, and place it in the body:
var button = new Button({ label:"click" }).placeAt(win.body());
// now, 'button' is still the widget reference to the newly created button
button.on("click", function(e){ console.log('click'); }));

Example 2

// create a button out of a node with id="src" and append it to id="wrapper":
var button = new Button({},"src").placeAt("wrapper");

Example 3

// place a new button as the first element of some div
var button = new Button({ label:"click" }).placeAt("wrapper","first");

Example 4

// create a contentpane and add it to a TabContainer
var tc = dijit.byId("myTabs");
new ContentPane({ href:"foo.html", title:"Wow!" }).placeAt(tc)
postCreate()
Defined by dijit/_WidgetBase

Processing after the DOM fragment is created

Called after the DOM fragment has been created, but not necessarily added to the document. Do not include any operations which rely on node dimensions or placement.

postMixInProperties()
Defined by dijit/_WidgetBase

Called after the parameters to the widget have been read-in, but before the widget template is instantiated. Especially useful to set properties that are referenced in the widget template.

postscript()
refreshRendering()
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 encodeDate property if not null. If the encodeDate property is null a Date object will be set in the start and end time. When using a JsonRest store, for example, it is recommended to transfer dates using the ISO format (see dojo.date.stamp). In that case, provide a custom function to the encodeDate property that is using the date ISO encoding provided by Dojo.

Parameter Type Description
renderItem Object

The render item.

store dojo.store.api.Store

The store.

Returns:Object | undefined
resize(e)
Parameter Type Description
e undefined
scrollView(dir)

Scrolls the view to the specified direction of one time slot duration.

Parameter Type Description
dir Integer

Direction of the scroll. Valid values are -1 and 1.

scrollViewHorizontal(dir)

Scrolls the view horizontally to the specified direction of one column or sub column (if set).

Parameter Type Description
dir Integer

Direction of the scroll. Valid values are -1 and 1.

selectFromEvent(e,item,renderer,dispatch)
Parameter Type Description
e undefined
item undefined
renderer undefined
dispatch undefined
set(name,value)
Defined by dijit/_WidgetBase

Set a property on a widget

Sets named properties on a widget which may potentially be handled by a setter in the widget.

For example, if the widget has properties foo and bar and a method named _setFooAttr(), calling myWidget.set("foo", "Howdy!") would be equivalent to calling widget._setFooAttr("Howdy!") and myWidget.set("bar", 3) would be equivalent to the statement widget.bar = 3;

set() may also be called with a hash of name/value pairs, ex:

myWidget.set({
    foo: "Howdy",
    bar: 3
});

This is equivalent to calling set(foo, "Howdy") and set(bar, 3)

Parameter Type Description
name undefined

The property to set.

value undefined

The value to set in the property.

Returns:function | string

Set a property on a widget

setItemSelected(item,value)
Parameter Type Description
item undefined
value undefined
startup()
Defined by dijit/_WidgetBase

Processing after the DOM fragment is added to the document

Called after a widget and its children have been created and added to the page, and all related widgets have finished their create() cycle, up through postCreate().

Note that startup() may be called while the widget is still hidden, for example if the widget is inside a hidden dijit/Dialog or an unselected tab of a dijit/layout/TabContainer. For widgets that need to do layout, it's best to put that layout code inside resize(), and then extend dijit/layout/_LayoutWidget so that resize() is called when the widget is visible.

styleColumnHeaderCell(node,date,renderData)

Styles the CSS classes to the node that displays a column header cell. By default this method is setting: - "dojoxCalendarToday" class name if the date displayed is the current date, - "dojoxCalendarWeekend" if the date represents a weekend, - the CSS class corresponding of the displayed day of week ("Sun", "Mon" and so on).

Parameter Type Description
node Node

The DOM node that displays the column in the grid.

date Date

The date displayed by this column

renderData Object

The render data.

styleGridCell(node,date,hours,minutes,renderData)

Styles the CSS classes to the node that displays a cell. Delegates to styleGridCellFunc if defined or defaultStyleGridCell otherwise.

Parameter Type Description
node Node

The DOM node that displays the cell in the grid.

date Date

The date displayed by this column

hours undefined
minutes undefined
renderData Object

The render data object.

styleRowHeaderCell(node,h,m,renderData)

Styles the CSS classes to the node that displays a row header cell. By default this method is doing nothing.

Parameter Type Description
node Node

The DOM node that displays the column in the grid.

h Integer

The time of day displayed by this row header cell.

m undefined
renderData Object

The render data.

styleSubColumnHeaderCell(node,date,renderData)

Styles the CSS classes to the node that displays a sub column header cell. By default this method is not setting anythin:

Parameter Type Description
node Node

The DOM node that displays the column in the grid.

date undefined
renderData Object

The render data.

subColumnLabelFunc(value)

Computes the label for a sub column from the subColumns property. By default, return the value.

Parameter Type Description
value undefined
Returns:undefined
subscribe(t,method)
Defined by dijit/_WidgetBase

Deprecated, will be removed in 2.0, use this.own(topic.subscribe()) instead.

Subscribes to the specified topic and calls the specified method of this object and registers for unsubscribe() on widget destroy.

Provide widget-specific analog to dojo.subscribe, except with the implicit use of this widget as the target object.

Parameter Type Description
t String

The topic

method Function

The callback

Returns:undefined

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
toString()
Defined by dijit/_WidgetBase

Returns a string that represents the widget.

When a widget is cast to a string, this method will be used to generate the output. Currently, it does not implement any sort of reversible serialization.

Returns:string
uninitialize()
Defined by dijit/_WidgetBase

Deprecated. Override destroy() instead to implement custom widget tear-down behavior.

Returns:boolean
unsubscribe(handle)
Defined by dijit/_WidgetBase

Deprecated, will be removed in 2.0, use handle.remove() instead.

Unsubscribes handle created by this.subscribe. Also removes handle from this widget's list of subscriptions

Parameter Type Description
handle Object
updateRenderers(obj,stateOnly)

Updates all the renderers that represents the specified item(s).

Parameter Type Description
obj Object

A render item or an array of render items.

stateOnly Boolean

Whether only the state of the item has changed (selected, edited, edited, focused) or a more global change has occured.

validateRendering()

Immediately validate the rendering if it has been invalidated. You generally do not call that method yourself.

watch(name,callback)
Defined by dojo/Stateful

Watches a property for changes

Parameter Type Description
name String
Optional

Indicates the property to watch. This is optional (the callback may be the only parameter), and if omitted, all the properties will be watched

callback Function

The function to execute when the property changes. This will be called after the property has been changed. The callback will be called with the |this| set to the instance, the first argument as the name of the property, the second argument as the old value and the third argument as the new value.

Returns:any | object

An object handle for the watch. The unwatch method of this object can be used to discontinue watching this property:

var watchHandle = obj.watch("foo", callback);
watchHandle.unwatch(); // callback won't be called now

Events

_onBlur()
Defined by: dijit/_FocusMixin

This is where widgets do processing for when they stop being active, such as changing CSS classes. See onBlur() for more details.

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
_onColumnHeaderClick(e)
Parameter Type Description
e undefined

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
_onFocus()
Defined by: dijit/_FocusMixin

This is where widgets do processing for when they are active, such as changing CSS classes. See onFocus() for more details.

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
_onGridClick(e)
Parameter Type Description
e undefined

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
_onGridDoubleClick(e)
Parameter Type Description
e undefined

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
_onGridMouseDown(e)
Parameter Type Description
e undefined

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
_onGridMouseMove(e)
Parameter Type Description
e undefined

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
_onGridMouseUp(e)
Parameter Type Description
e undefined

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
_onGridTouchEnd(e)
Parameter Type Description
e undefined

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
_onGridTouchMove(e)
Parameter Type Description
e undefined

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
_onGridTouchStart(e)
Parameter Type Description
e undefined

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
_onItemClick(e)
Parameter Type Description
e undefined

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
_onItemContextMenu(e)
Parameter Type Description
e undefined

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
_onItemDoubleClick(e)
Parameter Type Description
e undefined

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
_onItemEditBegin(e)
Parameter Type Description
e undefined

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
_onItemEditBeginGesture(e)
Parameter Type Description
e undefined

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
_onItemEditEnd(e)
Parameter Type Description
e undefined

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
_onItemEditEndGesture(e)
Parameter Type Description
e undefined

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
_onItemEditMoveGesture(e)
Parameter Type Description
e undefined

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
_onItemEditResizeGesture(e)
Parameter Type Description
e undefined

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
_onMap(type)
Defined by: dijit/_WidgetBase

Maps on() type parameter (ex: "mousemove") to method name (ex: "onMouseMove"). If type is a synthetic event like touch.press then returns undefined.

Parameter Type Description
type String | Function
Returns:undefined

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
_onRendererCreated(e)
Parameter Type Description
e undefined

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
_onRendererDestroyed(e)
Parameter Type Description
e undefined

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
_onRendererRecycled(e)
Parameter Type Description
e undefined

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
_onRendererReused(e)
Parameter Type Description
e undefined

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
_onRenderersLayoutDone(view)
Parameter Type Description
view undefined

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
_onScrollTimer_tick()

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onBlur()
Defined by: dijit/_FocusMixin

Called when the widget stops being "active" because focus moved to something outside of it, or the user clicked somewhere outside of it, or the widget was hidden.

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onChange()

Called when the selection changed.

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onColumnHeaderClick(e)

Event dispatched when a column header cell is dispatched.

Parameter Type Description
e Object

The event has the following properties

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onFocus()
Defined by: dijit/_FocusMixin

Called when the widget becomes "active" because it or a widget inside of it either has focus, or has recently been clicked.

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onGridClick(e)

Event dispatched when the grid has been clicked.

Parameter Type Description
e Object

The event dispatched when the grid is clicked.

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onGridDoubleClick(e)

Event dispatched when the grid has been double-clicked.

Parameter Type Description
e Object

The event dispatched when the grid is double-clicked.

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onItemClick(e)

Event dispatched when an item renderer has been clicked.

Parameter Type Description
e Object

The event dispatched when an item is clicked.

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onItemContextMenu(e)

Event dispatched when an item renderer has been context-clicked.

Parameter Type Description
e Object

The event dispatched when an item is context-clicked.

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onItemDoubleClick(e)

Event dispatched when an item renderer has been double-clicked.

Parameter Type Description
e Object

The event dispatched when an item is double-clicked.

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onItemEditBegin(e)

Event dispatched when the item is entering the editing mode.

Parameter Type Description
e undefined

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onItemEditBeginGesture(e)

Event dispatched when an editing gesture is beginning.

Parameter Type Description
e Object

The editing event.

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onItemEditEnd(e)

Event dispatched when the item is leaving the editing mode.

Parameter Type Description
e undefined

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onItemEditEndGesture(e)

Event dispatched at the end of an editing gesture.

Parameter Type Description
e Object

The editing event.

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onItemEditMoveGesture(e)

Event dispatched during a move editing gesture.

Parameter Type Description
e Object

The editing event.

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onItemEditResizeGesture(e)

Event dispatched during a resize editing gesture.

Parameter Type Description
e Object

The editing event.

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onRendererCreated(e)

Event dispatched when an item renderer has been created.

Parameter Type Description
e Object

The renderer lifecycle event.

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onRendererDestroyed(e)

Event dispatched when an item renderer is destroyed.

Parameter Type Description
e Object

The renderer lifecycle event.

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onRendererRecycled(e)

Event dispatched when an item renderer has been recycled.

Parameter Type Description
e Object

The renderer lifecycle event.

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onRendererReused(e)

Event dispatched when an item renderer that was recycled is reused.

Parameter Type Description
e Object

The renderer lifecycle event.

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onRenderersLayoutDone(view)

Event triggered when item renderers layout has been done.

Parameter Type Description
view undefined

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
Error in the documentation? Can’t find what you are looking for? Let us know!