1.1 --- a/openide.util/src/org/openide/util/actions/BooleanStateAction.java Wed Jan 27 17:46:23 2010 -0500
1.2 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000
1.3 @@ -1,120 +0,0 @@
1.4 -/*
1.5 - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
1.6 - *
1.7 - * Copyright 1997-2009 Sun Microsystems, Inc. All rights reserved.
1.8 - *
1.9 - * The contents of this file are subject to the terms of either the GNU
1.10 - * General Public License Version 2 only ("GPL") or the Common
1.11 - * Development and Distribution License("CDDL") (collectively, the
1.12 - * "License"). You may not use this file except in compliance with the
1.13 - * License. You can obtain a copy of the License at
1.14 - * http://www.netbeans.org/cddl-gplv2.html
1.15 - * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
1.16 - * specific language governing permissions and limitations under the
1.17 - * License. When distributing the software, include this License Header
1.18 - * Notice in each file and include the License file at
1.19 - * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
1.20 - * particular file as subject to the "Classpath" exception as provided
1.21 - * by Sun in the GPL Version 2 section of the License file that
1.22 - * accompanied this code. If applicable, add the following below the
1.23 - * License Header, with the fields enclosed by brackets [] replaced by
1.24 - * your own identifying information:
1.25 - * "Portions Copyrighted [year] [name of copyright owner]"
1.26 - *
1.27 - * Contributor(s):
1.28 - *
1.29 - * The Original Software is NetBeans. The Initial Developer of the Original
1.30 - * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
1.31 - * Microsystems, Inc. All Rights Reserved.
1.32 - *
1.33 - * If you wish your version of this file to be governed by only the CDDL
1.34 - * or only the GPL Version 2, indicate your decision by adding
1.35 - * "[Contributor] elects to include this software in this distribution
1.36 - * under the [CDDL or GPL Version 2] license." If you do not indicate a
1.37 - * single choice of license, a recipient has the option to distribute
1.38 - * your version of this file under either the CDDL, the GPL Version 2 or
1.39 - * to extend the choice of license to its licensees as provided above.
1.40 - * However, if you add GPL Version 2 code and therefore, elected the GPL
1.41 - * Version 2 license, then the option applies only if the new code is
1.42 - * made subject to such option by the copyright holder.
1.43 - */
1.44 -package org.openide.util.actions;
1.45 -
1.46 -
1.47 -/** An action that can be toggled on or off.
1.48 -* The actual "performing" of the action is the toggle itself, so
1.49 -* this action should be used by listening to the {@link #PROP_BOOLEAN_STATE} property.
1.50 -* <p>The default value of the state is <code>true</code> (on).
1.51 -*
1.52 -*
1.53 -* @author Ian Formanek, Petr Hamernik
1.54 -*/
1.55 -public abstract class BooleanStateAction extends SystemAction implements Presenter.Menu, Presenter.Popup,
1.56 - Presenter.Toolbar {
1.57 - /** serialVersionUID */
1.58 - static final long serialVersionUID = 6394800019181426199L;
1.59 -
1.60 - /** Name of property hold the state of the action. */
1.61 - public static final String PROP_BOOLEAN_STATE = "booleanState"; // NOI18N
1.62 -
1.63 - /* Returns a JMenuItem that presents the Action, that implements this
1.64 - * interface, in a MenuBar.
1.65 - * @return the JMenuItem representation for the Action
1.66 - */
1.67 - public javax.swing.JMenuItem getMenuPresenter() {
1.68 - return org.openide.util.actions.ActionPresenterProvider.getDefault().createMenuPresenter(this);
1.69 - }
1.70 -
1.71 - /* Returns a JMenuItem that presents the Action, that implements this
1.72 - * interface, in a Popup Menu.
1.73 - * The default implmentation returns the same JMenuItem as the getMenuPresenter.
1.74 - * @return the JMenuItem representation for the Action
1.75 - */
1.76 - public javax.swing.JMenuItem getPopupPresenter() {
1.77 - return org.openide.util.actions.ActionPresenterProvider.getDefault().createPopupPresenter(this);
1.78 - }
1.79 -
1.80 - /* Returns a Component that presents the Action, that implements this
1.81 - * interface, in a ToolBar.
1.82 - * @return the Component representation for the Action
1.83 - */
1.84 - public java.awt.Component getToolbarPresenter() {
1.85 - return org.openide.util.actions.ActionPresenterProvider.getDefault().createToolbarPresenter(this);
1.86 - }
1.87 -
1.88 - /** Get the current state.
1.89 - * @return <code>true</code> if on
1.90 - */
1.91 - public boolean getBooleanState() {
1.92 - return getProperty(PROP_BOOLEAN_STATE).equals(Boolean.TRUE);
1.93 - }
1.94 -
1.95 - /** Set the current state.
1.96 - * Fires a change event, which should be used to affect other components when
1.97 - * its state is toggled.
1.98 - * @param value <code>true</code> to turn on, <code>false</code> to turn off
1.99 - */
1.100 - public void setBooleanState(boolean value) {
1.101 - Boolean newValue = value ? Boolean.TRUE : Boolean.FALSE;
1.102 - Boolean oldValue = (Boolean) putProperty(PROP_BOOLEAN_STATE, newValue);
1.103 -
1.104 - firePropertyChange(PROP_BOOLEAN_STATE, oldValue, newValue);
1.105 - }
1.106 -
1.107 - /* Initializes its own properties (and let superclass initialize
1.108 - * too).
1.109 - */
1.110 - protected void initialize() {
1.111 - putProperty(PROP_BOOLEAN_STATE, Boolean.TRUE);
1.112 - super.initialize();
1.113 - }
1.114 -
1.115 - /* Implementation of method of javax.swing.Action interface.
1.116 - * Changes the boolean state.
1.117 - *
1.118 - * @param ev ignored
1.119 - */
1.120 - public void actionPerformed(java.awt.event.ActionEvent ev) {
1.121 - setBooleanState(!getBooleanState());
1.122 - }
1.123 -}