KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > modules > refactoring > spi > ui > TreeElement


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.ui;
21
22 import javax.swing.Icon JavaDoc;
23
24 /**
25  * Tree Elements are shown in Refactoring Preview.
26  * If you want to implement your own TreeElements, you
27  * must register your TreeElementFactoryImplementation
28  * @see TreeElementFactoryImplementation
29  * @see TreeElementFactory
30  * @author Jan Becicka
31  */

32 public interface TreeElement {
33     /**
34      * @param isLogical true if parent in lagical view is requested.
35      * @return parent of this TreeElement
36      */

37     public TreeElement getParent(boolean isLogical);
38     
39     /**
40      * @return icon for this TreeElement
41      */

42     public Icon JavaDoc getIcon();
43     /**
44      * @param isLogical true if logical description is requested
45      * @return text of this TreeElement
46      */

47     public String JavaDoc getText(boolean isLogical);
48     /**
49      * @return corresponding object, usually RefactoringElement, FileObject
50      */

51     public Object JavaDoc getUserObject();
52 }
53
54
Popular Tags