dojox/grid/DataGrid (version 1.8)

Add a row to the grid.

The function overridden in the _BidiSupport module, originally used for setting element.dir according to this.textDir. In this case does nothing.

Set or get properties on a widget instance.

This method is deprecated, use get() or set() directly.

Use to make multiple changes to rows while queueing row updating.

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.

Creates a new Grid layout

create grid managers for various tasks including rows, focus, selection, editing

Creates a new virtual scroller

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

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.

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

Use after calling beginUpdate to render any changes made to rows.

Retrieves the cell object for a given grid column.

Returns all the widgets contained by this, i.e., all widgets underneath this.containerNode. Does not return nested widgets, nor widgets that are part of this widget's template.

returns an array of dijit.CheckedMenuItem widgets that can be added to a menu for toggling columns on and off.

Returns all the widgets contained by this, i.e., all widgets underneath this.containerNode. This method should generally be avoided as it returns widgets declared in templates, which are supposed to be internal/hidden, but it's left here for back-compat reasons.

Returns the parent widget of this widget

find the rowNode that is not a rowSelector

Returns true if grid is sorted in an ascending direction.

Returns the index of the column on which the grid is sorted

Return direction of the text. The function overridden in the _BidiSupport module, its main purpose is to calculate the direction of the text, if was defined by the programmer through textDir.

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

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

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.

Render the grid, headers, and views. Edit and scrolling states are reset. To retain edit and scrolling states, see Update.

Update the grid's rendering dimensions and resize it

Update grid when the height of a row has changed. Row height is handled automatically as rows are rendered. Use this function only to update a row's height outside the normal rendering process.

Vertically scroll the grid to a given pixel position

Scroll the grid to a specific row.

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)

Deprecated. Use set() instead.

Sort the grid on a column in a specified direction

Install a new structure and rebuild the grid.

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.

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

Update the grid, retaining edit and scrolling states.

Render a single row.

Change the number of rows.

Render consecutive rows at once.

Update the styles for a row after it's state has changed.

Watches a property for changes

Event fired when editing is applied for a given grid cell

Event fired when editing is applied for a given grid row

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.

Event fired when editing is cancelled for a given grid cell

Event to determine if a grid row may be deselected

Event to determine if a grid row may be selected

Event fired when a cell is clicked.

Event fired when a cell context menu is accessed via mouse right click.

Event fired when a cell is double-clicked.

Event fired when a cell receives focus.

Event fired when mouse is down in a header cell.

Event fired when mouse moves out of a cell.

Event fired when mouse is over a cell.

Connect to this function to receive notifications of mouse click events.

Called when this widget is being displayed as a popup (ex: a Calendar popped up from a DateTextBox), and it is hidden. This is called from the dijit.popup code, and should not be called directly.

Also used as a parameter for children of dijit/layout/StackContainer or subclasses. Callback if a user tries to close the child. Child will be closed if this function returns true.

Top level handler for Content events

Connect to this function to receive notifications of mouse double click events.

Event fired when a grid row is deselected

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

Event fired when a header cell is clicked.

Event fired when a header cell context menu is accessed via mouse right click.

Event fired when a header cell is double clicked.

Event fired when mouse is down in a header cell.

Event fired when mouse moves out of a header cell.

Event fired when mouse moves over a header cell.

Event fired when the grid header is clicked.

Event fired when the grid header context menu is accessed via mouse right click.

Event fired when the grid header is double clicked.

Top level handler for header events

Event fired when mouse moves out of the grid header.

Event fired when mouse moves over the grid header.

Called when another widget becomes the selected pane in a dijit/layout/TabContainer, dijit/layout/StackContainer, dijit/layout/AccordionContainer, etc.

Also called to indicate hide of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane.

Connect to this function to receive notifications of keys being pressed down.

top level handler for Key Events

Connect to this function to receive notifications of printable keys being typed.

Connect to this function to receive notifications of keys being released.

Connect to this function to receive notifications of when the mouse button is pressed down.

Event fired when mouse is down inside grid row

Connect to this function to receive notifications of when the mouse moves onto this widget.

Connect to this function to receive notifications of when the mouse moves off of this widget.

Connect to this function to receive notifications of when the mouse moves over nodes contained within this widget.

Connect to this function to receive notifications of when the mouse moves off of nodes contained within this widget.

Event fired when mouse moves out of any row (data or header).

Connect to this function to receive notifications of when the mouse moves onto nodes contained within this widget.

Event fired when mouse is over any row (data or header).

Connect to this function to receive notifications of when the mouse button is released.

Event fired when a row is clicked.

Event fired when a row context menu is accessed via mouse right click.

Event fired when a row is double clicked.

Event fired when mouse is down in a row.

Event fired when mouse moves out of a data row.

Event fired when mouse moves over a data row.

Event fired when a grid row is selected

Called when this widget becomes the selected pane in a dijit/layout/TabContainer, dijit/layout/StackContainer, dijit/layout/AccordionContainer, etc.

Also called to indicate display of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane.

Event fired when editing is started for a given grid cell