HSLFSlideMaster (POI API Documentation)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.poi.hslf.usermodel
Class HSLFSlideMaster

java.lang.Object
  org.apache.poi.hslf.usermodel.HSLFSheet
      org.apache.poi.hslf.usermodel.HSLFMasterSheet
          org.apache.poi.hslf.usermodel.HSLFSlideMaster

All Implemented Interfaces:: java.lang.Iterable<HSLFShape>, HSLFShapeContainer, MasterSheet<HSLFShape,HSLFTextParagraph>, ShapeContainer<HSLFShape,HSLFTextParagraph>, Sheet<HSLFShape,HSLFTextParagraph>

public final class HSLFSlideMaster
extends HSLFMasterSheet
extends HSLFMasterSheet

SlideMaster determines the graphics, layout, and formatting for all the slides in a given presentation. It stores information about default font styles, placeholder sizes and positions, background design, and color schemes.

Author:: Yegor Kozlov

Constructor Summary
`HSLFSlideMaster(MainMaster record, int sheetNo)` Constructs a SlideMaster from the MainMaster record,

Method Summary
`HSLFMasterSheet`	`getMasterSheet()` Returns `null` since SlideMasters doen't have master sheet.
`TextProp`	`getStyleAttribute(int txtype, int level, java.lang.String name, boolean isCharacter)` Pickup a style attribute from the master.
`java.util.List<java.util.List<HSLFTextParagraph>>`	`getTextParagraphs()` Returns an array of all the TextRuns found
`TxMasterStyleAtom[]`	`getTxMasterStyleAtoms()`
`protected void`	`onAddTextShape(HSLFTextShape shape)` Subclasses should call this method and update the array of text runs when a text shape is added
`void`	`setSlideShow(HSLFSlideShow ss)` Assign SlideShow for this slide master.

Methods inherited from class org.apache.poi.hslf.usermodel.HSLFMasterSheet
`isPlaceholder`

Methods inherited from class org.apache.poi.hslf.usermodel.HSLFSheet
`_getSheetNumber, _getSheetRefId, addShape, allocateShapeId, createAutoShape, createConnector, createFreeform, createGroup, createPicture, createTable, createTextBox, draw, getBackground, getColorScheme, getFollowMasterGraphics, getPlaceholder, getPlaceholderByTextType, getPPDrawing, getProgrammableTag, getShapes, getSheetContainer, getSlideShow, iterator, onCreate, removeShape`

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
`draw, getBackground, getFollowMasterGraphics, 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

HSLFSlideMaster

public HSLFSlideMaster(MainMaster record,
                       int sheetNo)

Constructs a SlideMaster from the MainMaster record,

Method Detail

getTextParagraphs

public java.util.List<java.util.List<HSLFTextParagraph>> getTextParagraphs()

Returns an array of all the TextRuns found

Specified by:: getTextParagraphs in class HSLFSheet

getMasterSheet

public HSLFMasterSheet getMasterSheet()

Returns null since SlideMasters doen't have master sheet.

Specified by:: getMasterSheet in interface Sheet<HSLFShape,HSLFTextParagraph>
Specified by:: getMasterSheet in class HSLFSheet

getStyleAttribute

public TextProp getStyleAttribute(int txtype,
                                  int level,
                                  java.lang.String name,
                                  boolean isCharacter)

Pickup a style attribute from the master. This is the "workhorse" which returns the default style attrubutes.

Specified by:: getStyleAttribute in class HSLFMasterSheet

setSlideShow

public void setSlideShow(HSLFSlideShow ss)

Assign SlideShow for this slide master. (Used interanlly)

Overrides:: setSlideShow in class HSLFSheet

onAddTextShape

protected void onAddTextShape(HSLFTextShape shape)

Description copied from class: HSLFSheet

Subclasses should call this method and update the array of text runs when a text shape is added

Overrides:: onAddTextShape in class HSLFSheet

getTxMasterStyleAtoms

public TxMasterStyleAtom[] getTxMasterStyleAtoms()