UnifiedEditorAction.java

/**
 * This file Copyright (c) 2005-2008 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.editors.actions;

import org.eclipse.jface.action.Action;
import org.eclipse.jface.util.IPropertyChangeListener;

import com.aptana.ide.editors.unified.IFileLanguageService;
import com.aptana.ide.editors.unified.IUnifiedEditor;
import com.aptana.ide.editors.unified.UnifiedEditor;

/**
 * UnifiedEditorAction
 * 
 * @author Ingo Muschenetz
 */
public abstract class UnifiedEditorAction extends Action
{
	private IFileLanguageService service;
	private UnifiedEditor editor;

	/**
	 * UnifiedEditorAction
	 * 
	 * @param actionId
	 * @param actionText
	 */
	public UnifiedEditorAction(String actionId, String actionText)
	{
		this.setText(actionText);
		this.setActionDefinitionId(actionId);
	}

	/**
	 * Returns the unified editor that this action is associated with.
	 * 
	 * @return IUnifiedEditor
	 */
	protected IUnifiedEditor getActiveEditor()
	{
		return editor;
	}

	/**
	 * Returns the RuntimeEnvironment that this action is associated with.
	 * 
	 * @return JSFileLanguageService
	 */
	protected IFileLanguageService getFileService()
	{
		return service;
	}

	/**
	 * Hook to deal with being associated with a new editor.
	 */
	protected void onActiveEditorChanged()
	{
	}

	/**
	 * Sets the editor that this action is associated with.
	 * 
	 * @param editor
	 * @param service
	 */
	public final void setActiveEditor(UnifiedEditor editor, IFileLanguageService service)
	{
		this.service = service;
		this.editor = editor;

		if (editor != null)
		{
			editor.getSite().getKeyBindingService().unregisterAction(this);
		}

		if (editor != null)
		{
			editor.getSite().getKeyBindingService().registerAction(this);
		}

		onActiveEditorChanged();
	}

	/**
	 * @see org.eclipse.jface.action.Action#removePropertyChangeListener(org.eclipse.jface.util.IPropertyChangeListener)
	 */
	public void removePropertyChangeListener(IPropertyChangeListener listener)
	{
		super.removePropertyChangeListener(listener);
	}

	/**
	 * dispose any lingering refs
	 */
	public void dispose()
	{
		this.service = null;
		this.editor = null;
	}
}