RefactoringCustomUI


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  package org.netbeans.modules.refactoring.spi.ui;
20  
21  import java.awt.Component  ;
22  import java.util.Collection  ;
23  import javax.swing.Icon  ;
24  import org.netbeans.modules.refactoring.api.RefactoringElement;
25  
26  /**
27   * Backward compatible extension to RefactoringUI providing custom preview panel.
28   * If implementation of RefactoringUI also implement RefactoringCustomUI, default 
29   * Refactoring Preview appears with new "Custom View" toggle button, which
30   * shows custom Component
31   * 
32   * this interface is just prototype and might be subject of change.
33   * 
34   * @author Jan Becicka
35   */
36  public interface RefactoringCustomUI {
37      /**
38       * @return component to show
39       */ 
40      Component   getCustomComponent(Collection  <RefactoringElement> elements);
41      /**
42       * @return icon for toggle button
43       */
44      Icon   getCustomIcon();
45      /**
46       * tooltip for toggle button
47       */ 
48      String   getCustomToolTip();
49  }
50

A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame

Popular Tags