BrowserPreferences (JxBrowser 6.23.1 API)

java.lang.Object
- com.teamdev.jxbrowser.chromium.BrowserPreferences

```
public class BrowserPreferences
extends java.lang.Object
```
Browser instance and global library preferences.
浏览器实例和全局库首选项。

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CHROMIUM_DIR_PROPERTY`
`static java.lang.String`	`TEMP_DIR_PROPERTY`
`static java.lang.String`	`USER_AGENT_PROPERTY`

Constructor Summary

Constructors
Constructor and Description
`BrowserPreferences()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static java.lang.String`	`getChromiumDir()` Returns path to the directory where Chromium binaries are located or empty string if there's no such path. 返回Chromium二进制文件所在目录的路径，如果没有这样的路径，则返回空字符串。
`static java.util.List<java.lang.String>`	`getChromiumSwitches()` Returns copy of the Chromium switches that were set via the `setChromiumSwitches(String...)` method. 返回通过setChromiumSwitches（String ...）方法设置的Chromium开关的副本。
`static java.util.Map<java.lang.String,java.lang.String>`	`getChromiumVariables()` Returns copy of Chromium environment variables set vis `setChromiumVariable(String, String)` or empty map if no environment variables were set. 返回设置为setChromiumVariable（String，String）的Chromium环境变量的副本；如果未设置任何环境变量，则返回空映射。
`static java.lang.String`	`getDefaultAcceptLanguage()` Returns a string that represents default accept language (e.g. 返回代表默认接受语言的字符串（例如
`static java.lang.String`	`getDefaultCacheDir()`
`static java.lang.String`	`getDefaultChromiumDir()` Returns a string that represents absolute path to the directory where Chromium binaries will be extracted by default and where Chromium profile directory will be created. 返回一个字符串，该字符串表示默认情况下将提取Chromium二进制文件和将在其中创建Chromium配置文件目录的目录的绝对路径。
`static java.lang.String`	`getDefaultDataDir()` Returns the path to the directory where user data files (e.g. 返回用户数据文件所在目录的路径（例如
`java.lang.String`	`getDefaultEncoding()`
`static java.lang.String`	`getDefaultMemoryDir()`
`static java.lang.String`	`getTempDir()`
`static java.lang.String`	`getUserAgent()` Returns the user agent string which was set using the `setUserAgent(String)` method. 返回使用setUserAgent（String）方法设置的用户代理字符串。
`WebRTCIPHandlingPolicy`	`getWebRTCIPHandlingPolicy()`
`boolean`	`isAllowDisplayingInsecureContent()` Deprecated. 已过时。
`boolean`	`isAllowRunningInsecureContent()`
`boolean`	`isAllowScriptsToCloseWindows()`
`boolean`	`isApplicationCacheEnabled()`
`boolean`	`isDatabasesEnabled()`
`boolean`	`isImagesEnabled()`
`boolean`	`isJavaScriptCanAccessClipboard()`
`boolean`	`isJavaScriptCanOpenWindowsAutomatically()`
`boolean`	`isJavaScriptEnabled()`
`boolean`	`isLoadsImagesAutomatically()`
`boolean`	`isLocalStorageEnabled()`
`boolean`	`isPluginsEnabled()`
`boolean`	`isTransparentBackground()`
`boolean`	`isUnifiedTextcheckerEnabled()` Deprecated. 已过时。
`boolean`	`isWebAudioEnabled()` Deprecated. 已过时。
`void`	`setAllowDisplayingInsecureContent(boolean allowDisplayingInsecureContent)` Deprecated. 已过时。
`void`	`setAllowRunningInsecureContent(boolean allowRunningInsecureContent)`
`void`	`setAllowScriptsToCloseWindows(boolean allowScriptsToCloseWindows)`
`void`	`setApplicationCacheEnabled(boolean applicationCacheEnabled)`
`static void`	`setChromiumDir(java.lang.String chromiumDir)` Configures the directory where Browser component will be looking for Chromium binaries. 配置浏览器组件将在其中查找Chromium二进制文件的目录。
`static void`	`setChromiumSwitches(java.lang.String... switches)` Configures Chromium engine to use the command line flags ( `switches`) in order to enable particular features or modify default functionality. 将Chromium引擎配置为使用命令行标志（开关）以启用特定功能或修改默认功能。
`static void`	`setChromiumVariable(java.lang.String name, java.lang.String value)` Sets Chromium environment variables that will be passed to each Chromium process. 设置将传递给每个Chromium进程的Chromium环境变量。
`void`	`setDatabasesEnabled(boolean databasesEnabled)`
`void`	`setDefaultEncoding(java.lang.String defaultEncoding)` Deprecated. This method does nothing. Chromium auto-detects encoding and ignores encoding settings since version 55. 已过时。此方法不执行任何操作。自版本55起，Chromium自动检测编码，并忽略编码设置。
`void`	`setImagesEnabled(boolean imagesEnabled)`
`void`	`setJavaScriptCanAccessClipboard(boolean javaScriptCanAccessClipboard)`
`void`	`setJavaScriptCanOpenWindowsAutomatically(boolean javaScriptCanOpenWindowsAutomatically)` Deprecated. This method does nothing. Chromium does not rely on this setting when blocking popups since version 60. For actual popup blocking see `Browser.setPopupHandler(PopupHandler)`}. 已过时。此方法不执行任何操作。从版本60开始，Chromium在阻止弹出窗口时不依赖此设置。有关实际弹出窗口的阻止，请参阅Browser.setPopupHandler（PopupHandler）}。
`void`	`setJavaScriptEnabled(boolean javascriptEnabled)`
`void`	`setLoadsImagesAutomatically(boolean loadsImagesAutomatically)`
`void`	`setLocalStorageEnabled(boolean localStorageEnabled)`
`void`	`setPluginsEnabled(boolean pluginsEnabled)`
`void`	`setTransparentBackground(boolean transparentBackground)`
`void`	`setUnifiedTextcheckerEnabled(boolean unifiedTextcheckerEnabled)` Deprecated. 已过时。
`static void`	`setUserAgent(java.lang.String userAgent)` Configures the user agent string for all Browser instances. 为所有浏览器实例配置用户代理字符串。
`void`	`setWebAudioEnabled(boolean webAudioEnabled)` Deprecated. 已过时。
`void`	`setWebRTCIPHandlingPolicy(WebRTCIPHandlingPolicy webRTCIPHandlingPolicy)`

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

- Field Detail
  - USER_AGENT_PROPERTY
```
public static final java.lang.String USER_AGENT_PROPERTY
```
    See Also:
    
    Constant Field Values
  - CHROMIUM_DIR_PROPERTY
```
public static final java.lang.String CHROMIUM_DIR_PROPERTY
```
    See Also:
    
    Constant Field Values
  - TEMP_DIR_PROPERTY
```
public static final java.lang.String TEMP_DIR_PROPERTY
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BrowserPreferences
```
public BrowserPreferences()
```
- Method Detail
  - getChromiumDir
```
public static java.lang.String getChromiumDir()
```
    Returns path to the directory where Chromium binaries are located or empty string if there's no such path. If the directory wasn't configured via setChromiumDir(String) method, then this method returns default value via the getDefaultChromiumDir() method.
    返回Chromium二进制文件所在目录的路径，如果没有这样的路径，则返回空字符串。如果未通过setChromiumDir（String）方法配置目录，则此方法通过getDefaultChromiumDir（）方法返回默认值。
    
    Returns:
    
    path to the directory where Chromium binaries are located or empty string if there's no such path. Chromium二进制文件所在目录的路径；如果没有这样的路径，则为空字符串。
  - setChromiumDir
```
public static void setChromiumDir(java.lang.String chromiumDir)
```
    Configures the directory where Browser component will be looking for Chromium binaries. If the passed directory doesn't exist or it doesn't contain Chromium binaries, the library will try to find the binaries in JAR file (with Chromium binaries) from application class path and extract the binaries from this JAR into the chromiumDir folder.
    By default Chromium binaries for Windows platform are located inside jxbrowser-win-*.jar, for Mac OS X inside jxbrowser-mac-*.jar that you can find in the lib folder of JxBrowser distribution package.
    配置浏览器组件将在其中查找Chromium二进制文件的目录。如果传递的目录不存在或不包含Chromium二进制文件，则该库将尝试从应用程序类路径中找到JAR文件中的二进制文件（带有Chromium二进制文件），并将该JAR中的二进制文件提取到chromiumDir文件夹中。默认情况下，用于Windows平台的Chromium二进制文件位于jxbrowser-win-*。jar内，对于Mac OS X，位于jxbrowser-mac-*。jar内，您可以在JxBrowser发行软件包的lib文件夹中找到该文件。
    
    Parameters:
    
    chromiumDir - the directory where the Chromium binaries are located. -Chromium二进制文件所在的目录。
    
    Throws:
    
    java.lang.IllegalArgumentException - when chromiumDir is null or empty.
  - getUserAgent
```
public static java.lang.String getUserAgent()
```
    Returns the user agent string which was set using the setUserAgent(String) method. Can return null if the user agent string wasn't provided via the setUserAgent(String) method. This method cannot be used to receive a default user agent string.
    返回使用setUserAgent（String）方法设置的用户代理字符串。如果未通过setUserAgent（String）方法提供用户代理字符串，则可以返回null。此方法不能用于接收默认的用户代理字符串。
    
    Returns:
    
    the user agent string which was set using the setUserAgent(String) method. 使用该方法设置的用户代理字符串。
  - setUserAgent
```
public static void setUserAgent(java.lang.String userAgent)
```
    Configures the user agent string for all Browser instances. This method must be invoked before you create any Browser instance. If you don't provide user agent string using this method, then a default user agent string will be used.
    为所有浏览器实例配置用户代理字符串。创建任何浏览器实例之前，必须调用此方法。如果您不使用此方法提供用户代理字符串，则将使用默认的用户代理字符串。
    
    Parameters:
    
    userAgent - a new user agent string. -新的用户代理字符串。
    
    Throws:
    
    java.lang.IllegalArgumentException - when userAgent is null or empty.
  - getDefaultChromiumDir
```
public static java.lang.String getDefaultChromiumDir()
```
    Returns a string that represents absolute path to the directory where Chromium binaries will be extracted by default and where Chromium profile directory will be created. On macOS and Linux platforms the directory will be located in user's temp folder. On Windows platform, in the C:\Users\<user_name>\AppData\Local\JxBrowser directory.
    返回一个字符串，该字符串表示默认情况下将提取Chromium二进制文件和将在其中创建Chromium配置文件目录的目录的绝对路径。在macOS和Linux平台上，该目录位于用户的temp文件夹中。在Windows平台上，位于C：\ Users \ <用户名> \ AppData \ Local \ JxBrowser目录中。
    
    Returns:
    
    the path to the directory where Chromium binaries will be extracted by default. 默认情况下将提取Chromium二进制文件的目录的路径。
  - getDefaultDataDir
```
public static java.lang.String getDefaultDataDir()
```
    Returns the path to the directory where user data files (e.g. history, cookies) will be stored. To calculate the path to this directory the method uses the following way: getDefaultChromiumDir() + "/data"
    返回将存储用户数据文件（例如历史记录，Cookie）的目录的路径。要计算此目录的路径，该方法使用以下方法：getDefaultChromiumDir（）+“ / data”
    
    Returns:
    
    path to the directory where user data files will be stored. 用户数据文件存储目录的路径。
  - getDefaultCacheDir
```
public static java.lang.String getDefaultCacheDir()
```
  - getDefaultMemoryDir
```
public static java.lang.String getDefaultMemoryDir()
```
  - getTempDir
```
public static java.lang.String getTempDir()
```
  - getDefaultAcceptLanguage
```
public static java.lang.String getDefaultAcceptLanguage()
```
    Returns a string that represents default accept language (e.g. "en-us", "it", "de") according to default locale for this instance of the Java Virtual Machine.
    根据此Java虚拟机实例的默认语言环境，返回一个表示默认接受语言（例如“ en-us”，“ it”，“ de”）的字符串。
    
    See Also:
    
    Locale.getDefault()
  - getChromiumSwitches
```
public static java.util.List<java.lang.String> getChromiumSwitches()
```
    Returns copy of the Chromium switches that were set via the setChromiumSwitches(String...) method.
    返回通过setChromiumSwitches（String ...）方法设置的Chromium开关的副本。
    
    Returns:
    
    a list of Chromium switches. 铬开关列表。
  - setChromiumSwitches
```
public static void setChromiumSwitches(java.lang.String... switches)
```
    Configures Chromium engine to use the command line flags ( switches) in order to enable particular features or modify default functionality.
    It is important to note that using these switches is not supported or recommended. They should only be used for temporary cases and may break in the future.
    Current switches may be found at http://peter.sh/examples/?/chromium-switches.html
    将Chromium引擎配置为使用命令行标志（开关）以启用特定功能或修改默认功能。重要的是要注意，不支持或不建议使用这些开关。它们仅应用于临时情况，并且将来可能会中断。当前的开关可以在http://peter.sh/examples/?/chromium-switches.html找到
    
    Parameters:
    
    switches - a list of command line flags (switches). -命令行标志（开关）列表。
    
    Throws:
    
    java.lang.IllegalArgumentException - when switches is null.
  - setChromiumVariable
```
public static void setChromiumVariable(java.lang.String name,
                                       java.lang.String value)
```
    Sets Chromium environment variables that will be passed to each Chromium process. Use this method when you need to provide environment variables to Chromium. For example, you can provide your GOOGLE_API_KEY, GOOGLE_DEFAULT_CLIENT_ID and GOOGLE_DEFAULT_CLIENT_SECRET environment variables to Chromium to enable Google APIs (see API Keys).
    设置将传递给每个Chromium进程的Chromium环境变量。当您需要向Chromium提供环境变量时，请使用此方法。例如，您可以将您的GOOGLE_API_KEY，GOOGLE_DEFAULT_CLIENT_ID和GOOGLE_DEFAULT_CLIENT_SECRET环境变量提供给Chromium，以启用Google API（请参阅API密钥）。
    
    Parameters:
    
    name - a string representation of the variable name. Cannot be null. -变量名称的字符串表示形式。不可能是。
    
    value - a string representation of the variable value. Cannot be null. -变量值的字符串表示形式。不可能是。
    
    Throws:
    
    java.lang.IllegalArgumentException - when name or value is null.
  - getChromiumVariables
```
public static java.util.Map<java.lang.String,java.lang.String> getChromiumVariables()
```
    Returns copy of Chromium environment variables set vis setChromiumVariable(String, String) or empty map if no environment variables were set.
    返回设置为setChromiumVariable（String，String）的Chromium环境变量的副本；如果未设置任何环境变量，则返回空映射。
  - getDefaultEncoding
```
public java.lang.String getDefaultEncoding()
```
  - setDefaultEncoding
```
@Deprecated
public void setDefaultEncoding(java.lang.String defaultEncoding)
```
    Deprecated. This method does nothing. Chromium auto-detects encoding and ignores encoding settings since version 55.
    已过时。此方法不执行任何操作。自版本55起，Chromium自动检测编码，并忽略编码设置。
  - isJavaScriptEnabled
```
public boolean isJavaScriptEnabled()
```
  - setJavaScriptEnabled
```
public void setJavaScriptEnabled(boolean javascriptEnabled)
```
  - isJavaScriptCanOpenWindowsAutomatically
```
public boolean isJavaScriptCanOpenWindowsAutomatically()
```
  - setJavaScriptCanOpenWindowsAutomatically
```
@Deprecated
public void setJavaScriptCanOpenWindowsAutomatically(boolean javaScriptCanOpenWindowsAutomatically)
```
    Deprecated. This method does nothing. Chromium does not rely on this setting when blocking popups since version 60. For actual popup blocking see Browser.setPopupHandler(PopupHandler)}.
    已过时。此方法不执行任何操作。从版本60开始，Chromium在阻止弹出窗口时不依赖此设置。有关实际弹出窗口的阻止，请参阅Browser.setPopupHandler（PopupHandler）}。
  - isLoadsImagesAutomatically
```
public boolean isLoadsImagesAutomatically()
```
  - setLoadsImagesAutomatically
```
public void setLoadsImagesAutomatically(boolean loadsImagesAutomatically)
```
  - isImagesEnabled
```
public boolean isImagesEnabled()
```
  - setImagesEnabled
```
public void setImagesEnabled(boolean imagesEnabled)
```
  - isPluginsEnabled
```
public boolean isPluginsEnabled()
```
  - setPluginsEnabled
```
public void setPluginsEnabled(boolean pluginsEnabled)
```
  - isAllowScriptsToCloseWindows
```
public boolean isAllowScriptsToCloseWindows()
```
  - setAllowScriptsToCloseWindows
```
public void setAllowScriptsToCloseWindows(boolean allowScriptsToCloseWindows)
```
  - isJavaScriptCanAccessClipboard
```
public boolean isJavaScriptCanAccessClipboard()
```
  - setJavaScriptCanAccessClipboard
```
public void setJavaScriptCanAccessClipboard(boolean javaScriptCanAccessClipboard)
```
  - isLocalStorageEnabled
```
public boolean isLocalStorageEnabled()
```
  - setLocalStorageEnabled
```
public void setLocalStorageEnabled(boolean localStorageEnabled)
```
  - isDatabasesEnabled
```
public boolean isDatabasesEnabled()
```
  - setDatabasesEnabled
```
public void setDatabasesEnabled(boolean databasesEnabled)
```
  - isWebAudioEnabled
```
@Deprecated
public boolean isWebAudioEnabled()
```
    Deprecated.
    已过时。
  - setWebAudioEnabled
```
@Deprecated
public void setWebAudioEnabled(boolean webAudioEnabled)
```
    Deprecated.
    已过时。
  - isApplicationCacheEnabled
```
public boolean isApplicationCacheEnabled()
```
  - setApplicationCacheEnabled
```
public void setApplicationCacheEnabled(boolean applicationCacheEnabled)
```
  - isAllowDisplayingInsecureContent
```
@Deprecated
public boolean isAllowDisplayingInsecureContent()
```
    Deprecated.
    已过时。
  - setAllowDisplayingInsecureContent
```
@Deprecated
public void setAllowDisplayingInsecureContent(boolean allowDisplayingInsecureContent)
```
    Deprecated.
    已过时。
  - isAllowRunningInsecureContent
```
public boolean isAllowRunningInsecureContent()
```
  - setAllowRunningInsecureContent
```
public void setAllowRunningInsecureContent(boolean allowRunningInsecureContent)
```
  - isUnifiedTextcheckerEnabled
```
@Deprecated
public boolean isUnifiedTextcheckerEnabled()
```
    Deprecated.
    已过时。
  - setUnifiedTextcheckerEnabled
```
@Deprecated
public void setUnifiedTextcheckerEnabled(boolean unifiedTextcheckerEnabled)
```
    Deprecated.
    已过时。
  - isTransparentBackground
```
public boolean isTransparentBackground()
```
  - setTransparentBackground
```
public void setTransparentBackground(boolean transparentBackground)
```
  - getWebRTCIPHandlingPolicy
```
public WebRTCIPHandlingPolicy getWebRTCIPHandlingPolicy()
```
  - setWebRTCIPHandlingPolicy
```
public void setWebRTCIPHandlingPolicy(WebRTCIPHandlingPolicy webRTCIPHandlingPolicy)
```

Class BrowserPreferences

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

USER_AGENT_PROPERTY

CHROMIUM_DIR_PROPERTY

TEMP_DIR_PROPERTY

Constructor Detail

BrowserPreferences

Method Detail

getChromiumDir

setChromiumDir

getUserAgent

setUserAgent

getDefaultChromiumDir

getDefaultDataDir

getDefaultCacheDir

getDefaultMemoryDir

getTempDir

getDefaultAcceptLanguage

getChromiumSwitches

setChromiumSwitches

setChromiumVariable

getChromiumVariables

getDefaultEncoding

setDefaultEncoding

isJavaScriptEnabled

setJavaScriptEnabled

isJavaScriptCanOpenWindowsAutomatically

setJavaScriptCanOpenWindowsAutomatically

isLoadsImagesAutomatically

setLoadsImagesAutomatically

isImagesEnabled

setImagesEnabled

isPluginsEnabled

setPluginsEnabled

isAllowScriptsToCloseWindows

setAllowScriptsToCloseWindows

isJavaScriptCanAccessClipboard

setJavaScriptCanAccessClipboard

isLocalStorageEnabled

setLocalStorageEnabled

isDatabasesEnabled

setDatabasesEnabled

isWebAudioEnabled

setWebAudioEnabled

isApplicationCacheEnabled

setApplicationCacheEnabled

isAllowDisplayingInsecureContent

setAllowDisplayingInsecureContent

isAllowRunningInsecureContent

setAllowRunningInsecureContent

isUnifiedTextcheckerEnabled

setUnifiedTextcheckerEnabled

isTransparentBackground

setTransparentBackground

getWebRTCIPHandlingPolicy

setWebRTCIPHandlingPolicy