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: package org.netbeans.modules.refactoring.spi.ui;
042:
043: import javax.swing.event.ChangeListener;
044: import org.netbeans.modules.refactoring.api.AbstractRefactoring;
045: import org.netbeans.modules.refactoring.api.Problem;
046: import org.openide.util.HelpCtx;
047:
048: /** Interface representing UI for a refactoring.
049: *
050: * @author Martin Matula
051: */
052: public interface RefactoringUI {
053: /** Returns name of the refactoring.
054: * @return Refactoring name.
055: */
056: String getName();
057:
058: /** Returns description of the refactoring.
059: * @return Refactoring description.
060: */
061: String getDescription();
062:
063: /** Indicates whether this class represents a real refactoring that changes
064: * code or whether it is just a query (e.g. all usages for a class).
065: * @return <code>true</code> if the class represents only a query,
066: * <code>false</code> if the class represents a real refactoring.
067: */
068: boolean isQuery();
069:
070: /** Returns refactoring-specific panel containing input fields for
071: * refactoring parameters.
072: * Name of the panel returned from this method will be used as the dialog
073: * name.
074: * this method might return null if hasParameters return false.
075: * @param parent dialog in which that the returned panel will be displayed in.
076: * @see #hasParameters
077: * @return Refactoring-specific parameters panel.
078: */
079: CustomRefactoringPanel getPanel(ChangeListener parent);
080:
081: /** Implementation of this method should set the refactoring parameters entered
082: * by user into the refactoring-specific parameters panel (returned from getPanel
083: * method) into the underlying refactoring object.
084: * @return Chain of problems returned from the underlying refactoring object
085: * when trying to set its parameters.
086: */
087: Problem setParameters();
088:
089: /**
090: * check parameters of refactoring
091: * @return Chain of problems returned from the underlying refactoring object
092: * when trying to check its parameters.
093: */
094: Problem checkParameters();
095:
096: /**
097: * true, if refactoring has parameters
098: * false otherwise. In this case {@link #getPanel} method can return null
099: * @return false if this UI does not require any parameters. True otherwise.
100: */
101: boolean hasParameters();
102:
103: /** Returns underlying refactoring object.
104: * @return Underlying refactoring object.
105: */
106: AbstractRefactoring getRefactoring();
107:
108: /**
109: * @return helpcontext
110: */
111: public HelpCtx getHelpCtx();
112: }
|