TestXSLFSlideShow.java
/* ====================================================================
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
==================================================================== */
package org.apache.poi.xslf.usermodel;
import java.awt.Dimension;
import java.awt.Rectangle;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.util.List;
import java.util.regex.Pattern;
import org.apache.poi.ooxml.POIXMLDocumentPart;
import org.apache.poi.openxml4j.opc.PackagePart;
import org.apache.poi.sl.usermodel.PictureData;
import org.apache.poi.sl.usermodel.Placeholder;
import org.apache.poi.xslf.XSLFTestDataSamples;
import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertSame;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertThrows;
class TestXSLFSlideShow {
@Test
void testCreateSlide() throws IOException {
try (XMLSlideShow ppt = new XMLSlideShow()) {
assertEquals(0, ppt.getSlides().size());
XSLFSlide slide1 = ppt.createSlide();
assertEquals(1, ppt.getSlides().size());
assertSame(slide1, ppt.getSlides().get(0));
List<POIXMLDocumentPart> rels = slide1.getRelations();
assertEquals(1, rels.size());
assertEquals(slide1.getSlideMaster().getLayout(SlideLayout.BLANK), rels.get(0));
XSLFSlide slide2 = ppt.createSlide();
assertEquals(2, ppt.getSlides().size());
assertSame(slide2, ppt.getSlides().get(1));
ppt.setSlideOrder(slide2, 0);
assertSame(slide2, ppt.getSlides().get(0));
assertSame(slide1, ppt.getSlides().get(1));
try (XMLSlideShow ppt2 = XSLFTestDataSamples.writeOutAndReadBack(ppt)) {
assertEquals(2, ppt2.getSlides().size());
rels = ppt2.getSlides().get(0).getRelations();
assertNotNull(rels);
}
}
}
@Test
void testRemoveSlide() throws IOException {
try (XMLSlideShow ppt = new XMLSlideShow()) {
assertEquals(0, ppt.getSlides().size());
XSLFSlide slide1 = ppt.createSlide();
XSLFSlide slide2 = ppt.createSlide();
assertEquals(2, ppt.getSlides().size());
assertSame(slide1, ppt.getSlides().get(0));
assertSame(slide2, ppt.getSlides().get(1));
XSLFSlide removedSlide = ppt.removeSlide(0);
assertSame(slide1, removedSlide);
assertEquals(1, ppt.getSlides().size());
assertSame(slide2, ppt.getSlides().get(0));
try (XMLSlideShow ppt2 = XSLFTestDataSamples.writeOutAndReadBack(ppt)) {
assertEquals(1, ppt2.getSlides().size());
// Check that the slide is actually removed from the package.
String slidePartRegEx = "/ppt/slides/slide[0-9]+\\.xml";
List<PackagePart> slideParts = ppt2.getPackage().getPartsByName(Pattern.compile(slidePartRegEx));
assertEquals(1, slideParts.size());
}
}
}
/**
* This test ensures that if a slide (with notes) is removed, that it
* is ACTUALLY removed (including the notes), and not left orphaned
* when the PPTX is later written.
*
* @throws IOException If there is an I/O issue during the test.
*/
@Test
void testRemoveSlideThatHasNotes() throws IOException {
try (XMLSlideShow ppt = new XMLSlideShow()) {
assertEquals(0, ppt.getSlides().size());
XSLFSlide slide1 = ppt.createSlide();
XSLFSlide slide2 = ppt.createSlide();
XSLFNotes note = ppt.getNotesSlide(slide1);
for (XSLFTextShape shape : note.getPlaceholders()) {
if (shape.getTextType() == Placeholder.BODY) {
shape.setText("Some notes");
break;
}
}
assertEquals(2, ppt.getSlides().size());
assertSame(slide1, ppt.getSlides().get(0));
assertSame(slide2, ppt.getSlides().get(1));
XSLFSlide removedSlide = ppt.removeSlide(0);
assertSame(slide1, removedSlide);
assertEquals(1, ppt.getSlides().size());
assertSame(slide2, ppt.getSlides().get(0));
try (XMLSlideShow ppt2 = XSLFTestDataSamples.writeOutAndReadBack(ppt)) {
assertEquals(1, ppt2.getSlides().size());
// Check that the slide is actually removed from the package.
String slidePartRegEx = "/ppt/slides/slide[0-9]+\\.xml";
List<PackagePart> slideParts = ppt2.getPackage().getPartsByName(Pattern.compile(slidePartRegEx));
assertEquals(1, slideParts.size());
// Check that there is no note slide part.
String notePartRegEx = "/ppt/notesSlides/notesSlide[0-9]+\\.xml";
List<PackagePart> noteParts = ppt2.getPackage().getPartsByName(Pattern.compile(notePartRegEx));
assertEquals(0, noteParts.size());
}
}
}
/**
* This test ensures that if a slide (with notes and images) is removed, that it
* is ACTUALLY removed (including the notes and images), and not left orphaned
* when the PPTX is later written.
*
* @throws IOException If there is an I/O issue during the test.
*/
@Test
void testRemoveSlideThatHasNotesAndImages() throws IOException {
try (XMLSlideShow ppt = new XMLSlideShow()) {
assertEquals(0, ppt.getSlides().size());
XSLFSlide slide1 = ppt.createSlide();
XSLFSlide slide2 = ppt.createSlide();
// NOTE: This image is INVALID but this doesnt matter for THIS test.
XSLFPictureData pictData = ppt.addPicture(
new ByteArrayInputStream(new byte[] { 00, 01, 02 }), PictureData.PictureType.PNG);
XSLFPictureShape picShape = slide1.createPicture(pictData);
picShape.setAnchor(new Rectangle(10, 10, 200, 100));
XSLFNotes note = ppt.getNotesSlide(slide1);
for (XSLFTextShape shape : note.getPlaceholders()) {
if (shape.getTextType() == Placeholder.BODY) {
shape.setText("Some notes");
break;
}
}
assertEquals(2, ppt.getSlides().size());
assertSame(slide1, ppt.getSlides().get(0));
assertSame(slide2, ppt.getSlides().get(1));
XSLFSlide removedSlide = ppt.removeSlide(0);
assertSame(slide1, removedSlide);
assertEquals(1, ppt.getSlides().size());
assertSame(slide2, ppt.getSlides().get(0));
try (XMLSlideShow ppt2 = XSLFTestDataSamples.writeOutAndReadBack(ppt)) {
assertEquals(1, ppt2.getSlides().size());
// Check that the slide is actually removed from the package.
String slidePartRegEx = "/ppt/slides/slide[0-9]+\\.xml";
List<PackagePart> slideParts = ppt2.getPackage().getPartsByName(Pattern.compile(slidePartRegEx));
assertEquals(1, slideParts.size());
// Check that there is no note slide part.
String notePartRegEx = "/ppt/notesSlides/notesSlide[0-9]+\\.xml";
List<PackagePart> noteParts = ppt2.getPackage().getPartsByName(Pattern.compile(notePartRegEx));
assertEquals(0, noteParts.size());
// Check that there is no image slide part.
String imagePartRegEx = "/ppt/media/image[0-9]+\\.png";
List<PackagePart> imageParts = ppt2.getPackage().getPartsByName(Pattern.compile(imagePartRegEx));
assertEquals(0, imageParts.size());
}
}
}
/**
* This test ensures that if a slide (with notes and images [inside a group])
* is removed, that it is ACTUALLY removed (including the notes and images),
* and not left orphaned when the PPTX is later written.
*
* @throws IOException If there is an I/O issue during the test.
*/
@Test
void testRemoveSlideThatHasNotesAndImagesInsideAGroup() throws IOException {
try (XMLSlideShow ppt = new XMLSlideShow()) {
assertEquals(0, ppt.getSlides().size());
XSLFSlide slide1 = ppt.createSlide();
XSLFSlide slide2 = ppt.createSlide();
XSLFGroupShape group = slide1.createGroup();
// NOTE: This image is INVALID but this doesnt matter for THIS test.
XSLFPictureData pictData = ppt.addPicture(
new ByteArrayInputStream(new byte[] { 00, 01, 02 }), PictureData.PictureType.PNG);
XSLFPictureShape picShape = group.createPicture(pictData);
picShape.setAnchor(new Rectangle(10, 10, 200, 100));
XSLFNotes note = ppt.getNotesSlide(slide1);
for (XSLFTextShape shape : note.getPlaceholders()) {
if (shape.getTextType() == Placeholder.BODY) {
shape.setText("Some notes");
break;
}
}
assertEquals(2, ppt.getSlides().size());
assertSame(slide1, ppt.getSlides().get(0));
assertSame(slide2, ppt.getSlides().get(1));
XSLFSlide removedSlide = ppt.removeSlide(0);
assertSame(slide1, removedSlide);
assertEquals(1, ppt.getSlides().size());
assertSame(slide2, ppt.getSlides().get(0));
try (XMLSlideShow ppt2 = XSLFTestDataSamples.writeOutAndReadBack(ppt)) {
assertEquals(1, ppt2.getSlides().size());
// Check that the slide is actually removed from the package.
String slidePartRegEx = "/ppt/slides/slide[0-9]+\\.xml";
List<PackagePart> slideParts = ppt2.getPackage().getPartsByName(Pattern.compile(slidePartRegEx));
assertEquals(1, slideParts.size());
// Check that there is no note slide part.
String notePartRegEx = "/ppt/notesSlides/notesSlide[0-9]+\\.xml";
List<PackagePart> noteParts = ppt2.getPackage().getPartsByName(Pattern.compile(notePartRegEx));
assertEquals(0, noteParts.size());
// Check that there is no image slide part.
String imagePartRegEx = "/ppt/media/image[0-9]+\\.png";
List<PackagePart> imageParts = ppt2.getPackage().getPartsByName(Pattern.compile(imagePartRegEx));
imageParts.forEach(System.out::println);
assertEquals(0, imageParts.size());
}
}
}
@Test
void testDimension() throws IOException {
try (XMLSlideShow ppt = new XMLSlideShow()) {
Dimension sz = ppt.getPageSize();
assertEquals(720, sz.width);
assertEquals(540, sz.height);
ppt.setPageSize(new Dimension(792, 612));
sz = ppt.getPageSize();
assertEquals(792, sz.width);
assertEquals(612, sz.height);
}
}
@Test
void testSlideMasters() throws IOException {
try (XMLSlideShow ppt = new XMLSlideShow()) {
List<XSLFSlideMaster> masters = ppt.getSlideMasters();
assertEquals(1, masters.size());
XSLFSlide slide = ppt.createSlide();
assertSame(masters.get(0), slide.getSlideMaster());
}
}
@Test
void testSlideLayout() throws IOException {
try (XMLSlideShow ppt = new XMLSlideShow()) {
List<XSLFSlideMaster> masters = ppt.getSlideMasters();
assertEquals(1, masters.size());
XSLFSlide slide = ppt.createSlide();
XSLFSlideLayout layout = slide.getSlideLayout();
assertNotNull(layout);
assertSame(masters.get(0), layout.getSlideMaster());
}
}
@Test
void testSlideLayoutNames() throws IOException {
final String[] names = {
"Blank", "Title Only", "Section Header", "Picture with Caption", "Title and Content",
"Title Slide", "Title and Vertical Text", "Vertical Title and Text", "Comparison",
"Two Content", "Content with Caption"
};
try (XMLSlideShow ppt = XSLFTestDataSamples.openSampleDocument("layouts.pptx")) {
for (String name : names) {
assertNotNull(ppt.findLayout(name));
}
final SlideLayout[] layTypes = {
SlideLayout.BLANK, SlideLayout.TITLE_ONLY, SlideLayout.SECTION_HEADER,
SlideLayout.PIC_TX, SlideLayout.TITLE_AND_CONTENT, SlideLayout.TITLE,
SlideLayout.VERT_TX, SlideLayout.VERT_TITLE_AND_TX, SlideLayout.TWO_TX_TWO_OBJ,
SlideLayout.TWO_OBJ, SlideLayout.OBJ_TX
};
for (SlideLayout sl : layTypes){
assertNotNull(ppt.getSlideMasters().get(0).getLayout(sl));
}
}
}
/**
* Test getting the first slide number, which defaults to 1.
* The first slide number is stored in the presentation.xml part.
*/
@Test
void testGetFirstSlideNumberDefault() throws IOException {
try (XMLSlideShow ppt = new XMLSlideShow()) {
// Default value when attribute is not present should be 1 (as per OOXML standard and CTPresentation logic)
assertEquals(1, ppt.getFirstSlideNumber());
}
}
/**
* Test setting, getting, and persisting the custom first slide number.
*/
@Test
void testSetAndPersistFirstSlideNumber() throws IOException {
final int customStartNum = 5;
final int zeroStartNum = 0;
final int maxStartNum = 9999;
try (XMLSlideShow ppt = new XMLSlideShow()) {
// 1. Set to a custom positive number (e.g., 5)
ppt.setFirstSlideNumber(customStartNum);
assertEquals(customStartNum, ppt.getFirstSlideNumber());
// Check persistence by writing out and reading back
try (XMLSlideShow ppt2 = XSLFTestDataSamples.writeOutAndReadBack(ppt)) {
assertEquals(customStartNum, ppt2.getFirstSlideNumber(),
"The custom first slide number should persist after save/load.");
}
// 2. Set to minimum valid number (0)
ppt.setFirstSlideNumber(zeroStartNum);
assertEquals(zeroStartNum, ppt.getFirstSlideNumber());
// 3. Set to maximum valid number (9999)
ppt.setFirstSlideNumber(maxStartNum);
assertEquals(maxStartNum, ppt.getFirstSlideNumber());
}
}
/**
* Test unsetting the first slide number, which should revert it to the default (1).
*/
@Test
void testUnsetFirstSlideNumber() throws IOException {
try (XMLSlideShow ppt = new XMLSlideShow()) {
// 1. Set a custom number
ppt.setFirstSlideNumber(50);
assertEquals(50, ppt.getFirstSlideNumber());
// 2. Unset it
ppt.unsetFirstSlideNumber();
// It should return the default value (1) after unsetting
assertEquals(1, ppt.getFirstSlideNumber(),
"Unsetting the first slide number should revert it to the default of 1.");
// Check persistence after unsetting
try (XMLSlideShow ppt2 = XSLFTestDataSamples.writeOutAndReadBack(ppt)) {
assertEquals(1, ppt2.getFirstSlideNumber(),
"The first slide number should remain the default (1) after unset and save/load.");
// Ensure the attribute is actually removed from the CTPresentation object
// Note: We access the internal object to confirm removal, which is acceptable in test code.
assertFalse(ppt2.getCTPresentation().isSetFirstSlideNum(),
"The 'firstSlideNum' attribute should be unset (removed) in the XML.");
}
}
}
/**
* Test that setting an invalid first slide number (outside [0, 9999]) throws an exception.
*/
@Test
void testSetFirstSlideNumberValidation() throws IOException {
try (XMLSlideShow ppt = new XMLSlideShow()) {
// Test case: Negative number
assertThrows(IllegalArgumentException.class, () ->
ppt.setFirstSlideNumber(-1),
"Negative number should throw IllegalArgumentException.");
// Test case: Number greater than 9999
assertThrows(IllegalArgumentException.class, () ->
ppt.setFirstSlideNumber(10000),
"Number greater than 9999 should throw IllegalArgumentException.");
// Ensure the value hasn't changed from the default after failed attempts
assertEquals(1, ppt.getFirstSlideNumber());
}
}
}