01: /*******************************************************************************
02: * Copyright (c) 2000, 2005 IBM Corporation and others.
03: * All rights reserved. This program and the accompanying materials
04: * are made available under the terms of the Eclipse Public License v1.0
05: * which accompanies this distribution, and is available at
06: * http://www.eclipse.org/legal/epl-v10.html
07: *
08: * Contributors:
09: * IBM Corporation - initial API and implementation
10: *******************************************************************************/package org.eclipse.jface.text;
11:
12: import org.eclipse.jface.viewers.ISelection;
13:
14: /**
15: * A mark selection. Is sent out by text viewers implementing the
16: * {@link org.eclipse.jface.text.IMarkRegionTarget} interface. By checking the
17: * type of the selection selection listeners can determine whether a selection
18: * event is about a mark or a normal text selection.
19: * <p>
20: * This interface is not intended to be implemented by clients others than
21: * {@link org.eclipse.jface.text.ITextViewer} implementers.
22: * </p>
23: *
24: * @since 2.0
25: */
26: public interface IMarkSelection extends ISelection {
27:
28: /**
29: * Returns the marked document.
30: *
31: * @return the marked document
32: */
33: IDocument getDocument();
34:
35: /**
36: * Returns the mark position. The offset may be <code>-1</code> if there's no marked region.
37: *
38: * @return the mark position or <code>-1</code> if there is no marked region
39: */
40: int getOffset();
41:
42: /**
43: * Returns the length of the mark selection. The length may be negative, if the caret
44: * is before the mark position. The length has no meaning if <code>getOffset()</code>
45: * returns <code>-1</code>.
46: *
47: * @return the length of the mark selection. Result is undefined for <code>getOffset == -1</code>
48: */
49: int getLength();
50: }
|