Package com.pnfsoftware.jeb.core.output.text

Interface ILine

All Known Implementing Classes:
CodeLine, Line
@Ser public interface ILine
Representation of a line within an ITextDocumentPart. A line should not contain new line characters such as carriage-return or line-feed. A line may contain optional, non-overlapping items that define regions of text onto which special meaning can be attached.

It is the responsibility of the implementor to make sure that lines do not contain CR/LF characters.

It is the responsibility of the implementor to make sure that items are non overlapping.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final ILine
    EMPTY_LINE
    An empty line with no anchor
    static final int
    FLAG_DISABLED_LINE
    This flag indicates that the current line is "disabled".

  • Method Summary

    Modifier and Type
    Method
    Description
    default int
    getFlags()
    Retrieve the flags for the entire line.
    List<? extends ITextItem>
    getItems()
    Get the list of text items within the current line.
    List<? extends ITextMark>
    getMarks()
    Get the list of marks for this line.
    CharSequence
    getText()
    Get the line text.

  • Field Details

    • EMPTY_LINE

      static final ILine EMPTY_LINE
      An empty line with no anchor

    • FLAG_DISABLED_LINE

      static final int FLAG_DISABLED_LINE
      This flag indicates that the current line is "disabled". Clients rendering the line may interpret this flag in the way of their choosing; they may also ignore it.
      See Also:

  • Method Details

    • getText

      CharSequence getText()
      Get the line text. It is the responsibility of the implementor to make sure that lines do not contain CR/LF characters.
      Returns:
      the line

    • getItems

      List<? extends ITextItem> getItems()
      Get the list of text items within the current line. It is the responsibility of the implementor to make sure that items are non overlapping and are sorted.
      Returns:
      a list, possibly empty, of text items

    • getMarks

      List<? extends ITextMark> getMarks()
      Get the list of marks for this line.
      Returns:

    • getFlags

      default int getFlags()
      Retrieve the flags for the entire line.
      Returns:
      optional flags (may be 0)