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-2006 Sun
17   * Microsystems, Inc. All Rights Reserved.
18   */
19  
20  package org.netbeans.modules.refactoring.spi;
21  
22  import javax.swing.Action  ;
23  import org.openide.util.Cancellable;
24  
25  /**
26   * Typical implementation will invoke UI component on showDetails() call
27   * This UI component will display ProblemDetails. There will be a button, or
28   * similar UI control, which will be connected to rerunRefactoringAction to
29   * invoke refactoring again once the Problem is fixed.
30   * @author Jan Becicka
31   * @since 1.5.0
32   */
33  public interface ProblemDetailsImplementation {
34  
35      /**
36       * This method will typically invoke component with ProblemDetails.
37       * It is fully upon clients, how this component will be implemented.
38       * @param rerunRefactoringAction this action is passed to client component
39       * @param parent parent component, than can be closed by cancel method.
40       * to allow clients to rerun refactoring once the Problem is fixed.
41       */
42      void showDetails(Action   rerunRefactoringAction, Cancellable parent);
43  
44      /**
45       * Message that will be displayed in parameters panel as a hint to suggest user,
46       * that there are more details available.
47       * @return string representation of details hint
48       */
49      String   getDetailsHint();
50      
51  }
52
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags