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.netbeans.spi.project.ui.support;
043:
044: import javax.swing.Action;
045: import javax.swing.Icon;
046: import org.netbeans.modules.project.uiapi.Utilities;
047:
048: /**
049: * Factory for creating project-sensitive actions.
050: * @author Petr Hrebejk
051: */
052: public class ProjectSensitiveActions {
053:
054: private ProjectSensitiveActions() {
055: }
056:
057: /**
058: * Creates an action sensitive to the set of currently selected projects.
059: * When performed the action will call the given command on the {@link org.netbeans.spi.project.ActionProvider} of
060: * the selected project(s). The action will only be enabled when the exactly one
061: * project is selected and the command is enabled in the project's action provider.<BR>
062: * Shortcuts for actions are shared according to command, i.e. actions based on the same command
063: * will have the same shortcut.
064: * @param command the command which should be invoked when the action is
065: * performed (see e.g. constants in {@link org.netbeans.spi.project.ActionProvider})
066: * @param namePattern a pattern which should be used for determining the action's
067: * name (label). It takes two parameters a la {@link java.text.MessageFormat}: <code>{0}</code> - number of selected projects;
068: * <code>{1}</code> - name of the first project.
069: * @param icon icon of the action (or null)
070: * @return an action sensitive to the current project
071: */
072: public static Action projectCommandAction(String command,
073: String namePattern, Icon icon) {
074: return Utilities.getActionsFactory().projectCommandAction(
075: command, namePattern, icon);
076: }
077:
078: /**
079: * Creates an action sensitive to the set of currently selected projects.
080: * When performed the action will call {@link ProjectActionPerformer#perform}
081: * on the action performer supplied
082: * as a parameter. The action will only be enabled when the exactly one
083: * project is selected and {@link ProjectActionPerformer#enable}
084: * returns true.<BR>
085: * Notice that it is not guaranteed that the {@link ProjectActionPerformer#enable}
086: * method will be called unless the project selection changes and someone is
087: * listeningon the action or explicitely asks for some of the action's values.
088: * @param performer an action performer.
089: * @param namePattern pattern which should be used for determining the action's
090: * name (label). It takes two parameters a la {@link java.text.MessageFormat}: <code>{0}</code> - number of selected projects;
091: * <code>{1}</code> - name of the first project.
092: * @param icon icon of the action (XXX or null?)
093: * @return an action sensitive to the current project
094: */
095: public static Action projectSensitiveAction(
096: ProjectActionPerformer performer, String namePattern,
097: Icon icon) {
098: return Utilities.getActionsFactory().projectSensitiveAction(
099: performer, namePattern, icon);
100: }
101:
102: }
|