KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > api > editor > settings > CodeTemplateSettings


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.api.editor.settings;
21
22 import java.util.List JavaDoc;
23 import javax.swing.KeyStroke JavaDoc;
24
25 /**
26  * The list of available templates. Instances of this class should be retrieved
27  * from <code>MimeLookup</code>.
28  *
29  *
30  * <p><font color="red">This class must NOT be extended by any API clients.</font>
31  *
32  * @author Martin Roskanin
33  */

34 public abstract class CodeTemplateSettings {
35
36     /**
37      * Construction prohibited for API clients.
38      */

39     public CodeTemplateSettings() {
40         // Control instantiation of the allowed subclass only
41
if (!"org.netbeans.modules.editor.settings.xxx".equals(getClass().getName())) { // NOI18N
42
throw new IllegalStateException JavaDoc("Instantiation prohibited."); // NOI18N
43
}
44     }
45     
46     /**
47      * Gets list of code template descriptions.
48      *
49      * @return non-modifiable list of the code template descriptions.
50      */

51     public abstract List JavaDoc<CodeTemplateDescription> getCodeTemplateDescriptions();
52     
53     /**
54      * Get the keystroke that expands the code templates abbreviations.
55      *
56      * @return non-null keystroke that expands the code template abbreviations
57      * into code templates.
58      */

59     public abstract KeyStroke JavaDoc getExpandKey();
60     
61 }
62
Popular Tags