org.apache.poi.hslf.record

Class PPDrawing

java.lang.Object

org.apache.poi.hslf.record.Record

org.apache.poi.hslf.record.RecordAtom

org.apache.poi.hslf.record.PPDrawing

All Implemented Interfaces:

Iterable<EscherRecord>, GenericRecord

public final class PPDrawing
extends RecordAtom
implements Iterable<EscherRecord>

These are actually wrappers onto Escher drawings. Make use of the DDF classes to do useful things with them. For now, creates a tree of the Escher records, and then creates any PowerPoint (hslf) records found within the EscherTextboxRecord (msofbtClientTextbox) records. Also provides easy access to the EscherTextboxRecords, so that their text may be extracted and used in Sheets.

[MS-PPT] - v20210216 refers to this as a DrawingContainer.

Field Summary

Fields inherited from class org.apache.poi.hslf.record.Record

LOG

Constructor Summary

Constructors

Constructor and Description
PPDrawing() Creates a new, empty, PPDrawing (typically for use with a new Slide or Notes)

Method Summary

Modifier and Type	Method and Description
void	addTextboxWrapper(EscherTextboxWrapper txtbox) Add a new EscherTextboxWrapper to this PPDrawing.
Record[]	getChildRecords() We're pretending to be an atom, so return null
EscherContainerRecord	getDgContainer()
EscherDgRecord	getEscherDgRecord() Return EscherDgRecord which keeps track of the number of shapes and shapeId in this drawing group
List<EscherRecord>	getEscherRecords() Get access to the underlying Escher Records
Map<String,Supplier<?>>	getGenericProperties()
StyleTextProp9Atom[]	getNumberedListInfo()
long	getRecordType() We are type 1036
EscherTextboxWrapper[]	getTextboxWrappers() Get access to the atoms inside Textboxes
Iterator<EscherRecord>	iterator()
Spliterator<EscherRecord>	spliterator()
void	writeOut(OutputStream out) Write the contents of the record back, so it can be written to disk Walks the escher layer to get the contents

Methods inherited from class org.apache.poi.hslf.record.RecordAtom

getMaxRecordLength, isAnAtom, setMaxRecordLength

Methods inherited from class org.apache.poi.hslf.record.Record

buildRecordAtOffset, createRecordForType, findChildRecords, getGenericChildren, getGenericRecordType, writeLittleEndian, writeLittleEndian

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

PPDrawing

public PPDrawing()

Creates a new, empty, PPDrawing (typically for use with a new Slide or Notes)

Method Detail

getEscherRecords

public List<EscherRecord> getEscherRecords()

Get access to the underlying Escher Records

iterator

public Iterator<EscherRecord> iterator()

Specified by:

iterator in interface Iterable<EscherRecord>

spliterator

public Spliterator<EscherRecord> spliterator()

Specified by:

spliterator in interface Iterable<EscherRecord>

Since:

POI 5.2.0

getTextboxWrappers

public EscherTextboxWrapper[] getTextboxWrappers()

Get access to the atoms inside Textboxes

getRecordType

public long getRecordType()

We are type 1036

Specified by:

getRecordType in class Record

getChildRecords

public Record[] getChildRecords()

We're pretending to be an atom, so return null

Overrides:

getChildRecords in class RecordAtom

writeOut

public void writeOut(OutputStream out)
              throws IOException

Write the contents of the record back, so it can be written to disk Walks the escher layer to get the contents

Specified by:

writeOut in class Record

Throws:

IOException

addTextboxWrapper

public void addTextboxWrapper(EscherTextboxWrapper txtbox)

Add a new EscherTextboxWrapper to this PPDrawing.

getDgContainer

public EscherContainerRecord getDgContainer()

Returns:

the container record for drawings

Since:

POI 3.14-Beta2

getEscherDgRecord

public EscherDgRecord getEscherDgRecord()

Return EscherDgRecord which keeps track of the number of shapes and shapeId in this drawing group

Returns:

EscherDgRecord

getNumberedListInfo

public StyleTextProp9Atom[] getNumberedListInfo()

getGenericProperties

public Map<String,Supplier<?>> getGenericProperties()

Specified by:

getGenericProperties in interface GenericRecord