KickJava   Java API By Example, From Geeks To Geeks.

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


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.util.Collection JavaDoc;
23 import javax.swing.text.AttributeSet JavaDoc;
24
25 /**
26  * Getters and setters for font & color editor profiles. Instances of this
27  * class should be registerred in <code>MimeLookup</code> for particular mime types.
28  *
29  * @author Jan Jancura
30  */

31 public abstract class FontColorSettingsFactory {
32
33     /**
34      * Gets all token font and colors for given scheme or null, if
35      * scheme does not exists.
36      *
37      * @param profile the name of profile
38      *
39      * @return token font and colors
40      */

41     public abstract Collection JavaDoc<AttributeSet JavaDoc> getAllFontColors (String JavaDoc profile);
42     
43     /**
44      * Gets default values for all font & colors for given profile, or null
45      * if profile does not exist or if it does not have any defaults.
46      *
47      * @param profile the name of profile
48      *
49      * @return default values for all font & colors
50      */

51     public abstract Collection JavaDoc<AttributeSet JavaDoc> getAllFontColorDefaults
52         (String JavaDoc profile);
53     
54     /**
55      * Sets all token font and colors for given scheme.
56      *
57      * @param profile the name of profile
58      * @param fontColors new colorings
59      */

60     public abstract void setAllFontColors (
61         String JavaDoc profile,
62         Collection JavaDoc<AttributeSet JavaDoc> fontColors
63     );
64     
65     /**
66      * Sets default values for all token font and colors for given scheme.
67      *
68      * @param profile the name of profile
69      * @param fontColors new colorings
70      */

71     public abstract void setAllFontColorsDefaults (
72         String JavaDoc profile,
73         Collection JavaDoc<AttributeSet JavaDoc> fontColors
74     );
75 }
76
Popular Tags