Eclipse Plug-in Developer Guide (Galileo) - ISpellingEngine (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.ui.texteditor.spelling
Interface ISpellingEngine

public interface ISpellingEngine

A spelling engine that can be contributed to the org.eclipse.ui.workbench.texteditor.spellingEngine extension point. The SpellingContext provides information about the content type to be checked. In general a spelling engine should at least support the text content type.

This interface is intended to be implemented by clients.

Since:: 3.1

Method Summary

void check ( IDocument document, IRegion[] regions, SpellingContext context, ISpellingProblemCollector collector, IProgressMonitor monitor)
Checks the given regions in the given document.

Method Detail

check

void check(
IDocument document,
           
IRegion[] regions,
           
SpellingContext context,
           
ISpellingProblemCollector collector,
           
IProgressMonitor monitor)

Checks the given regions in the given document. Reports all found spelling problems to the collector.

Parameters:: document - the document to check; regions - the regions to check; context - the context; collector - the problem collector; monitor - the progress monitor, can be null