net.sourceforge.phpeclipse.ui/src/net/sourceforge/phpdt/internal/ui/text/spelling/AddWordProposal.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;
  13
  14 import java.text.MessageFormat;
  15
  16 import net.sourceforge.phpdt.internal.ui.PHPUIMessages;
  17 import net.sourceforge.phpdt.internal.ui.PHPUiImages;
  18 import net.sourceforge.phpdt.internal.ui.text.java.IInvocationContext;
  19 import net.sourceforge.phpdt.internal.ui.text.java.IPHPCompletionProposal;
  20 import net.sourceforge.phpdt.internal.ui.text.spelling.engine.ISpellCheckEngine;
  21 import net.sourceforge.phpdt.internal.ui.text.spelling.engine.ISpellChecker;
  22 import net.sourceforge.phpdt.ui.PreferenceConstants;
  23
  24 import org.eclipse.jface.text.IDocument;
  25 import org.eclipse.jface.text.contentassist.IContextInformation;
  26 import org.eclipse.swt.graphics.Image;
  27 import org.eclipse.swt.graphics.Point;
  28
  29 /**
  30  * Proposal to add the unknown word to the dictionaries.
  31  *
  32  * @since 3.0
  33  */
  34 public class AddWordProposal implements IPHPCompletionProposal {
  35
  36         /** The invocation context */
  37         private final IInvocationContext fContext;
  38
  39         /** The word to add */
  40         private final String fWord;
  41
  42         /**
  43          * Creates a new add word proposal
  44          *
  45          * @param word
  46          *            The word to add
  47          * @param context
  48          *            The invocation context
  49          */
  50         public AddWordProposal(final String word, final IInvocationContext context) {
  51                 fContext = context;
  52                 fWord = word;
  53         }
  54
  55         /*
  56          * @see org.eclipse.jface.text.contentassist.ICompletionProposal#apply(org.eclipse.jface.text.IDocument)
  57          */
  58         public final void apply(final IDocument document) {
  59
  60                 final ISpellCheckEngine engine = SpellCheckEngine.getInstance();
  61                 final ISpellChecker checker = engine.createSpellChecker(engine
  62                                 .getLocale(), PreferenceConstants.getPreferenceStore());
  63
  64                 if (checker != null)
  65                         checker.addWord(fWord);
  66         }
  67
  68         /*
  69          * @see org.eclipse.jface.text.contentassist.ICompletionProposal#getAdditionalProposalInfo()
  70          */
  71         public String getAdditionalProposalInfo() {
  72                 return MessageFormat
  73                                 .format(
  74                                                 PHPUIMessages.getString("Spelling.add.info"), new String[] { WordCorrectionProposal.getHtmlRepresentation(fWord) }); //$NON-NLS-1$
  75         }
  76
  77         /*
  78          * @see org.eclipse.jface.text.contentassist.ICompletionProposal#getContextInformation()
  79          */
  80         public final IContextInformation getContextInformation() {
  81                 return null;
  82         }
  83
  84         /*
  85          * @see org.eclipse.jface.text.contentassist.ICompletionProposal#getDisplayString()
  86          */
  87         public String getDisplayString() {
  88                 return MessageFormat.format(PHPUIMessages
  89                                 .getString("Spelling.add.label"), new String[] { fWord }); //$NON-NLS-1$
  90         }
  91
  92         /*
  93          * @see org.eclipse.jface.text.contentassist.ICompletionProposal#getImage()
  94          */
  95         public Image getImage() {
  96                 return PHPUiImages.get(PHPUiImages.IMG_CORRECTION_ADD);
  97         }
  98
  99         /*
 100          * @see net.sourceforge.phpdt.ui.text.java.IJavaCompletionProposal#getRelevance()
 101          */
 102         public int getRelevance() {
 103                 return Integer.MIN_VALUE;
 104         }
 105
 106         /*
 107          * @see org.eclipse.jface.text.contentassist.ICompletionProposal#getSelection(org.eclipse.jface.text.IDocument)
 108          */
 109         public final Point getSelection(final IDocument document) {
 110                 return new Point(fContext.getSelectionOffset(), fContext
 111                                 .getSelectionLength());
 112         }
 113 }