Package org.docx4j.openpackaging.parts.PresentationML

Class MainPresentationPart

java.lang.Object

org.docx4j.openpackaging.Base

org.docx4j.openpackaging.parts.Part

org.docx4j.openpackaging.parts.JaxbXmlPart<E>

org.docx4j.openpackaging.parts.JaxbXmlPartXPathAware<E>

org.docx4j.openpackaging.parts.PresentationML.JaxbPmlPart<Presentation>

org.docx4j.openpackaging.parts.PresentationML.MainPresentationPart

All Implemented Interfaces:

XPathEnabled<Presentation>

public final class MainPresentationPart
extends JaxbPmlPart<Presentation>

Field Summary

Fields

Modifier and Type	Field	Description
protected static org.slf4j.Logger	log

Fields inherited from class org.docx4j.openpackaging.parts.PresentationML.JaxbPmlPart

COLOR_MAPPING, COMMON_SLIDE_DATA, random

Fields inherited from class org.docx4j.openpackaging.parts.JaxbXmlPartXPathAware

binder

Fields inherited from class org.docx4j.openpackaging.parts.JaxbXmlPart

jaxbElement, jc, MAX_BYTES_Unmarshal_Error

Fields inherited from class org.docx4j.openpackaging.parts.Part

pack

Fields inherited from class org.docx4j.openpackaging.Base

contentType, partName, relationships

Constructor Summary

Constructors

Constructor	Description
MainPresentationPart()
MainPresentationPart(PartName partName)

Method Summary

Modifier and Type	Method	Description
void	addSlide(int index, SlidePart slidePart)	Inserts the slide at the specified position in the presentation.
boolean	addSlide(SlidePart slidePart)	Append the slide at the end of the presentation.
Presentation.SldIdLst.SldId	addSlideIdListEntry(SlidePart slidePart)	Add a slide to this presentation.
Presentation.SldIdLst.SldId	addSlideIdListEntry(SlidePart slidePart, RelationshipsPart.AddPartBehaviour mode)	Deprecated.
Presentation.SldMasterIdLst.SldMasterId	addSlideMasterIdListEntry(SlideMasterPart slideMasterPart)
static Presentation	createJaxbPresentationElement()
static Presentation	createJaxbPresentationElement(SlideSizesWellKnown sz, boolean landscape)
static Presentation.SldSz	createSlideSize(SlideSizesWellKnown sz, boolean landscape)
CommentAuthorsPart	getCommentAuthorsPart()
CTExtension	getExtContaining(Class containingClass)	get p:ext containing specified class
CTExtendedGuideList	getExtendedGuideList(boolean createIfAbsent)
CTExtensionList	getExtensionList(boolean createIfAbsent)
NotesMasterPart	getNotesMasterPart(boolean createIfAbsent)	getNotesMasterPart creating if createIfAbsent flag allows
CTSection	getSection(SlidePart sp)
CTSectionList	getSectionList(boolean createIfAbsent)
Presentation.SldIdLst.SldId	getSldIdByRelId(String relId)	Get a SdlId from SldIdLst by its relId
SlidePart	getSlide(int index)
int	getSlideCount()
List<SlidePart>	getSlideParts()
ThemePart	getThemePart()
void	init()
boolean	removeExt(Class containingClass)	remove the p:ext containing specified class
void	removeSlide(int index)
void	removeSlide(Relationship rel)
boolean	setPartShortcut(Part part)
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.parts.PresentationML.JaxbPmlPart

getSlideId, getSlideLayoutOrMasterId, newPartForContentType

Methods inherited from class org.docx4j.openpackaging.parts.JaxbXmlPartXPathAware

createBinderAndJaxbElement, getBinder, getJAXBAssociationsForXPath, getJAXBAssociationsForXPath, getJAXBNodesViaXPath, getJAXBNodesViaXPath, setJaxbElement, unmarshal, unmarshal

Methods inherited from class org.docx4j.openpackaging.parts.JaxbXmlPart

addMcChoiceNamespace, getConfiguredUnmarshaller, getContents, getJAXBContext, getJaxbElement, getMcChoiceNamespaces, getMceIgnorable, getXML, inputStreamToXSR, isContentEqual, isUnmarshalled, marshal, marshal, marshal, marshal, pipe, pipe, pipe, preprocess, setContents, setJAXBContext, setJaxbElement, setMceIgnorable, transform, transformToDom, variableReplace

Methods inherited from class org.docx4j.openpackaging.parts.Part

getContentLengthAsLoaded, getOwningRelationshipPart, getPackage, getRelationshipType, getSourceRelationship, getSourceRelationships, getVersion, remove, rename, setContentLengthAsLoaded, setOwningRelationshipPart, setPackage, setRelationshipType, setSourceRelationship, setVersion

Methods inherited from class org.docx4j.openpackaging.Base

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

Methods inherited from class java.lang.Object

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

Field Details

log

protected static org.slf4j.Logger log

Constructor Details

MainPresentationPart

public MainPresentationPart(PartName partName)
                     throws InvalidFormatException

Throws:

InvalidFormatException

MainPresentationPart

public MainPresentationPart()
                     throws InvalidFormatException

Throws:

InvalidFormatException

Method Details

init

public void init()

setPartShortcut

public boolean setPartShortcut(Part part)

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 Part

Returns:

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

getCommentAuthorsPart

public CommentAuthorsPart getCommentAuthorsPart()

Since:

3.2.0

getThemePart

public ThemePart getThemePart()

Since:

8.1.3

getNotesMasterPart

public NotesMasterPart getNotesMasterPart(boolean createIfAbsent)
                                   throws Pptx4jException

getNotesMasterPart creating if createIfAbsent flag allows

Throws:

Pptx4jException

Since:

8.1.3

createSlideSize

public static Presentation.SldSz createSlideSize(SlideSizesWellKnown sz,
 boolean landscape)

Since:

2.7

createJaxbPresentationElement

public static Presentation createJaxbPresentationElement()
                                                  throws jakarta.xml.bind.JAXBException

Throws:

jakarta.xml.bind.JAXBException

createJaxbPresentationElement

public static Presentation createJaxbPresentationElement(SlideSizesWellKnown sz,
 boolean landscape)
                                                  throws jakarta.xml.bind.JAXBException

Throws:

jakarta.xml.bind.JAXBException

Since:

2.7

addSlideIdListEntry

public Presentation.SldIdLst.SldId addSlideIdListEntry(SlidePart slidePart)
                                                throws InvalidFormatException

Add a slide to this presentation.

Parameters:

slidePart -

Returns:

Throws:

InvalidFormatException

addSlideIdListEntry

@Deprecated
public Presentation.SldIdLst.SldId addSlideIdListEntry(SlidePart slidePart,
 RelationshipsPart.AddPartBehaviour mode)
                                                throws InvalidFormatException

Deprecated.

Throws:

InvalidFormatException

Since:

2.8.1

addSlideMasterIdListEntry

public Presentation.SldMasterIdLst.SldMasterId addSlideMasterIdListEntry(SlideMasterPart slideMasterPart)
                                                                  throws InvalidFormatException

Throws:

InvalidFormatException

addSlide

public boolean addSlide(SlidePart slidePart)
                 throws Pptx4jException

Append the slide at the end of the presentation.

Parameters:

slidePart -

Throws:

Pptx4jException

Since:

3.0

addSlide

public void addSlide(int index,
 SlidePart slidePart)
              throws Pptx4jException

Inserts the slide at the specified position in the presentation. Shifts the element currently at that position (if any) and any subsequent elements to the right (adds one to their indices).

Parameters:

index -

slidePart -

Throws:

Pptx4jException

Since:

3.0

removeSlide

public void removeSlide(int index)
                 throws Pptx4jException

Parameters:

index -

Throws:

Pptx4jException

Since:

3.0

removeSlide

public void removeSlide(Relationship rel)
                 throws Pptx4jException

Parameters:

rel -

Throws:

Pptx4jException

Since:

3.0

getSlide

public SlidePart getSlide(int index)
                   throws Pptx4jException

Parameters:

index -

Throws:

Pptx4jException

Since:

3.0.1

getSlideParts

public List<SlidePart> getSlideParts()
                              throws Pptx4jException

Throws:

Pptx4jException

Since:

3.4

getSlideCount

public int getSlideCount()
                  throws Pptx4jException

Parameters:

index -

Throws:

Pptx4jException

Since:

3.2.0

getExtContaining

public CTExtension getExtContaining(Class containingClass)

get p:ext containing specified class

Parameters:

extLst -

containingClass -

Returns:

Since:

8.1.0

removeExt

public boolean removeExt(Class containingClass)

remove the p:ext containing specified class

Parameters:

containingClass -

Returns:

Since:

8.1.0

getSectionList

public CTSectionList getSectionList(boolean createIfAbsent)

Since:

8.1.0

getExtendedGuideList

public CTExtendedGuideList getExtendedGuideList(boolean createIfAbsent)

Since:

8.1.0

getExtensionList

public CTExtensionList getExtensionList(boolean createIfAbsent)

Since:

8.1.0

getSection

public CTSection getSection(SlidePart sp)

Since:

8.1.0

getSldIdByRelId

public Presentation.SldIdLst.SldId getSldIdByRelId(String relId)

Get a SdlId from SldIdLst by its relId

Parameters:

relId -

Returns:

Since:

8.1.0