Provide printGrid function to the grid.
| Parameter | Type | Description |
|---|---|---|
| grid | undefined |
dojo.require("dojox.grid.enhanced.plugins.Printer");
dijit.byId("grid1").printGrid("my grid", //A title for the grid,optional
["cssfile1.css","cssfile2.css"],//An array of css files to decorate the printed gird,optional
{table:"border='border'"} //tagName:"attrbuteList" pairs, optional,
//control the html tags in the generated html
);
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.
| Parameter | Type | Description |
|---|---|---|
| args | undefined |
| Parameter | Type | Description |
|---|---|---|
| cssFiles | undefined |
Do the print job.
| Parameter | Type | Description |
|---|---|---|
| htmlStr | String | The html content string to be printed. |
undefined
Put title, cssFiles, and body_content together into an HTML string.
| Parameter | Type | Description |
|---|---|---|
| title | String | A title for the html page. |
| cssFiles | Array | css file pathes. |
| body_content | String | Content to print, not including part and tags |
the wrapped HTML string ready for print
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 |
Export selected rows to HTML string, but do NOT print. Users can use this to implement print preview. For meaning of arguments see function printGrid
| Parameter | Type | Description |
|---|---|---|
| args | __printArgs |
Optional Arguments for print. |
| onExported | undefined |
Export to HTML string, but do NOT print. Users can use this to implement print preview. For meaning of the 1st-3rd arguments see function printGrid.
| Parameter | Type | Description |
|---|---|---|
| args | __printArgs |
Optional Arguments for print. |
| onExported | undefined | call back function |
| Parameter | Type | Description |
|---|---|---|
| doc | undefined |
Print all the data in the grid, using title as a title, decorating generated html by cssFiles, using tagName:"attrbuteList" pairs(writerArgs) to control html tags in the generated html string.
| Parameter | Type | Description |
|---|---|---|
| args | __printArgs |
Optional Arguments for print. |
Print selected data. All other features are the same as printGrid. For meaning of arguments see function printGrid
| Parameter | Type | Description |
|---|---|---|
| args | __printArgs |
Optional Arguments for print. |
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
});