| /******************************************************************************* |
| * Copyright (c) 2000, 2007 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.jdt.internal.ui.text.spelling; |
| |
| import org.eclipse.swt.graphics.Image; |
| import org.eclipse.swt.graphics.Point; |
| import org.eclipse.swt.widgets.Shell; |
| |
| import org.eclipse.jface.dialogs.IDialogConstants; |
| import org.eclipse.jface.dialogs.MessageDialogWithToggle; |
| |
| import org.eclipse.jface.text.IDocument; |
| import org.eclipse.jface.text.contentassist.IContextInformation; |
| |
| import org.eclipse.ui.IEditorPart; |
| import org.eclipse.ui.IWorkbenchPage; |
| import org.eclipse.ui.dialogs.PreferencesUtil; |
| import org.eclipse.ui.texteditor.ITextEditor; |
| import org.eclipse.ui.texteditor.spelling.SpellingProblem; |
| |
| import org.eclipse.jdt.internal.corext.util.Messages; |
| |
| import org.eclipse.jdt.ui.PreferenceConstants; |
| import org.eclipse.jdt.ui.text.java.IInvocationContext; |
| import org.eclipse.jdt.ui.text.java.IJavaCompletionProposal; |
| |
| import org.eclipse.jdt.internal.ui.JavaPlugin; |
| import org.eclipse.jdt.internal.ui.JavaPluginImages; |
| import org.eclipse.jdt.internal.ui.JavaUIMessages; |
| import org.eclipse.jdt.internal.ui.text.spelling.engine.ISpellCheckEngine; |
| import org.eclipse.jdt.internal.ui.text.spelling.engine.ISpellChecker; |
| |
| /** |
| * Proposal to add the unknown word to the dictionaries. |
| * |
| * @since 3.0 |
| */ |
| public class AddWordProposal implements IJavaCompletionProposal { |
| |
| private static final String PREF_KEY_DO_NOT_ASK= "do_not_ask_to_install_user_dictionary"; //$NON-NLS-1$ |
| |
| /** The invocation context */ |
| private final IInvocationContext fContext; |
| |
| /** The word to add */ |
| private final String fWord; |
| |
| |
| /** |
| * Creates a new add word proposal |
| * |
| * @param word |
| * The word to add |
| * @param context |
| * The invocation context |
| */ |
| public AddWordProposal(final String word, final IInvocationContext context) { |
| fContext= context; |
| fWord= word; |
| } |
| |
| /* |
| * @see org.eclipse.jface.text.contentassist.ICompletionProposal#apply(org.eclipse.jface.text.IDocument) |
| */ |
| public final void apply(final IDocument document) { |
| |
| final ISpellCheckEngine engine= SpellCheckEngine.getInstance(); |
| final ISpellChecker checker= engine.getSpellChecker(); |
| |
| if (checker == null) |
| return; |
| |
| final ITextEditor editor= getEditor(); |
| |
| if (!checker.acceptsWords()) { |
| final Shell shell; |
| if (editor != null) |
| shell= editor.getEditorSite().getShell(); |
| else |
| shell= JavaPlugin.getActiveWorkbenchShell(); |
| |
| if (!canAskToConfigure() || !askUserToConfigureUserDictionary(shell)) |
| return; |
| |
| String[] preferencePageIds= new String[] { "org.eclipse.ui.editors.preferencePages.Spelling" }; //$NON-NLS-1$ |
| PreferencesUtil.createPreferenceDialogOn(shell, preferencePageIds[0], preferencePageIds, null).open(); |
| } |
| |
| if (checker.acceptsWords()) { |
| checker.addWord(fWord); |
| SpellingProblem.removeAllInActiveEditor(editor, fWord); |
| } |
| } |
| |
| /** |
| * Asks the user whether he wants to configure |
| * a user dictionary. |
| * |
| * @param shell |
| * @return <code>true</code> if the user wants to configure the user dictionary |
| * @since 3.3 |
| */ |
| private boolean askUserToConfigureUserDictionary(Shell shell) { |
| MessageDialogWithToggle toggleDialog= MessageDialogWithToggle.openYesNoQuestion( |
| shell, |
| JavaUIMessages.Spelling_add_askToConfigure_title, |
| JavaUIMessages.Spelling_add_askToConfigure_question, |
| JavaUIMessages.Spelling_add_askToConfigure_ignoreMessage, |
| false, |
| null, |
| null); |
| |
| PreferenceConstants.getPreferenceStore().setValue(PREF_KEY_DO_NOT_ASK, toggleDialog.getToggleState()); |
| |
| return toggleDialog.getReturnCode() == IDialogConstants.YES_ID; |
| } |
| |
| /** |
| * Tells whether this proposal can ask to |
| * configure a user dictionary. |
| * |
| * @return <code>true</code> if it can ask the user |
| */ |
| static boolean canAskToConfigure() { |
| return !PreferenceConstants.getPreferenceStore().getBoolean(PREF_KEY_DO_NOT_ASK); |
| } |
| |
| private ITextEditor getEditor() { |
| IWorkbenchPage activePage= JavaPlugin.getActivePage(); |
| if (activePage == null) |
| return null; |
| |
| IEditorPart editor= activePage.getActiveEditor(); |
| if (activePage.getActivePart() != editor || !(editor instanceof ITextEditor)) |
| return null; |
| |
| return (ITextEditor)editor; |
| |
| } |
| |
| /* |
| * @see org.eclipse.jface.text.contentassist.ICompletionProposal#getAdditionalProposalInfo() |
| */ |
| public String getAdditionalProposalInfo() { |
| return Messages.format(JavaUIMessages.Spelling_add_info, new String[] { WordCorrectionProposal.getHtmlRepresentation(fWord)}); |
| } |
| |
| /* |
| * @see org.eclipse.jface.text.contentassist.ICompletionProposal#getContextInformation() |
| */ |
| public final IContextInformation getContextInformation() { |
| return null; |
| } |
| |
| /* |
| * @see org.eclipse.jface.text.contentassist.ICompletionProposal#getDisplayString() |
| */ |
| public String getDisplayString() { |
| return Messages.format(JavaUIMessages.Spelling_add_label, new String[] { fWord }); |
| } |
| |
| /* |
| * @see org.eclipse.jface.text.contentassist.ICompletionProposal#getImage() |
| */ |
| public Image getImage() { |
| return JavaPluginImages.get(JavaPluginImages.IMG_CORRECTION_ADD); |
| } |
| |
| /* |
| * @see org.eclipse.jdt.ui.text.java.IJavaCompletionProposal#getRelevance() |
| */ |
| public int getRelevance() { |
| return Integer.MIN_VALUE; |
| } |
| |
| /* |
| * @see org.eclipse.jface.text.contentassist.ICompletionProposal#getSelection(org.eclipse.jface.text.IDocument) |
| */ |
| public final Point getSelection(final IDocument document) { |
| return new Point(fContext.getSelectionOffset(), fContext.getSelectionLength()); |
| } |
| } |