Eclipse Plug-in Developer Guide (Galileo) - ISpellingProblemCollector (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 ISpellingProblemCollector

public interface ISpellingProblemCollector

A collector of SpellingProblems. The SpellingService service will report its results to such a collector.

An implementer may specify if a collector is thread aware, i.e., if problems can be reported by any thread, potentially in parallel, and thus, multiple reporting sessions may be active at the same time. Clients of concrete collectors in turn must evaluate the usage of their collector and chose an appropriate implementation.

This interface is intended to be implemented by clients.

Since:: 3.1
See Also:: SpellingService

Method Summary

void accept ( SpellingProblem problem)
          Notification of a spelling problem.

void beginCollecting ()
          Notification sent before starting to collect problems.

void endCollecting ()
          Notification sent after completing to collect problems.

Method Detail

accept

void accept(
SpellingProblem problem)

Notification of a spelling problem.

Parameters:: problem - the spelling problem

beginCollecting

void beginCollecting()

Notification sent before starting to collect problems. This method will be called by the spelling infrastructure and is not intended to be called by clients.

endCollecting

void endCollecting()

Notification sent after completing to collect problems. This method will be called by the spelling infrastructure and is not intended to be called by clients.