content: /*******************************************************************************
   * Copyright (c) 2000, 2008 IBM Corporation and others.
   * All rights reserved. This program and the accompanying materials
   * are made available under the terms of the Eclipse Public License v1.0
   * which accompanies this distribution, and is available at
   * http://www.eclipse.org/legal/epl-v10.html
   *
   * Contributors:
   *     IBM Corporation - initial API and implementation
   *******************************************************************************/
  
  package org.eclipse.wst.jsdt.internal.ui.text.spelling.engine;
  
  import java.util.Set;
  
  /**
   * Event fired by spell checkers.
   *
   * 
   */
  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 <code>true</code> iff the word was found, <code>false</code> otherwise
  	 */
  	public boolean isMatch();
  
  	/**
  	 * Does the incorrectly spelled word start a new sentence?
  	 *
  	 * @return <code>true<code> iff the word starts a new sentence, <code>false</code> otherwise
  	 */
  	public boolean isStart();
  }
  