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
Ruler of a text as it differs from the style's ruler settings.
-
Field Summary
-
Constructor Summary
ConstructorsModifierConstructorDescriptionConstructs a new empty ruler atom.protected
TextRulerAtom
(byte[] source, int start, int len) Constructs the ruler atom record from its source data. -
Method Summary
Modifier and TypeMethodDescriptionInteger[]
First line of paragraph's distance from shape's left margin, in master coordinates (576 dpi).int
Default distance between tab stops, in master coordinates (576 dpi).int
Number of indent levels (maximum 5).static TextRulerAtom
long
Gets the record type.Default distance between tab stops, in master coordinates (576 dpi).Integer[]
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
-
Constructor Details
-
TextRulerAtom
public TextRulerAtom()Constructs a new empty ruler atom. -
TextRulerAtom
protected TextRulerAtom(byte[] source, int start, int len) Constructs the ruler 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 Details
-
getRecordType
public long getRecordType()Gets the record type.- Specified by:
getRecordType
in classRecord
- Returns:
- the record type.
-
writeOut
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
Default distance between tab stops, in master coordinates (576 dpi). -
getTextOffsets
Paragraph's distance from shape's left margin, in master coordinates (576 dpi). -
getBulletOffsets
First line of paragraph's distance from shape's left margin, in master coordinates (576 dpi). -
getParagraphInstance
-
setParagraphIndent
public void setParagraphIndent(short leftMargin, short indent)
-