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.modules.refactoring.spi.ui;
043:
044: import org.openide.util.Lookup;
045:
046: /**
047: * Create your own provider of this class and register it in META-INF services, if you want to
048: * create your own implementations of refactorin actions.
049: * For instance Java module wants to have refactoring rename action for java files.
050: * So Java Refactoring module must implement 2 methods.
051: *
052: * <pre>
053: * public boolean canRename(Lookup lookup) {
054: * Node[] nodes = lookup.lookupAll(Node.class);
055: * if (..one node selected and the node belongs to java...)
056: * return true;
057: * else
058: * return false;
059: * }
060: *
061: * public void doRename(Lookup selectedNodes) {
062: * Node[] nodes = lookup.lookupAll(Node.class);
063: * final FileObject fo = getFileFromNode(nodes[0]);
064: * UI.openRefactoringUI(new RenameRefactoringUI(fo);
065: * }
066: * </pre>
067: *
068: * For help on creating and registering actions
069: * See <a href=http://wiki.netbeans.org/wiki/view/RefactoringFAQ>Refactoring FAQ</a>
070: *
071: * @author Jan Becicka
072: */
073: public abstract class ActionsImplementationProvider {
074:
075: /**
076: * @param lookup current context
077: * @return true if provider can handle rename
078: */
079: public boolean canRename(Lookup lookup) {
080: return false;
081: }
082:
083: /**
084: * @param lookup current context
085: */
086: public void doRename(Lookup lookup) {
087: throw new UnsupportedOperationException("Not implemented!"); // NOI18N
088: }
089:
090: /**
091: * @param lookup current context
092: * @return true if provider can handle find usages
093: */
094: public boolean canFindUsages(Lookup lookup) {
095: return false;
096: }
097:
098: /**
099: * @param lookup current context
100: */
101: public void doFindUsages(Lookup lookup) {
102: throw new UnsupportedOperationException("Not implemented!"); // NOI18N
103: }
104:
105: /**
106: * @param lookup current context
107: * @return true if provider can handle delete
108: */
109: public boolean canDelete(Lookup lookup) {
110: return false;
111: }
112:
113: /**
114: * @param lookup current context
115: */
116: public void doDelete(Lookup lookup) {
117: throw new UnsupportedOperationException("Not implemented!"); // NOI18N
118: }
119:
120: /**
121: * @param lookup current context
122: * @return true if provider can handle move
123: */
124: public boolean canMove(Lookup lookup) {
125: return false;
126: }
127:
128: /**
129: * @param lookup current context
130: */
131: public void doMove(Lookup lookup) {
132: throw new UnsupportedOperationException("Not implemented!"); // NOI18N
133: }
134:
135: /**
136: * @param lookup current context
137: * @return true if provider can handle copy
138: */
139: public boolean canCopy(Lookup lookup) {
140: return false;
141: }
142:
143: /**
144: * @param lookup current context
145: */
146: public void doCopy(Lookup lookup) {
147: throw new UnsupportedOperationException("Not implemented!"); // NOI18N
148: }
149: }
|