Package com.teamten.typeset.element

Class Kern

java.lang.Object
com.teamten.typeset.element.Element
com.teamten.typeset.element.DiscardableElement
com.teamten.typeset.element.Kern
All Implemented Interfaces:
Dimensions
public class Kern extends DiscardableElement
Represents a kerning adjustment.

  • Field Summary

    Fields inherited from class com.teamten.typeset.element.Element

    DRAW_DEBUG

  • Constructor Summary

    Constructors
    Constructor
    Description
    Kern(long amount, boolean isHorizontal)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    getAmount()
    The amount to adjust.
    long
    getDepth()
    Return the depth (below the baseline) of the element.
    long
    getHeight()
    Return the height (above the baseline) of the element.
    long
    getWidth()
    Return the width of the element.
    boolean
    isHorizontal()
    Whether this kern is intended to be horizontal (between letters) or vertical (between lines).
    long
    layOutHorizontally(long x, long y, org.apache.pdfbox.pdmodel.PDPageContentStream contents)
    Add the element to the contents as part of a horizontal sequence.
    long
    layOutVertically(long x, long y, org.apache.pdfbox.pdmodel.PDPageContentStream contents)
    Add the element to the contents as part of a vertical sequence.
    void
    println(PrintStream stream, String indent)
    Pretty prints the element to the PrintWriter with the given indent.
    String
    toTextString()
    Return a text version of the element, ideally containing only the text of the element and its children.

    Methods inherited from class com.teamten.typeset.element.Element

    getVerticalSize, println, shouldSkipElementAtStart, toTextString, visit

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • Kern

      public Kern(long amount, boolean isHorizontal)

  • Method Details

    • getAmount

      public long getAmount()
      The amount to adjust. This is normally negative.

    • isHorizontal

      public boolean isHorizontal()
      Whether this kern is intended to be horizontal (between letters) or vertical (between lines). It's normally horizontal.

    • getWidth

      public long getWidth()
      Description copied from class: Element
      Return the width of the element.
      Specified by:
      getWidth in interface Dimensions
      Specified by:
      getWidth in class Element

    • getHeight

      public long getHeight()
      Description copied from class: Element
      Return the height (above the baseline) of the element.
      Specified by:
      getHeight in interface Dimensions
      Specified by:
      getHeight in class Element

    • getDepth

      public long getDepth()
      Description copied from class: Element
      Return the depth (below the baseline) of the element.
      Specified by:
      getDepth in interface Dimensions
      Specified by:
      getDepth in class Element

    • layOutHorizontally

      public long layOutHorizontally(long x, long y, org.apache.pdfbox.pdmodel.PDPageContentStream contents) throws IOException
      Description copied from class: Element
      Add the element to the contents as part of a horizontal sequence.
      Specified by:
      layOutHorizontally in class Element
      Parameters:
      x - the left-most point of the element.
      y - the baseline of the element.
      contents - the stream to add the element to.
      Returns:
      how much to move right afterward.
      Throws:
      IOException

    • layOutVertically

      public long layOutVertically(long x, long y, org.apache.pdfbox.pdmodel.PDPageContentStream contents) throws IOException
      Description copied from class: Element
      Add the element to the contents as part of a vertical sequence.
      Specified by:
      layOutVertically in class Element
      Parameters:
      x - the left-most point of the element.
      y - the upper-left point of the element.
      contents - the stream to add the element to.
      Returns:
      how much to move down afterward.
      Throws:
      IOException

    • println

      public void println(PrintStream stream, String indent)
      Description copied from class: Element
      Pretty prints the element to the PrintWriter with the given indent. The method must print its own newline.
      Overrides:
      println in class Element

    • toTextString

      public String toTextString()
      Description copied from class: Element
      Return a text version of the element, ideally containing only the text of the element and its children.
      Overrides:
      toTextString in class Element