X-Git-Url: http://secure.phpeclipse.com diff --git a/net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/internal/ui/text/spelling/engine/SpellEvent.java b/net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/internal/ui/text/spelling/engine/SpellEvent.java new file mode 100644 index 0000000..da9d671 --- /dev/null +++ b/net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/internal/ui/text/spelling/engine/SpellEvent.java @@ -0,0 +1,111 @@ +/******************************************************************************* + * 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; + +/** + * Spell event fired for words detected by a spell-check iterator. + * + * @since 3.0 + */ +public class SpellEvent implements ISpellEvent { + + /** The begin index of the word in the spell-checkable medium */ + private final int fBegin; + + /** The spell-checker that causes the event */ + private final ISpellChecker fChecker; + + /** The end index of the word in the spell-checkable medium */ + private final int fEnd; + + /** Was the word found in the dictionary? */ + private final boolean fMatch; + + /** Does the word start a new sentence? */ + private final boolean fSentence; + + /** The word that causes the spell event */ + private final String fWord; + + /** + * Creates a new spell event. + * + * @param checker + * The spell-checker that causes the event + * @param word + * The word that causes the event + * @param begin + * The begin index of the word in the spell-checkable medium + * @param end + * The end index of the word in the spell-checkable medium + * @param sentence + * true iff the word starts a new sentence, + * false otherwise + * @param match + * true iff the word was found in the dictionary, + * false otherwise + */ + protected SpellEvent(final ISpellChecker checker, final String word, + final int begin, final int end, final boolean sentence, + final boolean match) { + fChecker = checker; + fEnd = end; + fBegin = begin; + fWord = word; + fSentence = sentence; + fMatch = match; + } + + /* + * @see net.sourceforge.phpdt.internal.ui.text.spelling.engine.ISpellEvent#getBegin() + */ + public final int getBegin() { + return fBegin; + } + + /* + * @see net.sourceforge.phpdt.internal.ui.text.spelling.engine.ISpellEvent#getEnd() + */ + public final int getEnd() { + return fEnd; + } + + /* + * @see net.sourceforge.phpdt.internal.ui.text.spelling.engine.ISpellEvent#getProposals() + */ + public final Set getProposals() { + return fChecker.getProposals(fWord, fSentence); + } + + /* + * @see net.sourceforge.phpdt.internal.ui.text.spelling.engine.ISpellEvent#getWord() + */ + public final String getWord() { + return fWord; + } + + /* + * @see net.sourceforge.phpdt.internal.ui.text.spelling.engine.ISpellEvent#isMatch() + */ + public final boolean isMatch() { + return fMatch; + } + + /* + * @see net.sourceforge.phpdt.internal.ui.text.spelling.engine.ISpellEvent#isStart() + */ + public final boolean isStart() { + return fSentence; + } +}