Mercurial > projects > dwt-addons

comparison dwtx/jface/text/IDocumentInformationMapping.d @ 139:93a6ec48fd28

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Regexp throws removal in interfaces
author Frank Benoit <benoit@tionex.de>
date Sun, 24 Aug 2008 02:31:41 +0200
parents c4fb132a086c
children
comparison
equal deleted inserted replaced
138:b6bad70d540a 139:93a6ec48fd28
191 * 191 *
192 * @param imageOffset the offset in the image document 192 * @param imageOffset the offset in the image document
193 * @return the corresponding offset in the original document or <code>-1</code> 193 * @return the corresponding offset in the original document or <code>-1</code>
194 * @throws BadLocationException if <code>imageOffset</code> is not a valid offset in the image document 194 * @throws BadLocationException if <code>imageOffset</code> is not a valid offset in the image document
195 */ 195 */
196 int toOriginOffset(int imageOffset) throws BadLocationException; 196 int toOriginOffset(int imageOffset) ;
197 197
198 /** 198 /**
199 * Returns the minimal region of the original document that completely comprises the given region of the 199 * Returns the minimal region of the original document that completely comprises the given region of the
200 * image document or <code>null</code> if there is no such region. 200 * image document or <code>null</code> if there is no such region.
201 * 201 *
202 * @param imageRegion the region of the image document 202 * @param imageRegion the region of the image document
203 * @return the minimal region of the original document comprising the given region of the image document or <code>null</code> 203 * @return the minimal region of the original document comprising the given region of the image document or <code>null</code>
204 * @throws BadLocationException if <code>imageRegion</code> is not a valid region of the image document 204 * @throws BadLocationException if <code>imageRegion</code> is not a valid region of the image document
205 */ 205 */
206 IRegion toOriginRegion(IRegion imageRegion) throws BadLocationException; 206 IRegion toOriginRegion(IRegion imageRegion) ;
207 207
208 /** 208 /**
209 * Returns the range of lines of the original document that corresponds to the given line of the image document or 209 * Returns the range of lines of the original document that corresponds to the given line of the image document or
210 * <code>null</code> if there are no such lines. 210 * <code>null</code> if there are no such lines.
211 * 211 *
212 * @param imageLine the line of the image document 212 * @param imageLine the line of the image document
213 * @return the corresponding lines of the original document or <code>null</code> 213 * @return the corresponding lines of the original document or <code>null</code>
214 * @throws BadLocationException if <code>imageLine</code> is not a valid line number in the image document 214 * @throws BadLocationException if <code>imageLine</code> is not a valid line number in the image document
215 */ 215 */
216 IRegion toOriginLines(int imageLine) throws BadLocationException; 216 IRegion toOriginLines(int imageLine) ;
217 217
218 /** 218 /**
219 * Returns the line of the original document that corresponds to the given line of the image document or 219 * Returns the line of the original document that corresponds to the given line of the image document or
220 * <code>-1</code> if there is no such line. 220 * <code>-1</code> if there is no such line.
221 * 221 *
222 * @param imageLine the line of the image document 222 * @param imageLine the line of the image document
223 * @return the corresponding line of the original document or <code>-1</code> 223 * @return the corresponding line of the original document or <code>-1</code>
224 * @throws BadLocationException if <code>imageLine</code> is not a valid line number in the image document 224 * @throws BadLocationException if <code>imageLine</code> is not a valid line number in the image document
225 */ 225 */
226 int toOriginLine(int imageLine) throws BadLocationException; 226 int toOriginLine(int imageLine) ;
227 227
228 228
229 229
230 /** 230 /**
231 * Returns the offset in the image document that corresponds to the given offset in the original document 231 * Returns the offset in the image document that corresponds to the given offset in the original document
233 * 233 *
234 * @param originOffset the offset in the original document 234 * @param originOffset the offset in the original document
235 * @return the corresponding offset in the image document or <code>-1</code> 235 * @return the corresponding offset in the image document or <code>-1</code>
236 * @throws BadLocationException if <code>originOffset</code> is not a valid offset in the original document 236 * @throws BadLocationException if <code>originOffset</code> is not a valid offset in the original document
237 */ 237 */
238 int toImageOffset(int originOffset) throws BadLocationException; 238 int toImageOffset(int originOffset) ;
239 239
240 /** 240 /**
241 * Returns the minimal region of the image document that completely comprises the given region of the 241 * Returns the minimal region of the image document that completely comprises the given region of the
242 * original document or <code>null</code> if there is no such region. 242 * original document or <code>null</code> if there is no such region.
243 * 243 *
244 * @param originRegion the region of the original document 244 * @param originRegion the region of the original document
245 * @return the minimal region of the image document comprising the given region of the original document or <code>null</code> 245 * @return the minimal region of the image document comprising the given region of the original document or <code>null</code>
246 * @throws BadLocationException if <code>originRegion</code> is not a valid region of the original document 246 * @throws BadLocationException if <code>originRegion</code> is not a valid region of the original document
247 */ 247 */
248 IRegion toImageRegion(IRegion originRegion) throws BadLocationException; 248 IRegion toImageRegion(IRegion originRegion) ;
249 249
250 /** 250 /**
251 * Returns the line of the image document that corresponds to the given line of the original document or 251 * Returns the line of the image document that corresponds to the given line of the original document or
252 * <code>-1</code> if there is no such line. 252 * <code>-1</code> if there is no such line.
253 * 253 *
254 * @param originLine the line of the original document 254 * @param originLine the line of the original document
255 * @return the corresponding line of the image document or <code>-1</code> 255 * @return the corresponding line of the image document or <code>-1</code>
256 * @throws BadLocationException if <code>originLine</code> is not a valid line number in the original document 256 * @throws BadLocationException if <code>originLine</code> is not a valid line number in the original document
257 */ 257 */
258 int toImageLine(int originLine) throws BadLocationException; 258 int toImageLine(int originLine) ;
259 259
260 /** 260 /**
261 * Returns the line of the image document whose corresponding line in the original document 261 * Returns the line of the image document whose corresponding line in the original document
262 * is closest to the given line in the original document. 262 * is closest to the given line in the original document.
263 * 263 *
264 * @param originLine the line in the original document 264 * @param originLine the line in the original document
265 * @return the line in the image document that corresponds best to the given line in the original document 265 * @return the line in the image document that corresponds best to the given line in the original document
266 * @throws BadLocationException if <code>originLine</code>is not a valid line in the original document 266 * @throws BadLocationException if <code>originLine</code>is not a valid line in the original document
267 */ 267 */
268 int toClosestImageLine(int originLine) throws BadLocationException; 268 int toClosestImageLine(int originLine) ;
269 } 269 }