org.apache.poi.sl.usermodel.SlideShow Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of apache-poi Show documentation
The Apache Commons Codec package contains simple encoder and decoders for various formats such as Base64 and Hexadecimal. In addition to these widely used encoders and decoders, the codec package also maintains a collection of phonetic encoding utilities.
There is a newer version: 62
Show newest version
/* ====================================================================
   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.sl.usermodel;

import java.awt.Dimension;
import java.io.Closeable;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.List;

import org.apache.poi.common.usermodel.fonts.FontInfo;
import org.apache.poi.extractor.POITextExtractor;
import org.apache.poi.sl.usermodel.PictureData.PictureType;

@SuppressWarnings("java:S1452")
public interface SlideShow<
    S extends Shape,
    P extends TextParagraph
> extends Closeable {
    Slide createSlide() throws IOException;

    List> getSlides();

    MasterSheet createMasterSheet() throws IOException;

    /**
     * Returns all slide masters.
     * This doesn't include notes master and other arbitrary masters.
     */
    List> getSlideMasters();

    /**
     * Returns the current page size
     *
     * @return the page size
     */
    Dimension getPageSize();

    /**
     * Change the current page size
     *
     * @param pgsize page size (in points)
     */
    void setPageSize(Dimension pgsize);

    /**
     * Returns all Pictures of this slideshow.
     * The returned {@link List} is unmodifiable.
     * @return a {@link List} of {@link PictureData}.
     */
    List getPictureData();

    /**
     * Adds a picture to the presentation.
     *
     * @param pictureData       The bytes of the picture
     * @param format            The format of the picture.
     *
     * @return the picture data reference.
     */
    PictureData addPicture(byte[] pictureData, PictureType format) throws IOException;

    /**
     * Adds a picture to the presentation.
     *
     * @param is            The stream to read the image from
     * @param format        The format of the picture.
     *
     * @return the picture data reference.
     * @since 3.15 beta 1
     */
    PictureData addPicture(InputStream is, PictureType format) throws IOException;

    /**
     * Adds a picture to the presentation.
     *
     * @param pict              The file containing the image to add
     * @param format            The format of the picture.
     *
     * @return the picture data reference
     * @since 3.15 beta 1
     */
    PictureData addPicture(File pict, PictureType format) throws IOException;

    /**
     * check if a picture with this picture data already exists in this presentation
     *
     * @param pictureData The picture data to find in the SlideShow
     * @return {@code null} if picture data is not found in this slideshow
     * @since 3.15 beta 3
     */
    PictureData findPictureData(byte[] pictureData);

    /**
     * Writes out the slideshow file the is represented by an instance of this
     * class
     *
     * @param out
     *            The OutputStream to write to.
     * @throws IOException
     *             If there is an unexpected IOException from the passed in
     *             OutputStream
     */
    void write(OutputStream out) throws IOException;

    /**
     * @return an extractor for the slideshow metadata
     *
     * @since POI 4.0.0
     */
    POITextExtractor getMetadataTextExtractor();

    /**
     * @return the instance which handles the persisting of the slideshow,
     * which is either a subclass of {@link org.apache.poi.POIDocument}
     * or {@link org.apache.poi.ooxml.POIXMLDocument}
     *
     * @since POI 4.0.0
     */
    Object getPersistDocument();

    /**
     * Add an EOT font to the slideshow.
     * An EOT or MTX font is a transformed True-Type (.ttf) or Open-Type (.otf) font.
     * To transform a True-Type font use the sfntly library (see "see also" below)
     *
     * (Older?) Powerpoint versions handle embedded fonts by converting them to .ttf files
     * and put them into the Windows fonts directory. If the user is not allowed to install
     * fonts, the slideshow can't be opened. While the slideshow is opened, its possible
     * to copy the extracted .ttfs from the fonts directory. When the slideshow is closed,
     * they will be removed.
     *
     * @param fontData the EOT font as stream
     * @return the font info object containing the new font data
     * @throws IOException if the fontData can't be saved or if the fontData is no EOT font
     *
     * @see EOT specification
     * @see googles sfntly library
     * @see Example on how to subset and embed fonts
     */
    FontInfo addFont(InputStream fontData) throws IOException;

    /**
     * @return a list of registered fonts
     */
    List getFonts();
}