Package com.smartgwt.client.docs

# Interface Printing

public interface Printing

### Printing

The browser's built-in support for printing will at best print what you see, which in the case of a web application will often be useless, illegible, or partial.

Smart GWT has specialized printing support that can take any page built with Smart GWT components and provide a reasonable printed view. The default printed view:

- renders components without clipping or scrolling regions, so that a scrolling grid shows all rows in the cached range around the first visible row
- removes certain decorative images, such as image-based backgrounds, which may print poorly in black and white
- converts editing controls into static representations of the data being edited
- removes interactive elements such as buttons and menus, which don't work on paper and waste space

The default printed view can be customized with settings and method overrides as necessary, including the ability to created printed representations of custom components you have created.

For simple, built in printing support, see the `Canvas.showPrintPreview()` and `Canvas.getPrintPreview()` APIs, or for finer grained control developers may call `Canvas.getPrintHTML()` directly and work with the `PrintCanvas` or `PrintWindow` class.

Note that the `CubeGrid` component does not currently support WYSIWYG printing (as documented `in that class`).

See Also:
  - `Canvas.printComponents(java.lang.Object[])`
  - `com.smartgwt.client.widgets.Canvas#getPrintPreview`
  - `Canvas.showPrintPreview(com.smartgwt.client.widgets.Canvas)`
  - `Canvas.getPrintHTML(java.lang.Object[], com.smartgwt.client.util.PrintProperties, com.smartgwt.client.util.PrintHTMLCallback)`
  - `FacetChart.getPrintHTML(com.smartgwt.client.util.PrintProperties, com.smartgwt.client.util.PrintHTMLCallback)`
  - `Canvas.getPrintHTML(java.lang.Object[], com.smartgwt.client.util.PrintProperties, com.smartgwt.client.util.PrintHTMLCallback)`
  - `Canvas.print()`
  - `DrawPane.getPrintHTML(com.smartgwt.client.util.PrintProperties, com.smartgwt.client.util.PrintHTMLCallback)`
  - `com.smartgwt.client.widgets.form.fields.FormItem#getPrintValueIconStyle`
  - `com.smartgwt.client.widgets.form.fields.FormItem#getPrintValueIcon`
  - `PrintProperties`
  - `PrintCanvas`
  - `PrintWindow`
  - `FacetChart.getPrintZoomChart()`
  - `Canvas.getPrintChildrenAbsolutelyPositioned()`
  - `Canvas.getShouldPrint()`
  - `PrintProperties.getOmitControls()`
  - `PrintProperties.getIncludeControls()`
  - `PrintProperties.getPrintForExport()`
  - `FormItem.getPrintTitleStyle()`
  - `FormItem.getPrintTextBoxStyle()`
  - `FormItem.getPrintReadOnlyTextBoxStyle()`
  - `TextItem.getPrintFullText()`
  - `CheckboxItem.getPrintCheckedImage()`
  - `CheckboxItem.getPrintUncheckedImage()`
  - `CheckboxItem.getPrintPartialSelectedImage()`
  - `CheckboxItem.getPrintUnsetImage()`
  - `CheckboxItem.getPrintBooleanBaseStyle()`
  - `TextAreaItem.getPrintFullText()`
  - `DetailViewer.getPrintCellStyle()`
  - `DetailViewer.getPrintLabelStyle()`
  - `DetailViewer.getPrintHeaderStyle()`
  - `ListGridField.getShouldPrint()`
  - `ListGrid.getCheckboxFieldPartialImage()`
  - `ListGrid.getPrintCheckboxFieldTrueImage()`
  - `ListGrid.getPrintCheckboxFieldFalseImage()`
  - `ListGrid.getPrintCheckboxFieldPartialImage()`
  - `ListGrid.getPrintBooleanBaseStyle()`
  - `ListGrid.getPrintBooleanTrueImage()`
  - `ListGrid.getPrintBooleanFalseImage()`
  - `ListGrid.getPrintBooleanPartialImage()`
  - `ListGrid.getPrintAutoFit()`
  - `ListGrid.getPrintWrapCells()`
  - `ListGrid.getPrintHeaderStyle()`
  - `ListGrid.getPrintBaseStyle()`
  - `ListGrid.getPrintMaxRows()`