1 /*******************************************************************************
2 * Copyright (c) 2000, 2011 IBM Corporation and others.
3 * All rights reserved. This program and the accompanying materials
4 * are made available under the terms of the Eclipse Public License v1.0
5 * which accompanies this distribution, and is available at
6 * http://www.eclipse.org/legal/epl-v10.html
9 * IBM Corporation - initial API and implementation
10 *******************************************************************************/
11 package org.eclipse.jdt.internal.ui.refactoring.contentassist;
13 import java.util.ArrayList;
14 import java.util.Arrays;
16 import org.eclipse.swt.graphics.Image;
18 import org.eclipse.core.runtime.Assert;
20 import org.eclipse.jface.contentassist.IContentAssistSubjectControl;
21 import org.eclipse.jface.contentassist.ISubjectControlContentAssistProcessor;
22 import org.eclipse.jface.preference.IPreferenceStore;
23 import org.eclipse.jface.viewers.ILabelProvider;
25 import org.eclipse.jface.text.ITextViewer;
26 import org.eclipse.jface.text.contentassist.ICompletionProposal;
27 import org.eclipse.jface.text.contentassist.IContentAssistProcessor;
28 import org.eclipse.jface.text.contentassist.IContextInformation;
29 import org.eclipse.jface.text.contentassist.IContextInformationValidator;
31 import org.eclipse.jdt.core.IJavaElement;
32 import org.eclipse.jdt.core.IPackageFragment;
33 import org.eclipse.jdt.core.IPackageFragmentRoot;
34 import org.eclipse.jdt.core.JavaModelException;
36 import org.eclipse.jdt.ui.JavaElementLabelProvider;
37 import org.eclipse.jdt.ui.PreferenceConstants;
38 import org.eclipse.jdt.ui.text.java.CompletionProposalComparator;
40 import org.eclipse.jdt.internal.ui.JavaPlugin;
41 import org.eclipse.jdt.internal.ui.text.java.JavaCompletionProposal;
43 public class JavaPackageCompletionProcessor implements IContentAssistProcessor, ISubjectControlContentAssistProcessor {
45 private IPackageFragmentRoot fPackageFragmentRoot;
46 private CompletionProposalComparator fComparator;
47 private ILabelProvider fLabelProvider;
49 private char[] fProposalAutoActivationSet;
52 * Creates a <code>JavaPackageCompletionProcessor</code>.
53 * The completion context must be set via {@link #setPackageFragmentRoot(IPackageFragmentRoot)}.
55 public JavaPackageCompletionProcessor() {
56 this(new JavaElementLabelProvider(JavaElementLabelProvider.SHOW_SMALL_ICONS));
60 * Creates a <code>JavaPackageCompletionProcessor</code>.
61 * The Processor uses the given <code>ILabelProvider</code> to show text and icons for the
62 * possible completions.
63 * @param labelProvider Used for the popups.
65 public JavaPackageCompletionProcessor(ILabelProvider labelProvider) {
66 fComparator= new CompletionProposalComparator();
67 fLabelProvider= labelProvider;
69 IPreferenceStore preferenceStore= JavaPlugin.getDefault().getPreferenceStore();
70 String triggers= preferenceStore.getString(PreferenceConstants.CODEASSIST_AUTOACTIVATION_TRIGGERS_JAVA);
71 fProposalAutoActivationSet = triggers.toCharArray();
75 * @see org.eclipse.jface.text.contentassist.IContentAssistProcessor#computeCompletionProposals(org.eclipse.jface.text.ITextViewer, int)
77 public ICompletionProposal[] computeCompletionProposals(ITextViewer viewer, int documentOffset) {
78 Assert.isTrue(false, "ITextViewer not supported"); //$NON-NLS-1$
83 * @see org.eclipse.jface.text.contentassist.IContentAssistProcessor#computeContextInformation(org.eclipse.jface.text.ITextViewer, int)
85 public IContextInformation[] computeContextInformation(ITextViewer viewer, int documentOffset) {
86 Assert.isTrue(false, "ITextViewer not supported"); //$NON-NLS-1$
91 * @see org.eclipse.jface.text.contentassist.IContentAssistProcessor#getCompletionProposalAutoActivationCharacters()
93 public char[] getCompletionProposalAutoActivationCharacters() {
94 return fProposalAutoActivationSet;
98 * @see org.eclipse.jface.text.contentassist.IContentAssistProcessor#getContextInformationAutoActivationCharacters()
100 public char[] getContextInformationAutoActivationCharacters() {
105 * @see org.eclipse.jface.text.contentassist.IContentAssistProcessor#getErrorMessage()
107 public String getErrorMessage() {
112 * @see org.eclipse.jface.text.contentassist.IContentAssistProcessor#getContextInformationValidator()
114 public IContextInformationValidator getContextInformationValidator() {
115 return null; //no context
119 * @see ISubjectControlContentAssistProcessor#computeContextInformation(IContentAssistSubjectControl, int)
121 public IContextInformation[] computeContextInformation(IContentAssistSubjectControl contentAssistSubjectControl,
122 int documentOffset) {
127 * @see ISubjectControlContentAssistProcessor#computeCompletionProposals(IContentAssistSubjectControl, int)
129 public ICompletionProposal[] computeCompletionProposals(IContentAssistSubjectControl contentAssistSubjectControl, int documentOffset) {
130 if (fPackageFragmentRoot == null)
132 String input= contentAssistSubjectControl.getDocument().get();
133 ICompletionProposal[] proposals= createPackagesProposals(documentOffset, input);
134 Arrays.sort(proposals, fComparator);
138 public void setPackageFragmentRoot(IPackageFragmentRoot packageFragmentRoot) {
139 fPackageFragmentRoot= packageFragmentRoot;
142 private ICompletionProposal[] createPackagesProposals(int documentOffset, String input) {
143 ArrayList<JavaCompletionProposal> proposals= new ArrayList<JavaCompletionProposal>();
144 String prefix= input.substring(0, documentOffset);
146 IJavaElement[] packageFragments= fPackageFragmentRoot.getChildren();
147 for (int i= 0; i < packageFragments.length; i++) {
148 IPackageFragment pack= (IPackageFragment) packageFragments[i];
149 String packName= pack.getElementName();
150 if (packName.length() == 0 || ! packName.startsWith(prefix))
152 Image image= fLabelProvider.getImage(pack);
153 JavaCompletionProposal proposal= new JavaCompletionProposal(packName, 0, input.length(), image, fLabelProvider.getText(pack), 0);
154 proposals.add(proposal);
156 } catch (JavaModelException e) {
157 //fPackageFragmentRoot is not a proper root -> no proposals
159 return proposals.toArray(new ICompletionProposal[proposals.size()]);