Sheet (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.sl.usermodel
Interface Sheet<S extends Shape<S,P>,P extends TextParagraph<S,P,?>>

All Superinterfaces:: java.lang.Iterable<S>, ShapeContainer<S,P>

All Known Subinterfaces:: MasterSheet<S,P>, Notes<S,P>, Slide<S,P>

All Known Implementing Classes:: HSLFMasterSheet, HSLFNotes, HSLFSheet, HSLFSlide, HSLFSlideMaster, HSLFTitleMaster, XSLFNotes, XSLFNotesMaster, XSLFSheet, XSLFSlide, XSLFSlideLayout, XSLFSlideMaster

public interface Sheet<S extends Shape<S,P>,P extends TextParagraph<S,P,?>>
extends ShapeContainer<S,P>
extends ShapeContainer<S,P>

Common parent of Slides, Notes and Masters

Method Summary
`void`	`draw(java.awt.Graphics2D graphics)` Convenience method to draw a sheet to a graphics context
`Background<S,P>`	`getBackground()`
`boolean`	`getFollowMasterGraphics()`
`MasterSheet<S,P>`	`getMasterSheet()`
`SlideShow<S,P>`	`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`

Method Detail

getSlideShow

SlideShow<S,P> getSlideShow()

getFollowMasterGraphics

boolean getFollowMasterGraphics()

Returns:: whether shapes on the master sheet should be shown. By default master graphics is turned off. Sheets that support the notion of master (slide, slideLayout) should override it and check this setting in the sheet XML

getMasterSheet

MasterSheet<S,P> getMasterSheet()

getBackground

Background<S,P> getBackground()

draw

void draw(java.awt.Graphics2D graphics)

Convenience method to draw a sheet to a graphics context

Parameters:: graphics -