001/*
002 * Copyright (c) 2005 Einar Pehrson <einar@pehrson.nu>.
003 *
004 * This file is part of
005 * CleanSheets - a spreadsheet application for the Java platform.
006 *
007 * CleanSheets is free software; you can redistribute it and/or modify
008 * it under the terms of the GNU General Public License as published by
009 * the Free Software Foundation; either version 2 of the License, or
010 * (at your option) any later version.
011 *
012 * CleanSheets is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
015 * GNU General Public License for more details.
016 *
017 * You should have received a copy of the GNU General Public License
018 * along with CleanSheets; if not, write to the Free Software
019 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
020 */
021package csheets.ui.ctrl;
022
023import java.awt.event.ActionEvent;
024import java.awt.event.KeyEvent;
025
026import javax.swing.ImageIcon;
027import javax.swing.KeyStroke;
028
029import csheets.CleanSheets;
030
031/**
032 * An action for displaying the help.
033 * @author Einar Pehrson
034 */
035@SuppressWarnings("serial")
036public class HelpAction extends BaseAction {
037
038        /**
039         * Creates a new help action.
040         */
041        public HelpAction() {}
042
043        protected String getName() {
044                return "Contents...";
045        }
046
047        protected void defineProperties() {
048                setEnabled(false);
049                putValue(MNEMONIC_KEY, KeyEvent.VK_C);
050                putValue(ACCELERATOR_KEY, KeyStroke.getKeyStroke(KeyEvent.VK_F1, 0));
051                putValue(SMALL_ICON, new ImageIcon(CleanSheets.class.getResource("res/img/help.gif")));
052        }
053
054        public void actionPerformed(ActionEvent e) {}
055}