net.sourceforge.phpeclipse.ui/src/net/sourceforge/phpdt/internal/ui/text/spelling/engine/ISpellEvent.java

   1 /*******************************************************************************
   2  * Copyright (c) 2000, 2003 IBM Corporation and others.
   3  * All rights reserved. This program and the accompanying materials
   4  * are made available under the terms of the Common Public License v1.0
   5  * which accompanies this distribution, and is available at
   6  * http://www.eclipse.org/legal/cpl-v10.html
   7  *
   8  * Contributors:
   9  *     IBM Corporation - initial API and implementation
  10  *******************************************************************************/
  11
  12 package net.sourceforge.phpdt.internal.ui.text.spelling.engine;
  13
  14 import java.util.Set;
  15
  16 /**
  17  * Event fired by spell-checkers.
  18  *
  19  * @since 3.0
  20  */
  21 public interface ISpellEvent {
  22
  23         /**
  24          * Returns the begin index of the incorrectly spelled word.
  25          *
  26          * @return The begin index of the word
  27          */
  28         public int getBegin();
  29
  30         /**
  31          * Returns the end index of the incorrectly spelled word.
  32          *
  33          * @return The end index of the word
  34          */
  35         public int getEnd();
  36
  37         /**
  38          * Returns the proposals for the incorrectly spelled word.
  39          *
  40          * @return Array of proposals for the word
  41          */
  42         public Set getProposals();
  43
  44         /**
  45          * Returns the incorrectly spelled word.
  46          *
  47          * @return The incorrect word
  48          */
  49         public String getWord();
  50
  51         /**
  52          * Was the incorrectly spelled word found in the dictionary?
  53          *
  54          * @return <code>true</code> iff the word was found, <code>false</code>
  55          *         otherwise
  56          */
  57         public boolean isMatch();
  58
  59         /**
  60          * Does the incorrectly spelled word start a new sentence?
  61          *
  62          * @return <code>true<code> iff the word starts a new sentence, <code>false</code> otherwise
  63          */
  64         public boolean isStart();
  65 }