Package org.apache.poi.sl.extractor

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

java.lang.Object
org.apache.poi.sl.extractor.SlideShowExtractor<S,P>
All Implemented Interfaces:
Closeable, AutoCloseable, POITextExtractor
Direct Known Subclasses:
XSLFExtractor
public class SlideShowExtractor<S extends Shape<S,P>,P extends TextParagraph<S,P,? extends TextRun>> extends Object implements POITextExtractor
Common SlideShow extractor
Since:
4.0.0

  • Field Details

  • Constructor Details

    • SlideShowExtractor

      public SlideShowExtractor(SlideShow<S,P> slideshow)

  • Method Details

    • getDocument

      public SlideShow<S,P> getDocument()
      Returns opened document
      Specified by:
      getDocument in interface POITextExtractor
      Returns:
      the opened document

    • 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 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 String getText(Slide<S,P> slide)

    • getOLEShapes

      public List<? extends ObjectShape<S,P>> getOLEShapes()

    • getCodepointsInSparseBitSet

      @Internal public com.zaxxer.sparsebits.SparseBitSet getCodepointsInSparseBitSet(String typeface, Boolean italic, 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

    • setCloseFilesystem

      public void setCloseFilesystem(boolean doCloseFilesystem)
      Specified by:
      setCloseFilesystem in interface POITextExtractor
      Parameters:
      doCloseFilesystem - true (default), if underlying resources/filesystem should be closed on POITextExtractor.close()

    • isCloseFilesystem

      public boolean isCloseFilesystem()
      Specified by:
      isCloseFilesystem in interface POITextExtractor
      Returns:
      true, if resources/filesystem should be closed on POITextExtractor.close()

    • getFilesystem

      public SlideShow<S,P> getFilesystem()
      Specified by:
      getFilesystem in interface POITextExtractor
      Returns:
      The underlying resources/filesystem