KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > modules > xml > refactoring > ui > j > spi > ProblemDetailsImplementation


1 /*
2  * The contents of this file are subject to the terms of the Common Development
3  * and Distribution License (the License). You may not use this file except in
4  * compliance with the License.
5  *
6  * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7  * or http://www.netbeans.org/cddl.txt.
8  *
9  * When distributing Covered Code, include this CDDL Header Notice in each file
10  * and include the License file at http://www.netbeans.org/cddl.txt.
11  * If applicable, add the following below the CDDL Header, with the fields
12  * enclosed by brackets [] replaced by your own identifying information:
13  * "Portions Copyrighted [year] [name of copyright owner]"
14  *
15  * The Original Software is NetBeans. The Initial Developer of the Original
16  * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
17  * Microsystems, Inc. All Rights Reserved.
18  */

19 package org.netbeans.modules.xml.refactoring.ui.j.spi;
20
21 import javax.swing.Action JavaDoc;
22 import org.openide.util.Cancellable;
23
24 /**
25  * Typical implementation will invoke UI component on showDetails() call
26  * This UI component will display ProblemDetails. There will be a button, or
27  * similar UI control, which will be connected to rerunRefactoringAction to
28  * invoke refactoring again once the Problem is fixed.
29  * @author Jan Becicka
30  * @since 1.5.0
31  */

32 public interface ProblemDetailsImplementation {
33
34     /**
35      * This method will typically invoke component with ProblemDetails.
36      * It is fully upon clients, how this component will be implemented.
37      * @param rerunRefactoringAction this action is passed to client component
38      * @parent parent parent component, than can be closed by cancel method.
39      * to allow clients to rerun refactoring once the Problem is fixed.
40      */

41     void showDetails(Action JavaDoc rerunRefactoringAction, Cancellable parent);
42
43     /**
44      * Message that will be displayed in parameters panel as a hint to suggest user,
45      * that there are more details available.
46      */

47     String JavaDoc getDetailsHint();
48     
49 }
50
Popular Tags