| Package | Description | 
|---|---|
| org.apache.poi.ooxml | |
| org.apache.poi.ooxml.dev | |
| org.apache.poi.openxml4j.opc | |
| org.apache.poi.openxml4j.opc.internal | |
| org.apache.poi.openxml4j.opc.internal.marshallers | |
| org.apache.poi.openxml4j.opc.internal.unmarshallers | |
| org.apache.poi.poifs.crypt.dsig | |
| org.apache.poi.xddf.usermodel.chart | |
| org.apache.poi.xddf.usermodel.text | |
| org.apache.poi.xdgf.usermodel | |
| org.apache.poi.xdgf.xml | |
| org.apache.poi.xslf.usermodel | |
| org.apache.poi.xssf.binary | The org.apache.poi.xssf.binary package includes necessary underlying components
 for streaming/read-only processing of xlsb files. | 
| org.apache.poi.xssf.eventusermodel | |
| org.apache.poi.xssf.model | |
| org.apache.poi.xssf.streaming | |
| org.apache.poi.xssf.usermodel | |
| org.apache.poi.xwpf.usermodel | 
| Modifier and Type | Method and Description | 
|---|---|
| protected PackagePart | POIXMLDocument. getCorePart() | 
| PackagePart | POIXMLDocumentPart. getPackagePart()Provides access to the underlying PackagePart | 
| protected PackagePart[] | POIXMLDocument. getRelatedByType(java.lang.String contentType)Retrieves all the PackageParts which are defined as relationships of the base document with the
 specified content type. | 
| protected PackagePart | POIXMLDocumentPart. getTargetPart(PackageRelationship rel)Get the PackagePart that is the target of a relationship from this Part. | 
| protected PackagePart | POIXMLProperties. getThumbnailPart()Returns the  PackagePartfor the Document
  Thumbnail, ornullif there isn't one | 
| Modifier and Type | Method and Description | 
|---|---|
| abstract java.util.List<PackagePart> | POIXMLDocument. getAllEmbeddedParts()Get the document's embedded files. | 
| Modifier and Type | Method and Description | 
|---|---|
| POIXMLDocumentPart | POIXMLFactory. createDocumentPart(POIXMLDocumentPart parent,
                  PackagePart part)Create a POIXMLDocumentPart from existing package part and relation. | 
| java.io.InputStream | POIXMLRelation. getContents(PackagePart corePart)Fetches the InputStream to read the contents, based
  of the specified core part, for which we are defined
  as a suitable relationship | 
| protected PackageRelationship | POIXMLFactory. getPackageRelationship(POIXMLDocumentPart parent,
                      PackagePart part)Retrieves the package relationship of the child part within the parent | 
| POIXMLDocumentPart | POIXMLRelation.PackagePartConstructor. init(PackagePart part) | 
| POIXMLDocumentPart | POIXMLRelation.ParentPartConstructor. init(POIXMLDocumentPart parent,
    PackagePart part) | 
| Modifier and Type | Method and Description | 
|---|---|
| protected void | POIXMLDocumentPart. onSave(java.util.Set<PackagePart> alreadySaved)Save changes in the underlying OOXML package. | 
| protected void | POIXMLDocumentPart. read(POIXMLFactory factory,
    java.util.Map<PackagePart,POIXMLDocumentPart> context)Iterate through the underlying PackagePart and create child POIXMLFactory instances
 using the specified factory | 
| Constructor and Description | 
|---|
| POIXMLDocumentPart(PackagePart part)Creates an POIXMLDocumentPart representing the given package part and relationship. | 
| POIXMLDocumentPart(POIXMLDocumentPart parent,
                  PackagePart part)Creates an POIXMLDocumentPart representing the given package part, relationship and parent
 Called by  POIXMLDocumentPart.read(POIXMLFactory, java.util.Map)when reading in an existing file. | 
| Modifier and Type | Method and Description | 
|---|---|
| static long | OOXMLLister. getSize(PackagePart part)Figures out how big a given PackagePart is. | 
| Modifier and Type | Class and Description | 
|---|---|
| class  | ZipPackagePartZip implementation of a PackagePart. | 
| Modifier and Type | Method and Description | 
|---|---|
| protected PackagePart | OPCPackage. addPackagePart(PackagePart part)Add the specified part to the package. | 
| PackagePart | OPCPackage. createPart(PackagePartName partName,
          java.lang.String contentType)Create and add a part, with the specified name and content type, to the
 package. | 
| PackagePart | OPCPackage. createPart(PackagePartName partName,
          java.lang.String contentType,
          java.io.ByteArrayOutputStream content)Add a part to the package. | 
| protected abstract PackagePart | OPCPackage. createPartImpl(PackagePartName partName,
              java.lang.String contentType,
              boolean loadRelationships)Core method to create a package part. | 
| protected PackagePart | ZipPackage. createPartImpl(PackagePartName partName,
              java.lang.String contentType,
              boolean loadRelationships)Create a new MemoryPackagePart from the specified URI and content type
 aram partName The part URI. | 
| PackagePart | PackagePartCollection. get(PackagePartName partName) | 
| PackagePart | OPCPackage. getPart(PackagePartName partName)Retrieve a part identified by its name. | 
| PackagePart | OPCPackage. getPart(PackageRelationship partRel)Get the target part from the specified relationship. | 
| PackagePart | PackagePart. getRelatedPart(PackageRelationship rel)Get the PackagePart that is the target of a relationship. | 
| PackagePart | PackageRelationship. getSource() | 
| PackagePart | PackagePartCollection. put(PackagePartName partName,
   PackagePart part)Check rule [M1.11]: a package implementer shall neither create nor
 recognize a part with a part name derived from another part name by
 appending segments to it. | 
| PackagePart | PackagePartCollection. remove(PackagePartName key) | 
| Modifier and Type | Method and Description | 
|---|---|
| java.util.ArrayList<PackagePart> | OPCPackage. getParts()Load the parts of the archive if it has not been done yet. | 
| java.util.ArrayList<PackagePart> | OPCPackage. getPartsByContentType(java.lang.String contentType)Retrieve parts by content type. | 
| java.util.List<PackagePart> | OPCPackage. getPartsByName(java.util.regex.Pattern namePattern)Retrieve parts by name | 
| java.util.ArrayList<PackagePart> | OPCPackage. getPartsByRelationshipType(java.lang.String relationshipType)Retrieve parts by relationship type. | 
| java.util.Collection<PackagePart> | PackagePartCollection. sortedValues()The values themselves should be returned in sorted order. | 
| Modifier and Type | Method and Description | 
|---|---|
| protected PackagePart | OPCPackage. addPackagePart(PackagePart part)Add the specified part to the package. | 
| int | PackagePart. compareTo(PackagePart other)Compare based on the package part name, using a natural sort order | 
| static PackagePartName | PackagingURIHelper. createPartName(java.lang.String partName,
              PackagePart relativePart)Create an OPC compliant part name by resolving it using a base part. | 
| static PackagePartName | PackagingURIHelper. createPartName(java.net.URI partName,
              PackagePart relativePart)Create an OPC compliant part name by resolving it using a base part. | 
| PackageRelationship | PackageRelationshipCollection. findExistingInternalRelation(PackagePart packagePart) | 
| PackageRelationship | PackagePart. findExistingRelation(PackagePart packagePart)Check if the new part was already added before via PackagePart.addRelationship() | 
| void | PackageRelationshipCollection. parseRelationshipsPart(PackagePart relPart)Parse the relationship part and add all relationship in this collection. | 
| PackagePart | PackagePartCollection. put(PackagePartName partName,
   PackagePart part)Check rule [M1.11]: a package implementer shall neither create nor
 recognize a part with a part name derived from another part name by
 appending segments to it. | 
| void | OPCPackage. registerPartAndContentType(PackagePart part)Add the specified part, and register its content type with the content
 type manager. | 
| void | OPCPackage. removePart(PackagePart part)Remove the specified part in this package. | 
| Constructor and Description | 
|---|
| PackageRelationship(OPCPackage pkg,
                   PackagePart sourcePart,
                   java.net.URI targetUri,
                   TargetMode targetMode,
                   java.lang.String relationshipType,
                   java.lang.String id)Constructor. | 
| PackageRelationshipCollection(OPCPackage container,
                             PackagePart part)Constructor. | 
| PackageRelationshipCollection(PackagePart part)Constructor. | 
| Modifier and Type | Class and Description | 
|---|---|
| class  | MemoryPackagePartMemory version of a package part. | 
| class  | PackagePropertiesPartRepresents the core properties part of a package. | 
| Modifier and Type | Method and Description | 
|---|---|
| PackagePart | PartUnmarshaller. unmarshall(UnmarshallContext context,
          java.io.InputStream in)Save the content of the package in the stream | 
| Modifier and Type | Method and Description | 
|---|---|
| boolean | PartMarshaller. marshall(PackagePart part,
        java.io.OutputStream out)Save the content of the package in the stream | 
| Modifier and Type | Method and Description | 
|---|---|
| boolean | PackagePropertiesMarshaller. marshall(PackagePart part,
        java.io.OutputStream out)Marshall package core properties to an XML document. | 
| boolean | DefaultMarshaller. marshall(PackagePart part,
        java.io.OutputStream out)Save the given part in the output stream by using the save() method of the part. | 
| boolean | ZipPartMarshaller. marshall(PackagePart part,
        java.io.OutputStream os)Save the specified part to the given stream. | 
| boolean | ZipPackagePropertiesMarshaller. marshall(PackagePart part,
        java.io.OutputStream out) | 
| Modifier and Type | Method and Description | 
|---|---|
| PackagePart | PackagePropertiesUnmarshaller. unmarshall(UnmarshallContext context,
          java.io.InputStream in) | 
| Modifier and Type | Method and Description | 
|---|---|
| PackagePart | SignaturePart. getPackagePart() | 
| Constructor and Description | 
|---|
| XDDFChart(PackagePart part)Construct a DrawingML chart from a package part. | 
| Modifier and Type | Method and Description | 
|---|---|
| XDDFHyperlink | XDDFTextRun. linkToExternal(java.lang.String url,
              PackagePart localPart,
              POIXMLRelation relation) | 
| XDDFHyperlink | XDDFTextRun. linkToInternal(java.lang.String action,
              PackagePart localPart,
              POIXMLRelation relation,
              PackagePartName target) | 
| Modifier and Type | Method and Description | 
|---|---|
| java.util.List<PackagePart> | XmlVisioDocument. getAllEmbeddedParts()Not currently implemented | 
| Modifier and Type | Method and Description | 
|---|---|
| POIXMLDocumentPart | XDGFFactory. createDocumentPart(POIXMLDocumentPart parent,
                  PackagePart part) | 
| Constructor and Description | 
|---|
| XDGFBaseContents(PackagePart part) | 
| XDGFMasterContents(PackagePart part) | 
| XDGFMasters(PackagePart part) | 
| XDGFPageContents(PackagePart part) | 
| XDGFPages(PackagePart part) | 
| Constructor and Description | 
|---|
| XDGFXMLDocumentPart(PackagePart part) | 
| Modifier and Type | Method and Description | 
|---|---|
| PackagePart | XSLFSlideShow. getNodesPart(org.openxmlformats.schemas.presentationml.x2006.main.CTSlideIdListEntry parentSlide)Gets the PackagePart of the notes for the
  given slide, or null if there isn't one. | 
| PackagePart | XSLFSlideShow. getSlideMasterPart(org.openxmlformats.schemas.presentationml.x2006.main.CTSlideMasterIdListEntry master) | 
| PackagePart | XSLFSlideShow. getSlidePart(org.openxmlformats.schemas.presentationml.x2006.main.CTSlideIdListEntry slide) | 
| Modifier and Type | Method and Description | 
|---|---|
| java.util.List<PackagePart> | XMLSlideShow. getAllEmbeddedParts()Get the document's embedded files. | 
| java.util.List<PackagePart> | XSLFSlideShow. getAllEmbeddedParts()Get the document's embedded files. | 
| Modifier and Type | Method and Description | 
|---|---|
| protected PaintStyle | XSLFShape. selectPaint(org.openxmlformats.schemas.drawingml.x2006.main.CTBlipFillProperties blipFill,
           PackagePart parentPart,
           org.openxmlformats.schemas.drawingml.x2006.main.CTSchemeColor phClr,
           XSLFTheme theme) | 
| protected PaintStyle | XSLFShape. selectPaint(XSLFPropertiesDelegate.XSLFFillProperties fp,
           org.openxmlformats.schemas.drawingml.x2006.main.CTSchemeColor phClr,
           PackagePart parentPart,
           XSLFTheme theme,
           boolean hasPlaceholder)Convert shape fill into java.awt.Paint. | 
| Constructor and Description | 
|---|
| XSLFChart(PackagePart part)Construct a PresentationML chart from a package part. | 
| XSLFFontData(PackagePart part)Construct XSLFFontData from a package part | 
| XSLFNotesMaster(PackagePart part) | 
| XSLFObjectData(PackagePart part)Construct XSLFObjectData from a package part | 
| XSLFPictureData(PackagePart part)Construct XSLFPictureData from a package part | 
| XSLFSheet(PackagePart part) | 
| XSLFSlideLayout(PackagePart part) | 
| XSLFSlideMaster(PackagePart part) | 
| XSLFTableStyles(PackagePart part) | 
| XSLFTexturePaint(org.openxmlformats.schemas.drawingml.x2006.main.CTBlipFillProperties blipFill,
                PackagePart parentPart,
                org.openxmlformats.schemas.drawingml.x2006.main.CTSchemeColor phClr,
                XSLFTheme theme,
                XSLFSheet sheet) | 
| XSLFTheme(PackagePart part) | 
| Constructor and Description | 
|---|
| XSSFBHyperlinksTable(PackagePart sheetPart) | 
| Modifier and Type | Field and Description | 
|---|---|
| protected PackagePart | XSSFReader. workbookPart | 
| Modifier and Type | Method and Description | 
|---|---|
| PackagePart | XSSFReader.SheetIterator. getSheetPart() | 
| Constructor and Description | 
|---|
| ReadOnlySharedStringsTable(PackagePart part)Like POIXMLDocumentPart constructor
 Calls  ReadOnlySharedStringsTable.ReadOnlySharedStringsTable(PackagePart, boolean), with a
 value oftrueto include phonetic runs. | 
| ReadOnlySharedStringsTable(PackagePart part,
                          boolean includePhoneticRuns)Like POIXMLDocumentPart constructor | 
| Constructor and Description | 
|---|
| CalculationChain(PackagePart part) | 
| CommentsTable(PackagePart part) | 
| ExternalLinksTable(PackagePart part) | 
| MapInfo(PackagePart part) | 
| SharedStringsTable(PackagePart part) | 
| SingleXmlCells(PackagePart part) | 
| StylesTable(PackagePart part) | 
| ThemesTable(PackagePart part)Construct a ThemesTable. | 
| Modifier and Type | Method and Description | 
|---|---|
| protected static java.awt.Dimension | SXSSFPicture. getImageDimension(PackagePart part,
                 int type)Return the dimension of this image | 
| Modifier and Type | Method and Description | 
|---|---|
| PackagePart | XSSFObjectData. getObjectPart() | 
| Modifier and Type | Method and Description | 
|---|---|
| java.util.List<PackagePart> | XSSFWorkbook. getAllEmbeddedParts()Get the document's embedded files. | 
| Modifier and Type | Method and Description | 
|---|---|
| protected void | XSSFHyperlink. generateRelationIfNeeded(PackagePart sheetPart)Generates the relation if required | 
| protected static java.awt.Dimension | XSSFPicture. getImageDimension(PackagePart part,
                 int type)Return the dimension of this image | 
| Constructor and Description | 
|---|
| XSSFChart(PackagePart part)Construct a SpreadsheetML chart from a package part. | 
| XSSFChartSheet(PackagePart part) | 
| XSSFDrawing(PackagePart part)Construct a SpreadsheetML drawing from a package part | 
| XSSFPictureData(PackagePart part)Construct XSSFPictureData from a package part | 
| XSSFPivotCache(PackagePart part)Creates n XSSFPivotCache representing the given package part and relationship. | 
| XSSFPivotCacheDefinition(PackagePart part)Creates an XSSFPivotCacheDefintion representing the given package part and relationship. | 
| XSSFPivotCacheRecords(PackagePart part)Creates an XSSFPivotCacheRecords representing the given package part and relationship. | 
| XSSFPivotTable(PackagePart part)Creates an XSSFPivotTable representing the given package part and relationship. | 
| XSSFSheet(PackagePart part)Creates an XSSFSheet representing the given package part and relationship. | 
| XSSFTable(PackagePart part) | 
| XSSFVBAPart(PackagePart part)Construct XSSFVBAPart from a package part | 
| XSSFVMLDrawing(PackagePart part)Construct a SpreadsheetML drawing from a package part | 
| XSSFWorkbook(PackagePart part)Constructs a XSSFWorkbook object using Package Part. | 
| Modifier and Type | Method and Description | 
|---|---|
| PackagePart | XWPFDocument. getPartById(java.lang.String id)Get the document part that's defined as the
 given relationship of the core document. | 
| Modifier and Type | Method and Description | 
|---|---|
| java.util.List<PackagePart> | XWPFDocument. getAllEmbeddedParts()Get the document's embedded files. | 
| Constructor and Description | 
|---|
| XWPFAbstractFootnotesEndnotes(PackagePart part) | 
| XWPFAbstractFootnotesEndnotes(POIXMLDocumentPart parent,
                             PackagePart part) | 
| XWPFChart(PackagePart part)Construct a chart from a package part. | 
| XWPFEndnotes(PackagePart part)Construct XWPFEndnotes from a package part | 
| XWPFFooter(POIXMLDocumentPart parent,
          PackagePart part) | 
| XWPFFootnotes(PackagePart part)Construct XWPFFootnotes from a package part | 
| XWPFHeader(POIXMLDocumentPart parent,
          PackagePart part) | 
| XWPFHeaderFooter(POIXMLDocumentPart parent,
                PackagePart part) | 
| XWPFNumbering(PackagePart part)create a new styles object with an existing document | 
| XWPFPictureData(PackagePart part)Construct XWPFPictureData from a package part | 
| XWPFSettings(PackagePart part) | 
| XWPFStyles(PackagePart part)Construct XWPFStyles from a package part | 
Copyright 2021 The Apache Software Foundation or its licensors, as applicable.