001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: package org.openide.util.actions;
043:
044: import java.awt.Toolkit;
045: import java.awt.event.ActionEvent;
046: import java.util.Set;
047: import java.util.logging.Logger;
048: import org.openide.util.WeakSet;
049:
050: /** An action which may be called programmatically.
051: * Typically a presenter will call its {@link #performAction} method,
052: * which must be implemented.
053: * <p>Provides default presenters using the <a href="@org-openide-awt@/org/openide/awt/Actions.html">Actions</a> utility class.
054: *
055: * @author Ian Formanek, Jaroslav Tulach, Jan Jancura, Petr Hamernik
056: */
057: public abstract class CallableSystemAction extends SystemAction
058: implements Presenter.Menu, Presenter.Popup, Presenter.Toolbar {
059: /** serialVersionUID */
060: static final long serialVersionUID = 2339794599168944156L;
061:
062: // ASYNCHRONICITY
063: // Adapted from org.netbeans.core.ModuleActions by jglick
064:
065: /**
066: * Set of action classes for which we have already issued a warning that
067: * {@link #asynchronous} was not overridden to return false.
068: */
069: private static final Set<Class> warnedAsynchronousActions = new WeakSet<Class>();
070: private static final boolean DEFAULT_ASYNCH = !Boolean
071: .getBoolean("org.openide.util.actions.CallableSystemAction.synchronousByDefault");
072:
073: /* Returns a JMenuItem that presents the Action, that implements this
074: * interface, in a MenuBar.
075: * @return the JMenuItem representation for the Action
076: */
077: public javax.swing.JMenuItem getMenuPresenter() {
078: return org.netbeans.modules.openide.util.AWTBridge.getDefault()
079: .createMenuPresenter(this );
080: }
081:
082: /* Returns a JMenuItem that presents the Action, that implements this
083: * interface, in a Popup Menu.
084: * @return the JMenuItem representation for the Action
085: */
086: public javax.swing.JMenuItem getPopupPresenter() {
087: return org.netbeans.modules.openide.util.AWTBridge.getDefault()
088: .createPopupPresenter(this );
089: }
090:
091: /* Returns a Component that presents the Action, that implements this
092: * interface, in a ToolBar.
093: * @return the Component representation for the Action
094: */
095: public java.awt.Component getToolbarPresenter() {
096: return org.netbeans.modules.openide.util.AWTBridge.getDefault()
097: .createToolbarPresenter(this );
098: }
099:
100: /** Actually perform the action.
101: * This is the method which should be called programmatically.
102: * Presenters in <a href="@org-openide-awt@/org/openide/awt/Actions.html">Actions</a> use this.
103: * <p>See {@link SystemAction#actionPerformed} for a note on
104: * threading usage: in particular, do not access GUI components
105: * without explicitly asking for the AWT event thread!
106: */
107: public abstract void performAction();
108:
109: /* Implementation of method of javax.swing.Action interface.
110: * Delegates the execution to performAction method.
111: *
112: * @param ev the action event
113: */
114: public void actionPerformed(ActionEvent ev) {
115: if (isEnabled()) {
116: org.netbeans.modules.openide.util.ActionsBridge
117: .doPerformAction(
118: this ,
119: new org.netbeans.modules.openide.util.ActionsBridge.ActionRunnable(
120: ev, this , asynchronous()) {
121: public void run() {
122: performAction();
123: }
124: });
125: } else {
126: // Should not normally happen.
127: Toolkit.getDefaultToolkit().beep();
128: }
129: }
130:
131: /**
132: * If true, this action should be performed asynchronously in a private thread.
133: * If false, it will be performed synchronously as called in the event thread.
134: * <p>The default value is true for compatibility reasons; subclasses are strongly
135: * encouraged to override it to be false, and to either do their work promptly
136: * in the event thread and return, or to somehow do work asynchronously (for example
137: * using {@link org.openide.util.RequestProcessor#getDefault}).
138: * <p class="nonnormative">You may currently set the global default to false
139: * by setting the system property
140: * <code>org.openide.util.actions.CallableSystemAction.synchronousByDefault</code>
141: * to <code>true</code>.</p>
142: * <p class="nonnormative">When true, the current implementation also provides for a wait cursor during
143: * the execution of the action. Subclasses which override to return false should
144: * consider directly providing a wait or busy cursor if the nature of the action
145: * merits it.</p>
146: * @return true if this action should automatically be performed asynchronously
147: * @since 4.11
148: */
149: protected boolean asynchronous() {
150: if (warnedAsynchronousActions.add(getClass())) {
151: Logger
152: .getLogger(CallableSystemAction.class.getName())
153: .warning(
154: "Warning - "
155: + getClass().getName()
156: + " should override CallableSystemAction.asynchronous() to return false");
157: }
158:
159: return DEFAULT_ASYNCH;
160: }
161: }
|