/*******************************************************************************
* Copyright (c) 2000, 2003 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/cpl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package net.sourceforge.phpdt.internal.ui.text.spelling.engine;
import java.util.Set;
/**
* Event fired by spell-checkers.
*
* @since 3.0
*/
public interface ISpellEvent {
/**
* Returns the begin index of the incorrectly spelled word.
*
* @return The begin index of the word
*/
public int getBegin();
/**
* Returns the end index of the incorrectly spelled word.
*
* @return The end index of the word
*/
public int getEnd();
/**
* Returns the proposals for the incorrectly spelled word.
*
* @return Array of proposals for the word
*/
public Set getProposals();
/**
* Returns the incorrectly spelled word.
*
* @return The incorrect word
*/
public String getWord();
/**
* Was the incorrectly spelled word found in the dictionary?
*
* @return true
iff the word was found, false
* otherwise
*/
public boolean isMatch();
/**
* Does the incorrectly spelled word start a new sentence?
*
* @return true iff the word starts a new sentence, false
otherwise
*/
public boolean isStart();
}