Package org.apache.poi.hslf.usermodel
Class HSLFNotes
java.lang.Object
org.apache.poi.hslf.usermodel.HSLFSheet
org.apache.poi.hslf.usermodel.HSLFNotes
- All Implemented Interfaces:
Iterable<HSLFShape>
,HSLFShapeContainer
,Notes<HSLFShape,
,HSLFTextParagraph> ShapeContainer<HSLFShape,
,HSLFTextParagraph> Sheet<HSLFShape,
HSLFTextParagraph>
This class represents a slide's notes in a PowerPoint Document. It
allows access to the text within, and the layout. For now, it only
does the text side of things though
- Author:
- Nick Burch
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionHeader / Footer settings for this slide.Returnnull
- Notes Masters are not yet supportedgetPlaceholderDetails
(Placeholder placeholder) Get the placeholder details for the given placeholder type.Returns an array of all the TextParagraphs foundMethods inherited from class org.apache.poi.hslf.usermodel.HSLFSheet
_getSheetNumber, _getSheetRefId, addShape, allocateShapeId, createAutoShape, createConnector, createFreeform, createGroup, createOleShape, createPicture, createTable, createTextBox, draw, getBackground, getColorScheme, getFollowMasterGraphics, getPlaceholder, getPlaceholderByTextType, getPPDrawing, getProgrammableTag, getShapes, getSheetContainer, getSlideShow, iterator, onAddTextShape, onCreate, removeShape, setSlideShow
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface java.lang.Iterable
forEach, iterator, spliterator
Methods inherited from interface org.apache.poi.sl.usermodel.ShapeContainer
addShape, createTable, getShapes, removeShape
Methods inherited from interface org.apache.poi.sl.usermodel.Sheet
draw, getBackground, getFollowMasterGraphics, getSlideShow
-
Field Details
-
logger
-
-
Constructor Details
-
HSLFNotes
Constructs a Notes Sheet from the given Notes record. Initialises TextRuns, to provide easier access to the text- Parameters:
notes
- the Notes record to read from
-
-
Method Details
-
getTextParagraphs
Returns an array of all the TextParagraphs found- Specified by:
getTextParagraphs
in interfaceNotes<HSLFShape,
HSLFTextParagraph> - Specified by:
getTextParagraphs
in classHSLFSheet
-
getMasterSheet
Returnnull
- Notes Masters are not yet supported- Specified by:
getMasterSheet
in interfaceSheet<HSLFShape,
HSLFTextParagraph> - Specified by:
getMasterSheet
in classHSLFSheet
-
getPlaceholderDetails
Description copied from interface:Sheet
Get the placeholder details for the given placeholder type. Not all placeholders are also shapes - this is especially true for old HSLF slideshows, which notes have header/footers elements which aren't shapes.- Specified by:
getPlaceholderDetails
in interfaceSheet<HSLFShape,
HSLFTextParagraph> - Overrides:
getPlaceholderDetails
in classHSLFSheet
- Parameters:
placeholder
- the placeholder type- Returns:
- the placeholder details or
null
, if the placeholder isn't contained in the sheet
-