PrintOptions (Fujion Core Libraries 2.1.0 API)

java.lang.Object
- org.fujion.ancillary.Options
- - org.fujion.ancillary.PrintOptions

All Implemented Interfaces:

OptionMap.IOptionMapConverter, IClientTransform
```
public class PrintOptions
extends Options
```
Options for print operation.

Field Summary

Fields
Modifier and Type	Field and Description
`String`	`append` Adds custom HTML after the selected content.
`String`	`doctype` Prepends a doctype to the printed document frame.
`Boolean`	`globalStyles` Whether or not the styles from the parent document should be included.
`Boolean`	`iframe$boolean` Whether to print from an iframe instead of a pop-up window.
`String`	`iframe$selector` Selector of an existing iframe to use for printing.
`Boolean`	`manuallyCopyFormValues` If true, copy user-updated form input values onto the printed markup (this is done by manually iterating over each form element).
`Boolean`	`mediaPrint` Whether or not link tags with media='print' should be included; Overridden by the globalStyles option.
`String`	`noPrintSelector` A selector for the items that are to be excluded from printing.
`String`	`prepend` Adds custom HTML before the selected content.
`String`	`selector` Selector for the root element to print.
`String`	`stylesheet` URL of an external stylesheet to be included.
`Integer`	`timeout` The maximum amount of time, in milliseconds, to wait for the content, etc.
`String`	`title` Text to use for print title.

Constructor Summary

Constructors
Constructor and Description

PrintOptions()

Constructors
Constructor and Description
`PrintOptions()`

Method Summary
- Methods inherited from class org.fujion.ancillary.Options
  toMap
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
- Methods inherited from interface org.fujion.ancillary.OptionMap.IOptionMapConverter
  transformForClient

- Field Detail
  - append
```
@Option
public String append
```
    Adds custom HTML after the selected content. May be any valid jquery selector or HTML text.
  - doctype
```
@Option
public String doctype
```
    Prepends a doctype to the printed document frame.
    Default: "<!doctype html>"
  - globalStyles
```
@Option
public Boolean globalStyles
```
    Whether or not the styles from the parent document should be included.
    Default: true
  - iframe$boolean
```
@Option(value="iframe")
public Boolean iframe$boolean
```
    Whether to print from an iframe instead of a pop-up window.
    Default: true
  - iframe$selector
```
@Option(value="iframe")
public String iframe$selector
```
    Selector of an existing iframe to use for printing.
  - manuallyCopyFormValues
```
@Option
public Boolean manuallyCopyFormValues
```
    If true, copy user-updated form input values onto the printed markup (this is done by manually iterating over each form element).
    Default: true
  - mediaPrint
```
@Option
public Boolean mediaPrint
```
    Whether or not link tags with media='print' should be included; Overridden by the globalStyles option.
    Default: false
  - noPrintSelector
```
@Option
public String noPrintSelector
```
    A selector for the items that are to be excluded from printing.
    Default: ".no-print"
  - prepend
```
@Option
public String prepend
```
    Adds custom HTML before the selected content. May be any valid jquery selector or HTML text.
  - selector
```
@Option
public String selector
```
    Selector for the root element to print. Defaults to the widget's anchor element.
  - stylesheet
```
@Option
public String stylesheet
```
    URL of an external stylesheet to be included.
  - timeout
```
@Option
public Integer timeout
```
    The maximum amount of time, in milliseconds, to wait for the content, etc. to load before printing the element from the new window/iframe created, as a fallback if the load event for the new window/iframe has not fired yet.
    Default: 750
  - title
```
@Option
public String title
```
    Text to use for print title.
    Default: the page title
- Constructor Detail
  - PrintOptions
```
public PrintOptions()
```

Class PrintOptions

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.fujion.ancillary.Options

Methods inherited from class java.lang.Object

Methods inherited from interface org.fujion.ancillary.OptionMap.IOptionMapConverter

Field Detail

append

doctype

globalStyles

iframe$boolean

iframe$selector

manuallyCopyFormValues

mediaPrint

noPrintSelector

prepend

selector

stylesheet

timeout

title

Constructor Detail

PrintOptions