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

BaseOptions (Editor Module) - NetBeans API Javadoc (Current Development Version)

org.netbeans.modules.editor/3 1.32.0

org.netbeans.modules.editor.options
Class BaseOptions

java.lang.Object
  extended by org.openide.util.SharedClassObject
      extended by org.openide.options.SystemOption
          extended by org.netbeans.modules.editor.options.OptionSupport
              extended by org.netbeans.modules.editor.options.BaseOptions
All Implemented Interfaces:
Externalizable, Serializable, HelpCtx.Provider

public class BaseOptions
extends OptionSupport

Options for the base editor kit. Mime type vs editor kit class

The BaseOptions class suffers the conceptual problem introduced in the editor infrastructure in early days of the Netbeans project. The problem is that an implementation class of an editor kit is used for determining the mime type of a file being edited. Following this concept a lot of other stuff in the editor infrastructure tied up its initialization or registration with editor kit implementation classes. While in many situations this only causes efficiency problems or coding annoyances it is disasterous for modules that need to provide dynamic support for many mime types.

The following description tries to remedy the situation by providing guidelines for writing BaseOptions subclasses that are nearly editor kit independent.

First, use MimeLookup whenever you can and avoid using static getters such as getOptions(Class editorKitClass). Although the current MimeLookup infrastructure allows registering editor related classes in a declrative way based on a mime type the getOptions method can't simply query MimeLookup, because it doesn't know the mime type! The correct way of retrieving an instance of your options class from MimeLookup is this:

     MimePath mimePath = MimePath.parse("your-mime-type-here");
     YourOptions options = MimeLookup.getLookup(mimePath).lookup(YourOptions.class);
 

When implementing BaseOptions for a specific mime type override the getContentType method and return your mime type. Besides the getOptions method this is currently the only place in this class where an editor kit implementation class is used.

See Also:
Serialized Form

Field Summary
static String ABBREV_MAP_PROP
           
static String BASE
           
protected static String[] BASE_PROP_NAMES
           
static String CARET_BLINK_RATE_PROP
           
static String CARET_COLOR_INSERT_MODE_PROP
           
static String CARET_COLOR_OVERWRITE_MODE_PROP
           
static String CARET_ITALIC_INSERT_MODE_PROP
           
static String CARET_ITALIC_OVERWRITE_MODE_PROP
           
static String CARET_TYPE_INSERT_MODE_PROP
           
static String CARET_TYPE_OVERWRITE_MODE_PROP
           
static String CODE_FOLDING_PROPS_PROP
           
static String CODE_TEMPLATE_EXPAND_KEY
          Code template expand key setting name
static String COLORING_MAP_PROP
           
static String EXPAND_TABS_PROP
           
static String FIND_BLOCK_SEARCH_PROP
           
static String FIND_HIGHLIGHT_SEARCH_PROP
           
static String FIND_HISTORY_PROP
           
static String FIND_HISTORY_SIZE_PROP
           
static String FIND_INC_SEARCH_DELAY_PROP
           
static String FIND_INC_SEARCH_PROP
           
static String FIND_MATCH_CASE_PROP
           
static String FIND_REG_EXP_PROP
           
static String FIND_SMART_CASE_PROP
           
static String FIND_WHOLE_WORDS_PROP
           
static String FIND_WRAP_SEARCH_PROP
           
static String FONT_SIZE_PROP
           
static String HIGHLIGHT_CARET_ROW_PROP
           
static String HIGHLIGHT_MATCHING_BRACKET_PROP
           
static String INDENT_ENGINE_PROP
           
static String KEY_BINDING_LIST_PROP
           
protected static int LATEST_OPTIONS_VERSION
          Latest version of the options.
static String LINE_HEIGHT_CORRECTION_PROP
           
static String LINE_NUMBER_VISIBLE_PROP
           
static String MACRO_MAP_PROP
           
static String MARGIN_PROP
           
protected static String OPTIONS_VERSION_PROP
           
static String PAIR_CHARACTERS_COMPLETION
           
static String SCROLL_FIND_INSETS_PROP
           
static String SCROLL_JUMP_INSETS_PROP
           
static String SPACES_PER_TAB_PROP
           
static String STATUS_BAR_CARET_DELAY_PROP
           
static String STATUS_BAR_VISIBLE_PROP
           
static String TAB_SIZE_PROP
           
static String TEXT_ANTIALIASING_PROP
           
static String TEXT_LIMIT_LINE_COLOR_PROP
           
static String TEXT_LIMIT_LINE_VISIBLE_PROP
           
static String TEXT_LIMIT_WIDTH_PROP
           
static String TOOLBAR_VISIBLE_PROP
           
 
Constructor Summary
BaseOptions()
           
BaseOptions(Class kitClass, String typeName)
           
 
Method Summary
protected  void firePropertyChange(String name, Object oldValue, Object newValue)
           
 Map getAbbrevMap()
           
 int getCaretBlinkRate()
           
 Color getCaretColorInsertMode()
           
 Color getCaretColorOverwriteMode()
           
 boolean getCaretItalicInsertMode()
          Deprecated. since adaptation to new view implementation the option is not supported
 boolean getCaretItalicOverwriteMode()
          Deprecated. since adaptation to new view implementation the option is not supported
 String getCaretTypeInsertMode()
           
 String getCaretTypeOverwriteMode()
           
 Map getCodeFoldingProps()
           
static KeyStroke getCodeTemplateExpandKey()
          Gets Code Template Expand Key.
 Map<String,Coloring> getColoringMap()
          Deprecated. Use Editor Settings API instead.
protected  String getContentType()
           
 Map getDefaultAbbrevMap()
          Gets Map of default Abbreviations as they are stored in MIMEFolder/Defaults/abbreviations.xml
protected  Class getDefaultIndentEngineClass()
          Return class of the default indentation engine.
 Map getDefaultKeyBindingsMap()
          Gets Map of default KeyBindings as they are stored in MIMEFolder/Defaults/keybindings.xml
 Map getDefaultMacrosMap()
          Gets Map of default Macros as they are stored in MIMEFolder/Defaults/macros.xml
 boolean getFindBlockSearch()
           
 boolean getFindHighlightSearch()
           
 Map getFindHistory()
           
 int getFindHistorySize()
           
 boolean getFindIncSearch()
           
 int getFindIncSearchDelay()
           
 boolean getFindSmartCase()
           
 boolean getFindWrapSearch()
           
 int getFontSize()
          Deprecated. Use Editor Settings API instead.
 boolean getHighlightCaretRow()
           
 boolean getHighlightMatchingBracket()
           
 IndentEngine getIndentEngine()
           
 List getKeyBindingList()
           
 float getLineHeightCorrection()
           
 boolean getLineNumberVisible()
           
 Map getMacroMap()
          Gets Macro Map
 Insets getMargin()
           
protected  MIMEOptionFolder getMIMEFolder()
          Lazy initialization of the MIME specific settings folder.
 MIMEOptionNode getMimeNode()
          Gets MIMEOptionNode that belongs to this bean
static BaseOptions getOptions(Class kitClass)
          Deprecated. Use MimeLookup to find BaseOptions instances for a mime type.
 int getOptionsVersion()
           
 List getOrderedMultiPropertyFolderFiles(String folderName)
           
 boolean getPairCharactersCompletion()
           
 Insets getScrollFindInsets()
           
 Insets getScrollJumpInsets()
           
 Object getSettingValue(String settingName)
          Get the value of the setting from the Settings
 int getStatusBarCaretDelay()
           
 boolean getStatusBarVisible()
           
 int getTabSize()
           
 Color getTextLimitLineColor()
           
 boolean getTextLimitLineVisible()
           
 int getTextLimitWidth()
           
 void initPopupMenuItems()
          Retrieves the actions from XML file
 boolean isTextAntialiasing()
           
 boolean isToolbarVisible()
           
protected  void loadXMLSettings()
          Load all available settings from XML files and initialize them
 void readExternal(ObjectInput in)
           
 void setAbbrevMap(Map map)
          Sets new abbreviations map and save the diff-ed changes to XML file
 void setAbbrevMap(Map map, boolean saveToXML)
          Sets new abbreviations map to initializer map and if saveToXML is true, then new settings will be saved to XML file.
 void setCaretBlinkRate(int rate)
           
 void setCaretColorInsertMode(Color color)
          Sets new CaretColorInsertMode property to initializer map and save the changes to XML file
 void setCaretColorInsertMode(Color color, boolean saveToXML)
          Sets new CaretColorInsertMode property to initializer map and if saveToXML is true, then new settings will be saved to XML file (fontsColors.xml).
 void setCaretColorOverwriteMode(Color color)
          Sets new CaretColorOverwriteMode property to initializer map and save the changes to XML file
 void setCaretColorOverwriteMode(Color color, boolean saveToXML)
          Sets new CaretColorOverwriteMode property to initializer map and if saveToXML is true, then new settings will be saved to XML file (fontsColors.xml).
 void setCaretItalicInsertMode(boolean b)
          Deprecated. since adaptation to new view implementation the option is not supported
 void setCaretItalicOverwriteMode(boolean b)
          Deprecated. since adaptation to new view implementation the option is not supported
 void setCaretTypeInsertMode(String type)
           
 void setCaretTypeOverwriteMode(String type)
           
 void setCodeFoldingProps(Map props)
           
static void setCodeTemplateExpandKey(KeyStroke ks)
          Saves the keystroke of code tamplate expansion into properties.xml file under Editors/text/base
 void setColoringMap(Map coloringMap)
          Deprecated. Use Editor Settings Storage API instead.
 void setColoringMap(Map<String,Coloring> coloringMap, boolean saveToXML)
          Deprecated. Use Editor Settings Storage API instead.
 void setExpandTabs(boolean expandTabs)
           
 void setFindBlockSearch(boolean b)
           
 void setFindHighlightSearch(boolean b)
           
 void setFindHistory(Map m)
           
 void setFindHistorySize(int size)
           
 void setFindIncSearch(boolean b)
           
 void setFindIncSearchDelay(int delay)
           
 void setFindSmartCase(boolean b)
           
 void setFindWrapSearch(boolean b)
           
 void setFontSize(int size)
          Deprecated. Use Editor Settings Storage API instead.
 void setHighlightCaretRow(boolean highlight)
           
 void setHighlightMatchingBracket(boolean highlight)
           
 void setIndentEngine(IndentEngine eng)
           
 void setKeyBindingList(List list)
          Sets new keybindings map and save the diff-ed changes to XML file
 void setKeyBindingList(List list, boolean saveToXML)
          Sets new keybindings list to initializer map and if saveToXML is true, then new settings will be saved to XML file.
 void setKeyBindingsDiffMap(Map diffMap)
          Saves keybindings settings to XML file.
 void setLineHeightCorrection(float f)
           
 void setLineNumberVisible(boolean b)
           
 void setMacroDiffMap(Map diffMap)
          Saves macro settings to XML file.
 void setMacroMap(Map map)
          Sets new macros map and save the diff-ed changes to XML file
 void setMacroMap(Map map, boolean saveToXML)
          Sets new macro map to initializer map and if saveToXML is true, then new settings will be saved to XML file.
 void setMargin(Insets i)
           
 void setOptionsVersion(int optionsVersion)
           
 void setPairCharactersCompletion(boolean v)
           
 void setScrollFindInsets(Insets i)
           
 void setScrollJumpInsets(Insets i)
           
protected  void setSettingBoolean(String settingName, boolean newValue, String propertyName)
          Enables easier handling of the boolean settings.
protected  void setSettingInteger(String settingName, int newValue, String propertyName)
          Enables easier handling of the integer settings.
 void setSettingValue(String settingName, Object newValue)
          Can be used when the settingName is the same as the propertyName
 void setSettingValue(String settingName, Object newValue, String propertyName)
          Sets setting value to initializer Map and save the changes to XML file (properties.xml)
 void setSpacesPerTab(int i)
           
 void setStatusBarCaretDelay(int delay)
           
 void setStatusBarVisible(boolean v)
           
 void setTabSize(int tabSize)
           
 void setTextAntialiasing(boolean textAntialiasing)
           
 void setTextLimitLineColor(Color color)
          Deprecated. Use Editor Settings Storage API instead.
 void setTextLimitLineColor(Color color, boolean saveToXML)
          Deprecated. Use Editor Settings Storage API instead.
 void setTextLimitLineVisible(boolean visible)
           
 void setTextLimitWidth(int width)
           
 void setToolbarVisible(boolean toolbarVisible)
           
protected  void updateSettingsMap(Class kitClass, Map settingsMap)
           
protected  void upgradeOptions(int version, int latestVersion)
          Upgrade the deserialized options.
 boolean usesNewOptionsDialog()
           
 void writeExternal()
          Overriden writeExternal method.
 void writeExternal(ObjectOutput out)
          Overriden writeExternal method.
 
Methods inherited from class org.netbeans.modules.editor.options.OptionSupport
displayName, doSetSettingValue, getKitClass, getSettingBoolean, getSettingInteger, getSettingsInitializerName, getString, getTypeName, getTypeName, mergeStringArrays
 
Methods inherited from class org.openide.options.SystemOption
clearSharedData, getHelpCtx, getName, isReadExternal, isWriteExternal, reset
 
Methods inherited from class org.openide.util.SharedClassObject
addNotify, addPropertyChangeListener, equals, finalize, findObject, findObject, getLock, getProperty, hashCode, initialize, putProperty, putProperty, removeNotify, removePropertyChangeListener, writeReplace
 
Methods inherited from class java.lang.Object
clone, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

LATEST_OPTIONS_VERSION

protected static final int LATEST_OPTIONS_VERSION
Latest version of the options. It must be increased manually when new patch is added to the options.

See Also:
Constant Field Values

OPTIONS_VERSION_PROP

protected static final String OPTIONS_VERSION_PROP
See Also:
Constant Field Values

ABBREV_MAP_PROP

public static final String ABBREV_MAP_PROP
See Also:
Constant Field Values

BASE

public static final String BASE
See Also:
Constant Field Values

CARET_BLINK_RATE_PROP

public static final String CARET_BLINK_RATE_PROP
See Also:
Constant Field Values

CARET_COLOR_INSERT_MODE_PROP

public static final String CARET_COLOR_INSERT_MODE_PROP
See Also:
Constant Field Values

CARET_COLOR_OVERWRITE_MODE_PROP

public static final String CARET_COLOR_OVERWRITE_MODE_PROP
See Also:
Constant Field Values

CARET_ITALIC_INSERT_MODE_PROP

public static final String CARET_ITALIC_INSERT_MODE_PROP
See Also:
Constant Field Values

CARET_ITALIC_OVERWRITE_MODE_PROP

public static final String CARET_ITALIC_OVERWRITE_MODE_PROP
See Also:
Constant Field Values

CARET_TYPE_INSERT_MODE_PROP

public static final String CARET_TYPE_INSERT_MODE_PROP
See Also:
Constant Field Values

CARET_TYPE_OVERWRITE_MODE_PROP

public static final String CARET_TYPE_OVERWRITE_MODE_PROP
See Also:
Constant Field Values

COLORING_MAP_PROP

public static final String COLORING_MAP_PROP
See Also:
Constant Field Values

EXPAND_TABS_PROP

public static final String EXPAND_TABS_PROP
See Also:
Constant Field Values

FIND_HIGHLIGHT_SEARCH_PROP

public static final String FIND_HIGHLIGHT_SEARCH_PROP
See Also:
Constant Field Values

FIND_HISTORY_PROP

public static final String FIND_HISTORY_PROP
See Also:
Constant Field Values

FIND_HISTORY_SIZE_PROP

public static final String FIND_HISTORY_SIZE_PROP
See Also:
Constant Field Values

FIND_INC_SEARCH_DELAY_PROP

public static final String FIND_INC_SEARCH_DELAY_PROP
See Also:
Constant Field Values

FIND_INC_SEARCH_PROP

public static final String FIND_INC_SEARCH_PROP
See Also:
Constant Field Values

FIND_MATCH_CASE_PROP

public static final String FIND_MATCH_CASE_PROP
See Also:
Constant Field Values

FIND_REG_EXP_PROP

public static final String FIND_REG_EXP_PROP
See Also:
Constant Field Values

FIND_SMART_CASE_PROP

public static final String FIND_SMART_CASE_PROP
See Also:
Constant Field Values

FIND_WHOLE_WORDS_PROP

public static final String FIND_WHOLE_WORDS_PROP
See Also:
Constant Field Values

FIND_WRAP_SEARCH_PROP

public static final String FIND_WRAP_SEARCH_PROP
See Also:
Constant Field Values

FIND_BLOCK_SEARCH_PROP

public static final String FIND_BLOCK_SEARCH_PROP
See Also:
Constant Field Values

FONT_SIZE_PROP

public static final String FONT_SIZE_PROP
See Also:
Constant Field Values

HIGHLIGHT_CARET_ROW_PROP

public static final String HIGHLIGHT_CARET_ROW_PROP
See Also:
Constant Field Values

HIGHLIGHT_MATCHING_BRACKET_PROP

public static final String HIGHLIGHT_MATCHING_BRACKET_PROP
See Also:
Constant Field Values

INDENT_ENGINE_PROP

public static final String INDENT_ENGINE_PROP
See Also:
Constant Field Values

KEY_BINDING_LIST_PROP

public static final String KEY_BINDING_LIST_PROP
See Also:
Constant Field Values

LINE_HEIGHT_CORRECTION_PROP

public static final String LINE_HEIGHT_CORRECTION_PROP
See Also:
Constant Field Values

LINE_NUMBER_VISIBLE_PROP

public static final String LINE_NUMBER_VISIBLE_PROP
See Also:
Constant Field Values

MACRO_MAP_PROP

public static final String MACRO_MAP_PROP
See Also:
Constant Field Values

MARGIN_PROP

public static final String MARGIN_PROP
See Also:
Constant Field Values

PAIR_CHARACTERS_COMPLETION

public static final String PAIR_CHARACTERS_COMPLETION
See Also:
Constant Field Values

SCROLL_FIND_INSETS_PROP

public static final String SCROLL_FIND_INSETS_PROP
See Also:
Constant Field Values

SCROLL_JUMP_INSETS_PROP

public static final String SCROLL_JUMP_INSETS_PROP
See Also:
Constant Field Values

SPACES_PER_TAB_PROP

public static final String SPACES_PER_TAB_PROP
See Also:
Constant Field Values

STATUS_BAR_CARET_DELAY_PROP

public static final String STATUS_BAR_CARET_DELAY_PROP
See Also:
Constant Field Values

STATUS_BAR_VISIBLE_PROP

public static final String STATUS_BAR_VISIBLE_PROP
See Also:
Constant Field Values

TAB_SIZE_PROP

public static final String TAB_SIZE_PROP
See Also:
Constant Field Values

TEXT_LIMIT_LINE_COLOR_PROP

public static final String TEXT_LIMIT_LINE_COLOR_PROP
See Also:
Constant Field Values

TEXT_LIMIT_LINE_VISIBLE_PROP

public static final String TEXT_LIMIT_LINE_VISIBLE_PROP
See Also:
Constant Field Values

TEXT_LIMIT_WIDTH_PROP

public static final String TEXT_LIMIT_WIDTH_PROP
See Also:
Constant Field Values

TOOLBAR_VISIBLE_PROP

public static final String TOOLBAR_VISIBLE_PROP
See Also:
Constant Field Values

TEXT_ANTIALIASING_PROP

public static final String TEXT_ANTIALIASING_PROP
See Also:
Constant Field Values

CODE_FOLDING_PROPS_PROP

public static final String CODE_FOLDING_PROPS_PROP
See Also:
Constant Field Values

BASE_PROP_NAMES

protected static final String[] BASE_PROP_NAMES

CODE_TEMPLATE_EXPAND_KEY

public static final String CODE_TEMPLATE_EXPAND_KEY
Code template expand key setting name

See Also:
Constant Field Values
Constructor Detail

BaseOptions

public BaseOptions()

BaseOptions

public BaseOptions(Class kitClass,
                   String typeName)
Method Detail

usesNewOptionsDialog

public boolean usesNewOptionsDialog()

getContentType

protected String getContentType()

getOptions

public static BaseOptions getOptions(Class kitClass)
Deprecated. Use MimeLookup to find BaseOptions instances for a mime type.

Gets an instance of BaseOptions for an editir kit implementation class. Please see description of BaseKit.getKit(Class) for more details.

Parameters:
kitClass - The editor kit implementation class to get BaseOptions for.
Returns:
The BaseOptions or null if the options can't be found or loaded for some reason.
See Also:
BaseKit.getKit(Class)

getMIMEFolder

protected MIMEOptionFolder getMIMEFolder()
Lazy initialization of the MIME specific settings folder. The folder should be created via XML layers, if not, it will be created. Instances of all XML file in this folder will be created.


getMimeNode

public MIMEOptionNode getMimeNode()
Gets MIMEOptionNode that belongs to this bean


updateSettingsMap

protected void updateSettingsMap(Class kitClass,
                                 Map settingsMap)
Overrides:
updateSettingsMap in class OptionSupport

getTabSize

public int getTabSize()

setTabSize

public void setTabSize(int tabSize)

setExpandTabs

public void setExpandTabs(boolean expandTabs)

setSpacesPerTab

public void setSpacesPerTab(int i)

getDefaultAbbrevMap

public Map getDefaultAbbrevMap()
Gets Map of default Abbreviations as they are stored in MIMEFolder/Defaults/abbreviations.xml


getAbbrevMap

public Map getAbbrevMap()

setAbbrevMap

public void setAbbrevMap(Map map,
                         boolean saveToXML)
Sets new abbreviations map to initializer map and if saveToXML is true, then new settings will be saved to XML file.


setAbbrevMap

public void setAbbrevMap(Map map)
Sets new abbreviations map and save the diff-ed changes to XML file


getCaretTypeInsertMode

public String getCaretTypeInsertMode()

setCaretTypeInsertMode

public void setCaretTypeInsertMode(String type)

getCaretTypeOverwriteMode

public String getCaretTypeOverwriteMode()

setCaretTypeOverwriteMode

public void setCaretTypeOverwriteMode(String type)

getCaretItalicInsertMode

public boolean getCaretItalicInsertMode()
Deprecated. since adaptation to new view implementation the option is not supported


setCaretItalicInsertMode

public void setCaretItalicInsertMode(boolean b)
Deprecated. since adaptation to new view implementation the option is not supported


getCaretItalicOverwriteMode

public boolean getCaretItalicOverwriteMode()
Deprecated. since adaptation to new view implementation the option is not supported


setCaretItalicOverwriteMode

public void setCaretItalicOverwriteMode(boolean b)
Deprecated. since adaptation to new view implementation the option is not supported


getCaretColorInsertMode

public Color getCaretColorInsertMode()

setCaretColorInsertMode

public void setCaretColorInsertMode(Color color)
Sets new CaretColorInsertMode property to initializer map and save the changes to XML file


setCaretColorInsertMode

public void setCaretColorInsertMode(Color color,
                                    boolean saveToXML)
Sets new CaretColorInsertMode property to initializer map and if saveToXML is true, then new settings will be saved to XML file (fontsColors.xml).


getCaretColorOverwriteMode

public Color getCaretColorOverwriteMode()

setCaretColorOverwriteMode

public void setCaretColorOverwriteMode(Color color)
Sets new CaretColorOverwriteMode property to initializer map and save the changes to XML file


setCaretColorOverwriteMode

public void setCaretColorOverwriteMode(Color color,
                                       boolean saveToXML)
Sets new CaretColorOverwriteMode property to initializer map and if saveToXML is true, then new settings will be saved to XML file (fontsColors.xml).


getCaretBlinkRate

public int getCaretBlinkRate()

setCaretBlinkRate

public void setCaretBlinkRate(int rate)

getLineNumberVisible

public boolean getLineNumberVisible()

setLineNumberVisible

public void setLineNumberVisible(boolean b)

getScrollJumpInsets

public Insets getScrollJumpInsets()

setScrollJumpInsets

public void setScrollJumpInsets(Insets i)

getScrollFindInsets

public Insets getScrollFindInsets()

setScrollFindInsets

public void setScrollFindInsets(Insets i)

getDefaultKeyBindingsMap

public Map getDefaultKeyBindingsMap()
Gets Map of default KeyBindings as they are stored in MIMEFolder/Defaults/keybindings.xml


getKeyBindingList

public List getKeyBindingList()

setKeyBindingList

public void setKeyBindingList(List list)
Sets new keybindings map and save the diff-ed changes to XML file


setKeyBindingsDiffMap

public void setKeyBindingsDiffMap(Map diffMap)
Saves keybindings settings to XML file. (This is used especially for record macro action.)


setKeyBindingList

public void setKeyBindingList(List list,
                              boolean saveToXML)
Sets new keybindings list to initializer map and if saveToXML is true, then new settings will be saved to XML file.


getColoringMap

public Map<String,Coloring> getColoringMap()
Deprecated. Use Editor Settings API instead.

Tries to gather all colorings defined for the mime type of this instance.

Returns:
The map with all colorings defined the mime type of this instance. The returned map may be inaccurate, please use the new Editor Settings API and its FontColorSettings class.

setColoringMap

public void setColoringMap(Map coloringMap)
Deprecated. Use Editor Settings Storage API instead.

Calls setColoringMap(coloringMap, true).


setColoringMap

public void setColoringMap(Map<String,Coloring> coloringMap,
                           boolean saveToXML)
Deprecated. Use Editor Settings Storage API instead.

Tries to update colorings for the mime type of this instance.

Parameters:
coloringMap - The map with colorings.
saveToXML - Ignored.

getFontSize

public int getFontSize()
Deprecated. Use Editor Settings API instead.


setFontSize

public void setFontSize(int size)
Deprecated. Use Editor Settings Storage API instead.

Does nothing.


getLineHeightCorrection

public float getLineHeightCorrection()

setLineHeightCorrection

public void setLineHeightCorrection(float f)

getDefaultMacrosMap

public Map getDefaultMacrosMap()
Gets Map of default Macros as they are stored in MIMEFolder/Defaults/macros.xml


getMacroMap

public Map getMacroMap()
Gets Macro Map


setMacroDiffMap

public void setMacroDiffMap(Map diffMap)
Saves macro settings to XML file. (This is used especially for record macro action.)


setMacroMap

public void setMacroMap(Map map,
                        boolean saveToXML)
Sets new macro map to initializer map and if saveToXML is true, then new settings will be saved to XML file.


setMacroMap

public void setMacroMap(Map map)
Sets new macros map and save the diff-ed changes to XML file


getMargin

public Insets getMargin()

setMargin

public void setMargin(Insets i)

getStatusBarVisible

public boolean getStatusBarVisible()

setStatusBarVisible

public void setStatusBarVisible(boolean v)

getStatusBarCaretDelay

public int getStatusBarCaretDelay()

setStatusBarCaretDelay

public void setStatusBarCaretDelay(int delay)

getFindHighlightSearch

public boolean getFindHighlightSearch()

setFindHighlightSearch

public void setFindHighlightSearch(boolean b)

getFindBlockSearch

public boolean getFindBlockSearch()

setFindBlockSearch

public void setFindBlockSearch(boolean b)

getFindIncSearch

public boolean getFindIncSearch()

setFindIncSearch

public void setFindIncSearch(boolean b)

getFindIncSearchDelay

public int getFindIncSearchDelay()

setFindIncSearchDelay

public void setFindIncSearchDelay(int delay)

getFindWrapSearch

public boolean getFindWrapSearch()

setFindWrapSearch

public void setFindWrapSearch(boolean b)

getFindSmartCase

public boolean getFindSmartCase()

setFindSmartCase

public void setFindSmartCase(boolean b)

getFindHistory

public Map getFindHistory()

setFindHistory

public void setFindHistory(Map m)

getFindHistorySize

public int getFindHistorySize()

setFindHistorySize

public void setFindHistorySize(int size)

getPairCharactersCompletion

public boolean getPairCharactersCompletion()

setPairCharactersCompletion

public void setPairCharactersCompletion(boolean v)

getTextLimitLineColor

public Color getTextLimitLineColor()

setTextLimitLineColor

public void setTextLimitLineColor(Color color)
Deprecated. Use Editor Settings Storage API instead.

Sets new TextLimitLineColor property to initializer map and save the changes to XML file


setTextLimitLineColor

public void setTextLimitLineColor(Color color,
                                  boolean saveToXML)
Deprecated. Use Editor Settings Storage API instead.

Sets new TextLimitLineColor property to initializer map and if saveToXML is true, then new settings will be saved to XML file (fontsColors.xml).


getTextLimitWidth

public int getTextLimitWidth()

setTextLimitWidth

public void setTextLimitWidth(int width)

getTextLimitLineVisible

public boolean getTextLimitLineVisible()

setTextLimitLineVisible

public void setTextLimitLineVisible(boolean visible)

getHighlightMatchingBracket

public boolean getHighlightMatchingBracket()

setHighlightMatchingBracket

public void setHighlightMatchingBracket(boolean highlight)

getHighlightCaretRow

public boolean getHighlightCaretRow()

setHighlightCaretRow

public void setHighlightCaretRow(boolean highlight)

isToolbarVisible

public boolean isToolbarVisible()

setToolbarVisible

public void setToolbarVisible(boolean toolbarVisible)

isTextAntialiasing

public boolean isTextAntialiasing()

setTextAntialiasing

public void setTextAntialiasing(boolean textAntialiasing)

getCodeFoldingProps

public Map getCodeFoldingProps()

setCodeFoldingProps

public void setCodeFoldingProps(Map props)

initPopupMenuItems

public void initPopupMenuItems()
Retrieves the actions from XML file


getOrderedMultiPropertyFolderFiles

public List getOrderedMultiPropertyFolderFiles(String folderName)

getIndentEngine

public IndentEngine getIndentEngine()

setIndentEngine

public void setIndentEngine(IndentEngine eng)

getDefaultIndentEngineClass

protected Class getDefaultIndentEngineClass()
Return class of the default indentation engine.


setOptionsVersion

public void setOptionsVersion(int optionsVersion)

getOptionsVersion

public int getOptionsVersion()

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Overrides:
readExternal in class SystemOption
Throws:
IOException
ClassNotFoundException

upgradeOptions

protected void upgradeOptions(int version,
                              int latestVersion)
Upgrade the deserialized options.

Parameters:
version - deserialized version of the options
latestVersion - latest version of the options that will be set to them after they are upgraded

setSettingValue

public void setSettingValue(String settingName,
                            Object newValue)
Description copied from class: OptionSupport
Can be used when the settingName is the same as the propertyName

Overrides:
setSettingValue in class OptionSupport

setSettingValue

public void setSettingValue(String settingName,
                            Object newValue,
                            String propertyName)
Sets setting value to initializer Map and save the changes to XML file (properties.xml)

Overrides:
setSettingValue in class OptionSupport
Parameters:
settingName - name of the setting to change
newValue - new value of the setting
propertyName - if non-null it means that the property change should be fired if the newValue is differernt from the old one. Firing is performed using the given property name. Nothing is fired when it's set to null.

getSettingValue

public Object getSettingValue(String settingName)
Description copied from class: OptionSupport
Get the value of the setting from the Settings

Overrides:
getSettingValue in class OptionSupport
Parameters:
settingName - name of the setting to get.

setSettingBoolean

protected final void setSettingBoolean(String settingName,
                                       boolean newValue,
                                       String propertyName)
Description copied from class: OptionSupport
Enables easier handling of the boolean settings.

Overrides:
setSettingBoolean in class OptionSupport
Parameters:
settingName - name of the setting to change
newValue - new boolean value of the setting
propertyName - if non-null it means that the property change should be fired if the newValue is differernt from the old one. Firing is performed using the given property name. Nothing is fired when it's set to null.

setSettingInteger

protected final void setSettingInteger(String settingName,
                                       int newValue,
                                       String propertyName)
Description copied from class: OptionSupport
Enables easier handling of the integer settings.

Overrides:
setSettingInteger in class OptionSupport
Parameters:
settingName - name of the setting to change
newValue - new integer value of the setting
propertyName - if non-null it means that the property change should be fired if the newValue is differernt from the old one. Firing is performed using the given property name. Nothing is fired when it's set to null.

loadXMLSettings

protected void loadXMLSettings()
Load all available settings from XML files and initialize them


writeExternal

public void writeExternal()
                   throws IOException
Overriden writeExternal method. BaseOptions are no longer serialized.

Throws:
IOException

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Overriden writeExternal method. BaseOptions are no longer serialized.

Specified by:
writeExternal in interface Externalizable
Overrides:
writeExternal in class SystemOption
Throws:
IOException

firePropertyChange

protected void firePropertyChange(String name,
                                  Object oldValue,
                                  Object newValue)
Overrides:
firePropertyChange in class SystemOption

setCodeTemplateExpandKey

public static void setCodeTemplateExpandKey(KeyStroke ks)
Saves the keystroke of code tamplate expansion into properties.xml file under Editors/text/base


getCodeTemplateExpandKey

public static KeyStroke getCodeTemplateExpandKey()
Gets Code Template Expand Key. Can return null if there is no key in the settings file


org.netbeans.modules.editor/3 1.32.0

Built on May 28 2007.  |  Portions Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.