KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > modules > xml > catalog > spi > CatalogDescriptor


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.xml.catalog.spi;
20
21 import java.awt.Image JavaDoc;
22 import java.beans.*;
23
24 /**
25  * It provides information about a catalog instance.
26  * Information about the class can be provided as BeanInfo.
27  *
28  * @author Petr Kuzel
29  * @version 1.0
30  */
31 public interface CatalogDescriptor {
32
33     /**
34      * Name of icon property if fired.
35      */
36     public static final String JavaDoc PROP_CATALOG_ICON = "ca-icon"; // NOI18N
37
38     /**
39      * Name of name property
40      */
41     public static final String JavaDoc PROP_CATALOG_NAME = "ca-name"; // NOI18N
42
43     /**
44      * Name of short description property
45      */
46     public static final String JavaDoc PROP_CATALOG_DESC = "ca-desc"; // NOI18N
47
48     /**
49      * Return visuaized state of given catalog.
50      * @param type of icon defined by JavaBeans specs
51      * @return icon representing current state or null
52      */
53     public Image JavaDoc getIcon(int type);
54     
55     /**
56      * @return I18N display name
57      */
58     public String JavaDoc getDisplayName();
59     
60     /**
61      * @return I18N short description
62      */
63     public String JavaDoc getShortDescription();
64     
65     /** Registers new listener. */
66     public void addPropertyChangeListener(PropertyChangeListener l);
67     
68     /** Unregister the listener. */
69     public void removePropertyChangeListener(PropertyChangeListener l);
70 }
71
Popular Tags