Package org.apache.poi.hslf.record
Class TextRulerAtom
- java.lang.Object
-
- org.apache.poi.hslf.record.Record
-
- org.apache.poi.hslf.record.RecordAtom
-
- org.apache.poi.hslf.record.TextRulerAtom
-
public final class TextRulerAtom extends RecordAtom
Ruler of a text as it differs from the style's ruler settings.
-
-
Constructor Summary
Constructors Constructor Description TextRulerAtom()
Constructs a new empty ruler atom.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Integer[]
getBulletOffsets()
First line of paragraph's distance from shape's left margin, in master coordinates (576 dpi).int
getDefaultTabSize()
Default distance between tab stops, in master coordinates (576 dpi).int
getNumberOfLevels()
Number of indent levels (maximum 5).static TextRulerAtom
getParagraphInstance()
long
getRecordType()
Gets the record type.List<HSLFTabStop>
getTabStops()
Default distance between tab stops, in master coordinates (576 dpi).Integer[]
getTextOffsets()
Paragraph's distance from shape's left margin, in master coordinates (576 dpi).void
setParagraphIndent(short leftMargin, short indent)
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, isAnAtom
-
Methods inherited from class org.apache.poi.hslf.record.Record
buildRecordAtOffset, createRecordForType, findChildRecords, writeLittleEndian, writeLittleEndian
-
-
-
-
Method Detail
-
getRecordType
public long getRecordType()
Gets the record type.- Specified by:
getRecordType
in classRecord
- 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 classRecord
- Parameters:
out
- the output stream to write to.- Throws:
IOException
- if an error occurs.
-
getDefaultTabSize
public int getDefaultTabSize()
Default distance between tab stops, in master coordinates (576 dpi).
-
getNumberOfLevels
public int getNumberOfLevels()
Number of indent levels (maximum 5).
-
getTabStops
public List<HSLFTabStop> getTabStops()
Default distance between tab stops, in master coordinates (576 dpi).
-
getTextOffsets
public Integer[] getTextOffsets()
Paragraph's distance from shape's left margin, in master coordinates (576 dpi).
-
getBulletOffsets
public Integer[] getBulletOffsets()
First line of paragraph's distance from shape's left margin, in master coordinates (576 dpi).
-
getParagraphInstance
public static TextRulerAtom getParagraphInstance()
-
setParagraphIndent
public void setParagraphIndent(short leftMargin, short indent)
-
-