/*
 * Copyright (C) 2006 Davy Vanherbergen
 * dvanherbergen@users.sourceforge.net
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
package net.sourceforge.sqlexplorer.history.actions;

import net.sourceforge.sqlexplorer.history.SQLHistory;
import net.sourceforge.sqlexplorer.plugin.views.SQLHistoryView;

import org.eclipse.jface.action.Action;
import org.eclipse.jface.action.IAction;
import org.eclipse.jface.viewers.ISelection;
import org.eclipse.jface.viewers.TableViewer;
import org.eclipse.swt.widgets.Table;

/**
 * Abstract implementation for a context menu action of the SQL History View.
 * Extend this class to add new actions to the SQL History.
 * 
 * @author Davy Vanherbergen
 */
public abstract class AbstractHistoryContextAction extends Action {

    protected SQLHistory _history;

    protected Table _table;

    protected TableViewer _tableViewer;

    protected SQLHistoryView _view;

    /**
     * Implement this method to return true when your action is available for
     * the active table. When true, the action will be included in the context
     * menu, when false it will be ignored.
     * 
     * @return true if the action should be included in the context menu
     */
    public boolean isAvailable() {

        return true;
    }


    /**
     * Implement this method to return true when your action is enabled for the
     * active table. When true, the action will active in the context menu, when
     * false it will disabled
     * 
     * @return true if the action should be included in the context menu
     */
    public boolean isEnabled() {

        return true;
    }


    /*
     * (non-Javadoc)
     * 
     * @see org.eclipse.ui.IActionDelegate#selectionChanged(org.eclipse.jface.action.IAction,
     *      org.eclipse.jface.viewers.ISelection)
     */
    public void selectionChanged(IAction action, ISelection selection) {

        action.setEnabled(isEnabled());
    }


    /**
     * @param history SQLHistory
     */
    public final void setHistory(SQLHistory history) {

        _history = history;
    }


    /**
     * @param table Table displaying the SQL History Elements
     */
    public final void setTableViewer(TableViewer viewer) {

        _tableViewer = viewer;
        _table = viewer.getTable();
    }


    
    /**
     * @param view SQLHistory view
     */
    public void setView(SQLHistoryView view) {
        _view = view;
    }
    
    
}