Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.0

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.jface.text
Interface IMarkSelection

All Superinterfaces:

ISelection

All Known Implementing Classes:

MarkSelection

public interface IMarkSelection

extends ISelection

A mark selection. Is sent out by text viewers implementing the IMarkRegionTarget interface. By checking the type of the selection selection listeners can determine whether a selection event is about a mark or a normal text selection.

This interface is not intended to be implemented by clients others than ITextViewer implementers.

Since:

2.0

Method Summary

IDocument	getDocument() Returns the marked document.
int	getLength() Returns the length of the mark selection.
int	getOffset() Returns the mark position.

Methods inherited from interface org.eclipse.jface.viewers.ISelection

isEmpty

Method Detail

getDocument

public IDocument getDocument()

Returns the marked document.

Returns:

the marked document

getOffset

public int getOffset()

Returns the mark position. The offset may be -1 if there's no marked region.

Returns:

the mark position or -1 if there is no marked region

getLength

public int getLength()

Returns the length of the mark selection. The length may be negative, if the caret is before the mark position. The length has no meaning if getOffset() returns -1.

Returns:

the length of the mark selection. Result is undefined for getOffset == -1