XDGFPages (POI API Documentation)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.poi.xdgf.usermodel
Class XDGFPages

java.lang.Object
  org.apache.poi.POIXMLDocumentPart
      org.apache.poi.xdgf.xml.XDGFXMLDocumentPart
          org.apache.poi.xdgf.usermodel.XDGFPages

public class XDGFPages
extends XDGFXMLDocumentPart
extends XDGFXMLDocumentPart

Contains a list of Page objects (not page content!)

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.poi.POIXMLDocumentPart
`POIXMLDocumentPart.RelationPart`

Field Summary

Fields inherited from class org.apache.poi.xdgf.xml.XDGFXMLDocumentPart
`_document`

Constructor Summary
`XDGFPages(PackagePart part, XDGFDocument document)`

Method Summary
`java.util.List<XDGFPage>`	`getPageList()`
`protected void`	`onDocumentRead()` Fired when a package part is read

Methods inherited from class org.apache.poi.POIXMLDocumentPart
`_invokeOnDocumentRead, addRelation, commit, createRelationship, createRelationship, createRelationship, getNextPartNumber, getPackagePart, getParent, getRelationById, getRelationId, getRelationParts, getRelations, getTargetPart, onDocumentCreate, onDocumentRemove, onSave, prepareForCommit, read, rebase, removeRelation, removeRelation, toString`

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

Constructor Detail

XDGFPages

public XDGFPages(PackagePart part,
                 XDGFDocument document)

Since:: POI 3.14-Beta1

Method Detail

onDocumentRead

protected void onDocumentRead()

Description copied from class: POIXMLDocumentPart

Fired when a package part is read

Overrides:: onDocumentRead in class POIXMLDocumentPart

getPageList

public java.util.List<XDGFPage> getPageList()

Returns:: A list of pages ordered by page number