org.apache.poi.hslf.record

Class TextSpecInfoAtom

java.lang.Object

org.apache.poi.hslf.record.Record

org.apache.poi.hslf.record.RecordAtom

org.apache.poi.hslf.record.TextSpecInfoAtom

All Implemented Interfaces:

GenericRecord

public final class TextSpecInfoAtom
extends RecordAtom

The special info runs contained in this text. Special info runs consist of character properties which don?t follow styles.

Field Summary

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

logger

Constructor Summary

Constructors

Constructor and Description
TextSpecInfoAtom() Constructs an empty atom, with a default run of size 1
TextSpecInfoAtom(byte[] source, int start, int len) Constructs the link related atom record from its source data.

Method Summary

Modifier and Type	Method and Description
int	getCharactersCovered() Get the number of characters covered by this records
java.util.Map<java.lang.String,java.util.function.Supplier<?>>	getGenericProperties()
long	getRecordType() Gets the record type.
TextSpecInfoRun[]	getTextSpecInfoRuns()
void	reset(int size) Reset the content to one info run with the default values
void	setParentSize(int size) Adapts the size by enlarging the last TextSpecInfoRun or chopping the runs to the given length
void	setTextSize(int size) Update the text length
void	writeOut(java.io.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, isAnAtom

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

TextSpecInfoAtom

public TextSpecInfoAtom()

Constructs an empty atom, with a default run of size 1

TextSpecInfoAtom

public TextSpecInfoAtom(byte[] source,
                        int start,
                        int len)

Constructs the link related 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

getRecordType

public long getRecordType()

Gets the record type.

Specified by:

getRecordType in class Record

Returns:

the record type.

writeOut

public void writeOut(java.io.OutputStream out)
              throws java.io.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:

java.io.IOException - if an error occurs.

setTextSize

public void setTextSize(int size)

Update the text length

Parameters:

size - the text length

reset

public void reset(int size)

Reset the content to one info run with the default values

Parameters:

size - the site of parent text

setParentSize

public void setParentSize(int size)

Adapts the size by enlarging the last TextSpecInfoRun or chopping the runs to the given length

Parameters:

size -

getCharactersCovered

public int getCharactersCovered()

Get the number of characters covered by this records

Returns:

the number of characters covered by this records

getTextSpecInfoRuns

public TextSpecInfoRun[] getTextSpecInfoRuns()

getGenericProperties

public java.util.Map<java.lang.String,java.util.function.Supplier<?>> getGenericProperties()