The simple column view is displaying a day per column. Each cell of a column is a time slot.
See the dojox/calendar/SimpleColumnView reference documentation for more information.
List of connections associated with data-dojo-attach-event=... in the template
List of widget attribute names associated with data-dojo-attach-point=... in the template, ex: ["containerNode", "labelNode"]
Path to a blank 1x1 image.
Used by <img>
nodes in templates that really get their image via CSS background-image.
The number of units displayed by a visual layout unit (i.e. a column or a row)
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.
The attribute of the store item that contains the all day state of the events represented by this item. Default is "allDay".
If several sub columns are displayed, indicated if the data item can be reassigned to another sub column by an editing gesture.
Object to which attach points and events will be scoped. Defaults to 'this'.
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:
"focusNode" ---> { node: "focusNode", type: "attribute" }
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.
The number of column to display (from the startDate).
Custom date/time pattern for column header labels to override default one coming from the CLDR. See dojo/date/locale documentation for format string.
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.
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.
Optional function that returns a css class name to apply to item renderers that are displaying the specified item in parameter.
JavaScript namespace to find Calendar routines. Uses Gregorian Calendar routines at dojo.date by default.
An optional function to transform store date into Date objects. Default is null.
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.
Whether the data items displayed must be recomputed, usually after the displayed time range has changed.
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.
The maximum delay between two taps needed to trigger an "itemDoubleClick" event, in touch context.
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.
An optional function to transform Date objects into store date. Default is null.
The attribute of the store item that contains the end time of the events represented by this item. Default is "endTime".
This widget or a widget it contains has focus, or is "active" because it was recently clicked.
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.
The number of pixels between two item renderers that are overlapping each other if the percentOverlap property is 0.
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.
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.
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.
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.
The maximum hour to be displayed. It must be in the [1,36] interval and must be greater than the minHours.
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.
The minimum hour to be displayed. It must be in the [0,23] interval and must be lower than the maxHours.
A flag that indicates whether the user can move items displayed.
If true
, the user can move the items.
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
The percentage of the renderer width used to superimpose one item renderer on another when two events are overlapping.
The render data is the object that contains all the properties needed to render the component.
CSS value to apply to the cursor while resizing an item renderer.
A flag that indicates whether the items can be resized.
If true
, the control supports resizing of items.
Offset of the first row label from the top of the first row header cell in pixels.
Duration of the time slot in minutes in the row header. Must be a divisor of 60 and a multiple/divisor of timeSlotDuration.
Offset of the row label from the top of the row header cell in pixels.
Duration of the time slot in minutes in the row header labels. Must be a divisor of 60 and a multiple/divisor of timeSlotDuration.
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.
Position of the scroll bar in right-to-left display. Valid values are "left" and "right", default value is "left".
Method used to scroll the view, for example the scroll of column view. Valid value are:
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.
The list of selected items. Warning: Do not use this property directly, make sure to call set() or get() methods.
Valid values are:
Whether show or not an indicator (default a red line) at the current time.
The start date of the time interval displayed. If not set at initialization time, will be set to current day.
The attribute of the store item that contains the start time of the events represented by this item. Default is "startTime".
First time (hour/minute) of day displayed, if reachable. An object containing "hours" and "minutes" properties.
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.
The attribute of the store item that contains the sub column name of the events represented by this item. Default is "calendar".
The attribute of the store item that contains the summary of the events represented by this item. Default is "summary".
Path to template (HTML file) for this widget relative to dojo.baseUrl. Deprecated: use templateString with require([... "dojo/text!..."], ...) instead
Maximal interval between two refreshes of time indicator, in milliseconds.
Duration of the time slot in minutes. Must be a divisor of 60.
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.
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.
The class use to create decoration renderers.
The class use to create vertical renderers.
Type of the view. Used by the calendar widget to determine how to configure the view. This view kind is "columns".
Parameter | Type | Description |
---|---|---|
node | undefined | |
minutes | undefined |
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.
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 |
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:
Parameter | Type | Description |
---|---|---|
rootNode | DomNode | The node to search for properties. All descendants will be searched. |
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
|
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 |
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. |
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. |
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. |
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. |
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. |
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. |
Internal helper for directly changing an attribute value.
Parameter | Type | Description |
---|---|---|
id | undefined |
Parameter | Type | Description |
---|---|---|
e | undefined |
Parameter | Type | Description |
---|---|---|
renderData | undefined |
Parameter | Type | Description |
---|---|---|
item | undefined | |
editKind | String | Kind of edit: "resizeStart", "resizeEnd", "resizeBoth" or "move". |
rendererKind | undefined | |
times | undefined | |
eventSource | undefined |
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. |
Parameter | Type | Description |
---|---|---|
styleWidth | undefined |
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. |
Sets the scroll bar size and position.
Parameter | Type | Description |
---|---|---|
renderData | Object | The render data. |
Parameter | Type | Description |
---|---|---|
renderData | undefined |
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 |
Parameter | Type | Description |
---|---|---|
renderData | Object | |
oldRenderData | Object |
Destroys the item renderer.
Parameter | Type | Description |
---|---|---|
renderer | dojox/calendar/_RendererMixin | The item renderer to destroy. |
Parameter | Type | Description |
---|---|---|
kind | undefined |
Detach and clean up the attachments made in _attachtempalteNodes.
Adds view properties to event and enable bubbling at owner level.
Parameter | Type | Description |
---|---|---|
e | Event | The dispatched event. |
name | String | The event name. |
Parameter | Type | Description |
---|---|---|
obj | undefined | |
eventSource | undefined |
Leaves the item editing mode.
Parameter | Type | Description |
---|---|---|
eventSource | String | "mouse", "keyboard", "touch" |
canceled | Boolean |
Parameter | Type | Description |
---|---|---|
eventSource | String | |
e | Event |
Parameter | Type | Description |
---|---|---|
item | undefined |
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 |
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 |
Parameter | Type | Description |
---|---|---|
id | undefined | |
list | undefined |
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 |
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 |
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 |
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 |
Parameter | Type | Description |
---|---|---|
renderData | undefined | |
index | undefined | |
subIndex | undefined | |
itemsType | undefined |
Returns the visible last time of day.
Returns the horizontal scroll position (if the view is scrollable), using the scroll method defined.
Parameter | Type | Description |
---|---|---|
e | undefined | |
x | undefined | |
y | undefined | |
touchIndex | undefined |
Returns the vertical scroll position (if the view is scrollable), using the scroll method defined.
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 the visible first time of day.
Returns the top owner: the calendar or the parent view.
Parameter | Type | Description |
---|---|---|
value | undefined |
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
Parameter | Type | Description |
---|---|---|
item | undefined |
Associates a kind of renderer with a data item.
Parameter | Type | Description |
---|---|---|
item | Object | The data item. |
Parameter | Type | Description |
---|---|---|
renderData | undefined |
Parameter | Type | Description |
---|---|---|
renderData | Object | |
index | Integer | |
start | Date | |
end | Date | |
items | Object[] | |
itemsType | String |
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. |
Parameter | Type | Description |
---|---|---|
renderData | undefined |
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 |
Parameter | Type | Description |
---|---|---|
renderData | undefined | |
rendererKind | undefined | |
computeOverlap | undefined | |
index | undefined | |
start | undefined | |
end | undefined | |
items | undefined | |
itemsType | undefined |
Parameter | Type | Description |
---|---|---|
renderData | undefined |
Parameter | Type | Description |
---|---|---|
renderData | Object | |
rendererKind | String | |
computeOverlap | boolean | |
index | Integer | |
subIndex | Integer | |
startTime | Date | |
endTime | Date | |
items | Object[] | |
itemsType | String |
Mouse wheel handler.
Parameter | Type | Description |
---|---|---|
e | undefined |
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. |
Second pass of the overlap layout (optional). Compute the extent of each layout item.
Parameter | Type | Description |
---|---|---|
lanes | undefined | The array of lanes. |
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. |
Parameter | Type | Description |
---|---|---|
remove | undefined |
Recycles the item renderer to be reused in the future.
Parameter | Type | Description |
---|---|---|
renderer | dojox/calendar/_RendererMixin | The item renderer to recycle. |
remove | undefined |
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 |
Parameter | Type | Description |
---|---|---|
value | undefined |
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 |
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 |
Parameter | Type | Description |
---|---|---|
value | undefined |
Parameter | Type | Description |
---|---|---|
value | undefined |
Parameter | Type | Description |
---|---|---|
value | undefined |
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 |
Sets the current hovered item.
Parameter | Type | Description |
---|---|---|
item | Object | The data item. |
renderer | dojox/calendar/_RendererMixin | The item renderer. |
Sets the horizontal scroll position (if the view is scrollable), using the scroll method defined.
Parameter | Type | Description |
---|---|---|
pos | undefined |
Parameter | Type | Description |
---|---|---|
pos | undefined | |
useDom | undefined | |
cssProp | undefined |
Parameter | Type | Description |
---|---|---|
item | Object | |
state | String |
Parameter | Type | Description |
---|---|---|
value | undefined |
Sets the verical scroll position (if the view is scrollable), using the scroll method defined.
Parameter | Type | Description |
---|---|---|
pos | undefined |
Sets the scroll position (if the view is scrollable), using the scroll method defined.
Parameter | Type | Description |
---|---|---|
pos | undefined | |
vertical | undefined |
Parameter | Type | Description |
---|---|---|
value | undefined |
Parameter | Type | Description |
---|---|---|
value | undefined |
Parameter | Type | Description |
---|---|---|
value | undefined |
Parameter | Type | Description |
---|---|---|
value | undefined |
Parameter | Type | Description |
---|---|---|
value | undefined |
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 |
Parameter | Type | Description |
---|---|---|
value | undefined |
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 |
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 |
Parameter | Type | Description |
---|---|---|
value | undefined |
Parameter | Type | Description |
---|---|---|
a | undefined | |
b | undefined |
Starts the auto scroll of the view (if it's scrollable). Used only during editing.
Parameter | Type | Description |
---|---|---|
step | undefined |
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" |
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. |
Stops the auto scroll of the view (if it's scrollable). Used only during editing.
Does substitution of ${foo} type properties in template string
Parameter | Type | Description |
---|---|---|
tmpl | undefined |
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. |
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. |
Parameter | Type | Description |
---|---|---|
date | undefined | |
unit | undefined | |
steps | undefined |
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. |
Function invoked just after the view is displayed by the calendar.
Function invoked just after the view is the view is hidden or removed by the calendar.
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. |
Function invoked just before the view is displayed by the calendar.
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 |
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. |
The size in pixels of the representation of a day.
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. |
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 |
A handle that can be passed to disconnect
in order to disconnect before
the widget is destroyed.
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()); });
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:
|
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) |
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. |
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. |
Parameter | Type | Description |
---|---|---|
preserveDom | undefined |
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. |
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. |
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. |
Deprecated, will be removed in 2.0, use handle.remove() instead.
Disconnects handle created by connect
.
Parameter | Type | Description |
---|---|---|
handle | undefined |
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. |
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
|
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". |
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. |
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. |
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. |
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. |
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 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().
Utility method that return the specific CSS prefix for non standard CSS properties. Ex: -moz-border-radius.
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 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 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 the sub column index that has the specified value, if any. -1 otherwise.
Parameter | Type | Description |
---|---|---|
value | String | The sub column index. |
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. |
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 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. |
Invalidating the rendering for the next executation frame.
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. |
Return true if this widget can currently be focused and false if not
Returns whether an item is being edited or not.
Parameter | Type | Description |
---|---|---|
item | Object | The item to test. |
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 whether the specified item is focused or not.
Parameter | Type | Description |
---|---|---|
item | Object | The item. |
Returns whether the specified item is hovered or not.
Parameter | Type | Description |
---|---|---|
item | Object | The item. |
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. |
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. |
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.
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. |
Tests if the specified dates are in the same day.
Parameter | Type | Description |
---|---|---|
date1 | Date | The first date. |
date2 | Date | The second date. |
Tests if the specified date represents the starts of day.
Parameter | Type | Description |
---|---|---|
d | Date | The date to test. |
Returns whether the specified date is in the current day.
Parameter | Type | Description |
---|---|---|
date | Date | The date to test. |
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. |
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. |
Creates a new Date object.
Parameter | Type | Description |
---|---|---|
obj | Object | This object can have several values:
|
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 |
Track specified handles and remove/destroy them when this instance is destroyed, unless they were already removed/destroyed manually.
The array of specified handles, so you can do for example:
var handle = this.own(on(...))[0];
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(). |
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.
// 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'); }));
// create a button out of a node with id="src" and append it to id="wrapper": var button = new Button({},"src").placeAt("wrapper");
// place a new button as the first element of some div var button = new Button({ label:"click" }).placeAt("wrapper","first");
// create a contentpane and add it to a TabContainer var tc = dijit.byId("myTabs"); new ContentPane({ href:"foo.html", title:"Wow!" }).placeAt(tc)
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.
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.
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. |
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. |
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. |
Parameter | Type | Description |
---|---|---|
e | undefined | |
item | undefined | |
renderer | undefined | |
dispatch | undefined |
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. |
Set a property on a widget
Parameter | Type | Description |
---|---|---|
item | undefined | |
value | undefined |
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.
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. |
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. |
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. |
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. |
Computes the label for a sub column from the subColumns property. By default, return the value.
Parameter | Type | Description |
---|---|---|
value | undefined |
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 |
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); });
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
Parameter | Type | Description |
---|---|---|
handle | Object |
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. |
Immediately validate the rendering if it has been invalidated. You generally do not call that method yourself.
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. |
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
This is where widgets do processing for when they stop being active, such as changing CSS classes. See onBlur() for more details.
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); });
Parameter | Type | Description |
---|---|---|
e | undefined |
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); });
This is where widgets do processing for when they are active, such as changing CSS classes. See onFocus() for more details.
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); });
Parameter | Type | Description |
---|---|---|
e | undefined |
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); });
Parameter | Type | Description |
---|---|---|
e | undefined |
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); });
Parameter | Type | Description |
---|---|---|
e | undefined |
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); });
Parameter | Type | Description |
---|---|---|
e | undefined |
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); });
Parameter | Type | Description |
---|---|---|
e | undefined |
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); });
Parameter | Type | Description |
---|---|---|
e | undefined |
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); });
Parameter | Type | Description |
---|---|---|
e | undefined |
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); });
Parameter | Type | Description |
---|---|---|
e | undefined |
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); });
Parameter | Type | Description |
---|---|---|
e | undefined |
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); });
Parameter | Type | Description |
---|---|---|
e | undefined |
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); });
Parameter | Type | Description |
---|---|---|
e | undefined |
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); });
Parameter | Type | Description |
---|---|---|
e | undefined |
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); });
Parameter | Type | Description |
---|---|---|
e | undefined |
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); });
Parameter | Type | Description |
---|---|---|
e | undefined |
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); });
Parameter | Type | Description |
---|---|---|
e | undefined |
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); });
Parameter | Type | Description |
---|---|---|
e | undefined |
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); });
Parameter | Type | Description |
---|---|---|
e | undefined |
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); });
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 |
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); });
Parameter | Type | Description |
---|---|---|
e | undefined |
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); });
Parameter | Type | Description |
---|---|---|
e | undefined |
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); });
Parameter | Type | Description |
---|---|---|
e | undefined |
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); });
Parameter | Type | Description |
---|---|---|
e | undefined |
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); });
Parameter | Type | Description |
---|---|---|
view | undefined |
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); });
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); });
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.
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); });
Called when the selection changed.
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); });
Event dispatched when a column header cell is dispatched.
Parameter | Type | Description |
---|---|---|
e | Object | The event has the following properties |
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); });
Called when the widget becomes "active" because it or a widget inside of it either has focus, or has recently been clicked.
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); });
Event dispatched when the grid has been clicked.
Parameter | Type | Description |
---|---|---|
e | Object | The event dispatched when the grid is clicked. |
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); });
Event dispatched when the grid has been double-clicked.
Parameter | Type | Description |
---|---|---|
e | Object | The event dispatched when the grid is double-clicked. |
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); });
Event dispatched when an item renderer has been clicked.
Parameter | Type | Description |
---|---|---|
e | Object | The event dispatched when an item is clicked. |
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); });
Event dispatched when an item renderer has been context-clicked.
Parameter | Type | Description |
---|---|---|
e | Object | The event dispatched when an item is context-clicked. |
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); });
Event dispatched when an item renderer has been double-clicked.
Parameter | Type | Description |
---|---|---|
e | Object | The event dispatched when an item is double-clicked. |
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); });
Event dispatched when the item is entering the editing mode.
Parameter | Type | Description |
---|---|---|
e | undefined |
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); });
Event dispatched when an editing gesture is beginning.
Parameter | Type | Description |
---|---|---|
e | Object | The editing event. |
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); });
Event dispatched when the item is leaving the editing mode.
Parameter | Type | Description |
---|---|---|
e | undefined |
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); });
Event dispatched at the end of an editing gesture.
Parameter | Type | Description |
---|---|---|
e | Object | The editing event. |
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); });
Event dispatched during a move editing gesture.
Parameter | Type | Description |
---|---|---|
e | Object | The editing event. |
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); });
Event dispatched during a resize editing gesture.
Parameter | Type | Description |
---|---|---|
e | Object | The editing event. |
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); });
Event dispatched when an item renderer has been created.
Parameter | Type | Description |
---|---|---|
e | Object | The renderer lifecycle event. |
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); });
Event dispatched when an item renderer is destroyed.
Parameter | Type | Description |
---|---|---|
e | Object | The renderer lifecycle event. |
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); });
Event dispatched when an item renderer has been recycled.
Parameter | Type | Description |
---|---|---|
e | Object | The renderer lifecycle event. |
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); });
Event dispatched when an item renderer that was recycled is reused.
Parameter | Type | Description |
---|---|---|
e | Object | The renderer lifecycle event. |
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); });
Event triggered when item renderers layout has been done.
Parameter | Type | Description |
---|---|---|
view | undefined |
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); });