dojox/calendar/Calendar (version 1.10)

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.

Add a view to the calendar's view list.

Function called when the cell of a column header of the column view is clicked. Show the time range defined by the clicked date.

Set the localized labels of the buttons and the event handlers.

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.

The action triggerred when the day button is clicked. By default, sets the dateInterval property to "day" and the "dateIntervalSteps" to 1.

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

Destroy this widget, but not its descendants. Descendants means widgets inside of this.containerNode. Will also destroy any resources (including widgets) registered via this.own().

This method will also destroy internal widgets such as those created from a template, assuming those widgets exist inside of this.domNode but outside of this.containerNode.

For 2.0 it's planned that this method will also destroy descendant widgets, so apps should not depend on the current ability to destroy a widget without destroying its descendants. Generally they should use destroyRecursive() for widgets with children.

Recursively destroy the children of this widget and their descendants.

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.

Destroys the DOM nodes associated with this widget.

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

Disconnects handle created by connect.

Dispatch a selection change event.

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

floors the date to the unit.

Floors the specified date to the start of day.

Floors the specified date to the beginning of week.

The action triggerred when the 4 days button is clicked. By default, sets the dateInterval property to "day" and the "dateIntervalSteps" to 4.

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

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

Returns the parent widget of this widget.

Changes the displayed time interval to show the current day. Sets the date property to the current day, the dateInterval property to "day" and the "dateIntervalSteps" to 1.

Invalidating the rendering for the next executation frame.

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

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

Returns whether the specified item is hovered or not.

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

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

Returns whether an item is selected or not.

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

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.

Tests if the specified date represents the starts of day.

Returns whether the specified date is in the current day.

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.

Function called when the cell of a row header of the matrix view is clicked. The implementation is doing the foolowing actions: - If another row is already expanded, collapse it and then expand the clicked row. - If the clicked row is already expadned, collapse it. - If no row is expanded, expand the click row.

The action triggered when the month button is clicked. By default, sets the dateInterval property to "month" and the "dateIntervalSteps" to 1.

Creates a new Date object.

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

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

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.

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.

Refreshes all the visual rendering of the calendar.

Removes a view from the calendar's view list.

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.

Applies selection triggered by an user interaction

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)

Change the selection state of an item.

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.

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.

The action triggered when the today button is clicked. By default, calls the goToday() method.

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.

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

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

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

Watches a property for changes

The action triggered when the week button is clicked. By default, sets the dateInterval property to "week" and the "dateIntervalSteps" to 1.

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.

Called when the selection changed.

Event dispatched when a column header cell is dispatched.

Event dispatched when the current view has changed.

Event dispatched when an expand renderer is clicked.

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

Event dispatched when the grid has been clicked.

Event dispatched when the grid has been double-clicked.

Event dispatched when an item renderer has been clicked.

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

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

Event dispatched when the item is entering the editing mode.

Event dispatched when an editing gesture is beginning.

Event dispatched when the item is leaving the editing mode.

Event dispatched at the end of an editing gesture.

Event dispatched during a move editing gesture.

Event dispatched during a resize editing gesture.

Event dispatched when an item renderer has been created.

Event dispatched when an item renderer is destroyed.

Event dispatched when an item renderer has been recycled.

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

Event triggered when item renderers layout has been done.

Event dispatched when a row header cell is clicked.

Event dispatched when the displayed time interval has changed.

Event dispatched when a view is added from the calendar.

Event dispatched when the view has been configured after the queried time range and before the current view is changed (if needed).

Event dispatched when a view is removed from the calendar.