Package org.apache.poi.hslf.record

Class TextRulerAtom

  • public final class TextRulerAtom
extends RecordAtom
    Ruler of a text as it differs from the style's ruler settings.

    • Constructor Detail

      • TextRulerAtom

        public TextRulerAtom()
        Constructs a new empty ruler atom.

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

      • 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 java.util.List<HSLFTabStop> getTabStops()
        Default distance between tab stops, in master coordinates (576 dpi).

      • getTextOffsets

        public java.lang.Integer[] getTextOffsets()
        Paragraph's distance from shape's left margin, in master coordinates (576 dpi).

      • getBulletOffsets

        public java.lang.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)