org.eclipse.jface.text.IMarkSelection Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.jface.text Show documentation

This is org.eclipse.jface.text jar used by Scout SDK

The newest version!

/*******************************************************************************
 * Copyright (c) 2000, 2008 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * 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.
 * 
 * This interface is not intended to be implemented by clients other than
 * {@link org.eclipse.jface.text.ITextViewer} implementers.
 * 
 *
 * @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 -1 if there's no marked region.
	 *
	 * @return the mark position or -1 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 getOffset()
	 * returns -1.
	 *
	 * @return the length of the mark selection. Result is undefined for getOffset == -1
	 */
	int getLength();
}