Attachment #116107 for bug #204867

This Bugzilla instance is a read-only archive of historic NetBeans bug reports. To report a bug in NetBeans please follow the project's instructions for reporting issues.

View | Details | Raw Unified | Return to bug 204867
Collapse All | Expand All

Lines 50-55 Link Here

(-)a/editor.completion/nbproject/project.xml (+9 lines)
50	<code-name-base>org.netbeans.modules.editor.completion</code-name-base>	50	<code-name-base>org.netbeans.modules.editor.completion</code-name-base>
51	<module-dependencies>	51	<module-dependencies>
52	<dependency>	52	<dependency>
		53	<code-name-base>org.netbeans.api.annotations.common</code-name-base>
		54	<build-prerequisite/>
		55	<compile-dependency/>
		56	<run-dependency>
		57	<release-version>1</release-version>
		58	<specification-version>1.11</specification-version>
		59	</run-dependency>
		60	</dependency>
		61	<dependency>
53	<code-name-base>org.netbeans.modules.editor</code-name-base>	62	<code-name-base>org.netbeans.modules.editor</code-name-base>
54	<build-prerequisite/>	63	<build-prerequisite/>
55	<compile-dependency/>	64	<compile-dependency/>




import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;
import java.lang.ref.WeakReference;
import java.lang.reflect.Array;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;

    
    private static final int PLEASE_WAIT_TIMEOUT = 750;
    private static final int PRESCAN = 25;

    /**
     * A default {@link CompletionController} which is used for the "Please wait..."
     * and "No suggestions" completion results.
     */
    private final CompletionController FALLBACK_COMPLETION_CONTROLLER =
        new CompletionController() {
            @Override
            public void sortItems(List<? extends CompletionItem> items, int sortType) {
                assert items.size() == 1;
            }

            @Override
            public Selection getSelection(List<? extends CompletionItem> items) {
                assert items.size() == 1;
                return Selection.DEFAULT;
            }

            @Override
            public void defaultAction(CompletionItem bestMatch, boolean isSelected) {
                if (isSelected) {
                    bestMatch.defaultAction(getActiveComponent());
                }
            }

            @Override
            public void processKeyEvent(KeyEvent evt, CompletionItem bestMatch,
            boolean isSelected) {
                bestMatch.processKeyEvent(evt);
            }

            @Override
            public void render(Graphics g, Font defaultFont, Color foregroundColor,
            Color backgroundColor, Color selectedForegroundColor,
            Color selectedBackgroundColor, int width, int height, CompletionItem item,
            boolean isBestMatch, boolean isSelected) {
                if (isBestMatch) {
                    // Clear the background
                    g.setColor(selectedBackgroundColor);
                    g.fillRect(0, 0, width, height);
                    g.setColor(selectedForegroundColor);
                    item.render(g, defaultFont, selectedForegroundColor,
                            selectedBackgroundColor, width, height, isBestMatch);
                } else {
                    // Clear the background
                    g.setColor(backgroundColor);
                    g.fillRect(0, 0, width, height);
                    g.setColor(foregroundColor);
                    item.render(g, defaultFont, foregroundColor, backgroundColor,
                            width, height, isBestMatch);
                }
            }

            @Override
            public boolean instantSubstitution(CompletionItem uniqueMatch) {
                return uniqueMatch.instantSubstitution(getActiveComponent());
            }
        };
    
    public static CompletionImpl get() {
        if (singleton == null)

    /* Completion providers registered for the active component (its mime-type). Changed in AWT only. */
    private CompletionProvider[] activeProviders = null;
    
    /** Completion providers registered for the active component (its mime-type). Changed in AWT only. */
    private CompletionControllerProvider[] activeControllerProviders = null;
    
    /** Mapping of mime-type to service provider type to array of providers. Changed in AWT only. */
    private HashMap<String, HashMap<Class<?>, Object[]>> providersCache =
        new HashMap<String, HashMap<Class<?>, Object[]>>();

    /**
     * Result of the completion query.

        
        docAutoPopupTimer = new Timer(0, new ActionListener() {
            public void actionPerformed(ActionEvent e) {
                SelectedCompletionItem selectedItem = layout.getSelectedCompletionItem();
                CompletionItem currentSelectedItem = selectedItem != null ? selectedItem.getItem() : null;
                if (lastSelectedItem == null || lastSelectedItem.get() != currentSelectedItem)
                    showDocumentation();
            }
        });

                    }
                }
                layout.showCompletion(Collections.singletonList(waitText),
                        null, -1, CompletionImpl.this, null, null,
                        FALLBACK_COMPLETION_CONTROLLER,
                        CompletionController.Selection.DEFAULT);
                pleaseWaitDisplayed = true;
                if (!politeWaitText) {
                    long when = System.currentTimeMillis() - PLEASE_WAIT_TIMEOUT;

                            CompletionSettings.getInstance(getActiveComponent()).completionAutoPopup()) {
                        autoModEndOffset = modEndOffset;
                        if (completionResultNull)
                            showCompletion(false, false, true, type & (CompletionProvider.COMPLETION_QUERY_MASK | CompletionProvider.USER_QUERY_MASK));
                    }

                    boolean tooltipResultNull;

    }
    
    private void initActiveProviders(JTextComponent component) {
        activeProviders = initActiveProviders(CompletionProvider.class, component);
        // currently only one async warm up task is allowed at once
        activeControllerProviders = null;
    }
    
    private <T> T[] initActiveProviders(Class<T> clazz, JTextComponent component) {
        T[] providers = (component != null)
                ? getProvidersForComponent(clazz, component, true)
                : null;

        if (LOG.isLoggable(Level.FINE)) {
            StringBuilder sb = new StringBuilder(clazz.getName() + " PROVIDERS:\n"); // NOI18N
            if (providers != null) {
                for (int i = 0; i < providers.length; i++) {
                    sb.append("providers["); // NOI18N
                    sb.append(i);
                    sb.append("]: "); // NOI18N
                    sb.append(providers[i].getClass());
                    sb.append('\n');
                }
            }
            LOG.fine(sb.toString());
        }
        
        return providers;
    }
    
    private boolean ensureActiveProviders() {
        activeProviders = ensureActiveProviders(CompletionProvider.class, activeProviders);
        activeControllerProviders = ensureActiveProviders(CompletionControllerProvider.class, activeControllerProviders);
        // allow activeControllerProviders to be null since we have a
        // DefaultCompletionControllerProvider to fall back on.
        return activeProviders != null;
    }
    
    private <T> T[] ensureActiveProviders(Class<T> clazz, T[] providers) {
        if (providers != null)
            return providers;
        JTextComponent component = getActiveComponent();
        providers = (component != null)
                ? getProvidersForComponent(clazz, component, false)
                : null;
        if (LOG.isLoggable(Level.FINE)) {
            StringBuilder sb = new StringBuilder(clazz.getName() + " PROVIDERS:\n"); // NOI18N
            if (providers != null) {
                for (int i = 0; i < providers.length; i++) {
                    sb.append("providers["); // NOI18N
                    sb.append(i);
                    sb.append("]: "); // NOI18N
                    sb.append(providers[i].getClass());
                    sb.append('\n');
                }
            }
            LOG.fine(sb.toString());
        }
        return providers;
    }
    
    private void restartCompletionAutoPopupTimer() {

        docAutoPopupTimer.setInitialDelay(docDelay);
        docAutoPopupTimer.restart();
    }

    private <T> T[] getProvidersForComponent(final Class<T> clazz, JTextComponent component, boolean asyncWarmUp) {
        assert (SwingUtilities.isEventDispatchThread());

        if (component == null)

            BaseKit kit = Utilities.getKit(component);
            
            if (kit == null) {
                @SuppressWarnings("unchecked")
                T[] result = (T[])Array.newInstance(clazz, 0);
                return result;
            }
            
            mimeType = kit.getContentType();
        }
        
        HashMap<Class<?>, Object[]> providers = providersCache.get(mimeType);
        if (providers == null) {
            providers = new HashMap<Class<?>, Object[]>();
            providersCache.put(mimeType, providers);
        }

        if (providers.containsKey(clazz)) {
            @SuppressWarnings("unchecked")
            T[] result = (T[])providers.get(clazz);
            return result;
        }
        
        if (asyncWarmUpTask != null) {
            if (asyncWarmUp && mimeType != null && mimeType.equals(asyncWarmUpMimeType))
                return null;

            asyncWarmUpTask = null;
            asyncWarmUpMimeType = null;
        }

        final Lookup lookup = MimeLookup.getLookup(MimePath.get(mimeType));
        if (asyncWarmUp) {
            asyncWarmUpMimeType = mimeType;
            asyncWarmUpTask = RequestProcessor.getDefault().post(new Runnable() {
                @Override
                public void run() {
                    lookup.lookupAll(clazz);
                }
            });
            return null;
        }

        Collection<? extends T> col = lookup.lookupAll(clazz);
        int size = col.size();
        @SuppressWarnings("unchecked")
        T[] ret = size == 0 ? null : col.toArray((T[])Array.newInstance(clazz, size));
        providers.put(clazz, ret);
        return ret;
    }

    private void dispatchKeyEvent(KeyEvent e) {
        if (e == null)
            return;

            }
        }
        if (layout.isCompletionVisible()) {
            SelectedCompletionItem item = layout.getSelectedCompletionItem();
            if (item != null && completionResult != null) {
                sendUndoableEdit(doc, CloneableEditorSupport.BEGIN_COMMIT_GROUP);
                try {
                    if (compEditable && !guardedPos) {
                        LogRecord r = new LogRecord(Level.FINE, "COMPL_KEY_SELECT"); // NOI18N
                        r.setParameters(new Object[] {e.getKeyChar(), layout.getSelectedIndex(), item.getItem().getClass().getSimpleName()});
                        completionResult.getController().processKeyEvent(e, item.getItem(), item.isSelected());
                        if (e.isConsumed()) {
                            uilog(r);
                            return;
                        }
                    }
                    // Call default action if ENTER was pressed and the item is selected
                    // TODO: move this functionality to the CompletionController
                    if (item.isSelected() && e.getKeyCode() == KeyEvent.VK_ENTER && e.getID() == KeyEvent.KEY_PRESSED) {
                        e.consume();
                        if (guardedPos) {
                            Toolkit.getDefaultToolkit().beep();

                                consumeIdentifier();
                            }
                            LogRecord r = new LogRecord(Level.FINE, "COMPL_KEY_SELECT_DEFAULT"); // NOI18N
                            r.setParameters(new Object[]{'\n', layout.getSelectedIndex(), item.getItem().getClass().getSimpleName()});
                            completionResult.getController().defaultAction(item.getItem(), item.isSelected());
                            uilog(r);
                        }
                        return;

                    || e.getKeyCode() == KeyEvent.VK_HOME || e.getKeyCode() == KeyEvent.VK_END) {
                hideCompletion(false);                
            }
            // TODO: move this functionality to the CompletionController
            if (e.getKeyCode() == KeyEvent.VK_TAB && doc.getProperty(CT_HANDLER_DOC_PROPERTY) == null) {
                e.consume();
                if (guardedPos) {

            }
        } else {
            completionCancel();
            if (explicitQuery) {
                layout.showCompletion(Collections.singletonList(NO_SUGGESTIONS),
                      null, -1, CompletionImpl.this, null, null,
                      FALLBACK_COMPLETION_CONTROLLER,
                      CompletionController.Selection.DEFAULT);
            }
            pleaseWaitDisplayed = false;
            stopProfiling();
        }

                    return;
                }
            }
            SelectedCompletionItem item = layout.getSelectedCompletionItem();
            if (item != null)
                localCompletionResult.getController().defaultAction(item.getItem(), item.isSelected());
        }
    }
    

        
        final ArrayList<CompletionItem> sortedResultItems = new ArrayList<CompletionItem>(size = resultItems.size());
        if (size > 0) {
            result.getController().sortItems(resultItems, getSortType());
            int cnt = 0;
            for(int i = 0; i < size; i++) {
                CompletionItem item = resultItems.get(i);                


        final boolean noSuggestions = sortedResultItems.size() == 0;
        if (noSuggestions) {
            if (hasAdditionalItems && (qType & CompletionProvider.COMPLETION_ALL_QUERY_TYPE) != CompletionProvider.COMPLETION_ALL_QUERY_TYPE) {
                showCompletion(this.explicitQuery, this.refreshedQuery, false, CompletionProvider.COMPLETION_ALL_QUERY_TYPE);
                return;
            }
            if (!explicitQuery) {
                hideCompletion(false);
                return;
            }

                Document doc = c.getDocument();
                CompletionSettings cs = CompletionSettings.getInstance(c);
                int caretOffset = c.getSelectionStart();

                CompletionController.Selection selection = result.getController().getSelection(sortedResultItems);
                // the CompletionController should be returning a valid selection
                assert selection != null
                    && (sortedResultItems.isEmpty()
                        || selection.getIndex() >= 0 && selection.getIndex() < sortedResultItems.size());
                if (selection == null || selection.getIndex() < 0 || selection.getIndex() > sortedResultItems.size()) {
                    selection = CompletionController.Selection.DEFAULT;
                }

                if (selection.isUnique() && !refreshedQuery && explicitQuery
                        && cs.completionInstantSubstitution()
                        && c.isEditable() && !(doc instanceof GuardedDocument && ((GuardedDocument)doc).isPosGuarded(caretOffset))) {

                    sendUndoableEdit(doc, CloneableEditorSupport.BEGIN_COMMIT_GROUP);
                    try {
                        if (result.getController().instantSubstitution(sortedResultItems.get(selection.getIndex())))
                            return;
                    } finally {
                        sendUndoableEdit(doc, CloneableEditorSupport.END_COMMIT_GROUP);
                            try {
                                if (item.instantSubstitution(c))
                                    return;
                            } finally {
                                sendUndoableEdit(doc, CloneableEditorSupport.END_COMMIT_GROUP);
                            }
                        }
                    } catch (BadLocationException ex) {
                    }
                }
                
                int selectedIndex = getCompletionPreSelectionIndex(sortedResultItems);
                c.putClientProperty("completion-visible", Boolean.TRUE);
                layout.showCompletion(
                        noSuggestions ? Collections.singletonList(NO_SUGGESTIONS) : sortedResultItems,
                        displayTitle, displayAnchorOffset, CompletionImpl.this,
                        displayAdditionalItems ? hasAdditionalItemsText.toString() : null,
                        displayAdditionalItems ? completionShortcut : null,
                        result.getController(),
                        selection);
                pleaseWaitDisplayed = false;
                stopProfiling();


        };
        runInAWT(requestShowRunnable);
    }
    
    private int getCompletionPreSelectionIndex(List<CompletionItem> items) {
        String prefix = null;
        if(getActiveDocument() instanceof BaseDocument) {
            BaseDocument doc = (BaseDocument)getActiveDocument();
            int caretOffset = getActiveComponent().getSelectionStart();
            try {
                int[] block = Utilities.getIdentifierBlock(doc, caretOffset);
                if (block != null) {
                    block[1] = caretOffset;
                    prefix = doc.getText(block);
                }
            } catch (BadLocationException ble) {
            }
        }
        if (prefix != null && prefix.length() > 0) {
            int idx = 0;
            for (CompletionItem item : items) {
                CharSequence text = item.getInsertPrefix();
                if (text != null && text.toString().startsWith(prefix))
                    return idx;
                idx++;
            }
        }
        return 0;
    }

    /**
     * May be called from any thread. The UI changes will be rescheduled into AWT.

        List<CompletionResultSetImpl> documentationResultSets = docResult.getResultSets();

        CompletionTask docTask;
        SelectedCompletionItem selectedItem = layout.getSelectedCompletionItem();
        if (selectedItem != null) {
            lastSelectedItem = new WeakReference<CompletionItem>(selectedItem.getItem());
            docTask = selectedItem.getItem().createDocumentationTask();
            if (docTask != null) { // attempt the documentation for selected item
                CompletionResultSetImpl resultSet = new CompletionResultSetImpl(
                        this, newDocumentationResult, docTask, CompletionProvider.DOCUMENTATION_QUERY_TYPE);

        List<CompletionResultSetImpl> toolTipResultSets = newToolTipResult.getResultSets();

        CompletionTask toolTipTask;
        SelectedCompletionItem selectedItem = layout.getSelectedCompletionItem();
        if (selectedItem != null && (toolTipTask = selectedItem.getItem().createToolTipTask()) != null) {
            CompletionResultSetImpl resultSet = new CompletionResultSetImpl(
                    this, newToolTipResult, toolTipTask, CompletionProvider.TOOLTIP_QUERY_TYPE);
            toolTipResultSets.add(resultSet);

    void finishNotify(CompletionResultSetImpl finishedResult) {
        Result localResult;
        boolean finished = false;
        switch (finishedResult.getQueryType() & CompletionProvider.RESERVED_QUERY_MASK) {
            case CompletionProvider.COMPLETION_QUERY_TYPE:
            case CompletionProvider.COMPLETION_ALL_QUERY_TYPE:
                synchronized (this) {

    private static CompletionResultSetImpl findFirstValidResult(List<CompletionResultSetImpl> resultSets) {
        for (int i = 0; i < resultSets.size(); i++) {
            CompletionResultSetImpl result = resultSets.get(i);
            switch (result.getQueryType() & CompletionProvider.RESERVED_QUERY_MASK) {
                case CompletionProvider.DOCUMENTATION_QUERY_TYPE:
                    if (result.getDocumentation() != null) {
                        return result;

        private boolean invoked;                
        private boolean cancelled;
        private boolean beforeQuery = true;

        private CompletionController controller;
        
        Result(int resultSetsSize) {
            resultSets = new ArrayList<CompletionResultSetImpl>(resultSetsSize);

            return resultSets;
        }

        CompletionController getController() {
            synchronized (resultSets) {
                if (controller == null) {
                    if (resultSets.isEmpty()) {
                        return FALLBACK_COMPLETION_CONTROLLER;
                    }

                    JTextComponent component = getActiveComponent();
                    CompletionTask task = resultSets.get(0).getTask();
                    int queryType = resultSets.get(0).getQueryType();
                    CompletionControllerProvider[] providers = activeControllerProviders;
                    if (providers != null) {
                        for (CompletionControllerProvider provider : providers) {
                            controller = provider.createController(component, task, queryType);
                            if (controller != null) {
                                break;
                            }
                        }
                    }

                    if (controller == null) {
                        CompletionControllerProvider provider =
                            DefaultCompletionControllerProvider.INSTANCE;
                        controller = provider.createController(component, task, queryType);
                    }
                }

                return controller;
            }
        }

        /**
         * Cancel the resultSets.
         * <br>




/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 1997-2010 Oracle and/or its affiliates. All rights reserved.
 *
 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.
 * Other names may be trademarks of their respective owners.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common
 * Development and Distribution License("CDDL") (collectively, the
 * "License"). You may not use this file except in compliance with the
 * License. You can obtain a copy of the License at
 * http://www.netbeans.org/cddl-gplv2.html
 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
 * specific language governing permissions and limitations under the
 * License.  When distributing the software, include this License Header
 * Notice in each file and include the License file at
 * nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the GPL Version 2 section of the License file that
 * accompanied this code. If applicable, add the following below the
 * License Header, with the fields enclosed by brackets [] replaced by
 * your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * Contributor(s):
 *
 * The Original Software is NetBeans. The Initial Developer of the Original
 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
 * Microsystems, Inc. All Rights Reserved.
 *
 * If you wish your version of this file to be governed by only the CDDL
 * or only the GPL Version 2, indicate your decision by adding
 * "[Contributor] elects to include this software in this distribution
 * under the [CDDL or GPL Version 2] license." If you do not indicate a
 * single choice of license, a recipient has the option to distribute
 * your version of this file under either the CDDL, the GPL Version 2 or
 * to extend the choice of license to its licensees as provided above.
 * However, if you add GPL Version 2 code and therefore, elected the GPL
 * Version 2 license, then the option applies only if the new code is
 * made subject to such option by the copyright holder.
 */

package org.netbeans.modules.editor.completion;

import java.util.Comparator;
import org.netbeans.spi.editor.completion.CompletionItem;
import org.netbeans.spi.editor.completion.CompletionResultSet;

/**
 * Comparator for completion items either by sort priority or by sort text.
 *
 * @author Dusan Balek, Miloslav Metelka
 */

public class CompletionItemComparator implements Comparator<CompletionItem> {

    public static final Comparator<CompletionItem> BY_PRIORITY = new CompletionItemComparator(true);

    public static final Comparator<CompletionItem> ALPHABETICAL = new CompletionItemComparator(false);
    
    private final boolean byPriority;
    
    private CompletionItemComparator(boolean byPriority) {
        this.byPriority = byPriority;
    }
    
    public static final Comparator<CompletionItem> get(int sortType) {
        if (sortType == CompletionResultSet.PRIORITY_SORT_TYPE)
            return BY_PRIORITY;
        if (sortType == CompletionResultSet.TEXT_SORT_TYPE)
            return ALPHABETICAL;
        throw new IllegalArgumentException();
    }
    
    public int compare(CompletionItem i1, CompletionItem i2) {
        if (i1 == i2)
            return 0;
        if (byPriority) {
            int importanceDiff = i1.getSortPriority() - i2.getSortPriority();
            if (importanceDiff != 0)
                return importanceDiff;
            int alphabeticalDiff = compareText(i1.getSortText(), i2.getSortText());
            return alphabeticalDiff;
        } else {
            int alphabeticalDiff = compareText(i1.getSortText(), i2.getSortText());
            if (alphabeticalDiff != 0)
                return alphabeticalDiff;
            int importanceDiff = i1.getSortPriority() - i2.getSortPriority();
            return importanceDiff;
        }
    }
    
    private static int compareText(CharSequence text1, CharSequence text2) {
        if (text1 == null)
            text1 = ""; //NOI18N
        if (text2 == null)
            text2 = ""; //NOI18N
        int len = Math.min(text1.length(), text2.length());
        for (int i = 0; i < len; i++) {
            char ch1 = text1.charAt(i);
            char ch2 = text2.charAt(i);
            if (ch1 != ch2) {
                return ch1 - ch2;
            }
        }
        return text1.length() - text2.length();
    }

}

Lines 53-60 Link Here

(-)a/editor.completion/src/org/netbeans/modules/editor/completion/CompletionJList.java (-40 / +66 lines)
53	import javax.accessibility.AccessibleContext;	53	import javax.accessibility.AccessibleContext;
54	import javax.swing.*;	54	import javax.swing.*;
55	import javax.swing.text.JTextComponent;	55	import javax.swing.text.JTextComponent;
		56	import org.netbeans.api.annotations.common.NonNull;
56		57
57	import org.netbeans.editor.LocaleSupport;	58	import org.netbeans.editor.LocaleSupport;
		59	import org.netbeans.spi.editor.completion.CompletionController;
58	import org.netbeans.spi.editor.completion.CompletionItem;	60	import org.netbeans.spi.editor.completion.CompletionItem;
59	import org.netbeans.spi.editor.completion.LazyCompletionItem;	61	import org.netbeans.spi.editor.completion.LazyCompletionItem;
60		62
Lines 75-80 Link Here
75	private int maxVisibleRowCount;	77	private int maxVisibleRowCount;
76	private JTextComponent editorComponent;	78	private JTextComponent editorComponent;
77	private int smartIndex;	79	private int smartIndex;
		80	/** The current completion controller. */
		81	private CompletionController controller;
		82	/** <code>true</code> if the best match is selected, otherwise <code>false</code>. */
		83	private boolean isSelected;
78		84
79	public CompletionJList(int maxVisibleRowCount, MouseListener mouseListener, JTextComponent editorComponent) {	85	public CompletionJList(int maxVisibleRowCount, MouseListener mouseListener, JTextComponent editorComponent) {
80	this.maxVisibleRowCount = maxVisibleRowCount;	86	this.maxVisibleRowCount = maxVisibleRowCount;
Lines 91-118 Link Here
91	setCellRenderer(new ListCellRenderer() {	97	setCellRenderer(new ListCellRenderer() {
92	private ListCellRenderer defaultRenderer = new DefaultListCellRenderer();	98	private ListCellRenderer defaultRenderer = new DefaultListCellRenderer();
93		99
94	public Component getListCellRendererComponent(JList list, Object value, int index, boolean isSelected, boolean cellHasFocus) {	100	@Override
		101	public Component getListCellRendererComponent(JList list, Object value, int index, boolean isBestMatch, boolean cellHasFocus) {
95	if( value instanceof CompletionItem ) {	102	if( value instanceof CompletionItem ) {
96	CompletionItem item = (CompletionItem)value;	103	CompletionItem item = (CompletionItem)value;
97	renderComponent.setItem(item);	104	renderComponent.setItem(item);
98	renderComponent.setSelected(isSelected);	105	renderComponent.setSelected(isBestMatch, isBestMatch && CompletionJList.this.isSelected);
99	renderComponent.setSeparator(smartIndex > 0 && smartIndex == index);	106	renderComponent.setSeparator(smartIndex > 0 && smartIndex == index);
100	Color bgColor;	107	Color bgColor = list.getBackground();
101	Color fgColor;	108	Color bgSelectedColor = list.getSelectionBackground();
102	if (isSelected) {	109	Color fgColor = list.getForeground();
103	bgColor = list.getSelectionBackground();	110	Color fgSelectedColor = list.getSelectionForeground();
104	fgColor = list.getSelectionForeground();	111	if ((index % 2) == 0) { // every second item slightly different
105	} else { // not selected	112	bgColor = new Color(
106	bgColor = list.getBackground();	113	Math.abs(bgColor.getRed() - DARKER_COLOR_COMPONENT),
107	if ((index % 2) == 0) { // every second item slightly different	114	Math.abs(bgColor.getGreen() - DARKER_COLOR_COMPONENT),
108	bgColor = new Color(	115	Math.abs(bgColor.getBlue() - DARKER_COLOR_COMPONENT)
109	Math.abs(bgColor.getRed() - DARKER_COLOR_COMPONENT),	116	);
110	Math.abs(bgColor.getGreen() - DARKER_COLOR_COMPONENT),
111	Math.abs(bgColor.getBlue() - DARKER_COLOR_COMPONENT)
112	);
113	}
114	fgColor = list.getForeground();
115	}	117	}
		118
		119	renderComponent.setColors(fgColor, bgColor, fgSelectedColor, bgSelectedColor);
116	// quick check Component.setBackground() always fires change	120	// quick check Component.setBackground() always fires change
117	if (renderComponent.getBackground() != bgColor) {	121	if (renderComponent.getBackground() != bgColor) {
118	renderComponent.setBackground(bgColor);	122	renderComponent.setBackground(bgColor);
Lines 123-129 Link Here
123	return renderComponent;	127	return renderComponent;
124		128
125	} else {	129	} else {
126	return defaultRenderer.getListCellRendererComponent( list, value, index, isSelected, cellHasFocus);	130	return defaultRenderer.getListCellRendererComponent( list, value, index, isBestMatch, cellHasFocus);
127	}	131	}
128	}	132	}
129	});	133	});
Lines 148-155 Link Here
148	}	152	}
149	}	153	}
150		154
151	void setData(List data) {	155	void setData(List data, @NonNull CompletionController controller) {
152	smartIndex = -1;	156	smartIndex = -1;
		157	this.controller = controller;
153	if (data != null) {	158	if (data != null) {
154	int itemCount = data.size();	159	int itemCount = data.size();
155	ListCellRenderer renderer = getCellRenderer();	160	ListCellRenderer renderer = getCellRenderer();
Lines 179-185 Link Here
179	setModel(lm);	184	setModel(lm);
180		185
181	if (itemCount > 0) {	186	if (itemCount > 0) {
182	setSelectedIndex(0);	187	setSelection(0, false);
183	}	188	}
184	int visibleRowCount = Math.min(itemCount, maxVisibleRowCount);	189	int visibleRowCount = Math.min(itemCount, maxVisibleRowCount);
185	setVisibleRowCount(visibleRowCount);	190	setVisibleRowCount(visibleRowCount);
Lines 214-219 Link Here
214	updateAccessible();	219	updateAccessible();
215	}	220	}
216	}	221	}
		222
		223	public @NonNull CompletionController.Selection getSelection() {
		224	return new CompletionController.Selection(getSelectedIndex(), isSelected);
		225	}
		226
		227	public void setSelection(@NonNull CompletionController.Selection selection) {
		228	setSelection(selection.getIndex(), selection.isSelected());
		229	}
		230
		231	public void setSelection(int index, boolean isSelected) {
		232	this.isSelected = isSelected;
		233	setSelectedIndex(index);
		234	}
217		235
218	private JLabel accessibleLabel;	236	private JLabel accessibleLabel;
219	private JLabel accessibleFakeLabel;	237	private JLabel accessibleFakeLabel;
Lines 241-247 Link Here
241	int idx = (getSelectedIndex() - 1 + size) % size;	259	int idx = (getSelectedIndex() - 1 + size) % size;
242	while(idx > 0 && getModel().getElementAt(idx) == null)	260	while(idx > 0 && getModel().getElementAt(idx) == null)
243	idx--;	261	idx--;
244	setSelectedIndex(idx);	262	setSelection(idx, true);
245	ensureIndexIsVisible(idx);	263	ensureIndexIsVisible(idx);
246	}	264	}
247	}	265	}
Lines 254-260 Link Here
254	idx++;	272	idx++;
255	if (idx == size)	273	if (idx == size)
256	idx = 0;	274	idx = 0;
257	setSelectedIndex(idx);	275	setSelection(idx, true);
258	ensureIndexIsVisible(idx);	276	ensureIndexIsVisible(idx);
259	}	277	}
260	}	278	}
Lines 265-271 Link Here
265	int idx = Math.max(getSelectedIndex() - pageSize, 0);	283	int idx = Math.max(getSelectedIndex() - pageSize, 0);
266	while(idx > 0 && getModel().getElementAt(idx) == null)	284	while(idx > 0 && getModel().getElementAt(idx) == null)
267	idx--;	285	idx--;
268	setSelectedIndex(idx);	286	setSelection(idx, true);
269	ensureIndexIsVisible(idx);	287	ensureIndexIsVisible(idx);
270	}	288	}
271	}	289	}
Lines 282-295 Link Here
282	while(idx > 0 && getModel().getElementAt(idx) == null)	300	while(idx > 0 && getModel().getElementAt(idx) == null)
283	idx--;	301	idx--;
284	}	302	}
285	setSelectedIndex(idx);	303	setSelection(idx, true);
286	ensureIndexIsVisible(idx);	304	ensureIndexIsVisible(idx);
287	}	305	}
288	}	306	}
289		307
290	public void begin() {	308	public void begin() {
291	if (getModel().getSize() > 0) {	309	if (getModel().getSize() > 0) {
292	setSelectedIndex(0);	310	setSelection(0, true);
293	ensureIndexIsVisible(0);	311	ensureIndexIsVisible(0);
294	}	312	}
295	}	313	}
Lines 300-306 Link Here
300	int idx = size - 1;	318	int idx = size - 1;
301	while(idx > 0 && getModel().getElementAt(idx) == null)	319	while(idx > 0 && getModel().getElementAt(idx) == null)
302	idx--;	320	idx--;
303	setSelectedIndex(idx);	321	setSelection(idx, true);
304	ensureIndexIsVisible(idx);	322	ensureIndexIsVisible(idx);
305	}	323	}
306	}	324	}
Lines 323-340 Link Here
323	}	341	}
324		342
325	private final class RenderComponent extends JComponent {	343	private final class RenderComponent extends JComponent {
326		344
327	private CompletionItem item;	345	private CompletionItem item;
328		346
329	private boolean selected;	347	private boolean isBestMatch;
		348	private boolean isSelected;
330	private boolean separator;	349	private boolean separator;
		350
		351	private Color fgColor;
		352	private Color bgColor;
		353	private Color fgSelectedColor;
		354	private Color bgSelectedColor;
331		355
332	void setItem(CompletionItem item) {	356	void setItem(CompletionItem item) {
333	this.item = item;	357	this.item = item;
334	}	358	}
335		359
336	void setSelected(boolean selected) {	360	void setSelected(boolean isBestMatch, boolean isSelected) {
337	this.selected = selected;	361	this.isBestMatch = isBestMatch;
		362	this.isSelected = isSelected;
338	}	363	}
339		364
340	void setSeparator(boolean separator) {	365	void setSeparator(boolean separator) {
Lines 349-366 Link Here
349	// of the widest item).	374	// of the widest item).
350	// Therefore the item's render width is taken from the viewport's width.	375	// Therefore the item's render width is taken from the viewport's width.
351	int itemRenderWidth = ((JViewport)CompletionJList.this.getParent()).getWidth();	376	int itemRenderWidth = ((JViewport)CompletionJList.this.getParent()).getWidth();
352	Color bgColor = getBackground();
353	Color fgColor = getForeground();
354	int height = getHeight();	377	int height = getHeight();
355		378
356	// Clear the background
357	g.setColor(bgColor);
358	g.fillRect(0, 0, itemRenderWidth, height);
359	g.setColor(fgColor);
360
361	// Render the item	379	// Render the item
362	item.render(g, CompletionJList.this.getFont(), getForeground(), bgColor,	380	controller.render(g, CompletionJList.this.getFont(), fgColor, bgColor,
363	itemRenderWidth, getHeight(), selected);	381	fgSelectedColor, bgSelectedColor, itemRenderWidth, getHeight(),
		382	item, isBestMatch, isSelected);
364		383
365	if (separator) {	384	if (separator) {
366	g.setColor(Color.gray);	385	g.setColor(Color.gray);
Lines 368-374 Link Here
368	g.setColor(fgColor);	387	g.setColor(fgColor);
369	}	388	}
370	}	389	}
371		390
372	public @Override Dimension getPreferredSize() {	391	public @Override Dimension getPreferredSize() {
373	if (cellPreferredSizeGraphics == null) {	392	if (cellPreferredSizeGraphics == null) {
374	// CompletionJList.this.getGraphics() is null	393	// CompletionJList.this.getGraphics() is null
Lines 381-386 Link Here
381	fixedItemHeight);	400	fixedItemHeight);
382	}	401	}
383		402
		403	private void setColors(Color fgColor, Color bgColor, Color fgSelectedColor, Color bgSelectedColor) {
		404	this.fgColor = fgColor;
		405	this.bgColor = bgColor;
		406	this.fgSelectedColor = fgSelectedColor;
		407	this.bgSelectedColor = bgSelectedColor;
		408	}
		409
384	}	410	}
385		411
386	}	412	}

Lines 71-79 Link Here

(-)a/editor.completion/src/org/netbeans/modules/editor/completion/CompletionLayout.java (-9 / +14 lines)
71	import javax.swing.event.ListSelectionListener;	71	import javax.swing.event.ListSelectionListener;
72	import javax.swing.text.Document;	72	import javax.swing.text.Document;
73	import javax.swing.text.JTextComponent;	73	import javax.swing.text.JTextComponent;
		74	import org.netbeans.api.annotations.common.CheckForNull;
74	import org.netbeans.editor.GuardedDocument;	75	import org.netbeans.editor.GuardedDocument;
		76	import org.netbeans.spi.editor.completion.CompletionController;
75	import org.netbeans.spi.editor.completion.CompletionDocumentation;	77	import org.netbeans.spi.editor.completion.CompletionDocumentation;
76	import org.netbeans.spi.editor.completion.CompletionItem;
77	import org.openide.text.CloneableEditorSupport;	78	import org.openide.text.CloneableEditorSupport;
78	import org.openide.util.NbBundle;	79	import org.openide.util.NbBundle;
79		80
Lines 138-145 Link Here
138	}	139	}
139		140
140	public void showCompletion(List data, String title, int anchorOffset,	141	public void showCompletion(List data, String title, int anchorOffset,
141	ListSelectionListener listSelectionListener, String additionalItemsText, String shortcutHint, int selectedIndex) {	142	ListSelectionListener listSelectionListener, String additionalItemsText,
142	completionPopup.show(data, title, anchorOffset, listSelectionListener, additionalItemsText, shortcutHint, selectedIndex);	143	String shortcutHint, CompletionController controller,
		144	CompletionController.Selection selection) {
		145	completionPopup.show(data, title, anchorOffset, listSelectionListener, additionalItemsText, shortcutHint, controller, selection);
143	if (!visiblePopups.contains(completionPopup))	146	if (!visiblePopups.contains(completionPopup))
144	visiblePopups.push(completionPopup);	147	visiblePopups.push(completionPopup);
145	}	148	}
Lines 159-165 Link Here
159	return completionPopup.isVisible();	162	return completionPopup.isVisible();
160	}	163	}
161		164
162	public CompletionItem getSelectedCompletionItem() {	165	public @CheckForNull SelectedCompletionItem getSelectedCompletionItem() {
163	return completionPopup.getSelectedCompletionItem();	166	return completionPopup.getSelectedCompletionItem();
164	}	167	}
165		168
Lines 305-311 Link Here
305	private CompletionScrollPane completionScrollPane;	308	private CompletionScrollPane completionScrollPane;
306		309
307	public void show(List data, String title, int anchorOffset,	310	public void show(List data, String title, int anchorOffset,
308	ListSelectionListener listSelectionListener, String additionalItemsText, String shortcutHint, int selectedIndex) {	311	ListSelectionListener listSelectionListener, String additionalItemsText,
		312	String shortcutHint, final CompletionController controller,
		313	CompletionController.Selection selection) {
309		314
310	JTextComponent editorComponent = getEditorComponent();	315	JTextComponent editorComponent = getEditorComponent();
311	if (editorComponent == null) {	316	if (editorComponent == null) {
Lines 330-336 Link Here
330	JTextComponent c = getEditorComponent();	335	JTextComponent c = getEditorComponent();
331	if (SwingUtilities.isLeftMouseButton(evt)) {	336	if (SwingUtilities.isLeftMouseButton(evt)) {
332	if (c != null && evt.getClickCount() == 2 ) {	337	if (c != null && evt.getClickCount() == 2 ) {
333	CompletionItem selectedItem	338	SelectedCompletionItem selectedItem
334	= completionScrollPane.getSelectedCompletionItem();	339	= completionScrollPane.getSelectedCompletionItem();
335	if (selectedItem != null) {	340	if (selectedItem != null) {
336	Document doc = c.getDocument();	341	Document doc = c.getDocument();
Lines 342-348 Link Here
342	CompletionImpl.uilog(r);	347	CompletionImpl.uilog(r);
343	CompletionImpl.sendUndoableEdit(doc, CloneableEditorSupport.BEGIN_COMMIT_GROUP);	348	CompletionImpl.sendUndoableEdit(doc, CloneableEditorSupport.BEGIN_COMMIT_GROUP);
344	try {	349	try {
345	selectedItem.defaultAction(c);	350	controller.defaultAction(selectedItem.getItem(), selectedItem.isSelected());
346	} finally {	351	} finally {
347	CompletionImpl.sendUndoableEdit(doc, CloneableEditorSupport.END_COMMIT_GROUP);	352	CompletionImpl.sendUndoableEdit(doc, CloneableEditorSupport.END_COMMIT_GROUP);
348	}	353	}
Lines 372-378 Link Here
372	}	377	}
373	// Set the new data	378	// Set the new data
374	getPreferredSize();	379	getPreferredSize();
375	completionScrollPane.setData(data, title, selectedIndex);	380	completionScrollPane.setData(data, title, controller, selection);
376	setAnchorOffset(anchorOffset);	381	setAnchorOffset(anchorOffset);
377		382
378	Dimension prefSize = getPreferredSize();	383	Dimension prefSize = getPreferredSize();
Lines 395-401 Link Here
395	} // otherwise present popup size will be retained	400	} // otherwise present popup size will be retained
396	}	401	}
397		402
398	public CompletionItem getSelectedCompletionItem() {	403	public @CheckForNull SelectedCompletionItem getSelectedCompletionItem() {
399	return isVisible() ? completionScrollPane.getSelectedCompletionItem() : null;	404	return isVisible() ? completionScrollPane.getSelectedCompletionItem() : null;
400	}	405	}
401		406




    
    public synchronized void setHasAdditionalItems(boolean value) {
        checkNotFinished();
        if ((queryType & CompletionProvider.COMPLETION_ALL_QUERY_TYPE) == CompletionProvider.COMPLETION_ALL_QUERY_TYPE) {
            return;
        }
        this.hasAdditionalItems = value;

    
    public synchronized void setHasAdditionalItemsText(String text) {
        checkNotFinished();
        if ((queryType & CompletionProvider.COMPLETION_ALL_QUERY_TYPE) == CompletionProvider.COMPLETION_ALL_QUERY_TYPE) {
            return;
        }
        this.hasAdditionalItemsText = text;


    public synchronized void setDocumentation(CompletionDocumentation documentation) {
        checkNotFinished();
        if (!active || (queryType & CompletionProvider.DOCUMENTATION_QUERY_TYPE) != CompletionProvider.DOCUMENTATION_QUERY_TYPE) {
            return;
        }
        this.documentation = documentation;

    
    public synchronized void setToolTip(JToolTip toolTip) {
        checkNotFinished();
        if (!active || (queryType & CompletionProvider.TOOLTIP_QUERY_TYPE) != CompletionProvider.TOOLTIP_QUERY_TYPE) {
            return;
        }
        this.toolTip = toolTip;

Lines 65-72 Link Here

(-)a/editor.completion/src/org/netbeans/modules/editor/completion/CompletionScrollPane.java (-6 / +16 lines)
65	import javax.swing.text.JTextComponent;	65	import javax.swing.text.JTextComponent;
66	import javax.swing.text.Keymap;	66	import javax.swing.text.Keymap;
67	import javax.swing.text.EditorKit;	67	import javax.swing.text.EditorKit;
		68	import org.netbeans.api.annotations.common.CheckForNull;
68	import org.netbeans.editor.BaseKit;	69	import org.netbeans.editor.BaseKit;
69	import org.netbeans.editor.ext.ExtKit;	70	import org.netbeans.editor.ext.ExtKit;
		71	import org.netbeans.spi.editor.completion.CompletionController;
70	import org.netbeans.spi.editor.completion.CompletionItem;	72	import org.netbeans.spi.editor.completion.CompletionItem;
71		73
72	/**	74	/**
Lines 122-132 Link Here
122	installKeybindings(editorComponent);	124	installKeybindings(editorComponent);
123	}	125	}
124		126
125	public void setData(List data, String title, int selectedIndex) {	127	public void setData(List data,
		128	String title,
		129	CompletionController controller,
		130	CompletionController.Selection selection) {
126	dataObj = data;	131	dataObj = data;
127	view.setData(data);	132	view.setData(data, controller);
128	view.setSelectedIndex(selectedIndex);	133	view.setSelection(selection);
129	Rectangle r = view.getCellBounds(selectedIndex, selectedIndex);	134	Rectangle r = view.getCellBounds(selection.getIndex(), selection.getIndex());
130	if (r != null)	135	if (r != null)
131	view.scrollRectToVisible(r);	136	view.scrollRectToVisible(r);
132	setTitle(title);	137	setTitle(title);
Lines 139-147 Link Here
139	setViewportView(getViewport().getView());	144	setViewportView(getViewport().getView());
140	}	145	}
141		146
142	public CompletionItem getSelectedCompletionItem() {	147	public @CheckForNull SelectedCompletionItem getSelectedCompletionItem() {
143	Object ret = view.getSelectedValue();	148	Object ret = view.getSelectedValue();
144	return ret instanceof CompletionItem ? (CompletionItem) ret : null;	149	if (ret instanceof CompletionItem) {
		150	boolean isSelected = view.getSelection().isSelected();
		151	return new SelectedCompletionItem((CompletionItem)ret, isSelected);
		152	}
		153
		154	return null;
145	}	155	}
146		156
147	public int getSelectedIndex() {	157	public int getSelectedIndex() {




/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2011 Oracle and/or its affiliates. All rights reserved.
 *
 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.
 * Other names may be trademarks of their respective owners.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common
 * Development and Distribution License("CDDL") (collectively, the
 * "License"). You may not use this file except in compliance with the
 * License. You can obtain a copy of the License at
 * http://www.netbeans.org/cddl-gplv2.html
 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
 * specific language governing permissions and limitations under the
 * License.  When distributing the software, include this License Header
 * Notice in each file and include the License file at
 * nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the GPL Version 2 section of the License file that
 * accompanied this code. If applicable, add the following below the
 * License Header, with the fields enclosed by brackets [] replaced by
 * your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * If you wish your version of this file to be governed by only the CDDL
 * or only the GPL Version 2, indicate your decision by adding
 * "[Contributor] elects to include this software in this distribution
 * under the [CDDL or GPL Version 2] license." If you do not indicate a
 * single choice of license, a recipient has the option to distribute
 * your version of this file under either the CDDL, the GPL Version 2 or
 * to extend the choice of license to its licensees as provided above.
 * However, if you add GPL Version 2 code and therefore, elected the GPL
 * Version 2 license, then the option applies only if the new code is
 * made subject to such option by the copyright holder.
 *
 * Contributor(s):
 *
 * Portions Copyrighted 2011 Sun Microsystems, Inc.
 */
package org.netbeans.modules.editor.completion;

import javax.swing.text.JTextComponent;
import org.netbeans.spi.editor.completion.BaseCompletionController;
import org.netbeans.spi.editor.completion.CompletionController;
import org.netbeans.spi.editor.completion.CompletionControllerProvider;
import org.netbeans.spi.editor.completion.CompletionTask;

/**
 *
 * @author Sam Harwell
 */
public class DefaultCompletionControllerProvider implements CompletionControllerProvider {
    public static final DefaultCompletionControllerProvider INSTANCE = new DefaultCompletionControllerProvider();

    @Override
    public CompletionController createController(JTextComponent component, CompletionTask task, int queryType) {
        return new BaseCompletionController(component, queryType);
    }

}




/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2011 Oracle and/or its affiliates. All rights reserved.
 *
 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.
 * Other names may be trademarks of their respective owners.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common
 * Development and Distribution License("CDDL") (collectively, the
 * "License"). You may not use this file except in compliance with the
 * License. You can obtain a copy of the License at
 * http://www.netbeans.org/cddl-gplv2.html
 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
 * specific language governing permissions and limitations under the
 * License.  When distributing the software, include this License Header
 * Notice in each file and include the License file at
 * nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the GPL Version 2 section of the License file that
 * accompanied this code. If applicable, add the following below the
 * License Header, with the fields enclosed by brackets [] replaced by
 * your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * If you wish your version of this file to be governed by only the CDDL
 * or only the GPL Version 2, indicate your decision by adding
 * "[Contributor] elects to include this software in this distribution
 * under the [CDDL or GPL Version 2] license." If you do not indicate a
 * single choice of license, a recipient has the option to distribute
 * your version of this file under either the CDDL, the GPL Version 2 or
 * to extend the choice of license to its licensees as provided above.
 * However, if you add GPL Version 2 code and therefore, elected the GPL
 * Version 2 license, then the option applies only if the new code is
 * made subject to such option by the copyright holder.
 *
 * Contributor(s):
 *
 * Portions Copyrighted 2011 Sun Microsystems, Inc.
 */
package org.netbeans.modules.editor.completion;

import org.netbeans.spi.editor.completion.CompletionItem;

/**
 *
 * @author Sam Harwell
 */
public final class SelectedCompletionItem {
    private final CompletionItem item;
    private final boolean selected;

    public SelectedCompletionItem(CompletionItem item, boolean selected) {
        this.item = item;
        this.selected = selected;
    }

    public CompletionItem getItem() {
        return item;
    }

    public boolean isSelected() {
        return selected;
    }
}




/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2011 Oracle and/or its affiliates. All rights reserved.
 *
 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.
 * Other names may be trademarks of their respective owners.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common
 * Development and Distribution License("CDDL") (collectively, the
 * "License"). You may not use this file except in compliance with the
 * License. You can obtain a copy of the License at
 * http://www.netbeans.org/cddl-gplv2.html
 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
 * specific language governing permissions and limitations under the
 * License.  When distributing the software, include this License Header
 * Notice in each file and include the License file at
 * nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the GPL Version 2 section of the License file that
 * accompanied this code. If applicable, add the following below the
 * License Header, with the fields enclosed by brackets [] replaced by
 * your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * If you wish your version of this file to be governed by only the CDDL
 * or only the GPL Version 2, indicate your decision by adding
 * "[Contributor] elects to include this software in this distribution
 * under the [CDDL or GPL Version 2] license." If you do not indicate a
 * single choice of license, a recipient has the option to distribute
 * your version of this file under either the CDDL, the GPL Version 2 or
 * to extend the choice of license to its licensees as provided above.
 * However, if you add GPL Version 2 code and therefore, elected the GPL
 * Version 2 license, then the option applies only if the new code is
 * made subject to such option by the copyright holder.
 *
 * Contributor(s):
 *
 * Portions Copyrighted 2011 Sun Microsystems, Inc.
 */
package org.netbeans.spi.editor.completion;

import java.awt.Color;
import java.awt.Font;
import java.awt.Graphics;
import java.awt.event.KeyEvent;
import java.util.Collections;
import java.util.List;
import javax.swing.text.BadLocationException;
import javax.swing.text.Document;
import javax.swing.text.JTextComponent;
import org.netbeans.api.annotations.common.CheckForNull;
import org.netbeans.api.annotations.common.NonNull;
import org.netbeans.api.annotations.common.NullAllowed;
import org.netbeans.editor.BaseDocument;
import org.netbeans.editor.Utilities;
import org.openide.util.Parameters;

/**
 *
 * @author Sam Harwell
 */
public class BaseCompletionController implements CompletionController {
    private final JTextComponent component;
    private final int queryType;

    /**
     *
     * @param component The active component.
     * @param queryType The query type.
     *
     * @throws NullPointerException if the parameter value is <code>null</code>.
     */
    public BaseCompletionController(@NonNull JTextComponent component,
                                    int queryType) {
        Parameters.notNull("component", component);
        this.component = component;
        this.queryType = queryType;
    }


    /**
     * Gets the active {@link JTextComponent}.
     *
     * @return The active component.
     */
    public @NonNull JTextComponent getComponent() {
        return component;
    }

    /**
     * Gets the active {@link Document}.
     *
     * @return The active document.
     */
    public Document getDocument() {
        return getComponent().getDocument();
    }

    @Override
    public void sortItems(List<? extends CompletionItem> items, int sortType) {
        Collections.sort(items, CompletionItemComparator.get(sortType));
    }

    @Override
    public Selection getSelection(List<? extends CompletionItem> items) {
        String prefix = getCompletionPrefix();
        if (prefix != null && prefix.length() > 0) {
            for (int idx = 0; idx < items.size(); idx++) {
                CompletionItem item = items.get(idx);
                CharSequence text = item.getInsertPrefix();
                if (text != null && text.toString().startsWith(prefix)) {
                    boolean selected = isSelected(items, prefix, idx);
                    boolean unique = isUnique(items, prefix, idx);
                    return new Selection(idx, selected, unique);
                }
            }
        }

        /* This follows existing behavior, which is slightly different from
         * Selection.DEFAULT because this method marks the item as selected.
         */
        return new Selection(0);
    }

    @Override
    public void defaultAction(CompletionItem bestMatch, boolean isSelected) {
        if (isSelected) {
            bestMatch.defaultAction(component);
        }
    }

    @Override
    public void processKeyEvent(KeyEvent evt, CompletionItem bestMatch, boolean isSelected) {
        bestMatch.processKeyEvent(evt);
    }

    @Override
    public void render(Graphics g, Font defaultFont, Color foregroundColor,
    Color backgroundColor, Color selectedForegroundColor,
    Color selectedBackgroundColor, int width, int height, CompletionItem item, boolean isBestMatch, boolean isSelected) {
        if (isBestMatch) {
            // Clear the background
            g.setColor(selectedBackgroundColor);
            g.fillRect(0, 0, width, height);
            g.setColor(selectedForegroundColor);
            item.render(g, defaultFont, selectedForegroundColor, selectedBackgroundColor, width, height, isBestMatch);
        } else {
            // Clear the background
            g.setColor(backgroundColor);
            g.fillRect(0, 0, width, height);
            g.setColor(foregroundColor);
            item.render(g, defaultFont, foregroundColor, backgroundColor, width, height, isBestMatch);
        }
    }

    @Override
    public boolean instantSubstitution(CompletionItem uniqueMatch) {
        return uniqueMatch.instantSubstitution(component);
    }

    /**
     * Gets the current completion prefix. The default implementation returns the
     * text of the current identifier (per {@link Utilities#getIdentifierBlock})
     * up to the location of the caret.
     *
     * @return The completion prefix.
     */
    protected @CheckForNull String getCompletionPrefix() {
        if(getDocument() instanceof BaseDocument) {
            BaseDocument doc = (BaseDocument)getDocument();
            int caretOffset = getComponent().getSelectionStart();
            try {
                int[] block = Utilities.getIdentifierBlock(doc, caretOffset);
                if (block != null) {
                    block[1] = caretOffset;
                    return doc.getText(block);
                }
            } catch (BadLocationException ble) {
            }
        }

        return null;
    }

    /**
     *
     * @param items
     * @param prefix
     * @param index
     *
     * @return <code>true</code> if the item is selected, otherwise <code>false</code>.
     */
    protected boolean isSelected(@NonNull List<? extends CompletionItem> items,
                                 @NullAllowed String prefix,
                                 int index) {
        return true;
    }

    /**
     *
     * @param items
     * @param prefix
     * @param index
     *
     * @return <code>true</code> if the selection is unique, otherwise <code>false</code>.
     */
    protected boolean isUnique(@NonNull List<? extends CompletionItem> items,
                               @NullAllowed String prefix,
                               int index) {
        if (items.size() != 1) {
            return false;
        }

        try {
            int caretOffset = getComponent().getSelectionStart();
            int[] block = Utilities.getIdentifierBlock(getComponent(),
                       getComponent().getSelectionStart());
            return block == null || block[1] == caretOffset;
        } catch (BadLocationException ble) {
            return false;
        }
    }
}




/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2011 Oracle and/or its affiliates. All rights reserved.
 *
 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.
 * Other names may be trademarks of their respective owners.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common
 * Development and Distribution License("CDDL") (collectively, the
 * "License"). You may not use this file except in compliance with the
 * License. You can obtain a copy of the License at
 * http://www.netbeans.org/cddl-gplv2.html
 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
 * specific language governing permissions and limitations under the
 * License.  When distributing the software, include this License Header
 * Notice in each file and include the License file at
 * nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the GPL Version 2 section of the License file that
 * accompanied this code. If applicable, add the following below the
 * License Header, with the fields enclosed by brackets [] replaced by
 * your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * If you wish your version of this file to be governed by only the CDDL
 * or only the GPL Version 2, indicate your decision by adding
 * "[Contributor] elects to include this software in this distribution
 * under the [CDDL or GPL Version 2] license." If you do not indicate a
 * single choice of license, a recipient has the option to distribute
 * your version of this file under either the CDDL, the GPL Version 2 or
 * to extend the choice of license to its licensees as provided above.
 * However, if you add GPL Version 2 code and therefore, elected the GPL
 * Version 2 license, then the option applies only if the new code is
 * made subject to such option by the copyright holder.
 *
 * Contributor(s):
 *
 * Portions Copyrighted 2011 Sun Microsystems, Inc.
 */
package org.netbeans.spi.editor.completion;

import java.awt.Color;
import java.awt.Font;
import java.awt.Graphics;
import java.awt.event.KeyEvent;
import java.util.List;
import org.netbeans.api.annotations.common.NonNull;

/**
 * This interface controls the sorting and selection behavior of the Code
 * Completion drop down.
 *
 * @author Sam Harwell
 */
public interface CompletionController {

    /**
     * Sorts the specified list of CompletionItem items.
     *
     * @param items The list of items to sort.
     * @param sortType The desired sort type, one of
     *  {@link CompletionResultSet#PRIORITY_SORT_TYPE} or
     *  {@link CompletionResultSet#TEXT_SORT_TYPE}.
     */
    void sortItems(@NonNull List<? extends CompletionItem> items, int sortType);

    /**
     * Gets the initial selected item from a list of CompletionItem items shown
     * in a code completion drop down. The initial selection represents a "best
     * match" among the available items.
     *
     * @param items A list of all CompletionItem items shown in the code
     *  completion drop down.
     *
     * @return A {@link Selection} object containing information about the
     *  initial selection.
     */
    @NonNull Selection getSelection(@NonNull List<? extends CompletionItem> items);

    /**
     * Gets invoked when user presses <code>VK_ENTER</code> key
     * or when she double-clicks on this item with the mouse cursor.
     * <br/>
     * This method gets invoked from AWT thread.
     *
     * @param bestMatch non-null completion item for which the action is invoked
     * @param isSelected whether or not the best match is currently selected
     */
    void defaultAction(@NonNull CompletionItem bestMatch, boolean isSelected);

    /**
     * Process the key pressed when this completion item was selected
     * in the completion popup window.
     * <br/>
     * This method gets invoked from AWT thread.
     *
     * @param evt non-null key event of the pressed key. It should be consumed
     *  in case the item is sensitive to the given key. The source of this
     *  event is the text component to which the corresponding action should
     *  be performed.
     * @param bestMatch non-null completion item which is the current best match
     * @param isSelected whether or not the best match is currently selected
     */
    void processKeyEvent(@NonNull KeyEvent evt, @NonNull CompletionItem bestMatch, boolean isSelected);

    /**
     * Render this item into the given graphics.
     *
     * @param g graphics to render the item into.
     * @param defaultFont default font used for rendering.
     * @param foregroundColor foreground color used for rendering.
     * @param backgroundColor color used for background.
     * @param selectedForegroundColor foreground color used for rendering selected items.
     * @param selectedBackgroundColor color used for background selected items.
     * @param width width of the area to render into.
     * @param height height of the are to render into.
     * @param item non-null completion item to render.
     * @param isBestMatch true if this item is the best match.
     * @param isSelected true if this item is selected.
     */
    void render(@NonNull Graphics g, @NonNull Font defaultFont, @NonNull Color foregroundColor,
    @NonNull Color backgroundColor, @NonNull Color selectedForegroundColor,
    @NonNull Color selectedBackgroundColor, int width, int height, @NonNull CompletionItem item,
    boolean isBestMatch, boolean isSelected);

    /**
     * When enabled for the item the instant substitution should process the item
     * in the same way like when the item is displayed and Enter key gets pressed
     * by the user.
     * <br>
     * Instant substitution is invoked when there would be just a single item
     * displayed in the completion popup window.
     * <br>
     * The implementation can invoke the {@link #defaultAction(JTextComponent)}
     * if necessary.
     * <br/>
     * This method gets invoked from AWT thread.
     *
     * @param uniqueMatch non-null unique completion item to perform the instant
     *  substitution.
     * @return <code>true</code> if the instant substitution was successfully done.
     *  <code>false</code> means that the instant substitution should not be done
     *  for this item and the completion item should normally be displayed.
     */
    boolean instantSubstitution(@NonNull CompletionItem uniqueMatch);

    /**
     * Represents an initial selected CompletionItem for code completion. This
     * item can be seen as the best match for a given input.
     */
    public static final class Selection {
        /**
         * The default selected item. The item has index 0 and is not selected
         * or unique.
         */
        public static final Selection DEFAULT = new Selection(0, false, false);

        private final int index;
        private final boolean selected;
        private final boolean unique;

        /**
         * Initializes a Selection with the specified index. The item is selected
         * but not unique.
         *
         * @param index The index of the selected CompletionItem.
         *
         * @throws IllegalArgumentException when the index argument is less than zero.
         */
        public Selection(int index) {
            this(index, true, false);
        }

        /**
         * Initializes a Selection with the specified index and selected state.
         * The item is not unique.
         *
         * @param index The index of the selected CompletionItem.
         * @param selected <code>true</code> if the match is selected, otherwise
         *  <code>false</code>.
         *
         * @throws IllegalArgumentException when the index argument is less than zero.
         */
        public Selection(int index, boolean selected) {
            this(index, selected, false);
        }

        /**
         * Initializes a Selection with the specified index, selected state, and
         * uniqueness.
         *
         * @param index The index of the selected CompletionItem.
         * @param selected <code>true</code> if the match is selected, otherwise
         *  <code>false</code>.
         * @param unique <code>true</code> if the match is unique, otherwise
         *  <code>false</code>.
         * 
         * @throws IllegalArgumentException when the index argument is less than zero.
         */
        public Selection(int index, boolean selected, boolean unique) {
            if (index < 0) {
                throw new IllegalArgumentException("The index cannot be negative."); // NOI18N
            }

            this.index = index;
            this.selected = selected;
            this.unique = unique;
        }

        /**
         *
         * @return The index of the selected CompletionItem.
         */
        public int getIndex() {
            return index;
        }

        /**
         *
         * @return <code>true</code> if the match is selected, otherwise <code>false</code>.
         */
        public boolean isSelected() {
            return selected;
        }

        /**
         *
         * @return <code>true</code> if the match is unique, otherwise <code>false</code>.
         */
        public boolean isUnique() {
            return unique;
        }
    }
}




/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2011 Oracle and/or its affiliates. All rights reserved.
 *
 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.
 * Other names may be trademarks of their respective owners.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common
 * Development and Distribution License("CDDL") (collectively, the
 * "License"). You may not use this file except in compliance with the
 * License. You can obtain a copy of the License at
 * http://www.netbeans.org/cddl-gplv2.html
 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
 * specific language governing permissions and limitations under the
 * License.  When distributing the software, include this License Header
 * Notice in each file and include the License file at
 * nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the GPL Version 2 section of the License file that
 * accompanied this code. If applicable, add the following below the
 * License Header, with the fields enclosed by brackets [] replaced by
 * your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * If you wish your version of this file to be governed by only the CDDL
 * or only the GPL Version 2, indicate your decision by adding
 * "[Contributor] elects to include this software in this distribution
 * under the [CDDL or GPL Version 2] license." If you do not indicate a
 * single choice of license, a recipient has the option to distribute
 * your version of this file under either the CDDL, the GPL Version 2 or
 * to extend the choice of license to its licensees as provided above.
 * However, if you add GPL Version 2 code and therefore, elected the GPL
 * Version 2 license, then the option applies only if the new code is
 * made subject to such option by the copyright holder.
 *
 * Contributor(s):
 *
 * Portions Copyrighted 2011 Sun Microsystems, Inc.
 */
package org.netbeans.spi.editor.completion;

import javax.swing.text.JTextComponent;
import org.netbeans.api.annotations.common.CheckForNull;
import org.netbeans.api.annotations.common.NonNull;
import org.netbeans.spi.editor.mimelookup.MimeLocation;

/**
 *
 * @author Sam Harwell
 */
@MimeLocation(subfolderName="CompletionProviders")
public interface CompletionControllerProvider {

    /**
     * Creates a {@link CompletionController} which provides behavior for the
     * code completion drop down.
     * 
     * @param component The active component.
     * @param task The completion task.
     * @param queryType The completion query type.
     *
     * @return A {@link CompletionController} to provide behavior for the completion drop
     *  down, or <code>null</code> if this provider does not support the specified
     *  component, task, or query type.
     */
    public @CheckForNull CompletionController createController(
        @NonNull JTextComponent component,
        @NonNull CompletionTask task,
        int queryType);

}




/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 1997-2010 Oracle and/or its affiliates. All rights reserved.
 *
 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.
 * Other names may be trademarks of their respective owners.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common
 * Development and Distribution License("CDDL") (collectively, the
 * "License"). You may not use this file except in compliance with the
 * License. You can obtain a copy of the License at
 * http://www.netbeans.org/cddl-gplv2.html
 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
 * specific language governing permissions and limitations under the
 * License.  When distributing the software, include this License Header
 * Notice in each file and include the License file at
 * nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the GPL Version 2 section of the License file that
 * accompanied this code. If applicable, add the following below the
 * License Header, with the fields enclosed by brackets [] replaced by
 * your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * Contributor(s):
 *
 * The Original Software is NetBeans. The Initial Developer of the Original
 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
 * Microsystems, Inc. All Rights Reserved.
 *
 * If you wish your version of this file to be governed by only the CDDL
 * or only the GPL Version 2, indicate your decision by adding
 * "[Contributor] elects to include this software in this distribution
 * under the [CDDL or GPL Version 2] license." If you do not indicate a
 * single choice of license, a recipient has the option to distribute
 * your version of this file under either the CDDL, the GPL Version 2 or
 * to extend the choice of license to its licensees as provided above.
 * However, if you add GPL Version 2 code and therefore, elected the GPL
 * Version 2 license, then the option applies only if the new code is
 * made subject to such option by the copyright holder.
 */

package org.netbeans.spi.editor.completion;

import java.util.Comparator;
import org.netbeans.api.annotations.common.NonNull;
import org.openide.util.Parameters;

/**
 * Comparator for completion items either by sort priority or by sort text.
 *
 * @author Dusan Balek, Miloslav Metelka
 */

public class CompletionItemComparator implements Comparator<CompletionItem> {

    /**
     * A Comparator which sorts CompletionItem items by priority, then alphabetically.
     */
    public static final Comparator<CompletionItem> BY_PRIORITY =
        new CompletionItemComparator(new PriorityComparator(), new TextComparator());

    /**
     * A Comparator which sorts CompletionItem items alphabetically, then by priority.
     */
    public static final Comparator<CompletionItem> ALPHABETICAL =
        new CompletionItemComparator(new TextComparator(), new PriorityComparator());

    private final Comparator<CompletionItem> primaryComparator;
    private final Comparator<CompletionItem> secondaryComparator;
    
    /**
     * Constructs a CompletionItemComparator from the specified primary and secondary
     * comparators.
     *
     * @param primaryComparator non-null primary comparator.
     * @param secondaryComparator non-null secondary comparator.
     */
    public CompletionItemComparator(@NonNull Comparator<CompletionItem> primaryComparator,
                                    @NonNull Comparator<CompletionItem> secondaryComparator) {
        Parameters.notNull("primaryComparator", primaryComparator);
        Parameters.notNull("secondaryComparator", secondaryComparator);
        this.primaryComparator = primaryComparator;
        this.secondaryComparator = secondaryComparator;
    }
    
    /**
     * Gets a default comparator that can be used for sorting CompletionItem lists
     * for the specified sort type.
     *
     * @param sortType The sort type, one of {@link CompletionResultSet#PRIORITY_SORT_TYPE}
     *  or {@link CompletionResultSet#TEXT_SORT_TYPE}.
     *
     * @return The Comparator to use when sorting CompletionItem items.
     *
     * @throws IllegalArgumentException the sortType argument is not a supported type.
     */
    public static Comparator<CompletionItem> get(int sortType) {
        if (sortType == CompletionResultSet.PRIORITY_SORT_TYPE)
            return BY_PRIORITY;

        if (sortType == CompletionResultSet.TEXT_SORT_TYPE)
            return ALPHABETICAL;

        throw new IllegalArgumentException();
    }
    
    @Override
    public int compare(CompletionItem i1, CompletionItem i2) {
        if (i1 == i2)
            return 0;

        int primaryDiff = primaryComparator.compare(i1, i2);
        if (primaryDiff != 0) {
            return primaryDiff;
        }

        return secondaryComparator.compare(i1, i2);
    }

    /**
     * A comparator which compares CompletionItem items by priority.
     *
     * @see CompletionItem#getSortPriority()
     */
    protected static class PriorityComparator implements Comparator<CompletionItem> {

        /**
         * Initializes a PriorityComparator.
         */
        public PriorityComparator() {
        }

        @Override
        public int compare(CompletionItem o1, CompletionItem o2) {
            if (o1 == o2) {
                return 0;
            }

            return o1.getSortPriority() - o2.getSortPriority();
        }

    }

    /**
     * A Comparator which compares CompletionItem items by text.
     *
     * @see CompletionItem#getSortText()
     */
    protected static class TextComparator implements Comparator<CompletionItem> {

        /**
         * Initializes a TextComparator.
         */
        public TextComparator() {
        }

        @Override
        public int compare(CompletionItem o1, CompletionItem o2) {
            return compareText(o1.getSortText(), o2.getSortText());
        }

        /**
         * Compares two CharSequence objects for order.
         *
         * @param text1 the first text to be compared
         * @param text2 the second text to be compared
         * @return a negative integer, zero, or a positive integer as the
         * 	       first argument is less than, equal to, or greater than the
         *	       second.
         */
        protected int compareText(CharSequence text1, CharSequence text2) {
            if (text1 == null)
                text1 = ""; //NOI18N

            if (text2 == null)
                text2 = ""; //NOI18N

            int len = Math.min(text1.length(), text2.length());
            for (int i = 0; i < len; i++) {
                char ch1 = text1.charAt(i);
                char ch2 = text2.charAt(i);
                if (ch1 != ch2) {
                    return ch1 - ch2;
                }
            }

            return text1.length() - text2.length();
        }

    }

}




    /**
     * The <code>int</code> value representing the query for a code completion.
     */
    public static final int COMPLETION_QUERY_TYPE = 0x01;

    /**
     * The <code>int</code> value representing the query for a documentation.
     */    
    public static final int DOCUMENTATION_QUERY_TYPE = 0x02;
    
    /**
     * The <code>int</code> value representing the query for a tooltip hint.
     */    
    public static final int TOOLTIP_QUERY_TYPE = 0x04;

    /**
     * The <code>int</code> value representing the query for an all code completion.
     */
    public static final int COMPLETION_ALL_QUERY_TYPE = 0x11;

    /**
     * The <code>int</code> mask representing the bits used for a completion query type.
     */
    public static final int COMPLETION_QUERY_MASK = COMPLETION_QUERY_TYPE | COMPLETION_ALL_QUERY_TYPE;

    /**
     * The <code>int</code> mask of bits a user can specify to customize the query type.
     */
    public static final int USER_QUERY_MASK = 0xFFFF0000;

    /**
     * The <code>int</code> mask of bits used by the API to specify the query type.
     */
    public static final int RESERVED_QUERY_MASK = ~USER_QUERY_MASK;

    /**
     * Creates a task that performs a query of the given type on the given component.

Lines 45-50 Link Here

(-)a/editor.completion/src/org/netbeans/spi/editor/completion/CompletionResultSet.java (-2 / +23 lines)
45	package org.netbeans.spi.editor.completion;	45	package org.netbeans.spi.editor.completion;
46		46
47	import java.util.Collection;	47	import java.util.Collection;
		48	import java.util.Collections;
		49	import java.util.List;
48	import javax.swing.JToolTip;	50	import javax.swing.JToolTip;
49	import org.netbeans.modules.editor.completion.CompletionResultSetImpl;	51	import org.netbeans.modules.editor.completion.CompletionResultSetImpl;
50	import org.netbeans.modules.editor.completion.CompletionSpiPackageAccessor;	52	import org.netbeans.modules.editor.completion.CompletionSpiPackageAccessor;
Lines 101-119 Link Here
101	}	103	}
102		104
103	/**	105	/**
104	* Set the document offset to which the returned completion items	106	* Get the document offset to which the returned completion items,
105	* or documentation or tooltip should be anchored.	107	* documentation, or tool tip should be anchored.
106	* <br>	108	* <br>
107	* If there will be multiple completion providers setting this property	109	* If there will be multiple completion providers setting this property
108	* for the given mime-type then only the first one	110	* for the given mime-type then only the first one
109	* (according to the xml-layer registration order)	111	* (according to the xml-layer registration order)
110	* will be taken into account.	112	* will be taken into account.
		113	* @return
		114	*/
		115	public int getAnchorOffset() {
		116	return impl.getAnchorOffset();
		117	}
		118
		119	/**
		120	* Set the document offset to which the returned completion items
		121	* or documentation or tooltip should be anchored.
		122	*
		123	* @see #getAnchorOffset()
111	*/	124	*/
112	public void setAnchorOffset(int anchorOffset) {	125	public void setAnchorOffset(int anchorOffset) {
113	impl.setAnchorOffset(anchorOffset);	126	impl.setAnchorOffset(anchorOffset);
114	}	127	}
115		128
116	/**	129	/**
		130	* Gets an unmodifiable list of completion items in this result set.
		131	* @return
		132	*/
		133	public List<? extends CompletionItem> getItems() {
		134	return Collections.unmodifiableList(impl.getItems());
		135	}
		136
		137	/**
117	* Add the completion item to this result set.	138	* Add the completion item to this result set.
118	* <br>	139	* <br>
119	* This method can be called multiple times until	140	* This method can be called multiple times until

Lines 47-52 Link Here

(-)a/editor.completion/src/org/netbeans/spi/editor/completion/support/AsyncCompletionTask.java (-2 / +23 lines)
47	import javax.swing.SwingUtilities;	47	import javax.swing.SwingUtilities;
48	import javax.swing.text.Document;	48	import javax.swing.text.Document;
49	import javax.swing.text.JTextComponent;	49	import javax.swing.text.JTextComponent;
		50	import org.netbeans.api.annotations.common.CheckForNull;
		51	import org.netbeans.api.annotations.common.NonNull;
		52	import org.netbeans.api.annotations.common.NullAllowed;
50	import org.netbeans.spi.editor.completion.CompletionResultSet;	53	import org.netbeans.spi.editor.completion.CompletionResultSet;
51	import org.netbeans.spi.editor.completion.CompletionTask;	54	import org.netbeans.spi.editor.completion.CompletionTask;
52	import org.openide.util.RequestProcessor;	55	import org.openide.util.RequestProcessor;
Lines 97-103 Link Here
97	* <br>	100	* <br>
98	* It may be null to indicate that no component was provided.	101	* It may be null to indicate that no component was provided.
99	*/	102	*/
100	public AsyncCompletionTask(AsyncCompletionQuery query, JTextComponent component) {	103	public AsyncCompletionTask(@NonNull AsyncCompletionQuery query, @NullAllowed JTextComponent component) {
101	assert (query != null) : "Query must be non-null";	104	assert (query != null) : "Query must be non-null";
102	this.query = query;	105	this.query = query;
103	this.component = component;	106	this.component = component;
Lines 110-120 Link Here
110	*	113	*
111	* @param query non-null query implementation.	114	* @param query non-null query implementation.
112	*/	115	*/
113	public AsyncCompletionTask(AsyncCompletionQuery query) {	116	public AsyncCompletionTask(@NonNull AsyncCompletionQuery query) {
114	this(query, null);	117	this(query, null);
115	}	118	}
116		119
117	/**	120	/**
		121	* Gets the {@link AsyncCompletionQuery} wrapped by this task.
		122	*
		123	* @return The {@link AsyncCompletionQuery}.
		124	*/
		125	public @NonNull AsyncCompletionQuery getQuery() {
		126	return query;
		127	}
		128
		129	/**
		130	* Gets the active component used by this task.
		131	*
		132	* @return The component.
		133	*/
		134	public @CheckForNull JTextComponent getComponent() {
		135	return component;
		136	}
		137
		138	/**
118	* Called by completion infrastructure in AWT thread to populate	139	* Called by completion infrastructure in AWT thread to populate
119	* the given result set with data.	140	* the given result set with data.
120	*/	141	*/

Lines 49-54 Link Here

(-)a/editor.completion/src/org/netbeans/spi/editor/completion/support/CompletionUtilities.java (-4 / +74 lines)
49	import java.awt.FontMetrics;	49	import java.awt.FontMetrics;
50	import java.awt.Graphics;	50	import java.awt.Graphics;
51	import javax.swing.ImageIcon;	51	import javax.swing.ImageIcon;
		52	import org.netbeans.api.annotations.common.NonNull;
		53	import org.netbeans.api.annotations.common.NullAllowed;
52	import org.netbeans.modules.editor.completion.PatchedHtmlRenderer;	54	import org.netbeans.modules.editor.completion.PatchedHtmlRenderer;
53		55
54	/**	56	/**
Lines 119-125 Link Here
119	}	121	}
120	return width;	122	return width;
121	}	123	}
122		124
123	/**	125	/**
124	* Render a completion item using the provided icon and left and right	126	* Render a completion item using the provided icon and left and right
125	* html texts.	127	* html texts.
Lines 160-189 Link Here
160	public static void renderHtml(ImageIcon icon, String leftHtmlText, String rightHtmlText,	162	public static void renderHtml(ImageIcon icon, String leftHtmlText, String rightHtmlText,
161	Graphics g, Font defaultFont, Color defaultColor,	163	Graphics g, Font defaultFont, Color defaultColor,
162	int width, int height, boolean selected) {	164	int width, int height, boolean selected) {
		165	renderHtml(icon, leftHtmlText, rightHtmlText, g, defaultFont, defaultColor, defaultColor, width, height, selected, true);
		166	}
		167
		168	/**
		169	* Render a completion item using the provided icon and left and right
		170	* html texts.
		171	*
		172	* @param icon icon 16x16 that will be displayed on the left. It may be null
		173	* which means that no icon will be displayed but the space for the icon
		174	* will still be reserved (to properly align with other items
		175	* that will provide an icon).
		176	*
		177	* @param leftHtmlText html text that will be displayed on the left side
		178	* of the item's rendering area next to the icon.
		179	* <br/>
		180	* It may be null which indicates that no left text will be displayed.
		181	* <br/>
		182	* If there's not enough horizontal space in the rendering area
		183	* the text will be shrinked and "..." will be displayed at the end.
		184	*
		185	* @param rightHtmlText html text that will be aligned to the right edge
		186	* of the item's rendering area.
		187	* <br/>
		188	* It may be null which means that no right text will be displayed.
		189	* <br/>
		190	* The right text is always attempted to be fully displayed unlike
		191	* the left text that may be shrinked if there's not enough rendering space
		192	* in the horizontal direction.
		193	* <br/>
		194	* If there's not enough space even for the right text it will be shrinked
		195	* and "..." will be displayed at the end of the rendered string.
		196	* @param g non-null graphics through which the rendering happens.
		197	* @param defaultFont non-null default font to be used for rendering.
		198	* @param foregroundColor non-null default color to be used for rendering.
		199	* @param selectedBackgroundColor non-null color to be used a the background
		200	* for rendering selected items.
		201	* @param width >=0 available width for rendering.
		202	* @param height >=0 available height for rendering.
		203	* @param isBestMatch whether the item being rendered is currently the best
		204	* match in the completion's JList. If selected the foreground color is forced
		205	* to be black for all parts of the rendered strings.
		206	* @param isSelected whether the item being rendered is currently selected in
		207	* the completion's JList. If <code>true</code>, the foreground color is
		208	* forced to the value of the foregroundColor argument for all parts of the
		209	* rendered strings.
		210	*/
		211	public static void renderHtml(@NullAllowed ImageIcon icon,
		212	@NullAllowed String leftHtmlText,
		213	@NullAllowed String rightHtmlText,
		214	@NonNull Graphics g,
		215	@NonNull Font defaultFont,
		216	@NonNull Color foregroundColor,
		217	@NonNull Color selectedBackgroundColor,
		218	int width,
		219	int height,
		220	boolean isBestMatch,
		221	boolean isSelected) {
163	if (icon != null) {	222	if (icon != null) {
164	// The image of the ImageIcon should already be loaded	223	// The image of the ImageIcon should already be loaded
165	// so no ImageObserver should be necessary	224	// so no ImageObserver should be necessary
166	boolean done = g.drawImage(icon.getImage(), BEFORE_ICON_GAP, (height - icon.getIconHeight()) /2, null);	225	boolean done = g.drawImage(icon.getImage(), BEFORE_ICON_GAP, (height - icon.getIconHeight()) /2, null);
167	assert (done);	226	assert (done);
168	}	227	}
		228
		229	if (isBestMatch && isSelected) {
		230	g.setColor(foregroundColor);
		231	}
		232
169	int iconWidth = BEFORE_ICON_GAP + ICON_WIDTH + AFTER_ICON_GAP;	233	int iconWidth = BEFORE_ICON_GAP + ICON_WIDTH + AFTER_ICON_GAP;
170	int rightTextX = width - AFTER_RIGHT_TEXT_GAP;	234	int rightTextX = width - AFTER_RIGHT_TEXT_GAP;
171	FontMetrics fm = g.getFontMetrics(defaultFont);	235	FontMetrics fm = g.getFontMetrics(defaultFont);
172	int textY = (height - fm.getHeight())/2 + fm.getHeight() - fm.getDescent();	236	int textY = (height - fm.getHeight())/2 + fm.getHeight() - fm.getDescent();
173	if (rightHtmlText != null && rightHtmlText.length() > 0) {	237	if (rightHtmlText != null && rightHtmlText.length() > 0) {
174	int rightTextWidth = (int)PatchedHtmlRenderer.renderHTML(rightHtmlText, g, 0, 0, Integer.MAX_VALUE, 0,	238	int rightTextWidth = (int)PatchedHtmlRenderer.renderHTML(rightHtmlText, g, 0, 0, Integer.MAX_VALUE, 0,
175	defaultFont, defaultColor, PatchedHtmlRenderer.STYLE_CLIP, false, true);	239	defaultFont, foregroundColor, PatchedHtmlRenderer.STYLE_CLIP, false, true);
176	rightTextX = Math.max(iconWidth, rightTextX - rightTextWidth);	240	rightTextX = Math.max(iconWidth, rightTextX - rightTextWidth);
177	// Render right text	241	// Render right text
178	PatchedHtmlRenderer.renderHTML(rightHtmlText, g, rightTextX, textY, rightTextWidth, textY,	242	PatchedHtmlRenderer.renderHTML(rightHtmlText, g, rightTextX, textY, rightTextWidth, textY,
179	defaultFont, defaultColor, PatchedHtmlRenderer.STYLE_CLIP, true, selected);	243	defaultFont, foregroundColor, PatchedHtmlRenderer.STYLE_CLIP, true, isBestMatch && isSelected);
180	rightTextX = Math.max(iconWidth, rightTextX - BEFORE_RIGHT_TEXT_GAP);	244	rightTextX = Math.max(iconWidth, rightTextX - BEFORE_RIGHT_TEXT_GAP);
181	}	245	}
182		246
183	// Render left text	247	// Render left text
184	if (leftHtmlText != null && leftHtmlText.length() > 0 && rightTextX > iconWidth) { // any space for left text?	248	if (leftHtmlText != null && leftHtmlText.length() > 0 && rightTextX > iconWidth) { // any space for left text?
185	PatchedHtmlRenderer.renderHTML(leftHtmlText, g, iconWidth, textY, rightTextX - iconWidth, textY,	249	PatchedHtmlRenderer.renderHTML(leftHtmlText, g, iconWidth, textY, rightTextX - iconWidth, textY,
186	defaultFont, defaultColor, PatchedHtmlRenderer.STYLE_TRUNCATE, true, selected);	250	defaultFont, foregroundColor, PatchedHtmlRenderer.STYLE_TRUNCATE, true, isBestMatch && isSelected);
		251	}
		252
		253	// Render border for best match items that are not selected
		254	if (isBestMatch && !isSelected) {
		255	g.setColor(selectedBackgroundColor);
		256	g.drawRect(0, 0, width - 1, height - 1);
187	}	257	}
188	}	258	}
189		259

Lines 74-80 Link Here

(-)a/java.editor/test/unit/src/org/netbeans/modules/java/editor/completion/CompletionTestBase.java (-1 / +1 lines)
74	import org.netbeans.api.java.source.gen.WhitespaceIgnoringDiff;	74	import org.netbeans.api.java.source.gen.WhitespaceIgnoringDiff;
75	import org.netbeans.api.lexer.Language;	75	import org.netbeans.api.lexer.Language;
76	import org.netbeans.junit.NbTestCase;	76	import org.netbeans.junit.NbTestCase;
77	import org.netbeans.modules.editor.completion.CompletionItemComparator;	77	import org.netbeans.spi.editor.completion.CompletionItemComparator;
78	import org.netbeans.modules.editor.java.JavaCompletionProvider;	78	import org.netbeans.modules.editor.java.JavaCompletionProvider;
79	import org.netbeans.modules.editor.java.JavaKit;	79	import org.netbeans.modules.editor.java.JavaKit;
80	import org.netbeans.modules.editor.java.Utilities;	80	import org.netbeans.modules.editor.java.Utilities;

Return to bug 204867

Removed Link Here

(-)a/editor.completion/src/org/netbeans/modules/editor/completion/CompletionItemComparator.java (-111 lines)
1	/*
2	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3	*
4	* Copyright 1997-2010 Oracle and/or its affiliates. All rights reserved.
5	*
6	* Oracle and Java are registered trademarks of Oracle and/or its affiliates.
7	* Other names may be trademarks of their respective owners.
8	*
9	* The contents of this file are subject to the terms of either the GNU
10	* General Public License Version 2 only ("GPL") or the Common
11	* Development and Distribution License("CDDL") (collectively, the
12	* "License"). You may not use this file except in compliance with the
13	* License. You can obtain a copy of the License at
14	* http://www.netbeans.org/cddl-gplv2.html
15	* or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
16	* specific language governing permissions and limitations under the
17	* License. When distributing the software, include this License Header
18	* Notice in each file and include the License file at
19	* nbbuild/licenses/CDDL-GPL-2-CP. Oracle designates this
20	* particular file as subject to the "Classpath" exception as provided
21	* by Oracle in the GPL Version 2 section of the License file that
22	* accompanied this code. If applicable, add the following below the
23	* License Header, with the fields enclosed by brackets [] replaced by
24	* your own identifying information:
25	* "Portions Copyrighted [year] [name of copyright owner]"
26	*
27	* Contributor(s):
28	*
29	* The Original Software is NetBeans. The Initial Developer of the Original
30	* Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
31	* Microsystems, Inc. All Rights Reserved.
32	*
33	* If you wish your version of this file to be governed by only the CDDL
34	* or only the GPL Version 2, indicate your decision by adding
35	* "[Contributor] elects to include this software in this distribution
36	* under the [CDDL or GPL Version 2] license." If you do not indicate a
37	* single choice of license, a recipient has the option to distribute
38	* your version of this file under either the CDDL, the GPL Version 2 or
39	* to extend the choice of license to its licensees as provided above.
40	* However, if you add GPL Version 2 code and therefore, elected the GPL
41	* Version 2 license, then the option applies only if the new code is
42	* made subject to such option by the copyright holder.
43	*/
44
45	package org.netbeans.modules.editor.completion;
46
47	import java.util.Comparator;
48	import org.netbeans.spi.editor.completion.CompletionItem;
49	import org.netbeans.spi.editor.completion.CompletionResultSet;
50
51	/**
52	* Comparator for completion items either by sort priority or by sort text.
53	*
54	* @author Dusan Balek, Miloslav Metelka
55	*/
56
57	public class CompletionItemComparator implements Comparator<CompletionItem> {
58
59	public static final Comparator<CompletionItem> BY_PRIORITY = new CompletionItemComparator(true);
60
61	public static final Comparator<CompletionItem> ALPHABETICAL = new CompletionItemComparator(false);
62
63	private final boolean byPriority;
64
65	private CompletionItemComparator(boolean byPriority) {
66	this.byPriority = byPriority;
67	}
68
69	public static final Comparator<CompletionItem> get(int sortType) {
70	if (sortType == CompletionResultSet.PRIORITY_SORT_TYPE)
71	return BY_PRIORITY;
72	if (sortType == CompletionResultSet.TEXT_SORT_TYPE)
73	return ALPHABETICAL;
74	throw new IllegalArgumentException();
75	}
76
77	public int compare(CompletionItem i1, CompletionItem i2) {
78	if (i1 == i2)
79	return 0;
80	if (byPriority) {
81	int importanceDiff = i1.getSortPriority() - i2.getSortPriority();
82	if (importanceDiff != 0)
83	return importanceDiff;
84	int alphabeticalDiff = compareText(i1.getSortText(), i2.getSortText());
85	return alphabeticalDiff;
86	} else {
87	int alphabeticalDiff = compareText(i1.getSortText(), i2.getSortText());
88	if (alphabeticalDiff != 0)
89	return alphabeticalDiff;
90	int importanceDiff = i1.getSortPriority() - i2.getSortPriority();
91	return importanceDiff;
92	}
93	}
94
95	private static int compareText(CharSequence text1, CharSequence text2) {
96	if (text1 == null)
97	text1 = ""; //NOI18N
98	if (text2 == null)
99	text2 = ""; //NOI18N
100	int len = Math.min(text1.length(), text2.length());
101	for (int i = 0; i < len; i++) {
102	char ch1 = text1.charAt(i);
103	char ch2 = text2.charAt(i);
104	if (ch1 != ch2) {
105	return ch1 - ch2;
106	}
107	}
108	return text1.length() - text2.length();
109	}
110
111	}

Lines 213-219 Link Here

(-)a/editor.completion/src/org/netbeans/modules/editor/completion/CompletionResultSetImpl.java (-4 / +4 lines)
213		213
214	public synchronized void setHasAdditionalItems(boolean value) {	214	public synchronized void setHasAdditionalItems(boolean value) {
215	checkNotFinished();	215	checkNotFinished();
216	if (queryType != CompletionProvider.COMPLETION_QUERY_TYPE) {	216	if ((queryType & CompletionProvider.COMPLETION_ALL_QUERY_TYPE) == CompletionProvider.COMPLETION_ALL_QUERY_TYPE) {
217	return;	217	return;
218	}	218	}
219	this.hasAdditionalItems = value;	219	this.hasAdditionalItems = value;
Lines 225-231 Link Here
225		225
226	public synchronized void setHasAdditionalItemsText(String text) {	226	public synchronized void setHasAdditionalItemsText(String text) {
227	checkNotFinished();	227	checkNotFinished();
228	if (queryType != CompletionProvider.COMPLETION_QUERY_TYPE) {	228	if ((queryType & CompletionProvider.COMPLETION_ALL_QUERY_TYPE) == CompletionProvider.COMPLETION_ALL_QUERY_TYPE) {
229	return;	229	return;
230	}	230	}
231	this.hasAdditionalItemsText = text;	231	this.hasAdditionalItemsText = text;
Lines 237-243 Link Here
237		237
238	public synchronized void setDocumentation(CompletionDocumentation documentation) {	238	public synchronized void setDocumentation(CompletionDocumentation documentation) {
239	checkNotFinished();	239	checkNotFinished();
240	if (!active \|\| queryType != CompletionProvider.DOCUMENTATION_QUERY_TYPE) {	240	if (!active \|\| (queryType & CompletionProvider.DOCUMENTATION_QUERY_TYPE) != CompletionProvider.DOCUMENTATION_QUERY_TYPE) {
241	return;	241	return;
242	}	242	}
243	this.documentation = documentation;	243	this.documentation = documentation;
Lines 253-259 Link Here
253		253
254	public synchronized void setToolTip(JToolTip toolTip) {	254	public synchronized void setToolTip(JToolTip toolTip) {
255	checkNotFinished();	255	checkNotFinished();
256	if (!active \|\| queryType != CompletionProvider.TOOLTIP_QUERY_TYPE) {	256	if (!active \|\| (queryType & CompletionProvider.TOOLTIP_QUERY_TYPE) != CompletionProvider.TOOLTIP_QUERY_TYPE) {
257	return;	257	return;
258	}	258	}
259	this.toolTip = toolTip;	259	this.toolTip = toolTip;

Added Link Here

(-)81cafa2674cb (+62 lines)
1	/*
2	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3	*
4	* Copyright 2011 Oracle and/or its affiliates. All rights reserved.
5	*
6	* Oracle and Java are registered trademarks of Oracle and/or its affiliates.
7	* Other names may be trademarks of their respective owners.
8	*
9	* The contents of this file are subject to the terms of either the GNU
10	* General Public License Version 2 only ("GPL") or the Common
11	* Development and Distribution License("CDDL") (collectively, the
12	* "License"). You may not use this file except in compliance with the
13	* License. You can obtain a copy of the License at
14	* http://www.netbeans.org/cddl-gplv2.html
15	* or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
16	* specific language governing permissions and limitations under the
17	* License. When distributing the software, include this License Header
18	* Notice in each file and include the License file at
19	* nbbuild/licenses/CDDL-GPL-2-CP. Oracle designates this
20	* particular file as subject to the "Classpath" exception as provided
21	* by Oracle in the GPL Version 2 section of the License file that
22	* accompanied this code. If applicable, add the following below the
23	* License Header, with the fields enclosed by brackets [] replaced by
24	* your own identifying information:
25	* "Portions Copyrighted [year] [name of copyright owner]"
26	*
27	* If you wish your version of this file to be governed by only the CDDL
28	* or only the GPL Version 2, indicate your decision by adding
29	* "[Contributor] elects to include this software in this distribution
30	* under the [CDDL or GPL Version 2] license." If you do not indicate a
31	* single choice of license, a recipient has the option to distribute
32	* your version of this file under either the CDDL, the GPL Version 2 or
33	* to extend the choice of license to its licensees as provided above.
34	* However, if you add GPL Version 2 code and therefore, elected the GPL
35	* Version 2 license, then the option applies only if the new code is
36	* made subject to such option by the copyright holder.
37	*
38	* Contributor(s):
39	*
40	* Portions Copyrighted 2011 Sun Microsystems, Inc.
41	*/
42	package org.netbeans.modules.editor.completion;
43
44	import javax.swing.text.JTextComponent;
45	import org.netbeans.spi.editor.completion.BaseCompletionController;
46	import org.netbeans.spi.editor.completion.CompletionController;
47	import org.netbeans.spi.editor.completion.CompletionControllerProvider;
48	import org.netbeans.spi.editor.completion.CompletionTask;
49
50	/**
51	*
52	* @author Sam Harwell
53	*/
54	public class DefaultCompletionControllerProvider implements CompletionControllerProvider {
55	public static final DefaultCompletionControllerProvider INSTANCE = new DefaultCompletionControllerProvider();
56
57	@Override
58	public CompletionController createController(JTextComponent component, CompletionTask task, int queryType) {
59	return new BaseCompletionController(component, queryType);
60	}
61
62	}

Added Link Here

(-)81cafa2674cb (+66 lines)
1	/*
2	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3	*
4	* Copyright 2011 Oracle and/or its affiliates. All rights reserved.
5	*
6	* Oracle and Java are registered trademarks of Oracle and/or its affiliates.
7	* Other names may be trademarks of their respective owners.
8	*
9	* The contents of this file are subject to the terms of either the GNU
10	* General Public License Version 2 only ("GPL") or the Common
11	* Development and Distribution License("CDDL") (collectively, the
12	* "License"). You may not use this file except in compliance with the
13	* License. You can obtain a copy of the License at
14	* http://www.netbeans.org/cddl-gplv2.html
15	* or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
16	* specific language governing permissions and limitations under the
17	* License. When distributing the software, include this License Header
18	* Notice in each file and include the License file at
19	* nbbuild/licenses/CDDL-GPL-2-CP. Oracle designates this
20	* particular file as subject to the "Classpath" exception as provided
21	* by Oracle in the GPL Version 2 section of the License file that
22	* accompanied this code. If applicable, add the following below the
23	* License Header, with the fields enclosed by brackets [] replaced by
24	* your own identifying information:
25	* "Portions Copyrighted [year] [name of copyright owner]"
26	*
27	* If you wish your version of this file to be governed by only the CDDL
28	* or only the GPL Version 2, indicate your decision by adding
29	* "[Contributor] elects to include this software in this distribution
30	* under the [CDDL or GPL Version 2] license." If you do not indicate a
31	* single choice of license, a recipient has the option to distribute
32	* your version of this file under either the CDDL, the GPL Version 2 or
33	* to extend the choice of license to its licensees as provided above.
34	* However, if you add GPL Version 2 code and therefore, elected the GPL
35	* Version 2 license, then the option applies only if the new code is
36	* made subject to such option by the copyright holder.
37	*
38	* Contributor(s):
39	*
40	* Portions Copyrighted 2011 Sun Microsystems, Inc.
41	*/
42	package org.netbeans.modules.editor.completion;
43
44	import org.netbeans.spi.editor.completion.CompletionItem;
45
46	/**
47	*
48	* @author Sam Harwell
49	*/
50	public final class SelectedCompletionItem {
51	private final CompletionItem item;
52	private final boolean selected;
53
54	public SelectedCompletionItem(CompletionItem item, boolean selected) {
55	this.item = item;
56	this.selected = selected;
57	}
58
59	public CompletionItem getItem() {
60	return item;
61	}
62
63	public boolean isSelected() {
64	return selected;
65	}
66	}

Added Link Here

(-)81cafa2674cb (+225 lines)
1	/*
2	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3	*
4	* Copyright 2011 Oracle and/or its affiliates. All rights reserved.
5	*
6	* Oracle and Java are registered trademarks of Oracle and/or its affiliates.
7	* Other names may be trademarks of their respective owners.
8	*
9	* The contents of this file are subject to the terms of either the GNU
10	* General Public License Version 2 only ("GPL") or the Common
11	* Development and Distribution License("CDDL") (collectively, the
12	* "License"). You may not use this file except in compliance with the
13	* License. You can obtain a copy of the License at
14	* http://www.netbeans.org/cddl-gplv2.html
15	* or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
16	* specific language governing permissions and limitations under the
17	* License. When distributing the software, include this License Header
18	* Notice in each file and include the License file at
19	* nbbuild/licenses/CDDL-GPL-2-CP. Oracle designates this
20	* particular file as subject to the "Classpath" exception as provided
21	* by Oracle in the GPL Version 2 section of the License file that
22	* accompanied this code. If applicable, add the following below the
23	* License Header, with the fields enclosed by brackets [] replaced by
24	* your own identifying information:
25	* "Portions Copyrighted [year] [name of copyright owner]"
26	*
27	* If you wish your version of this file to be governed by only the CDDL
28	* or only the GPL Version 2, indicate your decision by adding
29	* "[Contributor] elects to include this software in this distribution
30	* under the [CDDL or GPL Version 2] license." If you do not indicate a
31	* single choice of license, a recipient has the option to distribute
32	* your version of this file under either the CDDL, the GPL Version 2 or
33	* to extend the choice of license to its licensees as provided above.
34	* However, if you add GPL Version 2 code and therefore, elected the GPL
35	* Version 2 license, then the option applies only if the new code is
36	* made subject to such option by the copyright holder.
37	*
38	* Contributor(s):
39	*
40	* Portions Copyrighted 2011 Sun Microsystems, Inc.
41	*/
42	package org.netbeans.spi.editor.completion;
43
44	import java.awt.Color;
45	import java.awt.Font;
46	import java.awt.Graphics;
47	import java.awt.event.KeyEvent;
48	import java.util.Collections;
49	import java.util.List;
50	import javax.swing.text.BadLocationException;
51	import javax.swing.text.Document;
52	import javax.swing.text.JTextComponent;
53	import org.netbeans.api.annotations.common.CheckForNull;
54	import org.netbeans.api.annotations.common.NonNull;
55	import org.netbeans.api.annotations.common.NullAllowed;
56	import org.netbeans.editor.BaseDocument;
57	import org.netbeans.editor.Utilities;
58	import org.openide.util.Parameters;
59
60	/**
61	*
62	* @author Sam Harwell
63	*/
64	public class BaseCompletionController implements CompletionController {
65	private final JTextComponent component;
66	private final int queryType;
67
68	/**
69	*
70	* @param component The active component.
71	* @param queryType The query type.
72	*
73	* @throws NullPointerException if the parameter value is <code>null</code>.
74	*/
75	public BaseCompletionController(@NonNull JTextComponent component,
76	int queryType) {
77	Parameters.notNull("component", component);
78	this.component = component;
79	this.queryType = queryType;
80	}
81
82
83	/**
84	* Gets the active {@link JTextComponent}.
85	*
86	* @return The active component.
87	*/
88	public @NonNull JTextComponent getComponent() {
89	return component;
90	}
91
92	/**
93	* Gets the active {@link Document}.
94	*
95	* @return The active document.
96	*/
97	public Document getDocument() {
98	return getComponent().getDocument();
99	}
100
101	@Override
102	public void sortItems(List<? extends CompletionItem> items, int sortType) {
103	Collections.sort(items, CompletionItemComparator.get(sortType));
104	}
105
106	@Override
107	public Selection getSelection(List<? extends CompletionItem> items) {
108	String prefix = getCompletionPrefix();
109	if (prefix != null && prefix.length() > 0) {
110	for (int idx = 0; idx < items.size(); idx++) {
111	CompletionItem item = items.get(idx);
112	CharSequence text = item.getInsertPrefix();
113	if (text != null && text.toString().startsWith(prefix)) {
114	boolean selected = isSelected(items, prefix, idx);
115	boolean unique = isUnique(items, prefix, idx);
116	return new Selection(idx, selected, unique);
117	}
118	}
119	}
120
121	/* This follows existing behavior, which is slightly different from
122	* Selection.DEFAULT because this method marks the item as selected.
123	*/
124	return new Selection(0);
125	}
126
127	@Override
128	public void defaultAction(CompletionItem bestMatch, boolean isSelected) {
129	if (isSelected) {
130	bestMatch.defaultAction(component);
131	}
132	}
133
134	@Override
135	public void processKeyEvent(KeyEvent evt, CompletionItem bestMatch, boolean isSelected) {
136	bestMatch.processKeyEvent(evt);
137	}
138
139	@Override
140	public void render(Graphics g, Font defaultFont, Color foregroundColor,
141	Color backgroundColor, Color selectedForegroundColor,
142	Color selectedBackgroundColor, int width, int height, CompletionItem item, boolean isBestMatch, boolean isSelected) {
143	if (isBestMatch) {
144	// Clear the background
145	g.setColor(selectedBackgroundColor);
146	g.fillRect(0, 0, width, height);
147	g.setColor(selectedForegroundColor);
148	item.render(g, defaultFont, selectedForegroundColor, selectedBackgroundColor, width, height, isBestMatch);
149	} else {
150	// Clear the background
151	g.setColor(backgroundColor);
152	g.fillRect(0, 0, width, height);
153	g.setColor(foregroundColor);
154	item.render(g, defaultFont, foregroundColor, backgroundColor, width, height, isBestMatch);
155	}
156	}
157
158	@Override
159	public boolean instantSubstitution(CompletionItem uniqueMatch) {
160	return uniqueMatch.instantSubstitution(component);
161	}
162
163	/**
164	* Gets the current completion prefix. The default implementation returns the
165	* text of the current identifier (per {@link Utilities#getIdentifierBlock})
166	* up to the location of the caret.
167	*
168	* @return The completion prefix.
169	*/
170	protected @CheckForNull String getCompletionPrefix() {
171	if(getDocument() instanceof BaseDocument) {
172	BaseDocument doc = (BaseDocument)getDocument();
173	int caretOffset = getComponent().getSelectionStart();
174	try {
175	int[] block = Utilities.getIdentifierBlock(doc, caretOffset);
176	if (block != null) {
177	block[1] = caretOffset;
178	return doc.getText(block);
179	}
180	} catch (BadLocationException ble) {
181	}
182	}
183
184	return null;
185	}
186
187	/**
188	*
189	* @param items
190	* @param prefix
191	* @param index
192	*
193	* @return <code>true</code> if the item is selected, otherwise <code>false</code>.
194	*/
195	protected boolean isSelected(@NonNull List<? extends CompletionItem> items,
196	@NullAllowed String prefix,
197	int index) {
198	return true;
199	}
200
201	/**
202	*
203	* @param items
204	* @param prefix
205	* @param index
206	*
207	* @return <code>true</code> if the selection is unique, otherwise <code>false</code>.
208	*/
209	protected boolean isUnique(@NonNull List<? extends CompletionItem> items,
210	@NullAllowed String prefix,
211	int index) {
212	if (items.size() != 1) {
213	return false;
214	}
215
216	try {
217	int caretOffset = getComponent().getSelectionStart();
218	int[] block = Utilities.getIdentifierBlock(getComponent(),
219	getComponent().getSelectionStart());
220	return block == null \|\| block[1] == caretOffset;
221	} catch (BadLocationException ble) {
222	return false;
223	}
224	}
225	}

Added Link Here

(-)81cafa2674cb (+236 lines)
1	/*
2	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3	*
4	* Copyright 2011 Oracle and/or its affiliates. All rights reserved.
5	*
6	* Oracle and Java are registered trademarks of Oracle and/or its affiliates.
7	* Other names may be trademarks of their respective owners.
8	*
9	* The contents of this file are subject to the terms of either the GNU
10	* General Public License Version 2 only ("GPL") or the Common
11	* Development and Distribution License("CDDL") (collectively, the
12	* "License"). You may not use this file except in compliance with the
13	* License. You can obtain a copy of the License at
14	* http://www.netbeans.org/cddl-gplv2.html
15	* or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
16	* specific language governing permissions and limitations under the
17	* License. When distributing the software, include this License Header
18	* Notice in each file and include the License file at
19	* nbbuild/licenses/CDDL-GPL-2-CP. Oracle designates this
20	* particular file as subject to the "Classpath" exception as provided
21	* by Oracle in the GPL Version 2 section of the License file that
22	* accompanied this code. If applicable, add the following below the
23	* License Header, with the fields enclosed by brackets [] replaced by
24	* your own identifying information:
25	* "Portions Copyrighted [year] [name of copyright owner]"
26	*
27	* If you wish your version of this file to be governed by only the CDDL
28	* or only the GPL Version 2, indicate your decision by adding
29	* "[Contributor] elects to include this software in this distribution
30	* under the [CDDL or GPL Version 2] license." If you do not indicate a
31	* single choice of license, a recipient has the option to distribute
32	* your version of this file under either the CDDL, the GPL Version 2 or
33	* to extend the choice of license to its licensees as provided above.
34	* However, if you add GPL Version 2 code and therefore, elected the GPL
35	* Version 2 license, then the option applies only if the new code is
36	* made subject to such option by the copyright holder.
37	*
38	* Contributor(s):
39	*
40	* Portions Copyrighted 2011 Sun Microsystems, Inc.
41	*/
42	package org.netbeans.spi.editor.completion;
43
44	import java.awt.Color;
45	import java.awt.Font;
46	import java.awt.Graphics;
47	import java.awt.event.KeyEvent;
48	import java.util.List;
49	import org.netbeans.api.annotations.common.NonNull;
50
51	/**
52	* This interface controls the sorting and selection behavior of the Code
53	* Completion drop down.
54	*
55	* @author Sam Harwell
56	*/
57	public interface CompletionController {
58
59	/**
60	* Sorts the specified list of CompletionItem items.
61	*
62	* @param items The list of items to sort.
63	* @param sortType The desired sort type, one of
64	* {@link CompletionResultSet#PRIORITY_SORT_TYPE} or
65	* {@link CompletionResultSet#TEXT_SORT_TYPE}.
66	*/
67	void sortItems(@NonNull List<? extends CompletionItem> items, int sortType);
68
69	/**
70	* Gets the initial selected item from a list of CompletionItem items shown
71	* in a code completion drop down. The initial selection represents a "best
72	* match" among the available items.
73	*
74	* @param items A list of all CompletionItem items shown in the code
75	* completion drop down.
76	*
77	* @return A {@link Selection} object containing information about the
78	* initial selection.
79	*/
80	@NonNull Selection getSelection(@NonNull List<? extends CompletionItem> items);
81
82	/**
83	* Gets invoked when user presses <code>VK_ENTER</code> key
84	* or when she double-clicks on this item with the mouse cursor.
85	* <br/>
86	* This method gets invoked from AWT thread.
87	*
88	* @param bestMatch non-null completion item for which the action is invoked
89	* @param isSelected whether or not the best match is currently selected
90	*/
91	void defaultAction(@NonNull CompletionItem bestMatch, boolean isSelected);
92
93	/**
94	* Process the key pressed when this completion item was selected
95	* in the completion popup window.
96	* <br/>
97	* This method gets invoked from AWT thread.
98	*
99	* @param evt non-null key event of the pressed key. It should be consumed
100	* in case the item is sensitive to the given key. The source of this
101	* event is the text component to which the corresponding action should
102	* be performed.
103	* @param bestMatch non-null completion item which is the current best match
104	* @param isSelected whether or not the best match is currently selected
105	*/
106	void processKeyEvent(@NonNull KeyEvent evt, @NonNull CompletionItem bestMatch, boolean isSelected);
107
108	/**
109	* Render this item into the given graphics.
110	*
111	* @param g graphics to render the item into.
112	* @param defaultFont default font used for rendering.
113	* @param foregroundColor foreground color used for rendering.
114	* @param backgroundColor color used for background.
115	* @param selectedForegroundColor foreground color used for rendering selected items.
116	* @param selectedBackgroundColor color used for background selected items.
117	* @param width width of the area to render into.
118	* @param height height of the are to render into.
119	* @param item non-null completion item to render.
120	* @param isBestMatch true if this item is the best match.
121	* @param isSelected true if this item is selected.
122	*/
123	void render(@NonNull Graphics g, @NonNull Font defaultFont, @NonNull Color foregroundColor,
124	@NonNull Color backgroundColor, @NonNull Color selectedForegroundColor,
125	@NonNull Color selectedBackgroundColor, int width, int height, @NonNull CompletionItem item,
126	boolean isBestMatch, boolean isSelected);
127
128	/**
129	* When enabled for the item the instant substitution should process the item
130	* in the same way like when the item is displayed and Enter key gets pressed
131	* by the user.
132	* <br>
133	* Instant substitution is invoked when there would be just a single item
134	* displayed in the completion popup window.
135	* <br>
136	* The implementation can invoke the {@link #defaultAction(JTextComponent)}
137	* if necessary.
138	* <br/>
139	* This method gets invoked from AWT thread.
140	*
141	* @param uniqueMatch non-null unique completion item to perform the instant
142	* substitution.
143	* @return <code>true</code> if the instant substitution was successfully done.
144	* <code>false</code> means that the instant substitution should not be done
145	* for this item and the completion item should normally be displayed.
146	*/
147	boolean instantSubstitution(@NonNull CompletionItem uniqueMatch);
148
149	/**
150	* Represents an initial selected CompletionItem for code completion. This
151	* item can be seen as the best match for a given input.
152	*/
153	public static final class Selection {
154	/**
155	* The default selected item. The item has index 0 and is not selected
156	* or unique.
157	*/
158	public static final Selection DEFAULT = new Selection(0, false, false);
159
160	private final int index;
161	private final boolean selected;
162	private final boolean unique;
163
164	/**
165	* Initializes a Selection with the specified index. The item is selected
166	* but not unique.
167	*
168	* @param index The index of the selected CompletionItem.
169	*
170	* @throws IllegalArgumentException when the index argument is less than zero.
171	*/
172	public Selection(int index) {
173	this(index, true, false);
174	}
175
176	/**
177	* Initializes a Selection with the specified index and selected state.
178	* The item is not unique.
179	*
180	* @param index The index of the selected CompletionItem.
181	* @param selected <code>true</code> if the match is selected, otherwise
182	* <code>false</code>.
183	*
184	* @throws IllegalArgumentException when the index argument is less than zero.
185	*/
186	public Selection(int index, boolean selected) {
187	this(index, selected, false);
188	}
189
190	/**
191	* Initializes a Selection with the specified index, selected state, and
192	* uniqueness.
193	*
194	* @param index The index of the selected CompletionItem.
195	* @param selected <code>true</code> if the match is selected, otherwise
196	* <code>false</code>.
197	* @param unique <code>true</code> if the match is unique, otherwise
198	* <code>false</code>.
199	*
200	* @throws IllegalArgumentException when the index argument is less than zero.
201	*/
202	public Selection(int index, boolean selected, boolean unique) {
203	if (index < 0) {
204	throw new IllegalArgumentException("The index cannot be negative."); // NOI18N
205	}
206
207	this.index = index;
208	this.selected = selected;
209	this.unique = unique;
210	}
211
212	/**
213	*
214	* @return The index of the selected CompletionItem.
215	*/
216	public int getIndex() {
217	return index;
218	}
219
220	/**
221	*
222	* @return <code>true</code> if the match is selected, otherwise <code>false</code>.
223	*/
224	public boolean isSelected() {
225	return selected;
226	}
227
228	/**
229	*
230	* @return <code>true</code> if the match is unique, otherwise <code>false</code>.
231	*/
232	public boolean isUnique() {
233	return unique;
234	}
235	}
236	}

Added Link Here

(-)81cafa2674cb (+73 lines)
1	/*
2	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3	*
4	* Copyright 2011 Oracle and/or its affiliates. All rights reserved.
5	*
6	* Oracle and Java are registered trademarks of Oracle and/or its affiliates.
7	* Other names may be trademarks of their respective owners.
8	*
9	* The contents of this file are subject to the terms of either the GNU
10	* General Public License Version 2 only ("GPL") or the Common
11	* Development and Distribution License("CDDL") (collectively, the
12	* "License"). You may not use this file except in compliance with the
13	* License. You can obtain a copy of the License at
14	* http://www.netbeans.org/cddl-gplv2.html
15	* or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
16	* specific language governing permissions and limitations under the
17	* License. When distributing the software, include this License Header
18	* Notice in each file and include the License file at
19	* nbbuild/licenses/CDDL-GPL-2-CP. Oracle designates this
20	* particular file as subject to the "Classpath" exception as provided
21	* by Oracle in the GPL Version 2 section of the License file that
22	* accompanied this code. If applicable, add the following below the
23	* License Header, with the fields enclosed by brackets [] replaced by
24	* your own identifying information:
25	* "Portions Copyrighted [year] [name of copyright owner]"
26	*
27	* If you wish your version of this file to be governed by only the CDDL
28	* or only the GPL Version 2, indicate your decision by adding
29	* "[Contributor] elects to include this software in this distribution
30	* under the [CDDL or GPL Version 2] license." If you do not indicate a
31	* single choice of license, a recipient has the option to distribute
32	* your version of this file under either the CDDL, the GPL Version 2 or
33	* to extend the choice of license to its licensees as provided above.
34	* However, if you add GPL Version 2 code and therefore, elected the GPL
35	* Version 2 license, then the option applies only if the new code is
36	* made subject to such option by the copyright holder.
37	*
38	* Contributor(s):
39	*
40	* Portions Copyrighted 2011 Sun Microsystems, Inc.
41	*/
42	package org.netbeans.spi.editor.completion;
43
44	import javax.swing.text.JTextComponent;
45	import org.netbeans.api.annotations.common.CheckForNull;
46	import org.netbeans.api.annotations.common.NonNull;
47	import org.netbeans.spi.editor.mimelookup.MimeLocation;
48
49	/**
50	*
51	* @author Sam Harwell
52	*/
53	@MimeLocation(subfolderName="CompletionProviders")
54	public interface CompletionControllerProvider {
55
56	/**
57	* Creates a {@link CompletionController} which provides behavior for the
58	* code completion drop down.
59	*
60	* @param component The active component.
61	* @param task The completion task.
62	* @param queryType The completion query type.
63	*
64	* @return A {@link CompletionController} to provide behavior for the completion drop
65	* down, or <code>null</code> if this provider does not support the specified
66	* component, task, or query type.
67	*/
68	public @CheckForNull CompletionController createController(
69	@NonNull JTextComponent component,
70	@NonNull CompletionTask task,
71	int queryType);
72
73	}

Added Link Here

(-)81cafa2674cb (+195 lines)
1	/*
2	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3	*
4	* Copyright 1997-2010 Oracle and/or its affiliates. All rights reserved.
5	*
6	* Oracle and Java are registered trademarks of Oracle and/or its affiliates.
7	* Other names may be trademarks of their respective owners.
8	*
9	* The contents of this file are subject to the terms of either the GNU
10	* General Public License Version 2 only ("GPL") or the Common
11	* Development and Distribution License("CDDL") (collectively, the
12	* "License"). You may not use this file except in compliance with the
13	* License. You can obtain a copy of the License at
14	* http://www.netbeans.org/cddl-gplv2.html
15	* or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
16	* specific language governing permissions and limitations under the
17	* License. When distributing the software, include this License Header
18	* Notice in each file and include the License file at
19	* nbbuild/licenses/CDDL-GPL-2-CP. Oracle designates this
20	* particular file as subject to the "Classpath" exception as provided
21	* by Oracle in the GPL Version 2 section of the License file that
22	* accompanied this code. If applicable, add the following below the
23	* License Header, with the fields enclosed by brackets [] replaced by
24	* your own identifying information:
25	* "Portions Copyrighted [year] [name of copyright owner]"
26	*
27	* Contributor(s):
28	*
29	* The Original Software is NetBeans. The Initial Developer of the Original
30	* Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
31	* Microsystems, Inc. All Rights Reserved.
32	*
33	* If you wish your version of this file to be governed by only the CDDL
34	* or only the GPL Version 2, indicate your decision by adding
35	* "[Contributor] elects to include this software in this distribution
36	* under the [CDDL or GPL Version 2] license." If you do not indicate a
37	* single choice of license, a recipient has the option to distribute
38	* your version of this file under either the CDDL, the GPL Version 2 or
39	* to extend the choice of license to its licensees as provided above.
40	* However, if you add GPL Version 2 code and therefore, elected the GPL
41	* Version 2 license, then the option applies only if the new code is
42	* made subject to such option by the copyright holder.
43	*/
44
45	package org.netbeans.spi.editor.completion;
46
47	import java.util.Comparator;
48	import org.netbeans.api.annotations.common.NonNull;
49	import org.openide.util.Parameters;
50
51	/**
52	* Comparator for completion items either by sort priority or by sort text.
53	*
54	* @author Dusan Balek, Miloslav Metelka
55	*/
56
57	public class CompletionItemComparator implements Comparator<CompletionItem> {
58
59	/**
60	* A Comparator which sorts CompletionItem items by priority, then alphabetically.
61	*/
62	public static final Comparator<CompletionItem> BY_PRIORITY =
63	new CompletionItemComparator(new PriorityComparator(), new TextComparator());
64
65	/**
66	* A Comparator which sorts CompletionItem items alphabetically, then by priority.
67	*/
68	public static final Comparator<CompletionItem> ALPHABETICAL =
69	new CompletionItemComparator(new TextComparator(), new PriorityComparator());
70
71	private final Comparator<CompletionItem> primaryComparator;
72	private final Comparator<CompletionItem> secondaryComparator;
73
74	/**
75	* Constructs a CompletionItemComparator from the specified primary and secondary
76	* comparators.
77	*
78	* @param primaryComparator non-null primary comparator.
79	* @param secondaryComparator non-null secondary comparator.
80	*/
81	public CompletionItemComparator(@NonNull Comparator<CompletionItem> primaryComparator,
82	@NonNull Comparator<CompletionItem> secondaryComparator) {
83	Parameters.notNull("primaryComparator", primaryComparator);
84	Parameters.notNull("secondaryComparator", secondaryComparator);
85	this.primaryComparator = primaryComparator;
86	this.secondaryComparator = secondaryComparator;
87	}
88
89	/**
90	* Gets a default comparator that can be used for sorting CompletionItem lists
91	* for the specified sort type.
92	*
93	* @param sortType The sort type, one of {@link CompletionResultSet#PRIORITY_SORT_TYPE}
94	* or {@link CompletionResultSet#TEXT_SORT_TYPE}.
95	*
96	* @return The Comparator to use when sorting CompletionItem items.
97	*
98	* @throws IllegalArgumentException the sortType argument is not a supported type.
99	*/
100	public static Comparator<CompletionItem> get(int sortType) {
101	if (sortType == CompletionResultSet.PRIORITY_SORT_TYPE)
102	return BY_PRIORITY;
103
104	if (sortType == CompletionResultSet.TEXT_SORT_TYPE)
105	return ALPHABETICAL;
106
107	throw new IllegalArgumentException();
108	}
109
110	@Override
111	public int compare(CompletionItem i1, CompletionItem i2) {
112	if (i1 == i2)
113	return 0;
114
115	int primaryDiff = primaryComparator.compare(i1, i2);
116	if (primaryDiff != 0) {
117	return primaryDiff;
118	}
119
120	return secondaryComparator.compare(i1, i2);
121	}
122
123	/**
124	* A comparator which compares CompletionItem items by priority.
125	*
126	* @see CompletionItem#getSortPriority()
127	*/
128	protected static class PriorityComparator implements Comparator<CompletionItem> {
129
130	/**
131	* Initializes a PriorityComparator.
132	*/
133	public PriorityComparator() {
134	}
135
136	@Override
137	public int compare(CompletionItem o1, CompletionItem o2) {
138	if (o1 == o2) {
139	return 0;
140	}
141
142	return o1.getSortPriority() - o2.getSortPriority();
143	}
144
145	}
146
147	/**
148	* A Comparator which compares CompletionItem items by text.
149	*
150	* @see CompletionItem#getSortText()
151	*/
152	protected static class TextComparator implements Comparator<CompletionItem> {
153
154	/**
155	* Initializes a TextComparator.
156	*/
157	public TextComparator() {
158	}
159
160	@Override
161	public int compare(CompletionItem o1, CompletionItem o2) {
162	return compareText(o1.getSortText(), o2.getSortText());
163	}
164
165	/**
166	* Compares two CharSequence objects for order.
167	*
168	* @param text1 the first text to be compared
169	* @param text2 the second text to be compared
170	* @return a negative integer, zero, or a positive integer as the
171	* first argument is less than, equal to, or greater than the
172	* second.
173	*/
174	protected int compareText(CharSequence text1, CharSequence text2) {
175	if (text1 == null)
176	text1 = ""; //NOI18N
177
178	if (text2 == null)
179	text2 = ""; //NOI18N
180
181	int len = Math.min(text1.length(), text2.length());
182	for (int i = 0; i < len; i++) {
183	char ch1 = text1.charAt(i);
184	char ch2 = text2.charAt(i);
185	if (ch1 != ch2) {
186	return ch1 - ch2;
187	}
188	}
189
190	return text1.length() - text2.length();
191	}
192
193	}
194
195	}

Lines 67-88 Link Here

(-)a/editor.completion/src/org/netbeans/spi/editor/completion/CompletionProvider.java (-4 / +19 lines)
67	/**	67	/**
68	* The <code>int</code> value representing the query for a code completion.	68	* The <code>int</code> value representing the query for a code completion.
69	*/	69	*/
70	public static final int COMPLETION_QUERY_TYPE = 1;	70	public static final int COMPLETION_QUERY_TYPE = 0x01;
71		71
72	/**	72	/**
73	* The <code>int</code> value representing the query for a documentation.	73	* The <code>int</code> value representing the query for a documentation.
74	*/	74	*/
75	public static final int DOCUMENTATION_QUERY_TYPE = 2;	75	public static final int DOCUMENTATION_QUERY_TYPE = 0x02;
76		76
77	/**	77	/**
78	* The <code>int</code> value representing the query for a tooltip hint.	78	* The <code>int</code> value representing the query for a tooltip hint.
79	*/	79	*/
80	public static final int TOOLTIP_QUERY_TYPE = 4;	80	public static final int TOOLTIP_QUERY_TYPE = 0x04;
81		81
82	/**	82	/**
83	* The <code>int</code> value representing the query for an all code completion.	83	* The <code>int</code> value representing the query for an all code completion.
84	*/	84	*/
85	public static final int COMPLETION_ALL_QUERY_TYPE = 9;	85	public static final int COMPLETION_ALL_QUERY_TYPE = 0x11;
		86
		87	/**
		88	* The <code>int</code> mask representing the bits used for a completion query type.
		89	*/
		90	public static final int COMPLETION_QUERY_MASK = COMPLETION_QUERY_TYPE \| COMPLETION_ALL_QUERY_TYPE;
		91
		92	/**
		93	* The <code>int</code> mask of bits a user can specify to customize the query type.
		94	*/
		95	public static final int USER_QUERY_MASK = 0xFFFF0000;
		96
		97	/**
		98	* The <code>int</code> mask of bits used by the API to specify the query type.
		99	*/
		100	public static final int RESERVED_QUERY_MASK = ~USER_QUERY_MASK;
86		101
87	/**	102	/**
88	* Creates a task that performs a query of the given type on the given component.	103	* Creates a task that performs a query of the given type on the given component.