001: /*******************************************************************************
002: * Copyright (c) 2005, 2006 IBM Corporation and others.
003: * All rights reserved. This program and the accompanying materials
004: * are made available under the terms of the Eclipse Public License v1.0
005: * which accompanies this distribution, and is available at
006: * http://www.eclipse.org/legal/epl-v10.html
007: *
008: * Contributors:
009: * IBM Corporation - initial API and implementation
010: *******************************************************************************/package org.eclipse.ui.internal.dialogs;
011:
012: import java.util.ArrayList;
013: import java.util.Collection;
014: import java.util.HashMap;
015: import java.util.Iterator;
016: import java.util.List;
017: import java.util.Map;
018:
019: import org.eclipse.jface.preference.IPreferenceNode;
020: import org.eclipse.jface.viewers.ITreeContentProvider;
021: import org.eclipse.jface.viewers.TreeViewer;
022: import org.eclipse.jface.viewers.Viewer;
023: import org.eclipse.ui.dialogs.PatternFilter;
024: import org.eclipse.ui.internal.preferences.WorkbenchPreferenceExtensionNode;
025:
026: /**
027: * A class that handles filtering preference node items based on a supplied
028: * matching string.
029: *
030: * @since 3.2
031: *
032: */
033: public class PreferencePatternFilter extends PatternFilter {
034:
035: /**
036: * this cache is needed because
037: * WorkbenchPreferenceExtensionNode.getKeywordLabels() is expensive. When it
038: * tracks keyword changes effectivly than this cache can be removed.
039: */
040: private Map keywordCache = new HashMap();
041:
042: /**
043: * Create a new instance of a PreferencePatternFilter
044: *
045: * @param isMatchItem
046: */
047: public PreferencePatternFilter() {
048: super ();
049: }
050:
051: /*
052: * Return true if the given Object matches with any possible keywords that
053: * have been provided. Currently this is only applicable for preference and
054: * property pages.
055: */
056: private String[] getKeywords(Object element) {
057: List keywordList = new ArrayList();
058: if (element instanceof WorkbenchPreferenceExtensionNode) {
059: WorkbenchPreferenceExtensionNode workbenchNode = (WorkbenchPreferenceExtensionNode) element;
060:
061: Collection keywordCollection = (Collection) keywordCache
062: .get(element);
063: if (keywordCollection == null) {
064: keywordCollection = workbenchNode.getKeywordLabels();
065: keywordCache.put(element, keywordCollection);
066: }
067: if (!keywordCollection.isEmpty()) {
068: Iterator keywords = keywordCollection.iterator();
069: while (keywords.hasNext()) {
070: keywordList.add(keywords.next());
071: }
072: }
073: }
074: return (String[]) keywordList.toArray(new String[keywordList
075: .size()]);
076: }
077:
078: /*
079: * (non-Javadoc)
080: *
081: * @see org.eclipse.ui.internal.dialogs.PatternFilter#isElementSelectable(java.lang.Object)
082: */
083: public boolean isElementSelectable(Object element) {
084: return element instanceof WorkbenchPreferenceExtensionNode;
085: }
086:
087: /* (non-Javadoc)
088: * @see org.eclipse.ui.dialogs.PatternFilter#isElementVisible(org.eclipse.jface.viewers.Viewer, java.lang.Object)
089: */
090: public boolean isElementVisible(Viewer viewer, Object element) {
091: // Preference nodes are not differentiated based on category since
092: // categories are selectable nodes.
093: if (isLeafMatch(viewer, element)) {
094: return true;
095: }
096:
097: ITreeContentProvider contentProvider = (ITreeContentProvider) ((TreeViewer) viewer)
098: .getContentProvider();
099: IPreferenceNode node = (IPreferenceNode) element;
100: Object[] children = contentProvider.getChildren(node);
101: // Will return true if any subnode of the element matches the search
102: if (filter(viewer, element, children).length > 0) {
103: return true;
104: }
105: return false;
106: }
107:
108: /* (non-Javadoc)
109: * @see org.eclipse.ui.dialogs.PatternFilter#isLeafMatch(org.eclipse.jface.viewers.Viewer, java.lang.Object)
110: *
111: */
112: protected boolean isLeafMatch(Viewer viewer, Object element) {
113: IPreferenceNode node = (IPreferenceNode) element;
114: String text = node.getLabelText();
115:
116: if (wordMatches(text)) {
117: return true;
118: }
119:
120: // Also need to check the keywords
121: String[] keywords = getKeywords(node);
122: for (int i = 0; i < keywords.length; i++) {
123: if (wordMatches(keywords[i])) {
124: return true;
125: }
126: }
127: return false;
128: }
129:
130: }
|