Interface IDocumentRange

  • All Known Implementing Classes:
    DocumentRangeNode, StructureRootNode

    public interface IDocumentRange
    Defines a subrange in a document.

    It is used by text viewers that can work on a subrange of a document. For example, a text viewer for Java compilation units might use this to restrict the view to a single method.

    Clients may implement this interface.

    See Also:
    TextMergeViewer, DocumentRangeNode
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String RANGE_CATEGORY
      The position category typically used for an IDocumentRange position (value "DocumentRangeCategory").
    • Field Detail

      • RANGE_CATEGORY

        static final String RANGE_CATEGORY
        The position category typically used for an IDocumentRange position (value "DocumentRangeCategory").
        Since:
        2.0
        See Also:
        Constant Field Values
    • Method Detail

      • getDocument

        IDocument getDocument()
        Returns the underlying document.
        Returns:
        the underlying document
      • getRange

        Position getRange()
        Returns a position that specifies a subrange in the underlying document, or null if this document range spans the whole underlying document.
        Returns:
        a position that specifies a subrange in the underlying document, or null