dojox/grid/enhanced/plugins/exporter/TableWriter (version 1.10)

dojox/grid/enhanced/plugins/exporter/_ExportWriter

Summary

Export grid to HTML table format. Primarily used by Printer plugin.

Usage

var foo = new TableWriter(writerArgs);
dojox/grid/enhanced/plugins/exporter/TableWriter
Parameter Type Description
writerArgs object
Optional

Property Summary

Method Summary

Properties

argObj
Defined by: dojox/grid/enhanced/plugins/exporter/_ExportWriter

Methods

_getColumnClass(arg_obj)
Defined by dojox/grid/enhanced/plugins/exporter/TableWriter

Get CSS class string for a column

Parameter Type Description
arg_obj object
Returns:String
_getExportDataForCell(rowIndex,rowItem,cell,grid)
Defined by dojox/grid/enhanced/plugins/exporter/_ExportWriter
Parameter Type Description
rowIndex undefined
rowItem undefined
cell undefined
grid undefined
Returns:undefined
_getRowClass(arg_obj)
Defined by dojox/grid/enhanced/plugins/exporter/TableWriter

Get CSS class string for a row

Parameter Type Description
arg_obj object
Returns:String
_getTableAttrs(tagName)
Defined by dojox/grid/enhanced/plugins/exporter/TableWriter

Get html attribute string for the given kind of tag.

Parameter Type Description
tagName string

An html tag name
Returns:any | string

The well formatted attributes for the given html table.tag

afterContent()
Defined by dojox/grid/enhanced/plugins/exporter/TableWriter

Overrided from _ExportWriter

afterContentRow(argObj)
Defined by dojox/grid/enhanced/plugins/exporter/_ExportWriter

After handling a line of data (not header).

Parameter Type Description
argObj object

An object with at least the following context properties available: 

{
    grid,isHeader,
    row,rowIdx,
    spCols
}
Returns:any

undefined

afterHeader()
Defined by dojox/grid/enhanced/plugins/exporter/_ExportWriter

The header line has been handled.

Returns:any

undefined

afterSubrow(arg_obj)
Defined by dojox/grid/enhanced/plugins/exporter/TableWriter

Overrided from _ExportWriter

Parameter Type Description
arg_obj object
afterView(arg_obj)
Defined by dojox/grid/enhanced/plugins/exporter/TableWriter

Overrided from _ExportWriter

Parameter Type Description
arg_obj object
beforeContent(items)
Defined by dojox/grid/enhanced/plugins/exporter/_ExportWriter

We are ready to go through all the contents(items).

Parameter Type Description
items Array

All the items fetched from the store
Returns:any | boolean
  • true: go on handling the contents and then call afterContent.
  • false: skip all the contents, won't call afterContent.
beforeContentRow(argObj)
Defined by dojox/grid/enhanced/plugins/exporter/_ExportWriter

Before handling a line of data (not header).

Parameter Type Description
argObj object

An object with at least the following context properties available: 

{
    grid,isHeader,
    row,rowIdx,
    spCols
}
Returns:any | boolean
  • true: go on handling the current data row and then call afterContentRow.
  • false: skip the current data row, won't call afterContentRow.
beforeHeader(grid)
Defined by dojox/grid/enhanced/plugins/exporter/_ExportWriter

We are going to start the travel in the grid. Is there anything we should do now?

Parameter Type Description
grid EnhancedGrid
Returns:any | boolean
  • true: go on handling the header row and then call afterHeader.
  • false: skip the header row, won't call afterHeader.
beforeSubrow(arg_obj)
Defined by dojox/grid/enhanced/plugins/exporter/TableWriter

Overrided from _ExportWriter

Parameter Type Description
arg_obj object
Returns:boolean
beforeView(arg_obj)
Defined by dojox/grid/enhanced/plugins/exporter/TableWriter

Overrided from _ExportWriter

Parameter Type Description
arg_obj object
Returns:boolean
handleCell(arg_obj)
Defined by dojox/grid/enhanced/plugins/exporter/TableWriter

Overrided from _ExportWriter

Parameter Type Description
arg_obj object
toString()
Defined by dojox/grid/enhanced/plugins/exporter/TableWriter

Overrided from _ExportWriter

Returns:undefined
Error in the documentation? Can’t find what you are looking for? Let us know!