|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.poi.hslf.usermodel.HSLFSheet
org.apache.poi.hslf.usermodel.HSLFSlide
public final class HSLFSlide
This class represents a slide 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
| Constructor Summary | |
|---|---|
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. |
|
| Method Summary | |
|---|---|
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. |
Comment[] |
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 |
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. |
boolean |
getHidden()
|
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. |
protected SlideListWithText.SlideAtomsSet |
getSlideAtomsSet()
|
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 |
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)
|
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. |
| Methods inherited from class org.apache.poi.hslf.usermodel.HSLFSheet |
|---|
_getSheetNumber, _getSheetRefId, addShape, allocateShapeId, createAutoShape, createConnector, createFreeform, createGroup, createPicture, createTable, createTextBox, getPlaceholder, getPlaceholderByTextType, getPPDrawing, getProgrammableTag, getShapes, getSheetContainer, getSlideShow, iterator, removeShape, setSlideShow |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface org.apache.poi.sl.usermodel.Sheet |
|---|
getSlideShow |
| Methods inherited from interface org.apache.poi.sl.usermodel.ShapeContainer |
|---|
addShape, createAutoShape, createConnector, createFreeform, createGroup, createPicture, createTable, createTextBox, getShapes, removeShape |
| Methods inherited from interface java.lang.Iterable |
|---|
iterator |
| Constructor Detail |
|---|
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 from
public HSLFSlide(int sheetNumber,
int sheetRefId,
int slideNumber)
sheetNumber - The internal number of the sheet, as used by PersistPtrHolderslideNumber - The user facing number of the sheet| Method Detail |
|---|
public 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>TextHeaderAtompublic java.util.List<java.util.List<HSLFTextParagraph>> getTextParagraphs()
getTextParagraphs in class HSLFSheetpublic int getSlideNumber()
getSlideNumber in interface Slide<HSLFShape,HSLFTextParagraph>public Slide getSlideRecord()
protected 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 HSLFSheetpublic 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 HSLFSheetpublic ColorSchemeAtom getColorScheme()
getColorScheme in class HSLFSheetpublic Comment[] getComments()
public HeadersFooters getHeadersFooters()
protected void onAddTextShape(HSLFTextShape shape)
HSLFSheet
onAddTextShape in class HSLFSheetpublic StyleTextProp9Atom[] getNumberedListInfo()
public EscherTextboxWrapper[] getTextboxWrappers()
public void setHidden(boolean hidden)
public boolean getHidden()
public void draw(java.awt.Graphics2D graphics)
Sheet
draw in interface Sheet<HSLFShape,HSLFTextParagraph>draw in class HSLFSheetpublic 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 HSLFSheetpublic boolean getDisplayPlaceholder(Placeholder placeholder)
Slide
getDisplayPlaceholder in interface Slide<HSLFShape,HSLFTextParagraph>true if the placeholder should be displayed/rendered
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||