Configuration (LanguageTool common GUI classes 5.1 API)

java.lang.Object
- org.languagetool.gui.Configuration

```
public class Configuration
extends Object
```
Configuration like list of disabled rule IDs, server mode etc. Configuration is loaded from and stored to a properties file.

Author:

Daniel Naber

Field Summary

Fields
Modifier and Type Field and Description

static short UNDERLINE_BOLD

static short UNDERLINE_BOLDWAVE

static short UNDERLINE_DASH

static short UNDERLINE_WAVE

Fields
Modifier and Type	Field and Description
`static short`	`UNDERLINE_BOLD`
`static short`	`UNDERLINE_BOLDWAVE`
`static short`	`UNDERLINE_DASH`
`static short`	`UNDERLINE_WAVE`

Constructor Summary

Constructors
Constructor and Description
`Configuration(File baseDir, Language lang)`
`Configuration(File baseDir, String filename, File oldConfigFile, Language lang)`
`Configuration(File baseDir, String filename, Language lang)`
`Configuration(Language lang)` Uses the configuration file from the default location.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDisabledRuleIds(Set<String> ruleIds)`
`void`	`addProfile(String profile)` add a new profile
`void`	`addProfiles(List<String> profiles)` add a list of profiles
`boolean`	`doFullCheckAtFirst()` do a full check at first iteration?
`boolean`	`doRemoteCheck()`
`boolean`	`getAutoDetect()`
`int`	`getConfigurableValue(String ruleID)` Get the configurable value of a rule by ruleID returns -1 if no value is set by configuration
`Map<String,Integer>`	`getConfigurableValues()` returns all configured values
`String`	`getCurrentProfile()` get the current profile
`Language`	`getDefaultLanguage()`
`List<String>`	`getDefinedProfiles()` get the current profile
`Set<String>`	`getDisabledCategoryNames()`
`Set<String>`	`getDisabledRuleIds()`
`Set<String>`	`getEnabledCategoryNames()`
`Set<String>`	`getEnabledRuleIds()`
`boolean`	`getEnabledRulesOnly()`
`Map<ITSIssueType,Color>`	`getErrorColors()`
`String`	`getExternalRuleDirectory()`
`String`	`getFontName()` Returns the name of the GUI's editing textarea font.
`int`	`getFontSize()` Returns the size of the GUI's editing textarea font.
`int`	`getFontStyle()` Returns the style of the GUI's editing textarea font.
`Language`	`getLanguage()`
`String`	`getlogLevel()`
`String`	`getLookAndFeelName()` Returns the name of the GUI's LaF.
`Language`	`getMotherTongue()`
`File`	`getNgramDirectory()` Directory with ngram data or null.
`int`	`getNumParasToCheck()` get the number of paragraphs to be checked for TextLevelRules
`boolean`	`getRunServer()`
`int`	`getServerPort()`
`String`	`getServerUrl()`
`Set<String>`	`getSpecialTabCategories(String tabName)`
`String[]`	`getSpecialTabNames()`
`boolean`	`getTaggerShowsDisambigLog()` Determines whether the tagger window will also print the disambiguation log.
`Color`	`getUnderlineColor(String category)`
`Map<String,Color>`	`getUnderlineColors()`
`Short`	`getUnderlineType(String category)`
`Map<String,Short>`	`getUnderlineTypes()`
`boolean`	`getUseDocLanguage()`
`boolean`	`getUseGUIConfig()`
`File`	`getWord2VecDirectory()` Directory with word2vec data or null.
`void`	`initOptions()` Initialize variables and clears Maps, Sets and Lists
`void`	`initStyleCategories(List<Rule> allRules)`
`boolean`	`isInSpecialTab(String category, String tabName)`
`boolean`	`isMultiThread()` shall LO run in multi thread mode
`boolean`	`isResetCheck()` will all paragraphs check after every change of text?
`boolean`	`isSpecialTabCategory(String category)`
`boolean`	`isStyleCategory(String category)`
`boolean`	`isSwitchedOff()` if true: LT is switched Off, else: LT is switched On
`boolean`	`isValidServerUrl(String url)` Test if http-server URL is correct
`void`	`loadConfiguration(String profile)`
`boolean`	`markSingleCharBold()`
`boolean`	`noSynonymsAsSuggestions()`
`void`	`removeDisabledRuleIds(Set<String> ruleIds)`
`void`	`removeProfile(String profile)` remove an existing profile
`void`	`saveConfiguration(Language lang)`
`void`	`setAutoDetect(boolean autoDetect)`
`void`	`setConfigurableValue(String ruleID, int value)` Set the value for a rule with ruleID
`void`	`setCurrentProfile(String profile)` set the current profile
`void`	`setDefaultUnderlineColor(String category)`
`void`	`setDefaultUnderlineType(String category)`
`void`	`setDisabledCategoryNames(Set<String> categoryNames)`
`void`	`setDisabledRuleIds(Set<String> ruleIds)`
`void`	`setDoResetCheck(boolean resetCheck)` set all paragraphs to be checked after every change of text
`void`	`setEnabledCategoryNames(Set<String> categoryNames)`
`void`	`setEnabledRuleIds(Set<String> ruleIds)`
`void`	`setExternalRuleDirectory(String path)`
`void`	`setFontName(String fontName)` Sets the name of the GUI's editing textarea font.
`void`	`setFontSize(int fontSize)` Sets the size of the GUI's editing textarea font.
`void`	`setFontStyle(int fontStyle)` Sets the style of the GUI's editing textarea font.
`void`	`setFullCheckAtFirst(boolean doFullCheckAtFirst)` set option to do a full check at first iteration
`void`	`setLanguage(Language language)`
`void`	`setLookAndFeelName(String lookAndFeelName)` Sets the name of the GUI's LaF.
`void`	`setMarkSingleCharBold(boolean markSingleCharBold)`
`void`	`setMotherTongue(Language motherTongue)`
`void`	`setMultiThreadLO(boolean isMultiThread)` run LO in multi thread mode
`void`	`setNgramDirectory(File dir)` Sets the directory with ngram data (may be null).
`void`	`setNoSynonymsAsSuggestions(boolean noSynonymsAsSuggestions)`
`void`	`setNumParasToCheck(int numParas)` set the number of paragraphs to be checked for TextLevelRules
`void`	`setOtherServerUrl(String otherServerUrl)`
`void`	`setRemoteCheck(boolean doRemoteCheck)`
`void`	`setRunServer(boolean runServer)`
`void`	`setServerPort(int serverPort)`
`void`	`setSwitchedOff(boolean switchOff, Language lang)` Set LT is switched Off or On save configuration
`void`	`setTaggerShowsDisambigLog(boolean taggerShowsDisambigLog)` Enables or disables the disambiguation log on the tagger window, depending on the value of the parameter taggerShowsDisambigLog.
`void`	`setUnderlineColor(String category, Color col)`
`void`	`setUnderlineType(String category, short type)`
`void`	`setUseDocLanguage(boolean useDocLang)`
`void`	`setUseGUIConfig(boolean useGUIConfig)`
`void`	`setUseLtDictionary(boolean useLtDictionary)`
`void`	`setUseOtherServer(boolean useOtherServer)`
`void`	`setUseTextLevelQueue(boolean useTextLevelQueue)` set all paragraphs to be not checked after every change of text if more than one document loaded?
`void`	`setWord2VecDirectory(File dir)` Sets the directory with word2vec data (may be null).
`boolean`	`useLtDictionary()`
`boolean`	`useOtherServer()`
`boolean`	`useTextLevelQueue()` will all paragraphs not checked after every change of text if more than one document loaded?

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - UNDERLINE_WAVE
```
public static final short UNDERLINE_WAVE
```
    See Also:
    
    Constant Field Values
  - UNDERLINE_BOLDWAVE
```
public static final short UNDERLINE_BOLDWAVE
```
    See Also:
    
    Constant Field Values
  - UNDERLINE_BOLD
```
public static final short UNDERLINE_BOLD
```
    See Also:
    
    Constant Field Values
  - UNDERLINE_DASH
```
public static final short UNDERLINE_DASH
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Configuration
```
public Configuration(Language lang)
              throws IOException
```
    Uses the configuration file from the default location.
    
    Parameters:
    
    lang - The language for the configuration, used to distinguish rules that are enabled or disabled per language.
    
    Throws:
    
    IOException
  - Configuration
```
public Configuration(File baseDir,
                     Language lang)
              throws IOException
```
    Throws:
    
    IOException
  - Configuration
```
public Configuration(File baseDir,
                     String filename,
                     Language lang)
              throws IOException
```
    Throws:
    
    IOException
  - Configuration
```
public Configuration(File baseDir,
                     String filename,
                     File oldConfigFile,
                     Language lang)
              throws IOException
```
    Throws:
    
    IOException
- Method Detail
  - initOptions
```
public void initOptions()
```
    Initialize variables and clears Maps, Sets and Lists
  - getDisabledRuleIds
```
public Set<String> getDisabledRuleIds()
```
  - getEnabledRuleIds
```
public Set<String> getEnabledRuleIds()
```
  - getDisabledCategoryNames
```
public Set<String> getDisabledCategoryNames()
```
  - getEnabledCategoryNames
```
public Set<String> getEnabledCategoryNames()
```
  - setDisabledRuleIds
```
public void setDisabledRuleIds(Set<String> ruleIds)
```
  - addDisabledRuleIds
```
public void addDisabledRuleIds(Set<String> ruleIds)
```
  - removeDisabledRuleIds
```
public void removeDisabledRuleIds(Set<String> ruleIds)
```
  - setEnabledRuleIds
```
public void setEnabledRuleIds(Set<String> ruleIds)
```
  - setDisabledCategoryNames
```
public void setDisabledCategoryNames(Set<String> categoryNames)
```
  - setEnabledCategoryNames
```
public void setEnabledCategoryNames(Set<String> categoryNames)
```
  - getEnabledRulesOnly
```
public boolean getEnabledRulesOnly()
```
  - getLanguage
```
public Language getLanguage()
```
  - setLanguage
```
public void setLanguage(Language language)
```
  - getMotherTongue
```
public Language getMotherTongue()
```
  - setMotherTongue
```
public void setMotherTongue(Language motherTongue)
```
  - getDefaultLanguage
```
public Language getDefaultLanguage()
```
  - setUseDocLanguage
```
public void setUseDocLanguage(boolean useDocLang)
```
  - getUseDocLanguage
```
public boolean getUseDocLanguage()
```
  - getAutoDetect
```
public boolean getAutoDetect()
```
  - setAutoDetect
```
public void setAutoDetect(boolean autoDetect)
```
  - setRemoteCheck
```
public void setRemoteCheck(boolean doRemoteCheck)
```
  - doRemoteCheck
```
public boolean doRemoteCheck()
```
  - setUseOtherServer
```
public void setUseOtherServer(boolean useOtherServer)
```
  - useOtherServer
```
public boolean useOtherServer()
```
  - setOtherServerUrl
```
public void setOtherServerUrl(String otherServerUrl)
```
  - getServerUrl
```
public String getServerUrl()
```
  - getlogLevel
```
public String getlogLevel()
```
  - setMarkSingleCharBold
```
public void setMarkSingleCharBold(boolean markSingleCharBold)
```
  - markSingleCharBold
```
public boolean markSingleCharBold()
```
  - setUseLtDictionary
```
public void setUseLtDictionary(boolean useLtDictionary)
```
  - useLtDictionary
```
public boolean useLtDictionary()
```
  - setNoSynonymsAsSuggestions
```
public void setNoSynonymsAsSuggestions(boolean noSynonymsAsSuggestions)
```
  - noSynonymsAsSuggestions
```
public boolean noSynonymsAsSuggestions()
```
  - getTaggerShowsDisambigLog
```
public boolean getTaggerShowsDisambigLog()
```
    Determines whether the tagger window will also print the disambiguation log.
    
    Returns:
    
    true if the tagger window will print the disambiguation log, false otherwise
    
    Since:
    
    3.3
  - setTaggerShowsDisambigLog
```
public void setTaggerShowsDisambigLog(boolean taggerShowsDisambigLog)
```
    Enables or disables the disambiguation log on the tagger window, depending on the value of the parameter taggerShowsDisambigLog.
    
    Parameters:
    
    taggerShowsDisambigLog - If true, the tagger window will print the
    
    Since:
    
    3.3
  - getRunServer
```
public boolean getRunServer()
```
  - setRunServer
```
public void setRunServer(boolean runServer)
```
  - getServerPort
```
public int getServerPort()
```
  - setUseGUIConfig
```
public void setUseGUIConfig(boolean useGUIConfig)
```
  - getUseGUIConfig
```
public boolean getUseGUIConfig()
```
  - setServerPort
```
public void setServerPort(int serverPort)
```
  - getExternalRuleDirectory
```
public String getExternalRuleDirectory()
```
  - setExternalRuleDirectory
```
public void setExternalRuleDirectory(String path)
```
  - getNumParasToCheck
```
public int getNumParasToCheck()
```
    get the number of paragraphs to be checked for TextLevelRules
    
    Since:
    
    4.0
  - setNumParasToCheck
```
public void setNumParasToCheck(int numParas)
```
    set the number of paragraphs to be checked for TextLevelRules
    
    Since:
    
    4.0
  - isResetCheck
```
public boolean isResetCheck()
```
    will all paragraphs check after every change of text?
    
    Since:
    
    4.2
  - setDoResetCheck
```
public void setDoResetCheck(boolean resetCheck)
```
    set all paragraphs to be checked after every change of text
    
    Since:
    
    4.2
  - useTextLevelQueue
```
public boolean useTextLevelQueue()
```
    will all paragraphs not checked after every change of text if more than one document loaded?
    
    Since:
    
    4.5
  - setUseTextLevelQueue
```
public void setUseTextLevelQueue(boolean useTextLevelQueue)
```
    set all paragraphs to be not checked after every change of text if more than one document loaded?
    
    Since:
    
    4.5
  - setFullCheckAtFirst
```
public void setFullCheckAtFirst(boolean doFullCheckAtFirst)
```
    set option to do a full check at first iteration
    
    Since:
    
    4.7
  - doFullCheckAtFirst
```
public boolean doFullCheckAtFirst()
```
    do a full check at first iteration?
    
    Since:
    
    4.7
  - getCurrentProfile
```
public String getCurrentProfile()
```
    get the current profile
    
    Since:
    
    4.7
  - setCurrentProfile
```
public void setCurrentProfile(String profile)
```
    set the current profile
    
    Since:
    
    4.7
  - getDefinedProfiles
```
public List<String> getDefinedProfiles()
```
    get the current profile
    
    Since:
    
    4.7
  - addProfile
```
public void addProfile(String profile)
```
    add a new profile
    
    Since:
    
    4.7
  - addProfiles
```
public void addProfiles(List<String> profiles)
```
    add a list of profiles
    
    Since:
    
    4.7
  - removeProfile
```
public void removeProfile(String profile)
```
    remove an existing profile
    
    Since:
    
    4.7
  - setMultiThreadLO
```
public void setMultiThreadLO(boolean isMultiThread)
```
    run LO in multi thread mode
    
    Since:
    
    4.6
  - isMultiThread
```
public boolean isMultiThread()
```
    shall LO run in multi thread mode
    
    Since:
    
    4.6
  - getFontName
```
public String getFontName()
```
    Returns the name of the GUI's editing textarea font.
    
    Returns:
    
    the name of the font.
    
    Since:
    
    2.6
    
    See Also:
    
    Font.getFamily()
  - setFontName
```
public void setFontName(String fontName)
```
    Sets the name of the GUI's editing textarea font.
    
    Parameters:
    
    fontName - the name of the font.
    
    Since:
    
    2.6
    
    See Also:
    
    Font.getFamily()
  - getFontStyle
```
public int getFontStyle()
```
    Returns the style of the GUI's editing textarea font.
    
    Returns:
    
    the style of the font.
    
    Since:
    
    2.6
    
    See Also:
    
    Font.getStyle()
  - setFontStyle
```
public void setFontStyle(int fontStyle)
```
    Sets the style of the GUI's editing textarea font.
    
    Parameters:
    
    fontStyle - the style of the font.
    
    Since:
    
    2.6
    
    See Also:
    
    Font.getStyle()
  - getFontSize
```
public int getFontSize()
```
    Returns the size of the GUI's editing textarea font.
    
    Returns:
    
    the size of the font.
    
    Since:
    
    2.6
    
    See Also:
    
    Font.getSize()
  - setFontSize
```
public void setFontSize(int fontSize)
```
    Sets the size of the GUI's editing textarea font.
    
    Parameters:
    
    fontSize - the size of the font.
    
    Since:
    
    2.6
    
    See Also:
    
    Font.getSize()
  - getLookAndFeelName
```
public String getLookAndFeelName()
```
    Returns the name of the GUI's LaF.
    
    Returns:
    
    the name of the LaF.
    
    Since:
    
    2.6
    
    See Also:
    
    UIManager.LookAndFeelInfo.getName()
  - setLookAndFeelName
```
public void setLookAndFeelName(String lookAndFeelName)
```
    Sets the name of the GUI's LaF.
    
    Parameters:
    
    lookAndFeelName - the name of the LaF.
    
    Since:
    
    2.6 @see
    
    See Also:
    
    UIManager.LookAndFeelInfo.getName()
  - getNgramDirectory
```
@Nullable
public File getNgramDirectory()
```
    Directory with ngram data or null.
    
    Since:
    
    3.0
  - setNgramDirectory
```
public void setNgramDirectory(File dir)
```
    Sets the directory with ngram data (may be null).
    
    Since:
    
    3.0
  - getWord2VecDirectory
```
@Nullable
public File getWord2VecDirectory()
```
    Directory with word2vec data or null.
    
    Since:
    
    4.0
  - setWord2VecDirectory
```
public void setWord2VecDirectory(File dir)
```
    Sets the directory with word2vec data (may be null).
    
    Since:
    
    4.0
  - getErrorColors
```
public Map<ITSIssueType,Color> getErrorColors()
```
    Since:
    
    2.8
  - isStyleCategory
```
public boolean isStyleCategory(String category)
```
    Since:
    
    4.3 Returns true if category is style like
  - initStyleCategories
```
public void initStyleCategories(List<Rule> allRules)
```
    Since:
    
    4.4 Initialize set of style like categories
  - isSpecialTabCategory
```
public boolean isSpecialTabCategory(String category)
```
    Since:
    
    4.3 Returns true if category is a special Tab category
  - isInSpecialTab
```
public boolean isInSpecialTab(String category,
                              String tabName)
```
    Since:
    
    4.3 Returns true if category is member of named special Tab
  - getSpecialTabNames
```
public String[] getSpecialTabNames()
```
    Since:
    
    4.3 Returns all special tab names
  - getSpecialTabCategories
```
public Set<String> getSpecialTabCategories(String tabName)
```
    Since:
    
    4.3 Returns all categories for a named special tab
  - getUnderlineColors
```
public Map<String,Color> getUnderlineColors()
```
    Since:
    
    4.2
  - getUnderlineColor
```
public Color getUnderlineColor(String category)
```
    Since:
    
    4.2 Get the color to underline a rule match by the Name of its category
  - setUnderlineColor
```
public void setUnderlineColor(String category,
                              Color col)
```
    Since:
    
    4.2 Set the color to underline a rule match for its category
  - setDefaultUnderlineColor
```
public void setDefaultUnderlineColor(String category)
```
    Since:
    
    4.2 Set the color back to default (removes category from map)
  - getUnderlineTypes
```
public Map<String,Short> getUnderlineTypes()
```
    Since:
    
    4.9
  - getUnderlineType
```
public Short getUnderlineType(String category)
```
    Since:
    
    4.9 Get the type to underline a rule match by the Name of its category
  - setUnderlineType
```
public void setUnderlineType(String category,
                             short type)
```
    Since:
    
    4.9 Set the type to underline a rule match for its category
  - setDefaultUnderlineType
```
public void setDefaultUnderlineType(String category)
```
    Since:
    
    4.9 Set the type back to default (removes category from map)
  - getConfigurableValues
```
public Map<String,Integer> getConfigurableValues()
```
    returns all configured values
    
    Since:
    
    4.2
  - getConfigurableValue
```
public int getConfigurableValue(String ruleID)
```
    Get the configurable value of a rule by ruleID returns -1 if no value is set by configuration
    
    Since:
    
    4.2
  - setConfigurableValue
```
public void setConfigurableValue(String ruleID,
                                 int value)
```
    Set the value for a rule with ruleID
    
    Since:
    
    4.2
  - isSwitchedOff
```
public boolean isSwitchedOff()
```
    if true: LT is switched Off, else: LT is switched On
    
    Since:
    
    4.4
  - setSwitchedOff
```
public void setSwitchedOff(boolean switchOff,
                           Language lang)
                    throws IOException
```
    Set LT is switched Off or On save configuration
    
    Throws:
    
    IOException
    
    Since:
    
    4.4
  - isValidServerUrl
```
public boolean isValidServerUrl(String url)
```
    Test if http-server URL is correct
  - loadConfiguration
```
public void loadConfiguration(String profile)
                       throws IOException
```
    Throws:
    
    IOException
  - saveConfiguration
```
public void saveConfiguration(Language lang)
                       throws IOException
```
    Throws:
    
    IOException

Class Configuration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UNDERLINE_WAVE

UNDERLINE_BOLDWAVE

UNDERLINE_BOLD

UNDERLINE_DASH

Constructor Detail

Configuration

Configuration

Configuration

Configuration

Method Detail

initOptions

getDisabledRuleIds

getEnabledRuleIds

getDisabledCategoryNames

getEnabledCategoryNames

setDisabledRuleIds

addDisabledRuleIds

removeDisabledRuleIds

setEnabledRuleIds

setDisabledCategoryNames

setEnabledCategoryNames

getEnabledRulesOnly

getLanguage

setLanguage

getMotherTongue

setMotherTongue

getDefaultLanguage

setUseDocLanguage

getUseDocLanguage

getAutoDetect

setAutoDetect

setRemoteCheck

doRemoteCheck

setUseOtherServer

useOtherServer

setOtherServerUrl

getServerUrl

getlogLevel

setMarkSingleCharBold

markSingleCharBold

setUseLtDictionary

useLtDictionary

setNoSynonymsAsSuggestions

noSynonymsAsSuggestions

getTaggerShowsDisambigLog

setTaggerShowsDisambigLog

getRunServer

setRunServer

getServerPort

setUseGUIConfig

getUseGUIConfig

setServerPort

getExternalRuleDirectory

setExternalRuleDirectory

getNumParasToCheck

setNumParasToCheck

isResetCheck

setDoResetCheck

useTextLevelQueue

setUseTextLevelQueue

setFullCheckAtFirst

doFullCheckAtFirst

getCurrentProfile

setCurrentProfile

getDefinedProfiles

addProfile

addProfiles

removeProfile

setMultiThreadLO

isMultiThread

getFontName

setFontName

getFontStyle

setFontStyle