|
Added
Link Here
|
| 1 |
package org.eclipse.wst.sse.ui.views.contentoutline; |
| 2 |
|
| 3 |
/******************************************************************************* |
| 4 |
* Copyright (c) 2001, 2010 IBM Corporation and others. |
| 5 |
* All rights reserved. This program and the accompanying materials |
| 6 |
* are made available under the terms of the Eclipse Public License v1.0 |
| 7 |
* which accompanies this distribution, and is available at |
| 8 |
* http://www.eclipse.org/legal/epl-v10.html |
| 9 |
* |
| 10 |
* Contributors: |
| 11 |
* IBM Corporation - initial API and implementation |
| 12 |
*******************************************************************************/ |
| 13 |
|
| 14 |
|
| 15 |
import java.util.ArrayList; |
| 16 |
import java.util.HashMap; |
| 17 |
import java.util.HashSet; |
| 18 |
import java.util.Iterator; |
| 19 |
import java.util.Map; |
| 20 |
|
| 21 |
import org.eclipse.core.runtime.Assert; |
| 22 |
import org.eclipse.jdt.internal.ui.JavaPlugin; |
| 23 |
import org.eclipse.jdt.internal.ui.filters.CustomFiltersDialog; |
| 24 |
import org.eclipse.jdt.internal.ui.filters.FilterDescriptor; |
| 25 |
import org.eclipse.jdt.internal.ui.filters.NamePatternFilter; |
| 26 |
import org.eclipse.jdt.internal.ui.util.StringMatcher; |
| 27 |
import org.eclipse.jface.preference.IPreferenceStore; |
| 28 |
import org.eclipse.jface.viewers.StructuredViewer; |
| 29 |
import org.eclipse.jface.viewers.Viewer; |
| 30 |
import org.eclipse.jface.viewers.ViewerFilter; |
| 31 |
import org.eclipse.jface.window.Window; |
| 32 |
import org.eclipse.wst.sse.ui.internal.SSEUIMessages; |
| 33 |
import org.eclipse.wst.sse.ui.internal.contentoutline.PropertyChangeUpdateAction; |
| 34 |
import org.w3c.dom.Node; |
| 35 |
|
| 36 |
/** |
| 37 |
* Action group to add the filter action to a view part's tool bar |
| 38 |
* menu. |
| 39 |
* <p> |
| 40 |
* This class may be instantiated; it is not intended to be subclassed. |
| 41 |
* </p> |
| 42 |
* |
| 43 |
* @since 2.0 |
| 44 |
* |
| 45 |
* @noextend This class is not intended to be subclassed by clients. |
| 46 |
*/ |
| 47 |
public class CustomFilterAction extends PropertyChangeUpdateAction { |
| 48 |
|
| 49 |
|
| 50 |
private static final String SEPARATOR= ","; //$NON-NLS-1$ |
| 51 |
private final String TAG_USER_DEFINED_PATTERNS_ENABLED= "userDefinedPatternsEnabled"; //$NON-NLS-1$ |
| 52 |
private final String TAG_USER_DEFINED_PATTERNS= "userDefinedPatterns"; //$NON-NLS-1$ |
| 53 |
|
| 54 |
|
| 55 |
private static class FilterItem { |
| 56 |
boolean enabled; |
| 57 |
boolean previouslyEnabled; |
| 58 |
FilterDescriptor descriptor; |
| 59 |
String id; |
| 60 |
|
| 61 |
private ViewerFilter filterInstance= null; |
| 62 |
|
| 63 |
public FilterItem(FilterDescriptor descriptor) { |
| 64 |
this.descriptor= descriptor; |
| 65 |
this.id= descriptor.getId(); |
| 66 |
this.previouslyEnabled= false; |
| 67 |
this.enabled= descriptor.isEnabled(); |
| 68 |
} |
| 69 |
|
| 70 |
public ViewerFilter getFilterInstance() { |
| 71 |
if (filterInstance == null) { |
| 72 |
filterInstance= descriptor.createViewerFilter(); |
| 73 |
} |
| 74 |
return filterInstance; |
| 75 |
|
| 76 |
} |
| 77 |
} |
| 78 |
|
| 79 |
|
| 80 |
private final StructuredViewer fViewer; |
| 81 |
private final SSENamePatternFilter fPatternFilter; |
| 82 |
|
| 83 |
private boolean fUserDefinedPatternsEnabled; |
| 84 |
private String[] fUserDefinedPatterns; |
| 85 |
|
| 86 |
private String[] fPreviousPatterns; |
| 87 |
|
| 88 |
private final Map fFilterItems; |
| 89 |
|
| 90 |
|
| 91 |
|
| 92 |
private final String fTargetId; |
| 93 |
private IPreferenceStore fStore; |
| 94 |
|
| 95 |
|
| 96 |
/** |
| 97 |
* Creates a new <code>CustomFilterAction</code>. |
| 98 |
* |
| 99 |
* @param store the preference Store |
| 100 |
* @param ownerId the id of this action group's owner |
| 101 |
* @param viewer the viewer to be filtered |
| 102 |
*/ |
| 103 |
public CustomFilterAction(IPreferenceStore store,String ownerId, StructuredViewer viewer) { |
| 104 |
super(SSEUIMessages.ContentOutlineConfiguration_2, store, ownerId, store.getBoolean(ownerId)); //$NON-NLS-1$ |
| 105 |
Assert.isNotNull(ownerId); |
| 106 |
Assert.isNotNull(viewer); |
| 107 |
fStore = store; |
| 108 |
fTargetId= ownerId; |
| 109 |
fViewer= viewer; |
| 110 |
fPatternFilter= new SSENamePatternFilter(); |
| 111 |
|
| 112 |
fUserDefinedPatterns= new String[0]; |
| 113 |
fUserDefinedPatternsEnabled= false; |
| 114 |
fPreviousPatterns= new String[0]; |
| 115 |
|
| 116 |
fFilterItems= new HashMap(); |
| 117 |
FilterDescriptor[] filterDescriptors= FilterDescriptor.getFilterDescriptors(fTargetId); |
| 118 |
for (int i= 0; i < filterDescriptors.length; i++) { |
| 119 |
FilterItem item= new FilterItem(filterDescriptors[i]); |
| 120 |
Object existing= fFilterItems.put(item.id, item); |
| 121 |
if (existing != null) { |
| 122 |
JavaPlugin.logErrorMessage("WARNING: Duplicate id for extension-point \"org.eclipse.wst.sse.ui.sseElementFilters\" in " + ownerId); //$NON-NLS-1$ |
| 123 |
} |
| 124 |
} |
| 125 |
|
| 126 |
initializeWithViewDefaults(); |
| 127 |
|
| 128 |
updateViewerFilters(); |
| 129 |
|
| 130 |
} |
| 131 |
|
| 132 |
public void update() { |
| 133 |
openDialog(); |
| 134 |
} |
| 135 |
|
| 136 |
|
| 137 |
|
| 138 |
/* |
| 139 |
* @see org.eclipse.jface.action.IContributionItem#isDynamic() |
| 140 |
*/ |
| 141 |
public boolean isDynamic() { |
| 142 |
return true; |
| 143 |
} |
| 144 |
/** |
| 145 |
* Returns a list of currently enabled filters. The filter |
| 146 |
* is identified by its id. |
| 147 |
* <p> |
| 148 |
* This method is for internal use only and should not |
| 149 |
* be called by clients outside of JDT/UI. |
| 150 |
* </p> |
| 151 |
* |
| 152 |
* @return a list of currently enabled filters |
| 153 |
* |
| 154 |
* @since 3.1 |
| 155 |
* |
| 156 |
* @noreference This method is not intended to be referenced by clients. |
| 157 |
*/ |
| 158 |
public String[] internalGetEnabledFilterIds() { |
| 159 |
ArrayList enabledFilterIds= new ArrayList(); |
| 160 |
for (Iterator iterator= fFilterItems.values().iterator(); iterator.hasNext();) { |
| 161 |
FilterItem item= (FilterItem) iterator.next(); |
| 162 |
if (item.enabled) { |
| 163 |
enabledFilterIds.add(item.id); |
| 164 |
} |
| 165 |
} |
| 166 |
return (String[])enabledFilterIds.toArray(new String[enabledFilterIds.size()]); |
| 167 |
} |
| 168 |
|
| 169 |
private void setEnabledFilterIds(String[] enabledIds) { |
| 170 |
// set all to false |
| 171 |
fUserDefinedPatternsEnabled= false; |
| 172 |
for (Iterator iterator= fFilterItems.values().iterator(); iterator.hasNext();) { |
| 173 |
FilterItem item= (FilterItem) iterator.next(); |
| 174 |
item.enabled= false; |
| 175 |
} |
| 176 |
// set enabled to true |
| 177 |
for (int i= 0; i < enabledIds.length; i++) { |
| 178 |
FilterItem item= (FilterItem) fFilterItems.get(enabledIds[i]); |
| 179 |
if (item != null) { |
| 180 |
item.enabled= true; |
| 181 |
} |
| 182 |
if (fPatternFilter.getClass().getName().equals(enabledIds[i])) |
| 183 |
fUserDefinedPatternsEnabled= true; |
| 184 |
} |
| 185 |
} |
| 186 |
|
| 187 |
private void setUserDefinedPatterns(String[] patterns) { |
| 188 |
fUserDefinedPatterns= patterns; |
| 189 |
} |
| 190 |
|
| 191 |
|
| 192 |
private boolean areUserDefinedPatternsEnabled() { |
| 193 |
return fUserDefinedPatternsEnabled; |
| 194 |
} |
| 195 |
|
| 196 |
private void setUserDefinedPatternsEnabled(boolean state) { |
| 197 |
fUserDefinedPatternsEnabled= state; |
| 198 |
} |
| 199 |
|
| 200 |
|
| 201 |
// ---------- viewer filter handling ---------- |
| 202 |
|
| 203 |
private boolean updateViewerFilters() { |
| 204 |
ViewerFilter[] installedFilters= fViewer.getFilters(); |
| 205 |
ArrayList viewerFilters= new ArrayList(installedFilters.length); |
| 206 |
|
| 207 |
HashSet patterns= new HashSet(); |
| 208 |
|
| 209 |
boolean hasChange= false; |
| 210 |
boolean patternChange= false; |
| 211 |
|
| 212 |
for (Iterator iterator= fFilterItems.values().iterator(); iterator.hasNext();) { |
| 213 |
FilterItem item= (FilterItem) iterator.next(); |
| 214 |
if (item.descriptor.isCustomFilter()) { |
| 215 |
if (item.enabled != item.previouslyEnabled) { |
| 216 |
hasChange = true; |
| 217 |
} |
| 218 |
if (item.enabled){ |
| 219 |
ViewerFilter filter= item.getFilterInstance(); // only create when changed |
| 220 |
if (filter != null) { |
| 221 |
viewerFilters.add(filter); |
| 222 |
} |
| 223 |
} |
| 224 |
} else if (item.descriptor.isPatternFilter()) { |
| 225 |
if (item.enabled) { |
| 226 |
patterns.add(item.descriptor.getPattern()); |
| 227 |
} |
| 228 |
patternChange |= (item.enabled != item.previouslyEnabled); |
| 229 |
} |
| 230 |
item.previouslyEnabled= item.enabled; |
| 231 |
} |
| 232 |
|
| 233 |
if (areUserDefinedPatternsEnabled()) { |
| 234 |
for (int i= 0; i < fUserDefinedPatterns.length; i++) { |
| 235 |
patterns.add(fUserDefinedPatterns[i]); |
| 236 |
} |
| 237 |
} |
| 238 |
if (!patternChange) { // no pattern change so far, test if the user patterns made a difference |
| 239 |
patternChange= hasChanges(patterns, fPreviousPatterns); |
| 240 |
} |
| 241 |
|
| 242 |
fPreviousPatterns= (String[]) patterns.toArray(new String[patterns.size()]); |
| 243 |
if (patternChange) { |
| 244 |
fPatternFilter.setPatterns(fPreviousPatterns); |
| 245 |
if (patterns.isEmpty()) { |
| 246 |
viewerFilters.remove(fPatternFilter); |
| 247 |
} else if (!viewerFilters.contains(fPatternFilter)) { |
| 248 |
boolean contains = false; |
| 249 |
for (int i=0; i< viewerFilters.size();i++){ |
| 250 |
if (viewerFilters.get(i) instanceof SSENamePatternFilter){ |
| 251 |
SSENamePatternFilter filter = (SSENamePatternFilter)viewerFilters.get(i); |
| 252 |
String[] a1 =filter.getPatterns(); |
| 253 |
String[] a2 =fPatternFilter.getPatterns(); |
| 254 |
if (a1[0].equals(a2[0])) |
| 255 |
contains= true; |
| 256 |
else { |
| 257 |
viewerFilters.remove(i); |
| 258 |
} |
| 259 |
break; |
| 260 |
} |
| 261 |
} |
| 262 |
if (!contains) |
| 263 |
viewerFilters.add(fPatternFilter); |
| 264 |
} |
| 265 |
hasChange= true; |
| 266 |
} |
| 267 |
if (hasChange) { |
| 268 |
fViewer.setFilters((ViewerFilter[]) viewerFilters.toArray(new ViewerFilter[viewerFilters.size()])); // will refresh |
| 269 |
} |
| 270 |
return hasChange; |
| 271 |
} |
| 272 |
|
| 273 |
private boolean hasChanges(HashSet patterns, String[] oldPatterns) { |
| 274 |
HashSet copy= (HashSet) patterns.clone(); |
| 275 |
for (int i= 0; i < oldPatterns.length; i++) { |
| 276 |
boolean found= copy.remove(oldPatterns[i]); |
| 277 |
if (!found) |
| 278 |
return true; |
| 279 |
} |
| 280 |
return !copy.isEmpty(); |
| 281 |
} |
| 282 |
|
| 283 |
// ---------- view kind/defaults persistency ---------- |
| 284 |
|
| 285 |
private void initializeWithViewDefaults() { |
| 286 |
// get default values for view |
| 287 |
|
| 288 |
|
| 289 |
fUserDefinedPatternsEnabled= fStore.getBoolean(getPreferenceKey(TAG_USER_DEFINED_PATTERNS_ENABLED)); |
| 290 |
setUserDefinedPatterns(CustomFiltersDialog.convertFromString(fStore.getString(getPreferenceKey(TAG_USER_DEFINED_PATTERNS)), SEPARATOR)); |
| 291 |
|
| 292 |
for (Iterator iterator= fFilterItems.values().iterator(); iterator.hasNext();) { |
| 293 |
FilterItem item= (FilterItem) iterator.next(); |
| 294 |
String id= item.id; |
| 295 |
// set default to value from plugin contributions (fixes https://bugs.eclipse.org/bugs/show_bug.cgi?id=73991 ): |
| 296 |
fStore.setDefault(id, item.descriptor.isEnabled()); |
| 297 |
item.enabled= fStore.getBoolean(id); |
| 298 |
} |
| 299 |
|
| 300 |
} |
| 301 |
|
| 302 |
private void storeViewDefaults() { |
| 303 |
// get default values for view |
| 304 |
|
| 305 |
fStore.setValue(getPreferenceKey(TAG_USER_DEFINED_PATTERNS_ENABLED), fUserDefinedPatternsEnabled); |
| 306 |
fStore.setValue(getPreferenceKey(TAG_USER_DEFINED_PATTERNS), CustomFiltersDialog.convertToString(fUserDefinedPatterns ,SEPARATOR)); |
| 307 |
|
| 308 |
boolean fFilterSelected = false; |
| 309 |
for (Iterator iterator= fFilterItems.values().iterator(); iterator.hasNext();) { |
| 310 |
FilterItem item= (FilterItem) iterator.next(); |
| 311 |
fStore.setValue(item.id, item.enabled); |
| 312 |
if (item.enabled) |
| 313 |
fFilterSelected = true; |
| 314 |
} |
| 315 |
|
| 316 |
fStore.setValue(fTargetId, fUserDefinedPatternsEnabled || fFilterSelected); |
| 317 |
|
| 318 |
} |
| 319 |
|
| 320 |
private String getPreferenceKey(String tag) { |
| 321 |
return "CustomFiltersActionGroup." + fTargetId + '.' + tag; //$NON-NLS-1$ |
| 322 |
} |
| 323 |
|
| 324 |
|
| 325 |
private void openDialog() { |
| 326 |
CustomFiltersDialog dialog= new CustomFiltersDialog( |
| 327 |
fViewer.getControl().getShell(), |
| 328 |
fTargetId, |
| 329 |
areUserDefinedPatternsEnabled(), |
| 330 |
fUserDefinedPatterns, |
| 331 |
internalGetEnabledFilterIds()); |
| 332 |
|
| 333 |
if (dialog.open() == Window.OK) { |
| 334 |
setEnabledFilterIds(dialog.getEnabledFilterIds()); |
| 335 |
setUserDefinedPatternsEnabled(dialog.areUserDefinedPatternsEnabled()); |
| 336 |
setUserDefinedPatterns(dialog.getUserDefinedPatterns()); |
| 337 |
storeViewDefaults(); |
| 338 |
|
| 339 |
updateViewerFilters(); |
| 340 |
} |
| 341 |
else { |
| 342 |
storeViewDefaults(); |
| 343 |
} |
| 344 |
} |
| 345 |
|
| 346 |
|
| 347 |
public class SSENamePatternFilter extends NamePatternFilter{ |
| 348 |
public boolean select(Viewer viewer, Object parentElement, Object element) { |
| 349 |
if (getPatterns().length == 0) { |
| 350 |
return true; |
| 351 |
} |
| 352 |
String matchName= null; |
| 353 |
if (element instanceof Node){ |
| 354 |
matchName =((Node)element).getNodeName(); |
| 355 |
} |
| 356 |
if (matchName != null && matchName.length() > 0) { |
| 357 |
String[] fPatterns = getPatterns(); |
| 358 |
for (int i = 0; i < fPatterns.length; i++) { |
| 359 |
if (new StringMatcher(fPatterns[i], true, false).match(matchName)) |
| 360 |
return false; |
| 361 |
} |
| 362 |
return true; |
| 363 |
} |
| 364 |
return true; |
| 365 |
} |
| 366 |
} |
| 367 |
} |
| 368 |
|