KickJava   Java API By Example, From Geeks To Geeks.

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


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 /**
23  * The list of available key bindings. Each key binding is represented by an
24  * instance of the <code>MultiKeyBinding</code> class, which associates one
25  * or more keyboard shortcuts with an <code>Action</code>.
26  *
27  * <p>Instances of this class should be retrieved from <code>MimeLookup</code>.
28  *
29  * <p><font color="red">This class must NOT be extended by any API clients.</font>
30  *
31  * @author Martin Roskanin
32  */
33 public abstract class KeyBindingSettings {
34
35     /**
36      * Construction prohibited for API clients.
37      */
38     public KeyBindingSettings() {
39         // Control instantiation of the allowed subclass only
40 if (!"org.netbeans.modules.editor.settings.storage.KeyBindingSettingsImpl$Immutable".equals(getClass().getName())) { // NOI18N
41 throw new IllegalStateException JavaDoc("Instantiation prohibited."); // NOI18N
42 }
43     }
44     
45     /**
46      * Gets the keybindings list, where items are instances of {@link MultiKeyBinding}
47      *
48      * @return List of {@link MultiKeyBinding}
49      */
50     public abstract java.util.List JavaDoc<MultiKeyBinding> getKeyBindings();
51
52 }
53
Popular Tags