Package org.docx4j.openpackaging.packages

Class PresentationMLPackage

java.lang.Object

org.docx4j.openpackaging.Base

org.docx4j.openpackaging.packages.OpcPackage

org.docx4j.openpackaging.packages.PresentationMLPackage

All Implemented Interfaces:

PackageIdentifier

public class PresentationMLPackage
extends OpcPackage

Field Summary

Fields

Modifier and Type	Field	Description
(package private) Map<String,ShapeWrapper>	globalPlaceHolders
protected static org.slf4j.Logger	log
private MainPresentationPart	mainPresentationPart
private ProtectPresentation	presentationProtectionSettings
private static String	SAMPLE_SHAPE
private StyleTree	styleTree

Fields inherited from class org.docx4j.openpackaging.packages.OpcPackage

contentTypeManager, customXmlDataStorageParts, docPropsCorePart, docPropsCustomPart, docPropsExtendedPart, externalResources, handled, isNew, parts

Fields inherited from class org.docx4j.openpackaging.Base

contentType, partName, relationships

Constructor Summary

Constructors

Constructor	Description
PresentationMLPackage()	Constructor.
PresentationMLPackage(ContentTypeManager contentTypeManager)	Constructor.

Method Summary

Modifier and Type	Method	Description
static NotesSlidePart	createNotesSlidePart(Part sourcePart, PartName partName)	Deprecated.
static PresentationMLPackage	createPackage()	Create an empty presentation.
static PresentationMLPackage	createPackage(SlideSizesWellKnown sz, boolean landscape)	Create an empty presentation.
static SlidePart	createSlidePart(MainPresentationPart pp, SlideLayoutPart layoutPart, PartName partName)	Deprecated.
MainPresentationPart	getMainPresentationPart()
Map<String,ShapeWrapper>	getPlaceHoldersFromAcrossLayouts()
ProtectPresentation	getProtectionSettings()
StyleTree	getStyleTree()
static PresentationMLPackage	load(File pptxFile)	Convenience method to create a PresentationMLPackage from an existing File (.pptx or .xml Flat OPC).
static PresentationMLPackage	load(InputStream pptxInputStream)	Creates a PresentationMLPackage from an InputStream.
PresentationMLPackage	partialClone(int[] slideNumbers)	Create a PresentationMLPackage containing the specified slides only.
void	reset()	Reinit fields so this pkg object can be re-used.
boolean	setPartShortcut(Part part, String relationshipType)	Tell the source Part about this target Part, so the source can use this part via a convenience method.

Methods inherited from class org.docx4j.openpackaging.packages.OpcPackage

addDocPropsCorePart, addDocPropsCustomPart, addDocPropsExtendedPart, clone, cloneAs, getContentTypeManager, getCustomXmlDataStorageParts, getDocPropsCorePart, getDocPropsCustomPart, getDocPropsExtendedPart, getDrawingPropsIdTracker, getExternalResources, getPackage, getParts, getSourcePartStore, getTargetPartStore, getTitle, isNew, load, load, load, load, load, load, load, load, load, load, name, save, save, save, save, save, save, setContentTypeManager, setName, setNew, setSourcePartStore, setTargetPartStore, setTitle

Methods inherited from class org.docx4j.openpackaging.Base

addTargetPart, addTargetPart, addTargetPart, addTargetPart, getContentType, getPartName, getRelationshipsPart, getRelationshipsPart, getUserData, setContentType, setPartName, setRelationships, setUserData

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

log

protected static org.slf4j.Logger log

presentationProtectionSettings

private ProtectPresentation presentationProtectionSettings

mainPresentationPart

private MainPresentationPart mainPresentationPart

SAMPLE_SHAPE

private static String SAMPLE_SHAPE

globalPlaceHolders

Map<String,ShapeWrapper> globalPlaceHolders

styleTree

private StyleTree styleTree

Constructor Details

PresentationMLPackage

public PresentationMLPackage()

Constructor. Also creates a new content type manager

PresentationMLPackage

public PresentationMLPackage(ContentTypeManager contentTypeManager)

Constructor.

Parameters:

contentTypeManager - The content type manager to use

Method Details

getProtectionSettings

public ProtectPresentation getProtectionSettings()

load

public static PresentationMLPackage load(File pptxFile)
                                  throws Docx4JException

Convenience method to create a PresentationMLPackage from an existing File (.pptx or .xml Flat OPC).

Parameters:

pptxFile - The pptx file

Throws:

Docx4JException

load

public static PresentationMLPackage load(InputStream pptxInputStream)
                                  throws Docx4JException

Creates a PresentationMLPackage from an InputStream.

Parameters:

pptxInputStream - an InputStream of a .pptx file

Returns:

a PresentationMLPackage representing the .pptx file

Throws:

Docx4JException - if an exception is encountered in processing

setPartShortcut

public boolean setPartShortcut(Part part,
 String relationshipType)

Description copied from class: Base

Tell the source Part about this target Part, so the source can use this part via a convenience method.

Overrides:

setPartShortcut in class OpcPackage

Returns:

true if the source Part does use the target Part in a convenience method.

getMainPresentationPart

public MainPresentationPart getMainPresentationPart()

createPackage

public static PresentationMLPackage createPackage()
                                           throws InvalidFormatException

Create an empty presentation.

Returns:

Throws:

InvalidFormatException

createPackage

public static PresentationMLPackage createPackage(SlideSizesWellKnown sz,
 boolean landscape)
                                           throws InvalidFormatException

Create an empty presentation.

Returns:

Throws:

InvalidFormatException

Since:

2.7

createSlidePart

@Deprecated
public static SlidePart createSlidePart(MainPresentationPart pp,
 SlideLayoutPart layoutPart,
 PartName partName)
                                 throws InvalidFormatException,
jakarta.xml.bind.JAXBException

Deprecated.

Create a slide and add it to the package. Deprecated, so use MainPresentationPart's addSlide method instead.

Parameters:

pp -

layoutPart -

partName -

Returns:

the slide

Throws:

InvalidFormatException

jakarta.xml.bind.JAXBException

createNotesSlidePart

@Deprecated
public static NotesSlidePart createNotesSlidePart(Part sourcePart,
 PartName partName)
                                           throws Exception

Deprecated.

Create a notes slide and add it to slide relationships

Parameters:

sourcePart -

partName -

Returns:

the notes slide

Throws:

InvalidFormatException

jakarta.xml.bind.JAXBException

Exception

getPlaceHoldersFromAcrossLayouts

public Map<String,ShapeWrapper> getPlaceHoldersFromAcrossLayouts()

getStyleTree

public StyleTree getStyleTree()
                       throws InvalidFormatException

Throws:

InvalidFormatException

reset

public void reset()

Reinit fields so this pkg object can be re-used.

Overrides:

reset in class OpcPackage

Since:

3.3.7

partialClone

public PresentationMLPackage partialClone(int[] slideNumbers)

Create a PresentationMLPackage containing the specified slides only.

Returns:

Since:

8.1.6