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:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The position category typically used for anIDocumentRange
position (value"DocumentRangeCategory"
). -
Method Summary
Modifier and TypeMethodDescriptionReturns the underlying document.getRange()
Returns a position that specifies a subrange in the underlying document, ornull
if this document range spans the whole underlying document.
-
Field Details
-
RANGE_CATEGORY
The position category typically used for anIDocumentRange
position (value"DocumentRangeCategory"
).- Since:
- 2.0
- See Also:
-
-
Method Details
-
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, ornull
if this document range spans the whole underlying document.- Returns:
- a position that specifies a subrange in the underlying document, or
null
-