public final class HSLFSlide extends HSLFSheet implements Slide<HSLFShape,HSLFTextParagraph>
Constructor and Description |
---|
HSLFSlide(int sheetNumber,
int sheetRefId,
int slideNumber)
Create a new Slide instance
|
HSLFSlide(Slide slide,
HSLFNotes notes,
SlideListWithText.SlideAtomsSet atomSet,
int slideIdentifier,
int slideNumber)
Constructs a Slide from the Slide record, and the SlideAtomsSet
containing the text.
|
Modifier and Type | Method and Description |
---|---|
HSLFTextBox |
addTitle()
Create a
TextBox object that represents the slide's title. |
void |
draw(java.awt.Graphics2D graphics)
Convenience method to draw a sheet to a graphics context
|
HSLFBackground |
getBackground()
Background for this slide.
|
ColorSchemeAtom |
getColorScheme()
Color scheme for this slide.
|
java.util.List<HSLFComment> |
getComments()
Get the comment(s) for this slide.
|
boolean |
getDisplayPlaceholder(Placeholder placeholder)
In XSLF, slidenumber and date shapes aren't marked as placeholders
whereas in HSLF they are activated via a HeadersFooter configuration.
|
boolean |
getDisplayPlaceholder(SimpleShape<?,?> placeholderRef)
In XSLF, slidenumber and date shapes aren't marked as placeholders
whereas in HSLF they are activated via a HeadersFooter configuration.
|
boolean |
getFollowMasterBackground()
Whether this slide follows master sheet background
|
boolean |
getFollowMasterColourScheme() |
boolean |
getFollowMasterGraphics() |
boolean |
getFollowMasterObjects()
Whether this slide draws master sheet objects
|
boolean |
getFollowMasterScheme()
Whether this slide follows master color scheme
|
HeadersFooters |
getHeadersFooters()
Header / Footer settings for this slide.
|
HSLFMasterSheet |
getMasterSheet()
Returns master sheet associated with this slide.
|
HSLFNotes |
getNotes()
Returns the Notes Sheet for this slide, or null if there isn't one
|
StyleTextProp9Atom[] |
getNumberedListInfo()
This will return an atom per TextBox, so if the page has two text boxes the method should return two atoms.
|
SlideListWithText.SlideAtomsSet |
getSlideAtomsSet() |
HSLFMasterSheet |
getSlideLayout() |
java.lang.String |
getSlideName() |
int |
getSlideNumber()
Returns the (public facing) page number of this slide
|
Slide |
getSlideRecord()
Returns the underlying slide record
|
EscherTextboxWrapper[] |
getTextboxWrappers() |
java.util.List<java.util.List<HSLFTextParagraph>> |
getTextParagraphs()
Returns an array of all the TextRuns found
|
java.lang.String |
getTitle()
The title is a run of text of type
TextHeaderAtom.CENTER_TITLE_TYPE or
TextHeaderAtom.TITLE_TYPE |
boolean |
isHidden() |
protected void |
onAddTextShape(HSLFTextShape shape)
Subclasses should call this method and update the array of text runs
when a text shape is added
|
void |
onCreate()
Called by SlideShow ater a new slide is created.
|
void |
setFollowMasterBackground(boolean flag)
Sets whether this slide follows master background
|
void |
setFollowMasterColourScheme(boolean follow) |
void |
setFollowMasterObjects(boolean flag)
Sets whether this slide draws master sheet objects
|
void |
setFollowMasterScheme(boolean flag)
Sets whether this slide draws master color scheme
|
void |
setHidden(boolean hidden)
Sets the slide visibility
|
void |
setMasterSheet(HSLFMasterSheet master)
Change Master of this slide.
|
void |
setNotes(Notes<HSLFShape,HSLFTextParagraph> notes)
Sets the Notes that are associated with this.
|
void |
setSlideNumber(int newSlideNumber)
Changes the Slide's (external facing) page number.
|
_getSheetNumber, _getSheetRefId, addShape, allocateShapeId, createAutoShape, createConnector, createFreeform, createGroup, createOleShape, createPicture, createTable, createTextBox, getPlaceholder, getPlaceholderByTextType, getPlaceholderDetails, getPPDrawing, getProgrammableTag, getShapes, getSheetContainer, getSlideShow, iterator, removeShape, setSlideShow, spliterator
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getPlaceholderDetails, getSlideShow
addShape, createAutoShape, createConnector, createFreeform, createGroup, createOleShape, createPicture, createTable, createTextBox, getShapes, removeShape
public HSLFSlide(Slide slide, HSLFNotes notes, SlideListWithText.SlideAtomsSet atomSet, int slideIdentifier, int slideNumber)
slide
- the Slide record we're based onnotes
- the Notes sheet attached to usatomSet
- the SlideAtomsSet to get the text frompublic HSLFSlide(int sheetNumber, int sheetRefId, int slideNumber)
sheetNumber
- The internal number of the sheet, as used by PersistPtrHolderslideNumber
- The user facing number of the sheetpublic HSLFNotes getNotes()
getNotes
in interface Slide<HSLFShape,HSLFTextParagraph>
public void setNotes(Notes<HSLFShape,HSLFTextParagraph> notes)
setNotes
in interface Slide<HSLFShape,HSLFTextParagraph>
public void setSlideNumber(int newSlideNumber)
HSLFSlideShow.reorderSlide(int, int)
public void onCreate()
For Slide we need to do the following:
public HSLFTextBox addTitle()
TextBox
object that represents the slide's title.TextBox
object that represents the slide's title.public java.lang.String getTitle()
The title is a run of text of type TextHeaderAtom.CENTER_TITLE_TYPE
or
TextHeaderAtom.TITLE_TYPE
getTitle
in interface Slide<HSLFShape,HSLFTextParagraph>
TextHeaderAtom
public java.lang.String getSlideName()
getSlideName
in interface Slide<HSLFShape,HSLFTextParagraph>
public java.util.List<java.util.List<HSLFTextParagraph>> getTextParagraphs()
getTextParagraphs
in class HSLFSheet
public int getSlideNumber()
getSlideNumber
in interface Slide<HSLFShape,HSLFTextParagraph>
public Slide getSlideRecord()
public SlideListWithText.SlideAtomsSet getSlideAtomsSet()
SlideListWithtext
container
which hold text data for this slide (typically for placeholders).public HSLFMasterSheet getMasterSheet()
getMasterSheet
in interface Sheet<HSLFShape,HSLFTextParagraph>
getMasterSheet
in class HSLFSheet
public void setMasterSheet(HSLFMasterSheet master)
public void setFollowMasterBackground(boolean flag)
setFollowMasterBackground
in interface Slide<HSLFShape,HSLFTextParagraph>
flag
- true
if the slide follows master,
false
otherwisepublic boolean getFollowMasterBackground()
getFollowMasterBackground
in interface Slide<HSLFShape,HSLFTextParagraph>
true
if the slide follows master background,
false
otherwisepublic void setFollowMasterObjects(boolean flag)
setFollowMasterObjects
in interface Slide<HSLFShape,HSLFTextParagraph>
flag
- true
if the slide draws master sheet objects,
false
otherwisepublic boolean getFollowMasterScheme()
true
if the slide follows master color scheme,
false
otherwisepublic void setFollowMasterScheme(boolean flag)
flag
- true
if the slide draws master color scheme,
false
otherwisepublic boolean getFollowMasterObjects()
getFollowMasterObjects
in interface Slide<HSLFShape,HSLFTextParagraph>
true
if the slide draws master sheet objects,
false
otherwisepublic HSLFBackground getBackground()
getBackground
in interface Sheet<HSLFShape,HSLFTextParagraph>
getBackground
in class HSLFSheet
public ColorSchemeAtom getColorScheme()
getColorScheme
in class HSLFSheet
public java.util.List<HSLFComment> getComments()
getComments
in interface Slide<HSLFShape,HSLFTextParagraph>
public HeadersFooters getHeadersFooters()
getHeadersFooters
in class HSLFSheet
protected void onAddTextShape(HSLFTextShape shape)
HSLFSheet
onAddTextShape
in class HSLFSheet
public StyleTextProp9Atom[] getNumberedListInfo()
public EscherTextboxWrapper[] getTextboxWrappers()
public void setHidden(boolean hidden)
Slide
setHidden
in interface Slide<HSLFShape,HSLFTextParagraph>
hidden
- slide visibility, if true
the slide is hidden, false
shows the slidepublic boolean isHidden()
isHidden
in interface Slide<HSLFShape,HSLFTextParagraph>
true
- or shown when false
public void draw(java.awt.Graphics2D graphics)
Sheet
public boolean getFollowMasterColourScheme()
getFollowMasterColourScheme
in interface Slide<HSLFShape,HSLFTextParagraph>
public void setFollowMasterColourScheme(boolean follow)
setFollowMasterColourScheme
in interface Slide<HSLFShape,HSLFTextParagraph>
public boolean getFollowMasterGraphics()
getFollowMasterGraphics
in interface Sheet<HSLFShape,HSLFTextParagraph>
getFollowMasterGraphics
in class HSLFSheet
public boolean getDisplayPlaceholder(Placeholder placeholder)
Slide
getDisplayPlaceholder
in interface Slide<HSLFShape,HSLFTextParagraph>
placeholder
- the placeholder typetrue
if the placeholder should be displayed/renderedpublic boolean getDisplayPlaceholder(SimpleShape<?,?> placeholderRef)
Slide
getDisplayPlaceholder
in interface Slide<HSLFShape,HSLFTextParagraph>
placeholderRef
- the shape which references to the placeholdertrue
if the placeholder should be displayed/renderedpublic HSLFMasterSheet getSlideLayout()
getSlideLayout
in interface Slide<HSLFShape,HSLFTextParagraph>
Copyright 2022 The Apache Software Foundation or its licensors, as applicable.