This plugin provides a way to persist some grid features in cookie. Default persistable features are: column width: "columnWidth" (handler name) column order: "columnOrder" sorting order: "sortOrder"
Grid users can define new persistable features by calling the following before grid is initialized (that is, during "preInit");
grid.addCookieHandler({
name: "a name for the new persistable feature",
onLoad: function(savedObject, grid){
//load the cookie.
},
onSave: function(grid){
//save the cookie.
}
});
| Parameter | Type | Description |
|---|---|---|
| grid | undefined | |
| args | undefined |
Plugin properties - leveraged with default and user specified properties. e.g. for dnd plugin, it may look like {"class": dojox.grid.enhanced.plugins.DnD, "dependency": ["nestedSorting"], ...}
Private properties/methods shouldn't be mixin-ed anytime.
If a grid plugin wants cookie service, call this. This must be called during preInit.
| Parameter | Type | Description |
|---|---|---|
| args | Object | An object with the following structure: {
name: "some-string",
onLoad: /* void */ function(/* object */partOfCookie, /* EDG */grid){...},
onSave: /* object */ function(/* EDG */grid){...}
}
|
Connects specified obj/event to specified method of this object.
| Parameter | Type | Description |
|---|---|---|
| obj | undefined | |
| event | undefined | |
| method | undefined |
var plugin = new dojox.grid.enhanced._Plugin(grid,"myPlugin",{...});
// when foo.bar() is called, call the listener in the scope of plugin
plugin.connect(foo, "bar", function(){
console.debug(this.xxx());//"this" - plugin scope
});
Disconnects handle and removes it from connection list.
| Parameter | Type | Description |
|---|---|---|
| handle | undefined |
A getter to check cookie support of a particular Grid feature.
| Parameter | Type | Description |
|---|---|---|
| cookieName | String |
Optional Name of a cookie handler if provided, otherwise for all cookies. |
A setter to enable|disable cookie support for a particular Grid feature.
| Parameter | Type | Description |
|---|---|---|
| cookieName | String |
Optional Name of a cookie handler if provided, otherwise for all cookies. |
| enabled | Boolean |
Subscribes to the specified topic and calls the specified method of this object.
| Parameter | Type | Description |
|---|---|---|
| topic | undefined | |
| method | undefined |
var plugin = new dojox.grid.enhanced._Plugin(grid,"myPlugin",{...});
// when /my/topic is published, call the subscriber in the scope of plugin
// with passed parameter - "v"
plugin.subscribe("/my/topic", function(v){
console.debug(this.xxx(v));//"this" - plugin scope
});
Un-subscribes handle and removes it from subscriptions list.
| Parameter | Type | Description |
|---|---|---|
| handle | undefined |
var plugin = new dojox.grid.enhanced._Plugin(grid,"myPlugin",{...});
// when /my/topic is published, call the subscriber in the scope of plugin
// with passed parameter - "v"
plugin.subscribe("/my/topic", function(v){
console.debug(this.xxx(v));//"this" - plugin scope
});
var plugin = new dojox.grid.enhanced._Plugin(grid,"myPlugin",{...});
// when /my/topic is published, call the subscriber in the scope of plugin
// with passed parameter - "v"
plugin.subscribe("/my/topic", function(v){
console.debug(this.xxx(v));//"this" - plugin scope
});
Called when store is changed.
| Parameter | Type | Description |
|---|---|---|
| store | undefined |
var plugin = new dojox.grid.enhanced._Plugin(grid,"myPlugin",{...});
// when /my/topic is published, call the subscriber in the scope of plugin
// with passed parameter - "v"
plugin.subscribe("/my/topic", function(v){
console.debug(this.xxx(v));//"this" - plugin scope
});
var plugin = new dojox.grid.enhanced._Plugin(grid,"myPlugin",{...});
// when /my/topic is published, call the subscriber in the scope of plugin
// with passed parameter - "v"
plugin.subscribe("/my/topic", function(v){
console.debug(this.xxx(v));//"this" - plugin scope
});