TaskPaneAction.java

/*
 * This file is part of the aidGer project.
 *
 * Copyright (C) 2010-2013 The aidGer Team
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package de.aidger.controller.actions;

import java.awt.Cursor;
import java.awt.event.ActionEvent;
import java.awt.event.MouseEvent;

import javax.swing.Action;
import javax.swing.SwingUtilities;

import de.aidger.view.TaskPane;
import de.aidger.view.UI;
import de.aidger.view.tabs.ActivityReportViewerTab;
import de.aidger.view.tabs.BalanceViewerTab;
import de.aidger.view.tabs.BudgetViewerTab;
import de.aidger.view.tabs.ControllingViewerTab;
import de.aidger.view.tabs.EditorTab;
import de.aidger.view.tabs.EmptyTab;
import de.aidger.view.tabs.FinancialControllingViewerTab;
import de.aidger.view.tabs.ProtocolViewerTab;
import de.aidger.view.tabs.Tab;
import de.aidger.view.tabs.ViewerTab;
import de.aidger.view.tabs.ViewerTab.DataType;

/**
 * Base class for all task pane actions.
 * 
 * @author aidGer Team
 */
@SuppressWarnings("serial")
public class TaskPaneAction extends LinkAction {
    /**
     * All possible tasks that can open tabs.
     * 
     * @author aidGer Team
     */
    public enum Task {

        ViewCourses, ViewAssistants, ViewFinancialCategories, ViewHourlyWages, ViewCostUnits, ViewEmployments, CreateNewEmployment, ViewContracts, ViewActivities, CreateNewActivity, ExportActivities, ViewFullBalance, ViewAnnualBalance, ViewSemesterBalance, ViewActivityReport, CheckCourses, CheckAssistants, CheckFinancialCategories, ViewEmpty, Void

    }

    /**
     * The task of the action.
     */
    private final Task task;

    /**
     * The task pane of the action.
     */
    private TaskPane taskPane;

    /**
     * A flag whether the task pane link should be opened.
     */
    private boolean openLink = true;

    /**
     * Constructs a task pane action.
     * 
     * @param name
     *            the action name
     * @param tabName
     *            the tab name that will be opened on click
     */
    public TaskPaneAction(String name, Task task) {
        putValue(Action.NAME, name);

        this.task = task;
    }

    /*
     * (non-Javadoc)
     * 
     * @see javax.swing.AbstractAction#clone()
     */
    @Override
    public TaskPaneAction clone() {
        return new TaskPaneAction((String) getValue(Action.NAME), task);
    }

    /**
     * Sets the task pane of the action.
     * 
     * @param tp
     *            the task pane
     */
    public void setTaskPane(TaskPane tp) {
        taskPane = tp;
    }

    /**
     * The task pane link will not be opened after click.
     */
    public void dropLink() {
        openLink = false;
    }

    /**
     * Returns a new tab of the actions task. If there is no tab for the given
     * task, null will be returned.
     * 
     * @return the new tab
     */
    private Tab getNewTab() {
        switch (task) {
        case ViewCourses:
            return new ViewerTab(DataType.Course);
        case ViewAssistants:
            return new ViewerTab(DataType.Assistant);
        case ViewFinancialCategories:
            return new ViewerTab(DataType.FinancialCategory);
        case ViewHourlyWages:
            return new ViewerTab(DataType.HourlyWage);
        case ViewCostUnits:
            return new ViewerTab(DataType.CostUnit);
        case ViewEmployments:
            return new ViewerTab(DataType.Employment);
        case CreateNewEmployment:
            return new EditorTab(DataType.Employment);
        case ViewContracts:
            return new ViewerTab(DataType.Contract);
        case ViewActivities:
            return new ViewerTab(DataType.Activity);
        case CreateNewActivity:
            return new EditorTab(DataType.Activity);
        case ExportActivities:
            return new ProtocolViewerTab();
        case ViewFullBalance:
            return new BalanceViewerTab(1);
        case ViewAnnualBalance:
            return new BalanceViewerTab(2);
        case ViewSemesterBalance:
            return new BalanceViewerTab(3);
        case ViewActivityReport:
            return new ActivityReportViewerTab();
        case CheckCourses:
            return new BudgetViewerTab();
        case CheckAssistants:
            return new ControllingViewerTab();
        case CheckFinancialCategories:
            return new FinancialControllingViewerTab();
        case ViewEmpty:
            return new EmptyTab();
        case Void:
        default:
            return null;
        }
    }

    /*
     * (non-Javadoc)
     * 
     * @see java.awt.event.MouseListener#mouseClicked(java.awt.event.MouseEvent)
     */
    @Override
    public void mouseClicked(MouseEvent e) {
        if (SwingUtilities.isLeftMouseButton(e)) {
            // handling for a click on the title bar
            if (taskPane != null) {
                if (!openLink || task == Task.Void) {
                    taskPane.setExpanded(!taskPane.isExpanded());

                    UI.getInstance().validate();

                    return;
                } else if (!taskPane.isExpanded()) {
                    taskPane.setExpanded(true);

                    UI.getInstance().validate();
                }
            }

            Tab tab = getNewTab();

            if (tab != null) {
                UI.getInstance().addNewTab(tab);
            }
        } else if (SwingUtilities.isMiddleMouseButton(e)) {
            Tab tab = getNewTab();

            if (tab != null) {
                UI.getInstance().replaceCurrentTab(tab);
            }
        }
    }

    /*
     * (non-Javadoc)
     * 
     * @see java.awt.event.MouseListener#mouseEntered(java.awt.event.MouseEvent)
     */
    @Override
    public void mouseEntered(MouseEvent e) {
        e.getComponent().setCursor(
            Cursor.getPredefinedCursor(Cursor.HAND_CURSOR));
    }

    /*
     * (non-Javadoc)
     * 
     * @see java.awt.event.MouseListener#mouseExited(java.awt.event.MouseEvent)
     */
    @Override
    public void mouseExited(MouseEvent e) {
        e.getComponent().setCursor(Cursor.getDefaultCursor());
    }

    /*
     * (non-Javadoc)
     * 
     * @see java.awt.event.MouseListener#mousePressed(java.awt.event.MouseEvent)
     */
    @Override
    public void mousePressed(MouseEvent e) {
    }

    /*
     * (non-Javadoc)
     * 
     * @see
     * java.awt.event.MouseListener#mouseReleased(java.awt.event.MouseEvent)
     */
    @Override
    public void mouseReleased(MouseEvent e) {
    }

    /*
     * (non-Javadoc)
     * 
     * @see
     * java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
     */
    @Override
    public void actionPerformed(ActionEvent e) {
        // all task pane actions are handled by the mouse listener
    }
}