站内搜索: 请输入搜索关键词
当前页面: 在线文档首页 > NetBeans API Javadoc (Current Development Version)

SettingsUtil (Editor Library) - NetBeans API Javadoc (Current Development Version)

Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
org.netbeans.modules.editor.lib/1 1.14.0 3
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.netbeans.editor
Class SettingsUtil

java.lang.Object
  extended by org.netbeans.editor.SettingsUtil

public class SettingsUtil
extends Object

Utility methods for managing settings

Nested Class Summary
static class SettingsUtil.FontStylePrintColoringEvaluator
          Deprecated. Fonts and colors for printing are the same as those on screen. Use Editor Settings and Editor Settings Storage API instead.
static class SettingsUtil.ForeColorPrintColoringEvaluator
          Deprecated. Fonts and colors for printing are the same as those on screen. Use Editor Settings and Editor Settings Storage API instead.
static class SettingsUtil.PrintColoringEvaluator
          Deprecated. Fonts and colors for printing are the same as those on screen. Use Editor Settings and Editor Settings Storage API instead.
static class SettingsUtil.TokenColoringEvaluator
          Deprecated. Use Editor Settings and Editor Settings Storage API instead.
static class SettingsUtil.TokenColoringInitializer
          Deprecated. Use Editor Settings and Editor Settings Storage API instead.
 
Field Summary
static SettingsUtil.PrintColoringEvaluator defaultPrintColoringEvaluator
           
static String TOKEN_COLORING_INITIALIZER_NAME_SUFFIX
           
 
Constructor Summary
SettingsUtil()
           
 
Method Summary
static Acceptor getAcceptor(Class kitClass, String settingName, Acceptor defaultValue)
           
static boolean getBoolean(Class kitClass, String settingName, boolean defaultValue)
           
static boolean getBoolean(Class kitClass, String settingName, Boolean defaultValue)
           
static List getClonedList(Class kitClass, String settingName)
           
static List getClonedList(List l)
          Get either the cloned list or new list if the old one was null.
static List getClonedList(Map settingsMap, String settingName)
          Useful for initializers
static Map getClonedMap(Class kitClass, String settingName)
           
static Map getClonedMap(Map m)
           
static Map getClonedMap(Map settingsMap, String settingName)
          Useful for initializers
static Coloring getColoring(Class kitClass, String coloringName, boolean printingSet)
          Deprecated. Use Editor Settings API instead.
static Object getColoring(Class kitClass, String coloringName, boolean printingSet, boolean evaluateEvaluators)
          Deprecated. Use Editor Settings API instead.
static Object getColoring(Map settingsMap, String coloringName, boolean printingSet)
          Get the coloring setting from the map that holds the settings values for the particular kit.
static Map<String,Coloring> getColoringMap(Class kitClass, boolean printingSet, boolean evaluateEvaluators)
          Deprecated. Use Editor Settings API instead.
static Settings.Initializer getColoringMapInitializer(Class kitClass, Map coloringMap, boolean printingSet, String initializerName)
          Deprecated. Use Editor Settings and Editor Settings Storage API instead.
static List getCumulativeList(Class kitClass, String settingName, List defaultValue)
           
static int getInteger(Class kitClass, String settingName, int defaultValue)
           
static int getInteger(Class kitClass, String settingName, Integer defaultValue)
           
static List getList(Class kitClass, String settingName, List defaultValue)
           
static Map getMap(Class kitClass, String settingName, Map defaultValue)
           
static int getNonNegativeInteger(Class kitClass, String settingName, int defaultValue)
           
static int getNonNegativeInteger(Class kitClass, String settingName, Integer defaultValue)
           
static int getPositiveInteger(Class kitClass, String settingName, int defaultValue)
           
static int getPositiveInteger(Class kitClass, String settingName, Integer defaultValue)
           
static String getString(Class kitClass, String settingName, String defaultValue)
           
static Coloring getTokenColoring(TokenContextPath tcp, TokenCategory tokenIDOrCategory, boolean printingSet)
          Deprecated. Use Editor Settings API instead.
static Object getTokenColoring(TokenContextPath tcp, TokenCategory tokenIDOrCategory, boolean printingSet, boolean evaluateEvaluators)
          Deprecated. Use Editor Settings API instead.
static Object getValue(Class kitClass, String settingName, Object defaultValue)
           
static void setColoring(Class kitClass, String coloringName, Object componentColoringNewValue)
          Deprecated. Use Editor Settings Storage API instead.
static void setColoring(Class kitClass, String coloringName, Object newValue, boolean printingSet)
          Deprecated. Use Editor Settings Storage API instead.
static void setColoring(Class kitClass, String coloringName, Object componentColoringNewValue, Object printColoringNewValue)
          Deprecated. Use Editor Settings Storage API instead.
static void setColoring(Map settingsMap, String coloringName, Object componentColoringNewValue)
          Put the coloring into a map holding the settings for the particular kit and assign a default print coloring Evaluator to the print coloring setting.
static void setColoring(Map settingsMap, String coloringName, Object newValue, boolean printingSet)
          Put the coloring into a map holding the settings for the particular kit.
static void setColoring(Map settingsMap, String coloringName, Object componentColoringNewValue, Object printColoringNewValue)
           
static void setColoringMap(Class kitClass, Map coloringMap, boolean printingSet)
          Deprecated. Use Editor Settings Storage API instead.
static void updateListSetting(Class kitClass, String settingName, Object[] addToList)
           
static void updateListSetting(Map settingsMap, String settingName, Object[] addToList)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TOKEN_COLORING_INITIALIZER_NAME_SUFFIX

public static final String TOKEN_COLORING_INITIALIZER_NAME_SUFFIX
See Also:
Constant Field Values

defaultPrintColoringEvaluator

public static final SettingsUtil.PrintColoringEvaluator defaultPrintColoringEvaluator
Constructor Detail

SettingsUtil

public SettingsUtil()
Method Detail

getClonedList

public static List getClonedList(List l)
Get either the cloned list or new list if the old one was null.

Parameters:
l - list to check
Returns:
the cloned list if it was non-null or the new list

getClonedList

public static List getClonedList(Class kitClass,
                                 String settingName)

getClonedList

public static List getClonedList(Map settingsMap,
                                 String settingName)
Useful for initializers

getClonedMap

public static Map getClonedMap(Map m)

getClonedMap

public static Map getClonedMap(Class kitClass,
                               String settingName)

getClonedMap

public static Map getClonedMap(Map settingsMap,
                               String settingName)
Useful for initializers

getValue

public static Object getValue(Class kitClass,
                              String settingName,
                              Object defaultValue)

getInteger

public static int getInteger(Class kitClass,
                             String settingName,
                             int defaultValue)

getInteger

public static int getInteger(Class kitClass,
                             String settingName,
                             Integer defaultValue)

getPositiveInteger

public static int getPositiveInteger(Class kitClass,
                                     String settingName,
                                     int defaultValue)

getPositiveInteger

public static int getPositiveInteger(Class kitClass,
                                     String settingName,
                                     Integer defaultValue)

getNonNegativeInteger

public static int getNonNegativeInteger(Class kitClass,
                                        String settingName,
                                        int defaultValue)

getNonNegativeInteger

public static int getNonNegativeInteger(Class kitClass,
                                        String settingName,
                                        Integer defaultValue)

getBoolean

public static boolean getBoolean(Class kitClass,
                                 String settingName,
                                 boolean defaultValue)

getBoolean

public static boolean getBoolean(Class kitClass,
                                 String settingName,
                                 Boolean defaultValue)

getString

public static String getString(Class kitClass,
                               String settingName,
                               String defaultValue)

getAcceptor

public static Acceptor getAcceptor(Class kitClass,
                                   String settingName,
                                   Acceptor defaultValue)

getList

public static List getList(Class kitClass,
                           String settingName,
                           List defaultValue)

getCumulativeList

public static List getCumulativeList(Class kitClass,
                                     String settingName,
                                     List defaultValue)

getMap

public static Map getMap(Class kitClass,
                         String settingName,
                         Map defaultValue)

updateListSetting

public static void updateListSetting(Class kitClass,
                                     String settingName,
                                     Object[] addToList)

updateListSetting

public static void updateListSetting(Map settingsMap,
                                     String settingName,
                                     Object[] addToList)

getColoring

public static Coloring getColoring(Class kitClass,
                                   String coloringName,
                                   boolean printingSet)
Deprecated. Use Editor Settings API instead.

getColoring

public static Object getColoring(Class kitClass,
                                 String coloringName,
                                 boolean printingSet,
                                 boolean evaluateEvaluators)
Deprecated. Use Editor Settings API instead.

getTokenColoring

public static Coloring getTokenColoring(TokenContextPath tcp,
                                        TokenCategory tokenIDOrCategory,
                                        boolean printingSet)
Deprecated. Use Editor Settings API instead.

getTokenColoring

public static Object getTokenColoring(TokenContextPath tcp,
                                      TokenCategory tokenIDOrCategory,
                                      boolean printingSet,
                                      boolean evaluateEvaluators)
Deprecated. Use Editor Settings API instead.

getColoring

public static Object getColoring(Map settingsMap,
                                 String coloringName,
                                 boolean printingSet)
Get the coloring setting from the map that holds the settings values for the particular kit.

Parameters:
settingsMap - map that holds the [setting-name, setting-value] pairs for some kit-class.
coloringName - name of the coloring to retrieve
printingSet - retrieve the value of printing coloring instead of component coloring.

setColoring

public static void setColoring(Class kitClass,
                               String coloringName,
                               Object newValue,
                               boolean printingSet)
Deprecated. Use Editor Settings Storage API instead.

setColoring

public static void setColoring(Class kitClass,
                               String coloringName,
                               Object componentColoringNewValue)
Deprecated. Use Editor Settings Storage API instead.

setColoring

public static void setColoring(Class kitClass,
                               String coloringName,
                               Object componentColoringNewValue,
                               Object printColoringNewValue)
Deprecated. Use Editor Settings Storage API instead.

setColoring

public static void setColoring(Map settingsMap,
                               String coloringName,
                               Object newValue,
                               boolean printingSet)
Put the coloring into a map holding the settings for the particular kit.

setColoring

public static void setColoring(Map settingsMap,
                               String coloringName,
                               Object componentColoringNewValue)
Put the coloring into a map holding the settings for the particular kit and assign a default print coloring Evaluator to the print coloring setting.

setColoring

public static void setColoring(Map settingsMap,
                               String coloringName,
                               Object componentColoringNewValue,
                               Object printColoringNewValue)

getColoringMap

public static Map<String,Coloring> getColoringMap(Class kitClass,
                                                  boolean printingSet,
                                                  boolean evaluateEvaluators)
Deprecated. Use Editor Settings API instead.

Tries to gather all colorings defined for the kit's mime type. If the mime type can't be determined from the editor kit's class passed in, this method will try to load colorings defined for the empty mime path (ie. all languages).

Parameters:
kitClass - The kit class for which the colorings should be loaded.
printingSet - Ignored.
evaluateEvaluators - Ignored.
Returns:
The map with all colorings defined for the mime type of the editor kit class passed in. The returned map may be inaccurate, please use the new Editor Settings API and its FontColorSettings class.

setColoringMap

public static void setColoringMap(Class kitClass,
                                  Map coloringMap,
                                  boolean printingSet)
Deprecated. Use Editor Settings Storage API instead.

Update the settings according to the changes provided in the coloringMap.

Parameters:
kitClass - class of the kit for which the colorings are being updated. Only the colorings with the names contained in COLORING_NAME_LIST will be updated for the kitClass settings. The rest is considered to be the token colorings so they are updated in BaseKit settings.
coloringMap - map containing [coloring-name, coloring-value] pairs.
printingSet - whether printing colorings should be updated instead of component colorings.

getColoringMapInitializer

public static Settings.Initializer getColoringMapInitializer(Class kitClass,
                                                             Map coloringMap,
                                                             boolean printingSet,
                                                             String initializerName)
Deprecated. Use Editor Settings and Editor Settings Storage API instead.

Create initializer that reflects the colorings given by the coloring map.

Parameters:
kitClass - class of the kit for which the colorings will be updated by the initializer. Only the colorings with the names contained in COLORING_NAME_LIST will be updated for the kitClass settings. The rest is considered to be the token colorings so they are updated in BaseKit settings by the initializer.
coloringMap - map containing [coloring-name, coloring-value] pairs.
printingSet - whether printing colorings should be updated instead of component colorings.
initializerName - name that will be assigned to the initializer.
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
org.netbeans.modules.editor.lib/1 1.14.0 3
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Built on May 28 2007.  |  Portions Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.