org.apache.poi.hslf.usermodel

Class HSLFMasterSheet

java.lang.Object

org.apache.poi.hslf.usermodel.HSLFSheet

org.apache.poi.hslf.usermodel.HSLFMasterSheet

All Implemented Interfaces:

java.lang.Iterable<HSLFShape>, HSLFShapeContainer, MasterSheet<HSLFShape,HSLFTextParagraph>, ShapeContainer<HSLFShape,HSLFTextParagraph>, Sheet<HSLFShape,HSLFTextParagraph>

Direct Known Subclasses:

HSLFSlideMaster, HSLFTitleMaster

public abstract class HSLFMasterSheet
extends HSLFSheet
implements MasterSheet<HSLFShape,HSLFTextParagraph>

The superclass of all master sheets - Slide masters, Notes masters, etc. For now it's empty. When we understand more about masters in ppt we will add the common functionality here.

Author:

Yegor Kozlov

Constructor Summary

Constructors

Constructor and Description
HSLFMasterSheet(SheetContainer container, int sheetNo)

Method Summary

Modifier and Type	Method and Description
abstract TextProp	getStyleAttribute(int txtype, int level, java.lang.String name, boolean isCharacter) Pickup a style attribute from the master.
static boolean	isPlaceholder(HSLFShape shape) Checks if the shape is a placeholder.

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, getMasterSheet, getPlaceholder, getPlaceholderByTextType, getPPDrawing, getProgrammableTag, getShapes, getSheetContainer, getSlideShow, getTextParagraphs, 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 org.apache.poi.sl.usermodel.Sheet

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

forEach, iterator, spliterator

Constructor Detail

HSLFMasterSheet

public HSLFMasterSheet(SheetContainer container,
                       int sheetNo)

Method Detail

getStyleAttribute

public abstract 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.

isPlaceholder

public static boolean isPlaceholder(HSLFShape shape)

Checks if the shape is a placeholder. (placeholders aren't normal shapes, they are visible only in the Edit Master mode)

Returns:

true if the shape is a placeholder