/*******************************************************************************
* Copyright (c) 2007, 2015 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.ui.internal.views.markers;
import org.eclipse.core.resources.IMarker;
import org.eclipse.ui.IMemento;
import org.eclipse.ui.views.markers.MarkerFieldFilter;
import org.eclipse.ui.views.markers.MarkerItem;
import org.eclipse.ui.views.markers.internal.ProblemFilter;
/**
* CompletionFieldFilter is the field filter for marker fields.
*
* @since 3.4
*
*/
public class CompletionFieldFilter extends CompatibilityFieldFilter {
final static int COMPLETED = 2;
final static int NOT_COMPLETED = 1;
private static int ALL_SELECTED = COMPLETED + NOT_COMPLETED;
private int completion = ALL_SELECTED;
private static String COMPLETION_ATTRIBUTE = "completion"; //$NON-NLS-1$
/**
* Tag for the done value.
*/
private static final String TAG_DONE = "done"; //$NON-NLS-1$
/**
* Create a new instance of the receiver.
*/
public CompletionFieldFilter() {
super();
}
@Override
public void loadSettings(IMemento memento) {
Integer completionValue = memento.getInteger(COMPLETION_ATTRIBUTE);
if (completionValue == null)
return;
completion = completionValue.intValue();
}
@Override
void loadLegacySettings(IMemento memento, MarkerContentGenerator generator) {
String setting = memento.getString(TAG_DONE);
if (setting != null) {
completion = Boolean.valueOf(setting).booleanValue() ? COMPLETED : NOT_COMPLETED;
}
}
@Override
public void initialize(ProblemFilter problemFilter) {
//Problem filters have no completion value
}
@Override
public void saveSettings(IMemento memento) {
memento.putInteger(COMPLETION_ATTRIBUTE, completion);
}
@Override
public boolean select(MarkerItem item) {
if (completion == ALL_SELECTED)
return true;
if (item.getAttributeValue(IMarker.USER_EDITABLE, true)) {
if (item.getAttributeValue(IMarker.DONE, false))
return (completion & COMPLETED) > 0;
return (completion & NOT_COMPLETED) > 0;
}
return false;
}
/**
* Get the completion settings.
* @return int
* @see #COMPLETED
* @see #NOT_COMPLETED
*/
int getCompletion() {
return completion;
}
/**
* Set the completion settings.
* @param completion the completion value
* @see #COMPLETED
* @see #NOT_COMPLETED
*/
void setCompletion(int completion) {
this.completion = completion;
}
@Override
public void populateWorkingCopy(MarkerFieldFilter copy) {
super.populateWorkingCopy(copy);
((CompletionFieldFilter)copy).setCompletion(getCompletion());
}
}