Package org.apache.poi.hslf.record

Class RoundTripHFPlaceholder12

java.lang.Object

org.apache.poi.hslf.record.Record

org.apache.poi.hslf.record.RecordAtom

org.apache.poi.hslf.record.RoundTripHFPlaceholder12

All Implemented Interfaces:

GenericRecord

public final class RoundTripHFPlaceholder12
extends RecordAtom

An atom record that specifies that a shape is a header or footer placeholder shape

Field Summary

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

LOG

Constructor Summary

Constructors

Modifier	Constructor	Description
	RoundTripHFPlaceholder12()	Create a new instance of RoundTripHFPlaceholder12
protected	RoundTripHFPlaceholder12(byte[] source, int start, int len)	Constructs the comment atom record from its source data.

Method Summary

Modifier and Type	Method	Description
Map<String,Supplier<?>>	getGenericProperties()
int	getPlaceholderId()	Gets the comment number (note - each user normally has their own count).
long	getRecordType()	Gets the record type.
void	setPlaceholderId(int number)	Sets the comment number (note - each user normally has their own count).
void	writeOut(OutputStream out)	Write the contents of the record back, so it can be written to disk

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

getChildRecords, 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

Constructor Detail

RoundTripHFPlaceholder12

public RoundTripHFPlaceholder12()

Create a new instance of RoundTripHFPlaceholder12

RoundTripHFPlaceholder12

protected RoundTripHFPlaceholder12(byte[] source,
                                   int start,
                                   int len)

Constructs the comment atom record from its source data.

Parameters:

source - the source data as a byte array.

start - the start offset into the byte array.

len - the length of the slice in the byte array.

Method Detail

getPlaceholderId

public int getPlaceholderId()

Gets the comment number (note - each user normally has their own count).

Returns:

the comment number.

setPlaceholderId

public void setPlaceholderId(int number)

Sets the comment number (note - each user normally has their own count).

Parameters:

number - the comment number.

getRecordType

public long getRecordType()

Gets the record type.

Specified by:

getRecordType in class Record

Returns:

the record type.

writeOut

public void writeOut(OutputStream out)
              throws IOException

Write the contents of the record back, so it can be written to disk

Specified by:

writeOut in class Record

Parameters:

out - the output stream to write to.

Throws:

IOException - if an error occurs.

getGenericProperties

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