Interface HighlightingRectangle

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
HighlightingRectangleImpl

public interface HighlightingRectangle
extends java.io.Serializable
A rectangle (defined by its upper left and lower right coordinates) for highlighted text including the text itself.
  • Method Summary

    Modifier and Type Method Description
    double getLrx()
    the relative abscissa of the lower right point of the rectangle
    double getLry()
    the relative ordinate of the lower right point of the rectangle
    int getRef()
    The reference of the highlight rectangle, e.g. a page number
    java.lang.String getText()
    The text to be highlighted (e.g. for plaintext representation)
    double getUlx()
    The relative abscissa (x) of the upper left point of the rectangle
    double getUly()
    The relative ordinate (y) of the upper left point of the rectangle
  • Method Details

    • getText

      java.lang.String getText()
      The text to be highlighted (e.g. for plaintext representation)
      Returns:
      the text
    • getRef

      int getRef()
      The reference of the highlight rectangle, e.g. a page number
      Returns:
      the value of the reference
    • getUlx

      double getUlx()
      The relative abscissa (x) of the upper left point of the rectangle
      Returns:
      a value in the range [0..1]
    • getUly

      double getUly()
      The relative ordinate (y) of the upper left point of the rectangle
      Returns:
      a value in the range [0..1]
    • getLrx

      double getLrx()
      the relative abscissa of the lower right point of the rectangle
      Returns:
      a value in the range [0..1]
    • getLry

      double getLry()
      the relative ordinate of the lower right point of the rectangle
      Returns:
      a value in the range [0..1]