AbstractViewerFilterContributor.java

/**
 * This file Copyright (c) 2005-2010 Aptana, Inc. This program is
 * dual-licensed under both the Aptana Public License and the GNU General
 * Public license. You may elect to use one or the other of these licenses.
 * 
 * This program is distributed in the hope that it will be useful, but
 * AS-IS and WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, TITLE, or
 * NONINFRINGEMENT. Redistribution, except as permitted by whichever of
 * the GPL or APL you select, is prohibited.
 *
 * 1. For the GPL license (GPL), you can redistribute and/or modify this
 * program under the terms of the GNU General Public License,
 * Version 3, as published by the Free Software Foundation.  You should
 * have received a copy of the GNU General Public License, Version 3 along
 * with this program; if not, write to the Free Software Foundation, Inc., 51
 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 * 
 * Aptana provides a special exception to allow redistribution of this file
 * with certain other free and open source software ("FOSS") code and certain additional terms
 * pursuant to Section 7 of the GPL. You may view the exception and these
 * terms on the web at http://www.aptana.com/legal/gpl/.
 * 
 * 2. For the Aptana Public License (APL), this program and the
 * accompanying materials are made available under the terms of the APL
 * v1.0 which accompanies this distribution, and is available at
 * http://www.aptana.com/legal/apl/.
 * 
 * You may view the GPL, Aptana's exception and additional terms, and the
 * APL in the file titled license.html at the root of the corresponding
 * plugin containing this source file.
 * 
 * Any modifications to this file must keep this entire header intact.
 */
package com.aptana.ide.views;

import org.eclipse.jface.viewers.Viewer;
import org.eclipse.jface.viewers.ViewerFilter;

/**
 * A basic implementation of the {@link IViewerFilterContributor} which extends the {@link ViewerFilter}. Implementors
 * of the {@link IViewerFilterContributor} are advised to extends this class.
 * 
 * @author Shalom Gibly
 * @since Aptana Studio 1.2.6
 */
public abstract class AbstractViewerFilterContributor extends ViewerFilter implements IViewerFilterContributor
{
	protected Object data;

	public boolean select(Viewer viewer, Object parentElement, Object element, Object data)
	{
		setData(data);
		return select(viewer, parentElement, element);
	}

	/**
	 * Sets a data instance that can be used when invoking the {@link #select(Viewer, Object, Object)} method.
	 * 
	 * @param data
	 */
	public void setData(Object data)
	{
		this.data = data;
	}

	/**
	 * Returns the data instance that was attached to this contributor.
	 * 
	 * @return A data instance, or null.
	 */
	public Object getData()
	{
		return data;
	}
}