dojox.calendar.ColumnView

Object » dijit._WidgetBase » dojox.calendar.ViewBase » dojox.calendar.SimpleColumnView » dojox.calendar.ColumnView

This class defines a simple column view that also uses a secondary sheet to display long or all day events. By default an dojox.calendar.ColumnViewSecondarySheet instance is created. Set the secondarySheetClass property to define the class to instantiate, for example to mix the default class with Mouse, Keyboard or Touch plugins.

mixins: dojox.calendar.SimpleColumnView

Property Summary

_edProps
_gridProps
_scrollProps
renderData The render data is the object that contains all the properties needed to render the component.
scrollContainer
secondarySheet

Method Summary

__fixEvt(e)
_autoScroll(gx, gy, orientation)
_buildColumnHeader(renderData, oldRenderData) Creates incrementally the HTML structure of the column header and configures its content.
_buildGrid(renderData, oldRenderData) Creates incrementally the HTML structure of the grid and configures its content.
_buildItemContainer(renderData, oldRenderData) Creates the HTML structure of the item container and configures its content.
_buildRowHeader(renderData, oldRenderData) Creates incrementally the HTML structure of the row header and configures its content.
_cleanupColumnHeader()
_columnHeaderClick(e)
_computeItemEditingTimes(item, editKind, rendererKind, times, eventSource)
_configureScrollBar(renderData)
_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.
_createRendering(renderData, oldRenderData)
_createStructure(rd) Creates the HTML structure (grid, place holders, headers, etc)
_defaultItemToRendererKindFunc(item) returns String
_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)
_formatColumnHeaderLabel(d) Computes the column header label for the specified date. By default a formatter is used, optionally the <code>columnHeaderDatePattern</code> property can be used to set a custom date pattern to the formatter.
_formatRowHeaderLabel(d) Computes the row header label for the specified time of day. By default a formatter is used, optionally the <code>rowHeaderTimePattern</code> property can be used to set a custom time pattern to the formatter.
_getEndTimeOfDay()
_getExpandRendererAttr(value)
_getFormatItemTimeFuncAttr()
_getHorizontalRendererAttr(value)
_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.
_getStartTimeOfDay()
_getStartTimeOfDayAttr()
_getStoreAttr()
_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.
_layoutVerticalItems(renderData, index, startTime, endTime, items)
_mouseWheelScrollHander(e)
_moveOrResizeItemGesture(dates, eventSource, e) Moves or resizes an item.
_onColumnHeaderClick(e)
_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)
_overlapLayoutPass2(lanes) Second pass of the overlap layout (optional). Compute the extent of each layout item.
_recycleItemRenderers(remove)
_recycleRenderer(renderer, remove) Recycles the item renderer to be reused in the future.
_refreshItemsRendering()
_scrollBar_onScroll(value)
_scrollToPosition(position, maxDuration, easing)
_setColumnCountAttr(value)
_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.
_setExpandRendererAttr(value)
_setHorizontalRendererAttr(value)
_setHoveredItem(item, renderer)
_setItemsAttr(value)
_setScrollImpl(v)
_setSelectedItemAttr(value)
_setSelectedItemsAttr(value)
_setSelectionModeAttr(value)
_setStartDateAttr(value)
_setStartTimeOfDay(hour, minutes, maxDuration, easing)
_setStartTimeOfDayAttr(value)
_setText(node, text, allowHTML) Creates a text node under the parent node after having removed children nodes if any.
_setTextDirAttr(value)
_setVerticalRendererAttr(value)
_setVisibility(value)
_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)
_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).
buildRendering()
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)
destroy(preserveDom)
ensureMinimalDuration(renderData, item, unit, steps, editKind) During the resize editing gesture, ensures that the item has the specified minimal duration.
ensureVisibility(start, end, visibilityTarget, margin, 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.
getSecondarySheet() Returns the secondary sheet
getTime(e, x, y, touchIndex) Returns the time displayed at the specified point by this component.
getTimeOfDay(pos, rd) Return the time of day associated to the specified position.
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.
invalidateRendering()
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.
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.
refreshRendering()
resize()
resizeSecondarySheet(height) Resizes the secondary sheet header and relayout the other sub components according this new height. Warning: this method is only available for the default template and default CSS.
scrollView(dir) Scrolls the view to the specified direction of one time slot duration.
selectFromEvent(e, item, renderer, dispatch)
setItemSelected(item, value)
styleColumnHeaderCell(node, date, renderData) Styles the CSS classes to the node that displays a column header cell. By default this method is setting the "dojoxCalendarToday" class name if the date displayed is the current date or "dojoxCalendarWeekend" if the date represents a weekend.
styleGridColumn(node, date, renderData) Styles the CSS classes to the node that displays a column. By default this method is setting the "dojoxCalendarToday" class name if the date displayed is the current date or "dojoxCalendarWeekend" if the date represents a weekend.
styleRowHeaderCell(node, h, renderData) Styles the CSS classes to the node that displays a row header cell. By default this method is doing nothing.
updateRenderers(obj, stateOnly) Updates all the renderers that represents the specified item(s).

Event Summary

onColumnHeaderClick(e) Event dispatched when a column header cell is dispatched.
onGridClick(e) Event dispatched when the grid has been clicked.
onGridDoubleClick(e) Event dispatched when the grid has been double-clicked.
onItemClick(e) Event dispatched when an item renderer has been clicked.
onItemDoubleClick(e) Event dispatched when an item renderer has been double-clicked.
onItemEditBegin(e) Event dispatched when the item is entering the editing mode.
onItemEditBeginGesture(e) Event dispatched when an editing gesture is beginning.
onItemEditEnd(e) Event dispatched when the item is leaving the editing mode.
onItemEditEndGesture(e) Event dispatched at the end of an editing gesture.
onItemEditMoveGesture(e) Event dispatched during a move editing gesture.
onItemEditResizeGesture(e) Event dispatched during a resize editing gesture.
onRendererCreated(renderer) Event dispatched when an item renderer has been created.
onRendererDestroyed(renderer) Event dispatched when an item renderer is destroyed.
onRendererRecycled(renderer) Event dispatched when an item renderer has been recycled.
onRendererReused(renderer) Event dispatched when an item renderer that was recycled is reused.
onRenderersLayoutDone(view) Event triggered when item renderers layout has been done.
onRowHeaderClick(e) Event dispatched when the row header cell of the secondary sheet is clicked.

Attached Objects

dojox.calendar.ColumnView.secondarySheet

Properties

_edProps

Defined by dijit._WidgetBase

_gridProps

Defined by dijit._WidgetBase, dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

_scrollProps

Defined by dijit._WidgetBase

renderData

Defined by dijit._WidgetBase, dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

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

scrollContainer

Defined by dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

secondarySheet

Methods

__fixEvt

Defined by dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

Parameter	Type	Description
e

_autoScroll

Defined by dijit._WidgetBase

Parameter	Type	Description
gx
gy
orientation

_buildColumnHeader

Defined by dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

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

Parameter	Type	Description
renderData	The	render data to display.
oldRenderData	The	previously render data displayed, if any.

_buildGrid

Defined by dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

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

Parameter	Type	Description
renderData	The	render data to display.
oldRenderData	The	previously render data displayed, if any.

_buildItemContainer

Defined by dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

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

Parameter	Type	Description
renderData	The	render data to display.
oldRenderData	The	previously render data displayed, if any.

_buildRowHeader

Defined by dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

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

Parameter	Type	Description
renderData	The	render data to display.
oldRenderData	The	previously render data displayed, if any.

_cleanupColumnHeader

Defined by dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

_columnHeaderClick

Defined by dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

Parameter	Type	Description
e

_computeItemEditingTimes

Defined by dijit._WidgetBase

Parameter	Type	Description
item
editKind
rendererKind
times
eventSource

_configureScrollBar

Overrides dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

Parameter	Type	Description
renderData

_createItemEditEvent

Defined by dijit._WidgetBase

_createRenderData

Defined by dijit._WidgetBase, dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

Creates the object that contains all the data needed to render this widget.

_createRenderer

Defined by dijit._WidgetBase

Object tags protected

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 instanciate to create the renderer.
cssClass

_createRendering

Defined by dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

Parameter	Type	Description
renderData	Object
oldRenderData	Object

_createStructure

Defined by dijit._WidgetBase

Creates the HTML structure (grid, place holders, headers, etc)

Parameter	Type	Description
rd	Object

_defaultItemToRendererKindFunc

Overrides dijit._WidgetBase, dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

Returns String

Parameter	Type	Description
item

_destroyRenderer

Defined by dijit._WidgetBase

Destroys the item renderer.

Parameter	Type	Description
renderer	dojox.calendar._RendererMixin	The item renderer to destroy. tags protected

_destroyRenderersByKind

Defined by dijit._WidgetBase

Parameter	Type	Description
kind

_dispatchCalendarEvt

Defined by dijit._WidgetBase

Parameter	Type	Description
e
name

_doEndItemEditing

Defined by dijit._WidgetBase

Parameter	Type	Description
obj
eventSource

_endItemEditing

Defined by dijit._WidgetBase

Leaves the item editing mode. item: Object The item that was edited.

Parameter	Type	Description
eventSource	String	"mouse", "keyboard", "touch"
canceled	Boolean

_endItemEditingGesture

Defined by dijit._WidgetBase

Parameter	Type	Description
eventSource	String
e	Event

_ensureItemInView

Defined by dijit._WidgetBase, dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

Boolean Whether the item has been moved to be in view or not.

If needed, moves the item to be entirely in view.

Parameter	Type	Description
item

_findRenderItem

Defined by dijit._WidgetBase

Parameter	Type	Description
id
list

_formatColumnHeaderLabel

Defined by dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

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

Parameter	Type	Description
d	Date	The date to format

_formatRowHeaderLabel

Defined by dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

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

Parameter	Type	Description
d	Date	The date to format

_getEndTimeOfDay

Defined by dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

_getExpandRendererAttr

Parameter	Type	Description
value

_getFormatItemTimeFuncAttr

Defined by dijit._WidgetBase

_getHorizontalRendererAttr

Parameter	Type	Description
value

_getSelectedItemAttr

Defined by dijit._WidgetBase

Parameter	Type	Description
value

_getSelectedItemsAttr

Defined by dijit._WidgetBase

_getSelectionModeAttr

Defined by dijit._WidgetBase

Parameter	Type	Description
value

_getStartEndRenderers

Defined by 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.

Parameter	Type	Description
item	Object	The render item. retunrs: Object[]

_getStartTimeOfDay

Defined by dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

_getStartTimeOfDayAttr

Defined by dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

_getStoreAttr

Defined by dijit._WidgetBase

_isItemInView

Defined by dijit._WidgetBase, dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

Boolean

Computes whether the specified item is entirely in the view or not.

Parameter	Type	Description
item

_itemToRendererKind

Defined by dijit._WidgetBase

Returns String: String tags protected

Associates a kind of renderer with a data item.

Parameter	Type	Description
item	Object	The data item.

_layoutInterval

Defined by dijit._WidgetBase, dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

For each item in the items list: retrieve a renderer, compute its location and size and add it to the DOM.

Parameter	Type	Description
renderData	Object
index	Integer
start	Date
end	Date
items	Object[]

_layoutPass1

Defined by dijit._WidgetBase

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	The	array of lanes. tags private

_layoutRenderers

Overrides dijit._WidgetBase

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

Parameter	Type	Description
renderData

_layoutVerticalItems

Defined by dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

Parameter	Type	Description
renderData	Object
index	Integer
startTime	Date
endTime	Date
items	Object[]

_mouseWheelScrollHander

Defined by dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

Parameter	Type	Description
e

_moveOrResizeItemGesture

Defined by dijit._WidgetBase

Moves or resizes an item.

Parameter	Type	Description
dates	Date[]	The reference dates. editKind: String Kind of edit: "resizeStart", "resizeEnd", "resizeBoth" or "move".
eventSource	String	"mouse", "keyboard", "touch"
e	Event	The event at the origin of the editing gesture.

_onColumnHeaderClick

Defined by dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

Parameter	Type	Description
e

_onGridClick

Defined by dijit._WidgetBase

Parameter	Type	Description
e

_onGridDoubleClick

Defined by dijit._WidgetBase

Parameter	Type	Description
e

_onGridMouseDown

Overrides dijit._WidgetBase

Parameter	Type	Description
e

_onGridMouseUp

Defined by dijit._WidgetBase, dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

Parameter	Type	Description
e

_onGridTouchEnd

Defined by dijit._WidgetBase, dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

Parameter	Type	Description
e

_onGridTouchMove

Defined by dijit._WidgetBase, dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

Parameter	Type	Description
e

_onGridTouchStart

Overrides dijit._WidgetBase, dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

Parameter	Type	Description
e

_onItemClick

Defined by dijit._WidgetBase

Parameter	Type	Description
e

_onItemDoubleClick

Defined by dijit._WidgetBase

Parameter	Type	Description
e

_onItemEditBegin

Defined by dijit._WidgetBase

Parameter	Type	Description
e

_onItemEditBeginGesture

Defined by dijit._WidgetBase

Parameter	Type	Description
e

_onItemEditEnd

Defined by dijit._WidgetBase

Parameter	Type	Description
e

_onItemEditEndGesture

Defined by dijit._WidgetBase

Parameter	Type	Description
e

_onItemEditMoveGesture

Defined by dijit._WidgetBase

Parameter	Type	Description
e

_onItemEditResizeGesture

Defined by dijit._WidgetBase

Parameter	Type	Description
e

_onRenderersLayoutDone

Defined by dijit._WidgetBase

Parameter	Type	Description
view

_onScrollTimer_tick

Defined by dijit._WidgetBase, dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

Parameter	Type	Description
pos

_overlapLayoutPass2

Defined by dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

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

Parameter	Type	Description
lanes	The	array of lanes. tags private

_recycleItemRenderers

Defined by dijit._WidgetBase

Parameter	Type	Description
remove

_recycleRenderer

Defined by dijit._WidgetBase

Recycles the item renderer to be reused in the future.

Parameter	Type	Description
renderer	dojox.calendar._RendererMixin	The item renderer to recycle. tags protected
remove

_refreshItemsRendering

Overrides dijit._WidgetBase

_scrollBar_onScroll

Defined by dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

Parameter	Type	Description
value

_scrollToPosition

Defined by dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

Parameter	Type	Description
position
maxDuration
easing

_setColumnCountAttr

Overrides dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

Parameter	Type	Description
value

_setEditingProperties

Defined by 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.

Parameter	Type	Description
props

_setExpandRendererAttr

Parameter	Type	Description
value

_setHorizontalRendererAttr

Parameter	Type	Description
value

_setHoveredItem

Defined by dijit._WidgetBase

Parameter	Type	Description
item
renderer

_setItemsAttr

Overrides dijit._WidgetBase

Parameter	Type	Description
value

_setScrollImpl

Defined by dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

Parameter	Type	Description
v

_setSelectedItemAttr

Defined by dijit._WidgetBase

Parameter	Type	Description
value

_setSelectedItemsAttr

Defined by dijit._WidgetBase

Parameter	Type	Description
value

_setSelectionModeAttr

Defined by dijit._WidgetBase

Parameter	Type	Description
value

_setStartDateAttr

Overrides dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

Parameter	Type	Description
value

_setStartTimeOfDay

Defined by dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

Parameter	Type	Description
hour
minutes
maxDuration
easing

_setStartTimeOfDayAttr

Defined by dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

Parameter	Type	Description
value

_setText

Defined by dijit._WidgetBase

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

_setTextDirAttr

Parameter	Type	Description
value

_setVerticalRendererAttr

Defined by dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

Parameter	Type	Description
value

_setVisibility

Parameter	Type	Description
value

_sortItemsFunction

Defined by dijit._WidgetBase, dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

Parameter	Type	Description
a
b

_startAutoScroll

Defined by dijit._WidgetBase

Parameter	Type	Description
step

_startItemEditing

Defined by dijit._WidgetBase

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

Parameter	Type	Description
item	Object	The item that will be edited.
eventSource	String	"mouse", "keyboard", "touch"

_startItemEditingGesture

Defined by dijit._WidgetBase

Starts the editing gesture. date: Date[] The reference dates (at least one).

Parameter	Type	Description
dates
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

Defined by dijit._WidgetBase

_updateEditingCapabilities

Defined by dijit._WidgetBase

Parameter	Type	Description
item
renderer

_validateProperties

Defined by dijit._WidgetBase, dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

Validates the widget properties before the rendering pass. tags protected

_waDojoxAddIssue

Defined by dijit._WidgetBase

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
unit
steps

applyRendererZIndex

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

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.

buildRendering

Overrides dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

computeOverlapping

Defined by dijit._WidgetBase

Object

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. addedPass: Function Whether computes the extent of each item renderer on free sibling lanes.
func

computeProjectionOnDate

Defined by dijit._WidgetBase

Number

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 date to project.
max	Integer	The size in pixels of the representation of a day.

computeRangeOverlap

Defined by 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.

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.

constructor

Defined by dijit._WidgetBase, dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

Parameter	Type	Description
args	Object

destroy

Overrides dijit._WidgetBase, dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

Parameter	Type	Description
preserveDom

ensureMinimalDuration

Defined by dijit._WidgetBase

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

Defined by dijit._WidgetBase, dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

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	int	Margin in minutes around the time range.
duration	Number	Optional, the maximum duration of the scroll animation.

floorDate

Defined by dijit._WidgetBase

Date

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.

floorToDay

Defined by dijit._WidgetBase

Date

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.

floorToMonth

Defined by dijit._WidgetBase

Date

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.

getIdentity

Defined by dijit._WidgetBase

Parameter	Type	Description
item

getRenderers

Defined by 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.

Parameter	Type	Description
item	Object	The data or render item.

getSecondarySheet

dojox.calendar.MatrixView

Returns the secondary sheet

getTime

Defined by dijit._WidgetBase, dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

Date

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.

getTimeOfDay

Defined by dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

Return the time of day associated to the specified position.

Parameter	Type	Description
pos	Integer	The position in pixels.
rd	Object	The render data.

getWeekNumberLabel

Defined by dijit._WidgetBase

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.

invalidateLayout

Overrides dijit._WidgetBase

trigger a re-layout of the renderers.

invalidateRendering

isAscendantHasClass

Defined by dijit._WidgetBase

Boolean

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.

isItemBeingEdited

Defined by dijit._WidgetBase

Boolean

Returns whether an item is being edited or not.

Parameter	Type	Description
item	Object	The item to test.

isItemEditable

Defined by dijit._WidgetBase

Boolean

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.

isItemFocused

Defined by dijit._WidgetBase

Boolean

Returns whether the specified item is focused or not.

Parameter	Type	Description
item	Object	The item.

isItemHovered

Defined by dijit._WidgetBase

Boolean

Returns whether the specified item is hovered or not.

Parameter	Type	Description
item	Object	The item.

isItemMoveEnabled

Defined by dijit._WidgetBase

Boolean

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.

isItemResizeEnabled

Defined by dijit._WidgetBase

Boolean

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.

isItemSelected

Defined by dijit._WidgetBase

Parameter	Type	Description
item

isOverlapping

Defined by 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.

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.

isSameDay

Defined by dijit._WidgetBase

Boolean

Tests if the specified dates are in the same day.

Parameter	Type	Description
date1	Date	The first date.
date2	Date	The second date.

isStartOfDay

Defined by dijit._WidgetBase

Boolean

Tests if the specified date represents the starts of day.

Parameter	Type	Description
d	Date	The date to test.

isToday

Defined by dijit._WidgetBase

Boolean

Returns whether the specified date is in the current day.

Parameter	Type	Description
date	Date	The date to test. renderData: Object The current renderData

isWeekEnd

Defined by 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.

Parameter	Type	Description
date	Date	The date to test.

itemToRendererKindFunc

Defined by 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

Defined by 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

Defined by dijit._WidgetBase

Date

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

refreshRendering

Defined by dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

resize

Defined by dijit._WidgetBase

resizeSecondarySheet

Resizes the secondary sheet header and relayout the other sub components according this new height. Warning: this method is only available for the default template and default CSS.

Parameter	Type	Description
height	Integer	The new height in pixels.

scrollView

Defined by dijit._WidgetBase, dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

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.

selectFromEvent

Defined by dijit._WidgetBase

Parameter	Type	Description
e
item
renderer
dispatch

setItemSelected

Defined by dijit._WidgetBase

Parameter	Type	Description
item
value

styleColumnHeaderCell

Defined by dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

Styles the CSS classes to the node that displays a column header cell. By default this method is setting the "dojoxCalendarToday" class name if the date displayed is the current date or "dojoxCalendarWeekend" if the date represents a weekend.

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.

styleGridColumn

Defined by dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

Styles the CSS classes to the node that displays a column. By default this method is setting the "dojoxCalendarToday" class name if the date displayed is the current date or "dojoxCalendarWeekend" if the date represents a weekend.

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

styleRowHeaderCell

Defined by dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

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.
renderData	Object	The render data.

updateRenderers

Overrides dijit._WidgetBase

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

Parameter	Type	Description
obj
stateOnly

Events

onColumnHeaderClick

Defined by dojox.calendar.ViewBase, dojox.calendar.SimpleColumnView

Event dispatched when a column header cell is dispatched.

Parameter	Type	Description
e	Event	The event has the following properties: index: Integer The column index. date: Date The date displayed by the column. triggerEvent: Event The origin event.

onGridClick

Defined by dijit._WidgetBase

Event dispatched when the grid has been clicked.

Parameter	Type	Description
e

onGridDoubleClick

Defined by dijit._WidgetBase

Event dispatched when the grid has been double-clicked.

Parameter	Type	Description
e

onItemClick

Defined by dijit._WidgetBase

Event dispatched when an item renderer has been clicked.

Parameter	Type	Description
e

onItemDoubleClick

Defined by dijit._WidgetBase

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

Parameter	Type	Description
e

onItemEditBegin

Defined by dijit._WidgetBase

Event dispatched when the item is entering the editing mode.

Parameter	Type	Description
e

onItemEditBeginGesture

Defined by dijit._WidgetBase

Event dispatched when an editing gesture is beginning.

Parameter	Type	Description
e

onItemEditEnd

Defined by dijit._WidgetBase

Event dispatched when the item is leaving the editing mode.

Parameter	Type	Description
e

onItemEditEndGesture

Defined by dijit._WidgetBase

Event dispatched at the end of an editing gesture.

Parameter	Type	Description
e

onItemEditMoveGesture

Defined by dijit._WidgetBase

Event dispatched during a move editing gesture.

Parameter	Type	Description
e

onItemEditResizeGesture

Defined by dijit._WidgetBase

Event dispatched during a resize editing gesture.

Parameter	Type	Description
e

onRendererCreated

Defined by dijit._WidgetBase

Event dispatched when an item renderer has been created.

Parameter	Type	Description
renderer

onRendererDestroyed

Defined by dijit._WidgetBase

Event dispatched when an item renderer is destroyed.

Parameter	Type	Description
renderer

onRendererRecycled

Defined by dijit._WidgetBase

Event dispatched when an item renderer has been recycled.

Parameter	Type	Description
renderer

onRendererReused

Defined by dijit._WidgetBase

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

Parameter	Type	Description
renderer

onRenderersLayoutDone

Defined by dijit._WidgetBase

Event triggered when item renderers layout has been done.

Parameter	Type	Description
view

onRowHeaderClick

Event dispatched when the row header cell of the secondary sheet is clicked.

Parameter	Type	Description
e