org.eclipse.jface.text/src/org/eclipse/jface/text/IMarkSelection.java

/*******************************************************************************
 * Copyright (c) 2000, 2008 IBM Corporation and others.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.jface.text;


import org.eclipse.jface.viewers.ISelection;


/**
 * A mark selection can be sent out by text viewers. By checking the
 * type of the selection selection listeners can determine whether a selection
 * event is about a mark or a normal text selection.
 * <p>
 * This interface is not intended to be implemented by clients other than
 * {@link org.eclipse.jface.text.ITextViewer} implementers.
 * </p>
 *
 * @since 2.0
 */
public interface IMarkSelection extends ISelection {

	/**
	 * Returns the marked document.
	 *
	 * @return the marked document
	 */
	IDocument getDocument();

	/**
	 * Returns the mark position. The offset may be <code>-1</code> if there's no marked region.
	 *
	 * @return the mark position or <code>-1</code> if there is no marked region
	 */
	int getOffset();

	/**
	 * 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 <code>getOffset()</code>
	 * returns <code>-1</code>.
	 *
	 * @return the length of the mark selection. Result is undefined for <code>getOffset == -1</code>
	 */
	int getLength();
}