Interface IConsoleDocumentPartitioner

  • All Superinterfaces:
    IDocumentPartitioner

    public interface IConsoleDocumentPartitioner
    extends IDocumentPartitioner
    A document partitioner for a text console.

    In addition to regular partitioner duties, a console document partitioner dictates which regions in its document are read-only and provides style ranges.

    Clients may implement this interface.

    Since:
    3.1
    See Also:
    TextConsole
    • Method Detail

      • isReadOnly

        boolean isReadOnly​(int offset)
        Returns whether this partitioner's document is read-only at the specified offset. The user is not allowed to type in read-only locations.
        Parameters:
        offset - document offset
        Returns:
        whether this partitioner's document is read-only at the specified offset
      • getStyleRanges

        StyleRange[] getStyleRanges​(int offset,
                                    int length)
        Returns style ranges for the specified region of this partitioner's document to use when rendering, or null if none.
        Parameters:
        offset - beginning offset for which style ranges are requested
        length - the length of text for which style ranges are requested
        Returns:
        style ranges for the specified region of this partitioner's document to use when rendering, or null if none