Mercurial > projects > dwt-addons
diff dwtx/jface/text/IDocumentInformationMappingExtension2.d @ 129:eb30df5ca28b
Added JFace Text sources
author | Frank Benoit <benoit@tionex.de> |
---|---|
date | Sat, 23 Aug 2008 19:10:48 +0200 |
parents | |
children | c4fb132a086c |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/dwtx/jface/text/IDocumentInformationMappingExtension2.d Sat Aug 23 19:10:48 2008 +0200 @@ -0,0 +1,45 @@ +/******************************************************************************* + * Copyright (c) 2000, 2005 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 + * Port to the D programming language: + * Frank Benoit <benoit@tionex.de> + *******************************************************************************/ +module dwtx.jface.text.IDocumentInformationMappingExtension2; + +import dwt.dwthelper.utils; + +/** + * Extension to {@link dwtx.jface.text.IDocumentInformationMapping}. + * <p> + * Extends the information available in the mapping by providing access + * to the closest image region of an origin region. + * </p> + * + * @see dwtx.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 + * <code>originRegion</code> 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 <code>originRegion</code> is not a + * valid region of the original document + */ + IRegion toClosestImageRegion(IRegion originRegion) throws BadLocationException; +}