Class PrintManager

java.lang.Object

com.grapecity.documents.excel.PrintManager

All Implemented Interfaces:: Serializable

public class PrintManager extends Object implements Serializable

表示用于分页和 PDF 打印输出的打印管理器。

使用此类可以为工作簿或工作表生成 PageInfo 对象、调整分页结果，并将生成的页面保存为 PDF。它是自定义分页工作流的入口点，例如控制分页符、保持内容在一起，以及将一个或多个工作簿中的内容合并到单个 PDF 输出中。


 worksheet.getRange("A1:B4").setValue(new Object[][] {
     {"Name", "Value"},
     {"A", 100},
     {"B", 200},
     {"C", 300}
 });
 PrintManager printManager = new PrintManager();
 List<PageInfo> pages = printManager.paginate(worksheet);
 ByteArrayOutputStream stream = new ByteArrayOutputStream();
 printManager.savePageInfosToPDF(stream, pages);

Constructor Summary

Constructors

Constructor

Description

PrintManager()
Method Summary

Modifier and Type

Method

Description

final void

appendPage(org.apache.pdfbox.pdmodel.PDDocument doc, PageInfo pageInfo)

将指定的打印页面追加到 PDF 文档。

final void

appendPage(org.apache.pdfbox.pdmodel.PDDocument doc, PageInfo pageInfo, PdfSaveOptions options)

将指定的打印页面追加到 PDF 文档。

final void

draw(org.apache.pdfbox.pdmodel.PDDocument doc, org.apache.pdfbox.pdmodel.PDPage page, Point location, IRange range)

在 PDF 页面上的特定位置绘制指定的工作表区域。

final void

draw(org.apache.pdfbox.pdmodel.PDDocument doc, org.apache.pdfbox.pdmodel.PDPage page, Point location, IRange range, PdfSaveOptions options)

在 PDF 页面上的给定位置绘制指定的工作表区域。

final void

draw(org.apache.pdfbox.pdmodel.PDDocument doc, org.apache.pdfbox.pdmodel.PDPage page, Rectangle rect, IRange range)

将指定的工作表区域绘制到 PDF 页面上的矩形区域中。

final void

draw(org.apache.pdfbox.pdmodel.PDDocument doc, org.apache.pdfbox.pdmodel.PDPage page, Rectangle rect, IRange range, PdfSaveOptions options)

将指定的工作表区域绘制到 PDF 页面上的矩形区域中。

final void

draw(org.apache.pdfbox.pdmodel.PDDocument doc, org.apache.pdfbox.pdmodel.PDPage page, Rectangle rect, PageContentInfo pageContent)

将打印页面内容绘制到 PDF 页面上的指定矩形中。

final void

draw(org.apache.pdfbox.pdmodel.PDDocument doc, org.apache.pdfbox.pdmodel.PDPage page, Rectangle rect, PageContentInfo pageContent, PdfSaveOptions options)

将打印页面内容绘制到 PDF 页面上的指定区域中。

final void

draw(org.apache.pdfbox.pdmodel.PDDocument doc, org.apache.pdfbox.pdmodel.PDPage page, Rectangle rect, PageInfo pageInfo)

将指定的打印页面信息绘制到 PDF 页面上的给定矩形中。

final void

draw(org.apache.pdfbox.pdmodel.PDDocument doc, org.apache.pdfbox.pdmodel.PDPage page, Rectangle rect, PageInfo pageInfo, PdfSaveOptions options)

将打印页面信息绘制到 PDF 页面上的指定区域中。

final void

draw(org.apache.pdfbox.pdmodel.PDDocument doc, org.apache.pdfbox.pdmodel.PDPage page, List<PageInfo> pages, int rows, int columns)

将页面集合中的页面绘制到 PDF 文档的某一页上。

final void

draw(org.apache.pdfbox.pdmodel.PDDocument doc, org.apache.pdfbox.pdmodel.PDPage page, List<PageInfo> pages, int rows, int columns, Order order)

按指定顺序将页面集合中的页面绘制到 PDF 页面上。

final void

draw(org.apache.pdfbox.pdmodel.PDDocument doc, org.apache.pdfbox.pdmodel.PDPage page, List<PageInfo> pages, int rows, int columns, Order order, PdfSaveOptions options)

将指定页面集合中的页面绘制到 PDF 页面上。

protected void

finalize()

在此打印管理器被垃圾回收之前释放内部字体集合资源。

final PageContentInfo

generatePageContentInfo(IRange printArea, Size availableSize, int rowStart, int columnStart, boolean rowHeaderVisible, boolean columnHeaderVisible)

返回指定打印区域和页面大小的 PageContentInfo 对象。

List<Integer>

GetPaginationInfo(IWorksheet worksheet, PaginationOrientation orientation)

返回定义指定工作表页面边界的行或列索引。

List<Integer>

GetPaginationInfo(IWorksheet worksheet, PaginationOrientation orientation, List<IRange> keepTogetherRanges, List<RepeatSetting> repeatSettings)

获取为指定工作表定义页面边界的行索引或列索引。

final List<IRange>

getPrintAreas(IWorksheet worksheet)

返回指定工作表的打印区域列表。

final Size

getSize(IRange range)

返回区域的大小。

final Size

getSize(PageContentInfo contentInfo)

返回 PageContentInfo 的大小。

final boolean

hasPrintContent(IRange range)

返回指定区域是否包含可打印的内容。

final List<PageInfo>

paginate(IRange printArea)

为指定区域生成分页信息。

final List<PageInfo>

paginate(IWorkbook workbook)

为工作簿中的所有可见工作表生成分页信息。

final List<PageInfo>

paginate(IWorksheet worksheet)

为工作表生成分页信息。

final List<PageInfo>

paginate(IWorksheet worksheet, List<IRange> keepTogetherRanges, List<RepeatSetting> repeatSettings)

获取指定工作表的分页信息。

final List<PageInfo>

paginate(List<IWorkbook> workbooks)

为所有工作簿中的所有工作表生成分页信息。

final void

savePageInfosToPDF(OutputStream stream, List<PageInfo> pages)

将页面数据保存到指定的 PDF 文件流。

final void

savePageInfosToPDF(OutputStream stream, List<PageInfo> pages, PdfSaveOptions options)

将指定的页面信息集合保存到 PDF 输出流。

final void

savePageInfosToPDF(String fileName, List<PageInfo> pages)

将指定的页面信息集合保存到 PDF 文件。

final void

savePageInfosToPDF(String fileName, List<PageInfo> pages, PdfSaveOptions options)

将指定的页面信息集合保存到 PDF 文件。

final void

saveWorkbooksToPDF(OutputStream stream, List<IWorkbook> workbooks)

将从指定工作簿生成的页面保存到 PDF 输出流。

final void

saveWorkbooksToPDF(OutputStream stream, List<IWorkbook> workbooks, PdfSaveOptions options)

将从指定工作簿生成的页面保存到 PDF 输出流。

final void

saveWorkbooksToPDF(String fileName, List<IWorkbook> workbooks)

将不同工作簿中的数据保存到指定的 PDF 文件。

final void

saveWorkbooksToPDF(String fileName, List<IWorkbook> workbooks, PdfSaveOptions options)

将来自不同工作簿的数据保存到指定的 pdf 文件。

final void

updatePageNumberAndPageSettings(List<PageInfo> pages)

更新每个页面的页码、页数和页面设置。

final void

updatePageNumberAndPageSettings(List<PageInfo> pages, int firstPageNumber, int pageCount)

更新每个页面的页码、页数和页面设置。

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- PrintManager
  
  public PrintManager()
Method Details
- finalize
  
  protected void finalize() throws Throwable
  
  在此打印管理器被垃圾回收之前释放内部字体集合资源。
  此实现会清除内部集合中缓存的每个字体集合，然后调用 super.finalize()。
  此方法由 JVM 的终结机制调用，不应由用户代码直接调用。
  @throws Throwable 在终结此对象或调用 super.finalize() 时发生错误。
  
  Overrides:
  
  finalize in class Object
  
  Throws:
  
  Throwable
- saveWorkbooksToPDF
  
  public final void saveWorkbooksToPDF(OutputStream stream, List<IWorkbook> workbooks)
  将从指定工作簿生成的页面保存到 PDF 输出流。
  此方法会通过调用 paginate(List) 按列表顺序对工作簿进行分页，然后通过调用 savePageInfosToPDF(OutputStream,List) 将生成的页面写入指定输出流。
  
  worksheet.getPageSetup().setPrintArea("B2:D6"); worksheet.getRange("B2:D6").setValue("Test"); IWorkbook secondWorkbook = workbook.clone(); secondWorkbook.getWorksheets().get(0).getRange("B2").setValue("Summary"); List<IWorkbook> workbooks = new ArrayList<IWorkbook>(); workbooks.add(workbook); workbooks.add(secondWorkbook); PrintManager printManager = new PrintManager(); ByteArrayOutputStream stream = new ByteArrayOutputStream(); printManager.saveWorkbooksToPDF(stream, workbooks);
  Parameters:
  
  stream - 接收生成的 PDF 数据的输出流。
  
  workbooks - 要分页并导出的工作簿。工作簿会按其在列表中出现的顺序处理。
- saveWorkbooksToPDF
  
  public final void saveWorkbooksToPDF(OutputStream stream, List<IWorkbook> workbooks, PdfSaveOptions options)
  将从指定工作簿生成的页面保存到 PDF 输出流。
  工作簿会按列表顺序进行分页，并通过调用 savePageInfosToPDF(OutputStream,List,PdfSaveOptions) 将生成的页面写入提供的流。
  
  worksheet.getPageSetup().setPrintArea("B2:D6"); worksheet.getRange("B2:D6").setValue("Test"); PrintManager printManager = new PrintManager(); List<IWorkbook> workbooks = new ArrayList<IWorkbook>(); workbooks.add(workbook); IWorkbook secondWorkbook = workbook.clone(); secondWorkbook.getWorksheets().get(0).getRange("A1").setValue("Second workbook"); workbooks.add(secondWorkbook); ByteArrayOutputStream stream = new ByteArrayOutputStream(); printManager.saveWorkbooksToPDF(stream, workbooks, new PdfSaveOptions());
  Parameters:
  
  stream - 要写入 PDF 数据的输出流。不得为 null。
  
  workbooks - 要分页并导出的工作簿。工作簿会按其在列表中出现的顺序处理。
  
  options - PDF 保存选项。可以为 null。
- saveWorkbooksToPDF
  
  public final void saveWorkbooksToPDF(String fileName, List<IWorkbook> workbooks)
  将不同工作簿中的数据保存到指定的 PDF 文件。
  集合中的每个工作簿都会分页，所有生成的页面都会写入 PDF。此重载会将 null 作为 PdfSaveOptions 传递给三参数重载。
  
  worksheet.getRange("A1").setValue("First workbook"); IWorkbook secondWorkbook = workbook.clone(); secondWorkbook.getWorksheets().get(0).getRange("A1").setValue("Second workbook"); PrintManager printManager = new PrintManager(); List<IWorkbook> workbooks = Arrays.asList(workbook, secondWorkbook); printManager.saveWorkbooksToPDF("path/to/workbooks.pdf", workbooks);
  Parameters:
  
  fileName - 要创建的 PDF 文件路径和名称。必须是有效的文件路径；null 或无效路径会导致 IllegalArgumentException。
  
  workbooks - 要保存的 Workbook 对象集合。此值会由此重载传递给底层保存操作，而不进行额外验证。
  
  Throws:
  
  IllegalArgumentException - 如果 fileName 不是有效路径。
  
  RuntimeException - 如果创建或写入 PDF 文件时发生 I/O 错误。
- saveWorkbooksToPDF
  
  public final void saveWorkbooksToPDF(String fileName, List<IWorkbook> workbooks, PdfSaveOptions options)
  将来自不同工作簿的数据保存到指定的 pdf 文件。
  worksheet.getRange("A1").setValue("First workbook"); IWorkbook secondWorkbook = workbook.clone(); secondWorkbook.getWorksheets().get(0).getRange("A1").setValue("Second workbook"); PrintManager printManager = new PrintManager(); List<IWorkbook> workbooks = Arrays.asList(workbook, secondWorkbook); PdfSaveOptions options = new PdfSaveOptions(); printManager.saveWorkbooksToPDF("path/to/workbooks.pdf", workbooks, options);
  Parameters:
  
  fileName - 指定的 pdf 文件。
  
  workbooks - 工作簿集合。
  
  options - 保存 pdf 文件的选项。
- savePageInfosToPDF
  
  public final void savePageInfosToPDF(OutputStream stream, List<PageInfo> pages)
  将页面数据保存到指定的 PDF 文件流。
  worksheet.getPageSetup().setPrintArea("A1:B4"); worksheet.getRange("A1:B4").setValue(new Object[][] { {"Name", "Value"}, {"A", 100}, {"B", 200}, {"C", 300} }); PrintManager printManager = new PrintManager(); List<PageInfo> pages = printManager.paginate(worksheet); ByteArrayOutputStream stream = new ByteArrayOutputStream(); printManager.savePageInfosToPDF(stream, pages);
  Parameters:
  
  stream - 指定的 PDF 文件。
  
  pages - 页面信息集合。
- savePageInfosToPDF
  
  public final void savePageInfosToPDF(OutputStream stream, List<PageInfo> pages, PdfSaveOptions options)
  将指定的页面信息集合保存到 PDF 输出流。
  pages 集合应由 paginate(IWorksheet) 生成。传入 null 或空集合会导致 IllegalStateException。
  
  worksheet.getPageSetup().setPrintArea("A1:B4"); worksheet.getRange("A1:B4").setValue(new Object[][] { {"Name", "Value"}, {"A", 100}, {"B", 200}, {"C", 300} }); PrintManager printManager = new PrintManager(); List<PageInfo> pages = printManager.paginate(worksheet); try (ByteArrayOutputStream stream = new ByteArrayOutputStream()) { printManager.savePageInfosToPDF(stream, pages, new PdfSaveOptions()); } catch (Exception e) { }
  Parameters:
  
  stream - 要写入 PDF 数据的输出流。不得为 null。
  
  pages - 要导出的页面信息集合。必须至少包含一个页面；null 或空列表会导致 IllegalStateException。
  
  options - PDF 保存选项。可以为 null。
  
  Throws:
  
  IllegalStateException - 如果 pages 为 null 或为空。
- savePageInfosToPDF
  
  public final void savePageInfosToPDF(String fileName, List<PageInfo> pages)
  将指定的页面信息集合保存到 PDF 文件。
  此重载会将 PdfSaveOptions 参数的 null 转发给savePageInfosToPDF(String,List,PdfSaveOptions)。
  
  worksheet.getPageSetup().setPrintArea("B2:D6"); worksheet.getRange("B2:D6").setValue("Test"); PrintManager printManager = new PrintManager(); List<PageInfo> pages = printManager.paginate(workbook); printManager.savePageInfosToPDF("path/to/pages.pdf", pages);
  Parameters:
  
  fileName - 要创建的 PDF 文件路径。必须是有效的文件路径。
  
  pages - 要保存的页面信息集合。
  
  Throws:
  
  IllegalArgumentException - 如果 fileName 不是有效路径。
- savePageInfosToPDF
  
  public final void savePageInfosToPDF(String fileName, List<PageInfo> pages, PdfSaveOptions options)
  将指定的页面信息集合保存到 PDF 文件。
  此方法会将提供的 PageInfo 对象写入由fileName 标识的 PDF 文件。options 参数会传递给savePageInfosToPDF(OutputStream,List,PdfSaveOptions)。
  
  worksheet.getPageSetup().setPrintArea("B2:D6"); worksheet.getRange("B2:D6").setValue("Test"); PrintManager printManager = new PrintManager(); List<PageInfo> pages = printManager.paginate(workbook); PdfSaveOptions options = new PdfSaveOptions(); printManager.savePageInfosToPDF("path/to/pages.pdf", pages, options);
  Parameters:
  
  fileName - 要创建的 PDF 文件路径。必须是有效的文件路径。
  
  pages - 要保存的页面信息集合。
  
  options - 保存 PDF 文件时使用的选项。可以为 null。
  
  Throws:
  
  IllegalArgumentException - 如果 fileName 不是有效路径。
  
  RuntimeException - 如果创建或写入 PDF 文件时发生 I/O 错误。
- paginate
  
  public final List<PageInfo> paginate(List<IWorkbook> workbooks)
  为所有工作簿中的所有工作表生成分页信息。
  此方法通过调用 paginate(IWorkbook) 对指定列表中的每个工作簿进行分页，将生成的 PageInfo 对象合并到单个列表中，然后更新合并页面的页码和页面设置。
  
  worksheet.getPageSetup().setPrintArea("B2:D6"); worksheet.getRange("B2:D6").setValue("Test"); List<IWorkbook> workbooks = new ArrayList<IWorkbook>(); workbooks.add(workbook); PrintManager printManager = new PrintManager(); List<PageInfo> pages = printManager.paginate(workbooks);
  Parameters:
  
  workbooks - 要分页的工作簿。工作簿会按其在列表中出现的顺序处理。
  
  Returns:
  
  从所有工作簿生成的 PageInfo 对象列表。如果指定列表为空，则返回空列表。
- paginate
  
  public final List<PageInfo> paginate(IWorkbook workbook)
  为工作簿中的所有可见工作表生成分页信息。
  此方法会对每个可见性为 Visibility.Visible 的工作表进行分页，将生成的 PageInfo 对象合并到单个列表中，并更新生成页面的页码、页数和页面设置。
  
  worksheet.getPageSetup().setPrintArea("B2:D6"); worksheet.getRange("B2:D6").setValue("Test"); PrintManager printManager = new PrintManager(); List<PageInfo> pages = printManager.paginate(workbook);
  Parameters:
  
  workbook - 要对其可见工作表进行分页的工作簿。不得为 null。
  
  Returns:
  
  工作簿中所有可见工作表的 PageInfo 对象列表。如果未生成页面，则返回空列表。
- paginate
  
  public final List<PageInfo> paginate(IWorksheet worksheet)
  为工作表生成分页信息。
  分页结果根据工作表当前的打印区域和页面设置计算。每个返回的 PageInfo 按页面顺序描述一个生成的页面。
  
  worksheet.getPageSetup().setPrintArea("B2:N40"); worksheet.getRange("B2:N40").setValue(10); PrintManager printManager = new PrintManager(); List<PageInfo> pages = printManager.paginate(worksheet);
  Parameters:
  
  worksheet - 要生成页面的工作表。不能为 null。
  
  Returns:
  
  按页面顺序描述生成页面的 PageInfo 对象列表。如果未生成可打印页面，则返回空列表。
- paginate
  
  public final List<PageInfo> paginate(IWorksheet worksheet, List<IRange> keepTogetherRanges, List<RepeatSetting> repeatSettings)
  获取指定工作表的分页信息。
  分页结果根据工作表当前的页面设置和打印区域计算。使用 keepTogetherRanges 可将特定区域保留在同一页上，使用repeatSettings 可在分页期间为区域重复标题行、尾部行或列。
  
  worksheet.getPageSetup().setPrintArea("A1:D80"); worksheet.getRange("A1:D80").setValue(100); List<IRange> keepTogetherRanges = new ArrayList<>(); keepTogetherRanges.add(worksheet.getRange("$20:$25")); RepeatSetting repeatSetting = new RepeatSetting(); repeatSetting.setRange(worksheet.getRange("A1:D80")); repeatSetting.setTitleRowStart(0); repeatSetting.setTitleRowEnd(0); List<RepeatSetting> repeatSettings = new ArrayList<>(); repeatSettings.add(repeatSetting); PrintManager printManager = new PrintManager(); List<PageInfo> pages = printManager.paginate(worksheet, keepTogetherRanges, repeatSettings);
  Parameters:
  
  worksheet - 要生成页面的工作表。不能为 null。
  
  keepTogetherRanges - 应保留在同一页上的区域。如果不需要保持在一起的区域，可以为 null 或空。
  
  repeatSettings - 分页期间应用的重复设置。如果不需要重复行或列，可以为 null 或空。
  
  Returns:
  
  按页面顺序描述生成页面的 PageInfo 对象列表。如果未生成可打印页面，则返回空列表。
  
  Throws:
  
  IllegalStateException - 如果保持在一起的区域或重复设置无法适配可打印页面区域。
- generatePageContentInfo
  
  public final PageContentInfo generatePageContentInfo(IRange printArea, Size availableSize, int rowStart, int columnStart, boolean rowHeaderVisible, boolean columnHeaderVisible)
  返回指定打印区域和页面大小的 PageContentInfo 对象。
  结果根据提供的起始行、起始列、可用大小以及行标题和列标题可见性设置计算。
  
  worksheet.getRange("A1:C5").setValue(new Object[][] { {"Name", "Value", "Status"}, {"Test", 100, "Ready"} }); PrintManager printManager = new PrintManager(); PageContentInfo info = printManager.generatePageContentInfo( worksheet.getRange("A1:C5"), new Size(400, 300), 0, 0, true, false);
  Parameters:
  
  printArea - 要计算的打印区域。不得为 null。
  
  availableSize - 不包含边距的页面内容大小。不得为 null。
  
  rowStart - 用于计算结束行的从零开始的起始行索引。
  
  columnStart - 用于计算结束列的从零开始的起始列索引。
  
  rowHeaderVisible - 行标题是否随此页面一起打印。
  
  columnHeaderVisible - 列标题是否随此页面一起打印。
  
  Returns:
  
  描述计算得到的页面内容的 PageContentInfo 对象。
- updatePageNumberAndPageSettings
  
  public final void updatePageNumberAndPageSettings(List<PageInfo> pages)
  更新每个页面的页码、页数和页面设置。
  当页面集合发生变化（例如添加、删除或移动页面）后，请调用此方法。它会刷新提供的 PageInfo 列表，以便在进一步处理或导出之前保持分页元数据一致。
  
  worksheet.getPageSetup().setPrintArea("B2:N40"); worksheet.getRange("B2:N40").setValue(10); PrintManager printManager = new PrintManager(); List<PageInfo> pages = printManager.paginate(worksheet); PageInfo page = pages.remove(0); pages.add(page); printManager.updatePageNumberAndPageSettings(pages);
  Parameters:
  
  pages - 要更新的页面集合。通常是在集合被更改后由 paginate(IWorksheet) 返回的列表。
- updatePageNumberAndPageSettings
  
  public final void updatePageNumberAndPageSettings(List<PageInfo> pages, int firstPageNumber, int pageCount)
  更新每个页面的页码、页数和页面设置。
  当页面集合发生变化（例如添加、删除或移动页面）后，请调用此方法。此重载使用提供的第一页页码和总页数更新指定页面。
  
  worksheet.getPageSetup().setPrintArea("B2:N40"); worksheet.getRange("B2:N40").setValue(10); PrintManager printManager = new PrintManager(); List<PageInfo> pages = printManager.paginate(worksheet); printManager.updatePageNumberAndPageSettings(pages, 5, 12);
  Parameters:
  
  pages - 要更新的页面集合。
  
  firstPageNumber - 要分配给 pages 中第一页的页码。
  
  pageCount - 要应用到页面信息的总页数。
- appendPage
  
  public final void appendPage(org.apache.pdfbox.pdmodel.PDDocument doc, PageInfo pageInfo)
  将指定的打印页面追加到 PDF 文档。
  此方法向 doc 添加一个使用pageInfo 中纸张大小的新页面，然后将页面内容绘制到追加的 PDF 页面上。
  
  此重载会将 null 转发给appendPage(PDDocument,PageInfo,PdfSaveOptions)。
  
  worksheet.getRange("A1:B4").setValue(new Object[][] { {"Name", "Value"}, {"A", 100}, {"B", 200}, {"C", 300} }); PrintManager printManager = new PrintManager(); PageInfo page = printManager.paginate(worksheet).get(0); try (PDDocument doc = new PDDocument()) { printManager.appendPage(doc, page); } catch (IOException e) { }
  Parameters:
  
  doc - 接收追加页面的 PDF 文档。不能为 null。
  
  pageInfo - 要追加的打印页面信息。不能为 null。
- appendPage
  
  public final void appendPage(org.apache.pdfbox.pdmodel.PDDocument doc, PageInfo pageInfo, PdfSaveOptions options)
  将指定的打印页面追加到 PDF 文档。
  此方法会在 doc 中使用 pageInfo 定义的纸张大小创建新的 PDF 页面，然后将页面内容绘制到追加的页面上。在调用此方法之前，请使用 paginate(IWorksheet) 生成 PageInfo实例。
  
  options 参数控制 PDF 渲染行为。如果不需要 PdfSaveOptions，请传入null。
  
  worksheet.getRange("A1:B3").setValue(new Object[][] { {"Name", "Value"}, {"A", 100}, {"B", 200} }); PrintManager printManager = new PrintManager(); PageInfo pageInfo = printManager.paginate(worksheet).get(0); PdfSaveOptions options = new PdfSaveOptions(); try (PDDocument doc = new PDDocument()) { printManager.appendPage(doc, pageInfo, options); } catch (IOException e) { }
  Parameters:
  
  doc - 接收追加页面的 PDF 文档。不得为 null。
  
  pageInfo - 要追加的打印页面信息。不得为 null。
  
  options - 绘制页面内容时应用的 PDF 保存选项；可以为 null。
- draw
  
  public final void draw(org.apache.pdfbox.pdmodel.PDDocument doc, org.apache.pdfbox.pdmodel.PDPage page, List<PageInfo> pages, int rows, int columns)
  将页面集合中的页面绘制到 PDF 文档的某一页上。
  此方法会将目标 PDF 页面划分为由 rows 和 columns 定义的网格，然后将指定的 PageInfo 对象绘制到该布局中。此重载会转发到 draw(PDDocument,PDPage,List,int,int,Order)，并使用 Order.OverThenDown。
  
  worksheet.getRange("A1:B4").setValue(new Object[][] { {"Name", "Value"}, {"A", 100}, {"B", 200}, {"C", 300} }); PrintManager printManager = new PrintManager(); List<PageInfo> pages = printManager.paginate(worksheet); try (PDDocument doc = new PDDocument()) { PDPage page = new PDPage(); doc.addPage(page); printManager.draw(doc, page, pages, 1, 1); } catch (IOException e) { }
  Parameters:
  
  doc - 接收绘制内容的 PDF 文档。不得为 null。
  
  page - 目标 PDF 页面。不得为 null。
  
  pages - 要绘制的页面集合。不得为 null。
  
  rows - 用于划分目标页面布局的行数。必须大于 0。
  
  columns - 用于划分目标页面布局的列数。必须大于 0。
- draw
  
  public final void draw(org.apache.pdfbox.pdmodel.PDDocument doc, org.apache.pdfbox.pdmodel.PDPage page, List<PageInfo> pages, int rows, int columns, Order order)
  按指定顺序将页面集合中的页面绘制到 PDF 页面上。
  此重载会使用 null 选项转发到 draw(PDDocument,PDPage,List,int,int,Order,PdfSaveOptions)。
  
  worksheet.getRange("A1:B3").setValue(new Object[][] { {"Name", "Value"}, {"A", 100}, {"B", 200} }); PrintManager printManager = new PrintManager(); List<PageInfo> pages = printManager.paginate(worksheet); try (PDDocument doc = new PDDocument()) { PDPage page = new PDPage(); doc.addPage(page); printManager.draw(doc, page, pages, 1, 1, Order.OverThenDown); } catch (Exception e) { }
  Parameters:
  
  doc - 接收绘制内容的 PDF 文档。不能为 null。
  
  page - 目标 PDF 页面。不能为 null。
  
  pages - 要绘制的页面集合。不能为 null。
  
  rows - 用于划分页面布局的行数。必须大于 0。
  
  columns - 用于划分页面布局的列数。必须大于 0。
  
  order - 用于排列页面的方向。不能为 null。
- draw
  
  public final void draw(org.apache.pdfbox.pdmodel.PDDocument doc, org.apache.pdfbox.pdmodel.PDPage page, List<PageInfo> pages, int rows, int columns, Order order, PdfSaveOptions options)
  将指定页面集合中的页面绘制到 PDF 页面上。
  此方法会将目标 PDF 页面划分为由 rows 和 columns 定义的网格，然后将每个 PageInfo 绘制到一个网格单元中。order 参数控制页面是先按列方向排列，还是先按行方向排列。
  
  worksheet.getRange("A1:C6").setValue(new Object[][] { {"Name", "Q1", "Q2"}, {"North", 100, 120}, {"South", 90, 110} }); PrintManager printManager = new PrintManager(); List<PageInfo> pages = printManager.paginate(worksheet); PdfSaveOptions options = new PdfSaveOptions(); try (PDDocument doc = new PDDocument()) { PDPage page = new PDPage(); doc.addPage(page); printManager.draw(doc, page, pages, 1, 1, Order.OverThenDown, options); } catch (Exception e) { }
  Parameters:
  
  doc - 接收绘制内容的 PDF 文档。不得为 null。
  
  page - 目标 PDF 页面。不得为 null。
  
  pages - 要绘制的页面集合。不得为 null。
  
  rows - 用于划分目标页面布局的行数。
  
  columns - 用于划分目标页面布局的列数。
  
  order - 在网格中排列页面所用的方向。不得为 null。
  
  options - 绘制页面内容时应用的 PDF 保存选项；可以为 null。
- hasPrintContent
  
  public final boolean hasPrintContent(IRange range)
  返回指定区域是否包含可打印的内容。
  worksheet.getPageSetup().setPrintArea("B2:D6"); worksheet.getRange("B2:D6").setValue("Test"); PrintManager printManager = new PrintManager(); boolean hasContent = printManager.hasPrintContent(worksheet.getRange("B2:D6"));
  Parameters:
  
  range - 页面的打印区域。不得为 null。
  
  Returns:
  
  如果指定区域包含可打印内容，则为 true；否则为 false。
  
  Throws:
  
  NullPointerException - 如果 range 为 null。
- getSize
  
  public final Size getSize(PageContentInfo contentInfo)
  返回 PageContentInfo 的大小。
  worksheet.getPageSetup().setPrintArea("A1:B4"); worksheet.getRange("A1:B4").setValue(new Object[][] { {"Name", "Value"}, {"A", 100}, {"B", 200}, {"C", 300} }); PrintManager printManager = new PrintManager(); List<PageInfo> pages = printManager.paginate(worksheet); PageContentInfo contentInfo = pages.get(0).getPageContent(); Size contentSize = printManager.getSize(contentInfo);
  Parameters:
  
  contentInfo - PageContentInfo 对象。
  
  Returns:
  
  PageContentInfo 的大小。
- getSize
  
  public final Size getSize(IRange range)
  返回区域的大小。
  worksheet.getRange("B2:D6").setValue("Test"); IRange printArea = worksheet.getRange("B2:D6"); PrintManager printManager = new PrintManager(); Size rangeSize = printManager.getSize(printArea);
  Parameters:
  
  range - Range 对象。
  
  Returns:
  
  区域的大小。
- paginate
  
  public final List<PageInfo> paginate(IRange printArea)
  为指定区域生成分页信息。
  分页结果会使用工作表的当前页面设置，针对提供的 printArea 计算。返回的每个 PageInfo 按页面顺序表示一个生成的页面，并且在返回列表之前会更新其页码、页数和页面设置。
  
  IRange printArea = worksheet.getRange("B2:D20"); printArea.setValue("Test"); PrintManager printManager = new PrintManager(); List<PageInfo> pages = printManager.paginate(printArea);
  Parameters:
  
  printArea - 要分页的区域。不得为 null。
  
  Returns:
  
  按页面顺序描述指定区域所生成页面的 PageInfo 对象列表。如果未生成可打印页面，则返回空列表。
- draw
  
  public final void draw(org.apache.pdfbox.pdmodel.PDDocument doc, org.apache.pdfbox.pdmodel.PDPage page, Point location, IRange range)
  在 PDF 页面上的特定位置绘制指定的工作表区域。
  此方法通过调用getSize(IRange) 测量 range 的渲染大小，然后转发到draw(PDDocument,PDPage,Rectangle,IRange)，并使用一个Rectangle，其原点为 location，宽度和高度与测量得到的区域大小一致。
  
  worksheet.getRange("A1:B2").setValue(new Object[][] { {"Name", "Value"}, {"Test", 100} }); IRange range = worksheet.getRange("A1:B2"); PrintManager printManager = new PrintManager(); try (PDDocument doc = new PDDocument()) { PDPage page = new PDPage(); doc.addPage(page); printManager.draw(doc, page, new Point(36, 72), range); } catch (Exception e) { }
  Parameters:
  
  doc - 接收渲染区域的 PDF 文档。
  
  page - 要在其上绘制区域的 PDF 页面。
  
  location - 以页面坐标表示的区域绘制位置的左上角。
  
  range - 要渲染的工作表区域。
- draw
  
  public final void draw(org.apache.pdfbox.pdmodel.PDDocument doc, org.apache.pdfbox.pdmodel.PDPage page, Point location, IRange range, PdfSaveOptions options)
  在 PDF 页面上的给定位置绘制指定的工作表区域。
  此重载会测量 range，创建一个以 location 为原点且大小与该区域匹配的矩形，然后转发到 draw(PDDocument,PDPage,Rectangle,IRange,PdfSaveOptions)。
  
  worksheet.getRange("A1:B2").setValue(new Object[][] { {"Name", "Value"}, {"Test", 100} }); IRange range = worksheet.getRange("A1:B2"); PrintManager printManager = new PrintManager(); PdfSaveOptions options = new PdfSaveOptions(); try (PDDocument doc = new PDDocument()) { PDPage page = new PDPage(); doc.addPage(page); printManager.draw(doc, page, new Point(36, 72), range, options); } catch (Exception e) { }
  Parameters:
  
  doc - 接收渲染区域的 PDF 文档。
  
  page - 要在其上绘制区域的 PDF 页面。
  
  location - 以页面坐标表示的区域绘制位置的左上角。
  
  range - 要渲染的工作表区域。
  
  options - PDF 渲染选项。可以为 null。
- draw
  
  public final void draw(org.apache.pdfbox.pdmodel.PDDocument doc, org.apache.pdfbox.pdmodel.PDPage page, Rectangle rect, IRange range)
  将指定的工作表区域绘制到 PDF 页面上的矩形区域中。
  此方法将 range 中的单元格渲染到 page 上的 rect 内。它会将 null 作为 options 转发到 draw(PDDocument,PDPage,Rectangle,IRange,PdfSaveOptions)。
  
  worksheet.getRange("A1:B2").setValue(new Object[][] { {"Name", "Value"}, {"Test", 100} }); IRange range = worksheet.getRange("A1:B2"); PrintManager printManager = new PrintManager(); try (PDDocument doc = new PDDocument()) { PDPage page = new PDPage(); doc.addPage(page); printManager.draw(doc, page, new Rectangle(36, 72, 220, 90), range); } catch (Exception e) { }
  Parameters:
  
  doc - 接收渲染区域的 PDF 文档。
  
  page - 要在其上绘制区域的 PDF 页面。
  
  rect - 目标矩形，以页面坐标表示，定义区域的绘制位置。
  
  range - 要渲染的工作表区域。
- draw
  
  public final void draw(org.apache.pdfbox.pdmodel.PDDocument doc, org.apache.pdfbox.pdmodel.PDPage page, Rectangle rect, IRange range, PdfSaveOptions options)
  将指定的工作表区域绘制到 PDF 页面上的矩形区域中。
  此方法使用工作表的页面设置渲染 range 中的单元格，并将输出写入 page 上的 rect 内。如果 options 不是null，则在绘制区域之前，它的 PDF 文档属性和安全设置也会应用到 doc。
  
  worksheet.getRange("A1:B2").setValue(new Object[][] { {"Name", "Value"}, {"Test", 100} }); IRange range = worksheet.getRange("A1:B2"); PrintManager printManager = new PrintManager(); PdfSaveOptions options = new PdfSaveOptions(); try (PDDocument doc = new PDDocument()) { PDPage page = new PDPage(); doc.addPage(page); Rectangle rect = new Rectangle(36, 72, 220, 90); printManager.draw(doc, page, rect, range, options); } catch (Exception e) { }
  Parameters:
  
  doc - 接收渲染区域的 PDF 文档。如果 options 包含文档属性或安全设置，则这些设置会应用到此文档。
  
  page - 要在其上绘制区域的 PDF 页面。
  
  rect - 目标矩形，以页面坐标表示，定义区域的绘制位置。
  
  range - 要渲染的工作表区域。
  
  options - PDF 渲染选项。可以为 null。
- draw
  
  public final void draw(org.apache.pdfbox.pdmodel.PDDocument doc, org.apache.pdfbox.pdmodel.PDPage page, Rectangle rect, PageContentInfo pageContent)
  将打印页面内容绘制到 PDF 页面上的指定矩形中。
  使用此方法可以将 PageContentInfo 对象（例如从 paginate(IWorksheet) 获取的对象）渲染到 page 上由 rect 定义的目标区域。此重载会将 null 作为options 转发到 draw(PDDocument,PDPage,Rectangle,PageContentInfo,PdfSaveOptions)。
  
  worksheet.getRange("A1:B4").setValue(new Object[][] { {"Name", "Value"}, {"A", 100}, {"B", 200}, {"C", 300} }); PrintManager printManager = new PrintManager(); PageContentInfo pageContent = printManager.paginate(worksheet).get(0).getPageContent(); try (PDDocument doc = new PDDocument()) { PDPage page = new PDPage(new PDRectangle(400, 600)); doc.addPage(page); printManager.draw(doc, page, new Rectangle(36, 36, 328, 528), pageContent); } catch (IOException e) { }
  Parameters:
  
  doc - 包含 page 的 PDF 文档。不得为 null。
  
  page - 要在其上绘制打印内容的 PDF 页面。不得为 null。
  
  rect - 以 PDF 页面坐标表示的目标位置和大小，用于绘制打印内容。不得为 null。
  
  pageContent - 要渲染的打印页面内容信息。不得为 null，并且必须包含区域。
- draw
  
  public final void draw(org.apache.pdfbox.pdmodel.PDDocument doc, org.apache.pdfbox.pdmodel.PDPage page, Rectangle rect, PageContentInfo pageContent, PdfSaveOptions options)
  将打印页面内容绘制到 PDF 页面上的指定区域中。
  此方法会从 pageContent 创建 PageInfo，使用工作表的奇数页设置，将纸张大小设置为 pageContent 的大小，清除所有页边距，然后将结果绘制到 rect 中并置于 page 上。
  
  worksheet.getRange("A1:B4").setValue(new Object[][] { {"Name", "Value"}, {"A", 100}, {"B", 200}, {"C", 300} }); PrintManager printManager = new PrintManager(); PageContentInfo pageContent = printManager.paginate(worksheet).get(0).getPageContent(); try (PDDocument doc = new PDDocument()) { PDPage page = new PDPage(new PDRectangle(400, 600)); doc.addPage(page); printManager.draw(doc, page, new Rectangle(36, 36, 328, 528), pageContent, new PdfSaveOptions()); } catch (IOException e) { }
  Parameters:
  
  doc - 包含 page 的 PDF 文档。不能为 null。
  
  page - 要在其上绘制打印内容的 PDF 页面。不能为 null。
  
  rect - 目标位置和大小，以 PDF 页面坐标表示，用于绘制打印内容。不能为 null。
  
  pageContent - 要渲染的打印页面内容信息。不能为 null，并且必须包含区域。
  
  options - 绘制期间应用的 PDF 保存选项。可以为 null。
- draw
  
  public final void draw(org.apache.pdfbox.pdmodel.PDDocument doc, org.apache.pdfbox.pdmodel.PDPage page, Rectangle rect, PageInfo pageInfo)
  将指定的打印页面信息绘制到 PDF 页面上的给定矩形中。
  此重载会转发到 draw(PDDocument,PDPage,Rectangle,PageInfo,PdfSaveOptions)，并为 options 传入 null。
  
  worksheet.getPageSetup().setPrintArea("A1:B4"); worksheet.getRange("A1:B4").setValue(new Object[][] {{"Name", "Value"}, {"Test", 100}, {"Hello", 200}, {"Total", 300}}); PrintManager printManager = new PrintManager(); PageInfo pageInfo = printManager.paginate(worksheet).get(0); Rectangle rect = new Rectangle(36, 36, 400, 300); try (PDDocument doc = new PDDocument()) { PDPage page = new PDPage(); doc.addPage(page); printManager.draw(doc, page, rect, pageInfo); } catch (IOException e) { }
  Parameters:
  
  doc - 包含目标页面的 PDF 文档。
  
  page - PDF 文档中的页面。
  
  rect - 绘制页面信息的区域的位置和大小。
  
  pageInfo - 要绘制的打印页面信息。
- draw
  
  public final void draw(org.apache.pdfbox.pdmodel.PDDocument doc, org.apache.pdfbox.pdmodel.PDPage page, Rectangle rect, PageInfo pageInfo, PdfSaveOptions options)
  将打印页面信息绘制到 PDF 页面上的指定区域中。
  此方法会将 pageInfo 表示的内容渲染到rect 中，并绘制在 page 上。页面内容流以追加模式打开，因此绘制的输出会添加到现有 PDF 页面内容中。pageInfo 对象通常从 paginate(IWorksheet) 获取。
  
  worksheet.getRange("A1:B4").setValue(new Object[][] { {"Name", "Value"}, {"A", 100}, {"B", 200}, {"C", 300} }); PrintManager printManager = new PrintManager(); PageInfo pageInfo = printManager.paginate(worksheet).get(0); try (PDDocument doc = new PDDocument()) { PDPage page = new PDPage(new PDRectangle(400, 600)); doc.addPage(page); printManager.draw(doc, page, new Rectangle(36, 36, 328, 528), pageInfo, new PdfSaveOptions()); } catch (IOException e) { }
  Parameters:
  
  doc - 包含 page 的 PDF 文档。不能为 null。
  
  page - 要在其上绘制打印内容的 PDF 页面。不能为 null。
  
  rect - 目标位置和大小，以 PDF 页面坐标表示，用于绘制打印内容。不能为 null。
  
  pageInfo - 要渲染的打印页面信息。不能为 null。
  
  options - 绘制期间应用的 PDF 保存选项。可以为 null。
- getPrintAreas
  
  public final List<IRange> getPrintAreas(IWorksheet worksheet)
  返回指定工作表的打印区域列表。
  worksheet.getPageSetup().setPrintArea("B2:D6"); worksheet.getRange("B2:D6").setValue("Test"); PrintManager printManager = new PrintManager(); List<IRange> printAreas = printManager.getPrintAreas(worksheet); String address = printAreas.get(0).getAddress();
  Parameters:
  
  worksheet - 工作表对象。
  
  Returns:
  
  指定工作表的打印区域列表。
- GetPaginationInfo
  
  public List<Integer> GetPaginationInfo(IWorksheet worksheet, PaginationOrientation orientation)
  返回定义指定工作表页面边界的行或列索引。
  分页基于工作表当前的 IPageSetup 设置。请分别针对水平分页和垂直分页调用此方法。如果未定义打印区域，则分页范围从单元格 A1 到包含数据的最后一个单元格。
  
  worksheet.getPageSetup().setPrintArea("B2:N40"); worksheet.getRange("B2:N40").setValue(10); PrintManager printManager = new PrintManager(); List<Integer> columnPageBoundaries = printManager.GetPaginationInfo(worksheet, PaginationOrientation.Horizontal);
  Parameters:
  
  worksheet - 要获取其分页信息的工作表。不能为 null。
  
  orientation - 决定返回行边界索引还是列边界索引的分页方向。
  
  Returns:
  
  表示指定方向页面边界的行或列索引列表。
- GetPaginationInfo
  
  public List<Integer> GetPaginationInfo(IWorksheet worksheet, PaginationOrientation orientation, List<IRange> keepTogetherRanges, List<RepeatSetting> repeatSettings)
  获取为指定工作表定义页面边界的行索引或列索引。
  分页结果根据工作表的当前页面设置和指定的 orientation 计算。使用 keepTogetherRanges 可防止特定区域被拆分到多个页面，使用 repeatSettings 可在分页期间为区域重复标题行、标题列、尾部行或尾部列。
  
  如果工作表没有打印区域，此方法返回 null。
  
  worksheet.getPageSetup().setPrintArea("A1:D80"); worksheet.getRange("A1:D80").setValue(100); List<IRange> keepTogetherRanges = new ArrayList<>(); keepTogetherRanges.add(worksheet.getRange("A20:D25")); RepeatSetting repeatSetting = new RepeatSetting(); repeatSetting.setRange(worksheet.getRange("A1:D80")); repeatSetting.setTitleRowStart(0); repeatSetting.setTitleRowEnd(0); List<RepeatSetting> repeatSettings = new ArrayList<>(); repeatSettings.add(repeatSetting); PrintManager printManager = new PrintManager(); List<Integer> pageBoundaries = printManager.GetPaginationInfo( worksheet, PaginationOrientation.Vertical, keepTogetherRanges, repeatSettings);
  Parameters:
  
  worksheet - 要获取其分页信息的工作表。不得为 null。
  
  orientation - 分页方向，用于确定返回行边界索引还是列边界索引。
  
  keepTogetherRanges - 应保留在同一页面上的区域。如果不需要保持在一起的区域，可以为 null 或空。
  
  repeatSettings - 分页期间应用的重复设置。如果不需要重复行或列，可以为 null 或空。
  
  Returns:
  
  表示指定方向页面边界的行索引或列索引列表；如果工作表没有打印区域，则返回 null。
  
  Throws:
  
  IllegalStateException - 如果保持在一起或重复设置无法适配可打印页面区域。

Class PrintManager

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

PrintManager

Method Details

finalize

saveWorkbooksToPDF

saveWorkbooksToPDF

saveWorkbooksToPDF

saveWorkbooksToPDF

savePageInfosToPDF

savePageInfosToPDF

savePageInfosToPDF

savePageInfosToPDF

paginate

paginate

paginate

paginate

generatePageContentInfo

updatePageNumberAndPageSettings

updatePageNumberAndPageSettings

appendPage

appendPage

draw

draw

draw

hasPrintContent

getSize

getSize

paginate

draw

draw

draw

draw

draw

draw

draw

draw

getPrintAreas

GetPaginationInfo

GetPaginationInfo