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
All Implemented Interfaces:
GenericRecord
public final class TextRulerAtom extends RecordAtom
Ruler of a text as it differs from the style's ruler settings.

  • Constructor Details

    • TextRulerAtom

      public TextRulerAtom()
      Constructs a new empty ruler atom.

  • Method Details

    • 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.

    • 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)

    • getGenericProperties

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