KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > ui > texteditor > spelling > ISpellingEngine


1 /*******************************************************************************
2  * Copyright (c) 2000, 2005 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/
11
12 package org.eclipse.ui.texteditor.spelling;
13
14 import org.eclipse.core.runtime.IProgressMonitor;
15
16 import org.eclipse.jface.text.IDocument;
17 import org.eclipse.jface.text.IRegion;
18
19 /**
20  * A spelling engine that can be contributed to the
21  * <code>org.eclipse.ui.workbench.texteditor.spellingEngine</code> extension
22  * point. The <code>SpellingContext</code> provides information about the
23  * content type to be checked. In general a spelling engine should at least
24  * support the text {@link org.eclipse.core.runtime.content.IContentType content type}.
25  * <p>
26  * This interface is intended to be implemented by clients.
27  * </p>
28  *
29  * @since 3.1
30  */
31 public interface ISpellingEngine {
32
33     /**
34      * Checks the given regions in the given document. Reports all found
35      * spelling problems to the collector.
36      *
37      * @param document the document to check
38      * @param regions the regions to check
39      * @param context the context
40      * @param collector the problem collector
41      * @param monitor the progress monitor, can be <code>null</code>
42      */
43     public void check(IDocument document, IRegion[] regions, SpellingContext context, ISpellingProblemCollector collector, IProgressMonitor monitor);
44 }
45
Popular Tags