KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > modules > editor > settings > storage > api > KeyBindingSettingsFactory


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.editor.settings.storage.api;
21
22 import java.beans.PropertyChangeListener JavaDoc;
23 import java.util.List JavaDoc;
24 import org.netbeans.api.editor.settings.MultiKeyBinding;
25
26
27 /**
28  * Getters and setters for keymap editor profiles. Instances of this
29  * class should be registerred in <code>MimeLookup</code> for particular mime types.
30  *
31  * @author Jan Jancura
32  */

33 public abstract class KeyBindingSettingsFactory {
34
35     /**
36      * Gets the keybindings list, where items are instances of
37      * {@link org.netbeans.api.editor.settings.MultiKeyBinding}.
38      *
39      * @return List of <code>MultiKeyBinding</code>s.
40      */

41     public abstract List JavaDoc<MultiKeyBinding> getKeyBindings ();
42     
43     /**
44      * Gets the keybindings list for given keymap name, where items
45      * are instances of {@link org.netbeans.api.editor.settings.MultiKeyBinding}.
46      *
47      * @param profile a name of keymap
48      *
49      * @return List of <code>MultiKeyBinding</code>s.
50      */

51     public abstract List JavaDoc<MultiKeyBinding> getKeyBindings (String JavaDoc profile);
52
53     
54     /**
55      * Returns default keybindings list for given keymap name, where items
56      * are instances of {@link org.netbeans.api.editor.settings.MultiKeyBinding}.
57      *
58      * @return List of <code>MultiKeyBinding</code>s.
59      */

60     public abstract List JavaDoc<MultiKeyBinding> getKeyBindingDefaults (String JavaDoc profile);
61     
62     /**
63      * Gets the keybindings list, where items are instances of
64      * {@link org.netbeans.api.editor.settings.MultiKeyBinding}.
65      *
66      * @param profile
67      * @param keyBindings the list of <code>MultiKeyBindings</code>
68      */

69     public abstract void setKeyBindings (
70         String JavaDoc profile,
71         List JavaDoc<MultiKeyBinding> keyBindings
72     );
73     
74     /**
75      * PropertyChangeListener registration.
76      *
77      * @param l a PropertyChangeListener to be registerred
78      */

79     public abstract void addPropertyChangeListener (PropertyChangeListener JavaDoc l);
80     
81     /**
82      * PropertyChangeListener registration.
83      *
84      * @param l a PropertyChangeListener to be unregisterred
85      */

86     public abstract void removePropertyChangeListener (PropertyChangeListener JavaDoc l);
87 }
88
Popular Tags