Go to the
current documentation.
Contents
This guide shows how to work with the Printing API.
Overview
The web page you load in browser can be printed using one of the following ways:
- Using the
window.print()JavaScript function. This function can be invoked from JavaScript code on the loaded web page (e.g. when user clicks some button, JavaScript code invokes this function to print the web page). - Using the
Browser.print()method of JxBrowser API. For example, you can invoke this method when user presses Print button in your Java application.
Both methods prints currently loaded web page using default print settings. If you need to print web page with custom print settings, you must register your own implementation of PrintHandler interface where you can override default print settings or cancel printing. For example:
import com.teamdev.jxbrowser.chromium.*;
import com.teamdev.jxbrowser.chromium.PrintJob;
import com.teamdev.jxbrowser.chromium.events.PrintJobEvent;
import com.teamdev.jxbrowser.chromium.events.PrintJobListener;
import com.teamdev.jxbrowser.chromium.swing.BrowserView;
import javax.swing.*;
import java.awt.*;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.util.ArrayList;
import java.util.List;
/**
* The sample demonstrates how to print currently loaded web page with custom print settings.
*/
public class PrintSample {
public static void main(String[] args) {
final Browser browser = new Browser();
BrowserView view = new BrowserView(browser);
JFrame frame = new JFrame();
frame.setDefaultCloseOperation(WindowConstants.EXIT_ON_CLOSE);
JButton print = new JButton("Print");
print.addActionListener(new ActionListener() {
@Override
public void actionPerformed(ActionEvent e) {
browser.print();
}
});
frame.add(print, BorderLayout.NORTH);
frame.add(view, BorderLayout.CENTER);
frame.setSize(700, 500);
frame.setLocationRelativeTo(null);
frame.setVisible(true);
browser.setPrintHandler(new PrintHandler() {
@Override
public PrintStatus onPrint(PrintJob printJob) {
PrintSettings printSettings = printJob.getPrintSettings();
printSettings.setPrinterName("Microsoft XPS Document Writer");
printSettings.setLandscape(false);
printSettings.setPrintBackgrounds(false);
printSettings.setColorModel(ColorModel.COLOR);
printSettings.setDuplexMode(DuplexMode.SIMPLEX);
printSettings.setDisplayHeaderFooter(true);
printSettings.setCopies(1);
printSettings.setPaperSize(PaperSize.ISO_A4);
List<PageRange> ranges = new ArrayList<PageRange>();
ranges.add(new PageRange(0, 3));
printSettings.setPageRanges(ranges);
printJob.addPrintJobListener(new PrintJobListener() {
@Override
public void onPrintingDone(PrintJobEvent event) {
System.out.println("Printing is finished successfully: " +
event.isSuccess());
}
});
return PrintStatus.CONTINUE;
}
});
browser.loadURL("http://www.teamdev.com");
}
}
Saving Web Page as PDF
To save web page as PDF document you must register your own implementation of PrintHandler where you override default print settings and tell Chromium engine to save web page as PDF document at the specified path on the local file system. For example:
browser.setPrintHandler(new PrintHandler() {
@Override
public PrintStatus onPrint(PrintJob printJob) {
PrintSettings settings = printJob.getPrintSettings();
settings.setPrintToPDF(true);
settings.setPDFFilePath("web_page.pdf");
return PrintStatus.CONTINUE;
}
});
Canceling Printing
If you need to cancel or disable printing at all you can use the following approach:
browser.setPrintHandler(new PrintHandler() {
@Override
public PrintStatus onPrint(PrintJob printJob) {
return PrintStatus.CANCEL;
}
});