Package org.apache.poi.sl.extractor

Class SlideShowExtractor<S extends Shape<S,​P>,​P extends TextParagraph<S,​P,​? extends TextRun>>

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable, POITextExtractor
    public class SlideShowExtractor<S extends Shape<S,​P>,​P extends TextParagraph<S,​P,​? extends TextRun>>
extends java.lang.Object
implements POITextExtractor
    Common SlideShow extractor
    Since:
    POI 4.0.0

    • Constructor Detail

      • SlideShowExtractor

        public SlideShowExtractor​(SlideShow<S,​P> slideshow)

    • Method Detail

      • setSlidesByDefault

        public void setSlidesByDefault​(boolean slidesByDefault)
        Should a call to getText() return slide text? Default is yes

      • setNotesByDefault

        public void setNotesByDefault​(boolean notesByDefault)
        Should a call to getText() return notes text? Default is no

      • setCommentsByDefault

        public void setCommentsByDefault​(boolean commentsByDefault)
        Should a call to getText() return comments text? Default is no

      • setMasterByDefault

        public void setMasterByDefault​(boolean masterByDefault)
        Should a call to getText() return text from master? Default is no

      • getMetadataTextExtractor

        public POITextExtractor getMetadataTextExtractor()
        Description copied from interface: POITextExtractor
        Returns another text extractor, which is able to output the textual content of the document metadata / properties, such as author and title.
        Specified by:
        getMetadataTextExtractor in interface POITextExtractor
        Returns:
        the metadata and text extractor

      • getText

        public java.lang.String getText()
        Fetches all the slide text from the slideshow, but not the notes, unless you've called setSlidesByDefault() and setNotesByDefault() to change this
        Specified by:
        getText in interface POITextExtractor
        Returns:
        All the text from the document

      • getText

        public java.lang.String getText​(Slide<S,​P> slide)

      • getOLEShapes

        public java.util.List<? extends ObjectShape<S,​P>> getOLEShapes()

      • getCodepoints

        @Deprecated
@Removal(version="6.0.0")
public java.util.BitSet getCodepoints​(java.lang.String typeface,
                                      java.lang.Boolean italic,
                                      java.lang.Boolean bold)
        Deprecated.
        use getCodepointsInSparseBitSet(String, Boolean, Boolean)
        Extract the used codepoints for font embedding / subsetting
        Parameters:
        typeface - the typeface/font family of the textruns to examine
        italic - use true for italic TextRuns, false for non-italic ones and null if it doesn't matter
        bold - use true for bold TextRuns, false for non-bold ones and null if it doesn't matter
        Returns:
        a bitset with the marked/used codepoints

      • getCodepointsInSparseBitSet

        @Internal
public com.zaxxer.sparsebits.SparseBitSet getCodepointsInSparseBitSet​(java.lang.String typeface,
                                                                      java.lang.Boolean italic,
                                                                      java.lang.Boolean bold)
        Extract the used codepoints for font embedding / subsetting. This method is not intended for public use.
        Parameters:
        typeface - the typeface/font family of the textruns to examine
        italic - use true for italic TextRuns, false for non-italic ones and null if it doesn't matter
        bold - use true for bold TextRuns, false for non-bold ones and null if it doesn't matter
        Returns:
        a bitset with the marked/used codepoints