Warning: Use of undefined constant Symbol - assumed 'Symbol' (this will throw an Error in a future version of PHP) in /mnt/new-ebs/workbench-106550/lib/dojo/util/docscripts/lib/parser2/dojo2.inc on line 215 Warning: Use of undefined constant JavaScriptSymbol - assumed 'JavaScriptSymbol' (this will throw an Error in a future version of PHP) in /mnt/new-ebs/workbench-106550/lib/dojo/util/docscripts/lib/parser2/dojo2.inc on line 215

dojox/grid/enhanced/plugins/Printer.js

  • Provides:

    • dojox.grid.enhanced.plugins.Printer

  • Requires:

    • dojox.grid.enhanced._Plugin in common
    • dojox.grid.enhanced.plugins.exporter.TableWriter in common

  • dojox.grid.enhanced.plugins.Printer

    • type
      Function
    • chains:
      • dojox.grid.enhanced._Plugin: (prototype)
      • dojox.grid.enhanced._Plugin: (call)
    • parameters:
      • grid
    • summary
      Provide printGrid function to the grid.
    • example
      	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
	);

  • dojox.grid.enhanced.plugins.Printer.name

    • type
      String
    • summary
      Plugin name

  • dojox.grid.enhanced.plugins.Printer.constructor

    • constructor - constructor
    • type
      Function
    • parameters:
      • grid
    • summary
      only newed by _Plugin
inGrid: EnhancedGrid
The grid to plug in to.

  • dojox.grid.enhanced.plugins.Printer._mixinGrid

    • type
      Function

  • dojox.grid.enhanced.plugins.Printer.grid

  • dojox.grid.enhanced.plugins.Printer.grid.printGrid

    • type
      Object

  • dojox.grid.enhanced.plugins.Printer.grid.printSelected

    • type
      Object

  • dojox.grid.enhanced.plugins.Printer.grid.exportToHTML

    • type
      Object

  • dojox.grid.enhanced.plugins.Printer.grid.exportSelectedToHTML

    • type
      Object

  • dojox.grid.enhanced.plugins.Printer.grid.normalizePrintedGrid

    • type
      Object

  • dojox.grid.enhanced.plugins.Printer.printGrid

    • parameters:
      • args: (typeof __printArgs)
        Arguments for print.
    • summary
      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.
    • tags: public
    • type
      Function

  • dojox.grid.enhanced.plugins.Printer.printSelected

    • parameters:
      • args: (typeof __printArgs)
        Arguments for print.
    • summary
      Print selected data. All other features are the same as printGrid.
For meaning of arguments see function *printGrid*
    • tags: public
    • type
      Function

  • dojox.grid.enhanced.plugins.Printer.exportToHTML

    • parameters:
      • args: (typeof __printArgs)
        Arguments for print.
      • onExported: (typeof function(string))
        call back function
    • summary
      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*.
    • tags: public
    • type
      Function

  • dojox.grid.enhanced.plugins.Printer.exportSelectedToHTML

    • parameters:
      • args: (typeof __printArgs)
        Arguments for print.
    • returns
      String
    • summary
      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*
    • tags: public
    • type
      Function

  • dojox.grid.enhanced.plugins.Printer._print

    • parameters:
      • htmlStr: (typeof string)
        String The html content string to be printed.
    • summary
      Do the print job.
    • tags:
    • return_summary
      undefined
    • type
      Function

  • dojox.grid.enhanced.plugins.Printer.grid.domNode

  • dojox.grid.enhanced.plugins.Printer._printFrame

  • dojox.grid.enhanced.plugins.Printer._wrapHTML

    • parameters:
      • title: (typeof string)
        String A title for the html page.
      • cssFiles: (typeof Array)
        css file pathes.
      • body_content: (typeof string)
        String Content to print, not including <head></head> part and <html> tags
    • returns
      String
    • summary
      Put title, cssFiles, and body_content together into an HTML string.
    • tags:
    • return_summary
      the wrapped HTML string ready for print
    • type
      Function

  • dojox.grid.enhanced.plugins.Printer.normalizeRowHeight

    • parameters:
      • doc
    • type
      Function

  • dojox.grid.enhanced.plugins.Printer._formalizeArgs

    • parameters:
      • args
    • returns
      Object
    • type
      Function

  • dojox.grid.enhanced.plugins

    • type
      Object

  • dojox.grid.enhanced

    • type
      Object

  • dojox.grid

    • type
      Object

  • dojox

    • type
      Object