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

/*******************************************************************************
 * Copyright (c) 2000, 2005 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;

/**
 * Extension to {@link org.eclipse.jface.text.IDocumentInformationMapping}.
 * 
 * Extends the information available in the mapping by providing access
 * to the closest image region of an origin region.
 * 
 *
 * @see org.eclipse.jface.text.IDocumentInformationMapping
 * @since 3.1
 */
public interface IDocumentInformationMappingExtension2 {

	/**
	 * Returns the minimal region of the image document that completely
	 * comprises the given region of the original document. The difference to
	 * {@link IDocumentInformationMapping#toImageRegion(IRegion)} is that this
	 * method will always return an image region for a valid origin region. If
	 * originRegion has no corresponding image region, the
	 * zero-length region at the offset between its surrounding fragments is
	 * returned.
	 *
	 * @param originRegion the region of the original document
	 * @return the minimal region of the image document comprising the given
	 *         region of the original document
	 * @throws BadLocationException if originRegion is not a
	 *         valid region of the original document
	 */
	IRegion toClosestImageRegion(IRegion originRegion) throws BadLocationException;
}