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 */
021 package csheets.ui.ext;
022
023 import java.awt.event.ActionEvent;
024
025 import javax.swing.JComponent;
026
027 import csheets.ui.ctrl.FocusOwnerAction;
028
029 /**
030 * An action for enabling and disabling UI extension components.
031 * @author Einar Pehrson
032 */
033 @SuppressWarnings("serial")
034 public class ComponentAction extends FocusOwnerAction {
035
036 /** The extension to control*/
037 private UIExtension extension;
038
039 /** The component to control */
040 private JComponent component;
041
042 /** The property key of the component */
043 private String componentKey;
044
045 /**
046 * Creates a new component action.
047 * @param extension the extension to control
048 * @param component the component to control
049 * @param componentKey the property key of the component
050 */
051 public ComponentAction(UIExtension extension, JComponent component,
052 String componentKey) {
053 // Stores members
054 this.extension = extension;
055 this.component = component;
056 this.componentKey = componentKey;
057
058 // Configures action
059 String name = extension.getExtension().getName();
060 putValue(NAME, name);
061 putValue(SHORT_DESCRIPTION, name);
062 putValue(ACTION_COMMAND_KEY, name);
063 putValue(SMALL_ICON, extension.getIcon());
064 }
065
066 protected String getName() {
067 return null;
068 }
069
070 /**
071 * Toggles the visiblity of the component.
072 * @param event the event that was fired
073 */
074 public void actionPerformed(ActionEvent event) {
075 component.setVisible(!component.isVisible());
076 extension.setEnabledProperty(componentKey, component.isVisible());
077 }
078 }