com.smartgwt.client.util

## Class PrintProperties

- java.lang.Object
- - com.smartgwt.client.core.JsObject
  - - com.smartgwt.client.core.DataClass
    - - com.smartgwt.client.util.PrintProperties

-     public class PrintProperties
      extends DataClass

  Settings for generating printable HTML for components.

- - ### Field Summary

    - ### Fields inherited from class com.smartgwt.client.core.DataClass

      `factoryCreated, factoryProperties`

    - ### Fields inherited from class com.smartgwt.client.core.JsObject

      `jsObj`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `PrintProperties()`
    `PrintProperties(JavaScriptObject jsObj)`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `java.lang.String[]` | `getIncludeControls()` An array of Strings indicating the classNames of controls that should be specifically included when printing, even if a superclass is listed in `omitControls`.
    `java.lang.String[]` | `getOmitControls()` An array of Strings indicating the classNames of controls that should be omitted from printing.
    `static PrintProperties` | `getOrCreateRef(JavaScriptObject jsObj)`
    `java.lang.Boolean` | `getPrintForExport()` If true, generates HTML for export.
    `void` | `setIncludeControls(java.lang.String[] includeControls)` An array of Strings indicating the classNames of controls that should be specifically included when printing, even if a superclass is listed in `omitControls`.
    `void` | `setOmitControls(java.lang.String[] omitControls)` An array of Strings indicating the classNames of controls that should be omitted from printing.
    `void` | `setPrintForExport(java.lang.Boolean printForExport)` If true, generates HTML for export.

    - ### Methods inherited from class com.smartgwt.client.core.DataClass

      `applyFactoryProperties, doAddHandler, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsDoubleArray, getAttributeAsFloat, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getAttributes, getHandlerCount, isFactoryCreated, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributeAsJavaObject, setFactoryCreated`

    - ### Methods inherited from class com.smartgwt.client.core.JsObject

      `equals, getJsObj, hashCode, isCreated, setJavaScriptObject, setJsObj`

    - ### Methods inherited from class java.lang.Object

      `clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### PrintProperties

          public PrintProperties()

    - #### PrintProperties

          public PrintProperties(JavaScriptObject jsObj)

  - ### Method Detail

    - #### getOrCreateRef

          public static PrintProperties getOrCreateRef(JavaScriptObject jsObj)

    - #### setPrintForExport

          public void setPrintForExport(java.lang.Boolean printForExport)

      If true, generates HTML for export.

      Some components, specifically `DrawPane` and `FacetChart` on IE8 and earlier, need to generate different HTML for export versus in-browser print preview. When using `RPCManager.exportContent()` the printForExport property is set to true automatically. If not using RPCManager.exportContent(), but the generated HTML will be sent for export, the `PrintProperties` passed to `Canvas.getPrintHTML()` must have printForExport:true.

      Parameters:
        `printForExport` - Default value is null
      See Also:
        `Printing overview and related methods`

    - #### getPrintForExport

          public java.lang.Boolean getPrintForExport()

      If true, generates HTML for export.

      Some components, specifically `DrawPane` and `FacetChart` on IE8 and earlier, need to generate different HTML for export versus in-browser print preview. When using `RPCManager.exportContent()` the printForExport property is set to true automatically. If not using RPCManager.exportContent(), but the generated HTML will be sent for export, the `PrintProperties` passed to `Canvas.getPrintHTML()` must have printForExport:true.

      Returns:
        Boolean
      See Also:
        `Printing overview and related methods`

    - #### setOmitControls

          public void setOmitControls(java.lang.String[] omitControls)
                               throws java.lang.IllegalStateException

      An array of Strings indicating the classNames of controls that should be omitted from printing. By default, `omitControls` includes all button-based controls, menus and similar interactive controls that are typically useless in printed output.

      All subclasses of the specified classes are also omitted.

      See also `includeControls`.

      Parameters:
        `omitControls` - omitControls Default value is null
      Throws:
        `java.lang.IllegalStateException` - this property cannot be changed after the component has been created

    - #### getOmitControls

          public java.lang.String[] getOmitControls()

      An array of Strings indicating the classNames of controls that should be omitted from printing. By default, `omitControls` includes all button-based controls, menus and similar interactive controls that are typically useless in printed output.

      All subclasses of the specified classes are also omitted.

      See also `includeControls`.

      Returns:
        Unhandled-Array of String

    - #### setIncludeControls

          public void setIncludeControls(java.lang.String[] includeControls)
                                  throws java.lang.IllegalStateException

      An array of Strings indicating the classNames of controls that should be specifically included when printing, even if a superclass is listed in `omitControls`.
      Parameters:
        `includeControls` - includeControls Default value is null
      Throws:
        `java.lang.IllegalStateException` - this property cannot be changed after the component has been created

    - #### getIncludeControls

          public java.lang.String[] getIncludeControls()

      An array of Strings indicating the classNames of controls that should be specifically included when printing, even if a superclass is listed in `omitControls`.
      Returns:
        Unhandled-Array of String