CefPdfPrintSettings (CEF3 Java API Docs)

java.lang.Object
- org.cef.misc.CefPdfPrintSettings

public class CefPdfPrintSettings
extends java.lang.Object

PDF print settings for browser.printToPDF()

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CefPdfPrintSettings.MarginType

Nested Classes
Modifier and Type	Class and Description
`static class`	`CefPdfPrintSettings.MarginType`

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`display_header_footer` Set to true to print headers and footers or false to not print headers and footers.
`java.lang.String`	`footer_template` HTML template for the print footer.
`boolean`	`generate_document_outline` Whether or not to embed the document outline into the PDF.
`boolean`	`generate_tagged_pdf` Whether or not to generate tagged (accessible) PDF.
`java.lang.String`	`header_template` HTML template for the print header.
`boolean`	`landscape` Set to true for landscape mode or false for portrait mode.
`double`	`margin_bottom`
`double`	`margin_left`
`double`	`margin_right`
`double`	`margin_top` Margins in inches.
`CefPdfPrintSettings.MarginType`	`margin_type` Margin type.
`java.lang.String`	`page_ranges` Paper ranges to print, one based, e.g., '1-5, 8, 11-13'.
`double`	`paper_height`
`double`	`paper_width` Output paper size in inches.
`boolean`	`prefer_css_page_size` Set to true to prefer page size as defined by css.
`boolean`	`print_background` Set to true to print background graphics or false to not print background graphics.
`double`	`scale` The percentage to scale the PDF by before printing (e.g.

Constructor Summary

Constructors
Constructor and Description

CefPdfPrintSettings()

Constructors
Constructor and Description
`CefPdfPrintSettings()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method and Description

CefPdfPrintSettings clone()
- Methods inherited from class java.lang.Object
  equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CefPdfPrintSettings`	`clone()`

- Field Detail
  - display_header_footer
```
public boolean display_header_footer
```
    Set to true to print headers and footers or false to not print headers and footers. Modify header_template and/or footer_template to customize the display.
  - footer_template
```
public java.lang.String footer_template
```
    HTML template for the print footer. Only displayed if |display_header_footer| is true (1). Uses the same format as |header_template|.
  - generate_document_outline
```
public boolean generate_document_outline
```
    Whether or not to embed the document outline into the PDF.
  - generate_tagged_pdf
```
public boolean generate_tagged_pdf
```
    Whether or not to generate tagged (accessible) PDF.
  - header_template
```
public java.lang.String header_template
```
    HTML template for the print header. Only displayed if |display_header_footer| is true (1). Should be valid HTML markup with the following classes used to inject printing values into them: - date: formatted print date - title: document title - url: document location - pageNumber: current page number - totalPages: total pages in the document For example, "" would generate a span containing the title.
  - landscape
```
public boolean landscape
```
    Set to true for landscape mode or false for portrait mode.
  - margin_bottom
```
public double margin_bottom
```
  - margin_left
```
public double margin_left
```
  - margin_right
```
public double margin_right
```
  - margin_top
```
public double margin_top
```
    Margins in inches. Only used if margin_type is set to CUSTOM.
  - margin_type
```
public CefPdfPrintSettings.MarginType margin_type
```
    Margin type.
  - page_ranges
```
public java.lang.String page_ranges
```
    Paper ranges to print, one based, e.g., '1-5, 8, 11-13'. Pages are printed in the document order, not in the order specified, and no more than once. Defaults to empty string, which implies the entire document is printed. The page numbers are quietly capped to actual page count of the document, and ranges beyond the end of the document are ignored. If this results in no pages to print, an error is reported. It is an error to specify a range with start greater than end.
  - paper_height
```
public double paper_height
```
  - paper_width
```
public double paper_width
```
    Output paper size in inches. If either of these values is less than or equal to zero then the default paper size (letter, 8.5 x 11 inches) will be used.
  - prefer_css_page_size
```
public boolean prefer_css_page_size
```
    Set to true to prefer page size as defined by css. Defaults to false in which case the content will be scaled to fit the paper size.
  - print_background
```
public boolean print_background
```
    Set to true to print background graphics or false to not print background graphics.
  - scale
```
public double scale
```
    The percentage to scale the PDF by before printing (e.g. .5 is 50%). If this value is less than or equal to zero the default value of 1.0 will be used.
- Constructor Detail
  - CefPdfPrintSettings
```
public CefPdfPrintSettings()
```
- Method Detail
  - clone
```
public CefPdfPrintSettings clone()
```
    Overrides:
    
    clone in class java.lang.Object

Class CefPdfPrintSettings

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

display_header_footer

footer_template

generate_document_outline

generate_tagged_pdf

header_template

landscape

margin_bottom

margin_left

margin_right

margin_top

margin_type

page_ranges

paper_height

paper_width

prefer_css_page_size

print_background

scale

Constructor Detail

CefPdfPrintSettings

Method Detail

clone