Package org.cef

Class CefSettings

  • public class CefSettings
extends java.lang.Object
    Initialization settings. Specify NULL or 0 to get the recommended default values. Many of these and other settings can also configured using command- line switches.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      CefSettings.ColorType background_color
      Opaque background color used for accelerated content.
      java.lang.String browser_subprocess_path
      The path to a separate executable that will be launched for sub-processes.
      java.lang.String cache_path
      The location where cache data will be stored on disk.
      boolean command_line_args_disabled
      Set to true to disable configuration of browser process features using standard CEF and Chromium command-line arguments.
      boolean ignore_certificate_errors
      Set to true to ignore errors related to invalid SSL certificates.
      java.lang.String javascript_flags
      Custom flags that will be used when initializing the V8 JavaScript engine.
      java.lang.String locale
      The locale string that will be passed to Blink.
      java.lang.String locales_dir_path
      The fully qualified path for the locales directory.
      java.lang.String log_file
      The directory and file name to use for the debug log.
      CefSettings.LogSeverity log_severity
      The log severity.
      boolean pack_loading_disabled
      Set to true to disable loading of pack files for resources and locales.
      boolean persist_session_cookies
      To persist session cookies (cookies without an expiry date or validity interval) by default when using the global cookie manager set this value to true.
      java.lang.String product_version
      Value that will be inserted as the product portion of the default User-Agent string.
      int remote_debugging_port
      Set to a value between 1024 and 65535 to enable remote debugging on the specified port.
      java.lang.String resources_dir_path
      The fully qualified path for the resources directory.
      int uncaught_exception_stack_size
      The number of stack trace frames to capture for uncaught exceptions.
      java.lang.String user_agent
      Value that will be returned as the User-Agent HTTP header.
      boolean windowless_rendering_enabled
      Set to true to enable windowless (off-screen) rendering support.

    • Constructor Summary

      Constructors 
      Constructor Description
      CefSettings()  

    • Field Detail

      • browser_subprocess_path

        public java.lang.String browser_subprocess_path
        The path to a separate executable that will be launched for sub-processes. By default the browser process executable is used. See the comments on CefExecuteProcess() for details. Also configurable using the "browser-subprocess-path" command-line switch.

      • windowless_rendering_enabled

        public boolean windowless_rendering_enabled
        Set to true to enable windowless (off-screen) rendering support. Do not enable this value if the application does not use windowless rendering as it may reduce rendering performance on some systems.

      • command_line_args_disabled

        public boolean command_line_args_disabled
        Set to true to disable configuration of browser process features using standard CEF and Chromium command-line arguments. Configuration can still be specified using CEF data structures or via the CefApp::OnBeforeCommandLineProcessing() method.

      • cache_path

        public java.lang.String cache_path
        The location where cache data will be stored on disk. If empty an in-memory cache will be used for some features and a temporary disk cache for others. HTML5 databases such as localStorage will only persist across sessions if a cache path is specified.

      • persist_session_cookies

        public boolean persist_session_cookies
        To persist session cookies (cookies without an expiry date or validity interval) by default when using the global cookie manager set this value to true. Session cookies are generally intended to be transient and most Web browsers do not persist them. A |cache_path| value must also be specified to enable this feature. Also configurable using the "persist-session-cookies" command-line switch.

      • user_agent

        public java.lang.String user_agent
        Value that will be returned as the User-Agent HTTP header. If empty the default User-Agent string will be used. Also configurable using the "user-agent" command-line switch.

      • product_version

        public java.lang.String product_version
        Value that will be inserted as the product portion of the default User-Agent string. If empty the Chromium product version will be used. If |userAgent| is specified this value will be ignored. Also configurable using the "product-version" command-line switch.

      • locale

        public java.lang.String locale
        The locale string that will be passed to Blink. If empty the default locale of "en-US" will be used. This value is ignored on Linux where locale is determined using environment variable parsing with the precedence order: LANGUAGE, LC_ALL, LC_MESSAGES and LANG. Also configurable using the "lang" command-line switch.

      • log_file

        public java.lang.String log_file
        The directory and file name to use for the debug log. If empty, the default name of "debug.log" will be used and the file will be written to the application directory. Also configurable using the "log-file" command-line switch.

      • log_severity

        public CefSettings.LogSeverity log_severity
        The log severity. Only messages of this severity level or higher will be logged. Also configurable using the "log-severity" command-line switch with a value of "verbose", "info", "warning", "error", "error-report" or "disable".

      • javascript_flags

        public java.lang.String javascript_flags
        Custom flags that will be used when initializing the V8 JavaScript engine. The consequences of using custom flags may not be well tested. Also configurable using the "js-flags" command-line switch.

      • resources_dir_path

        public java.lang.String resources_dir_path
        The fully qualified path for the resources directory. If this value is empty the cef.pak and/or devtools_resources.pak files must be located in the module directory on Windows/Linux or the app bundle Resources directory on Mac OS X. Also configurable using the "resources-dir-path" command-line switch.

      • locales_dir_path

        public java.lang.String locales_dir_path
        The fully qualified path for the locales directory. If this value is empty the locales directory must be located in the module directory. This value is ignored on Mac OS X where pack files are always loaded from the app bundle Resources directory. Also configurable using the "locales-dir-path" command-line switch.

      • pack_loading_disabled

        public boolean pack_loading_disabled
        Set to true to disable loading of pack files for resources and locales. A resource bundle handler must be provided for the browser and render processes via CefApp::GetResourceBundleHandler() if loading of pack files is disabled. Also configurable using the "disable-pack-loading" command- line switch.

      • remote_debugging_port

        public int remote_debugging_port
        Set to a value between 1024 and 65535 to enable remote debugging on the specified port. For example, if 8080 is specified the remote debugging URL will be http: *localhost:8080. CEF can be remotely debugged from any CEF or Chrome browser window. Also configurable using the "remote-debugging-port" command-line switch.

      • uncaught_exception_stack_size

        public int uncaught_exception_stack_size
        The number of stack trace frames to capture for uncaught exceptions. Specify a positive value to enable the CefV8ContextHandler:: OnUncaughtException() callback. Specify 0 (default value) and OnUncaughtException() will not be called. Also configurable using the "uncaught-exception-stack-size" command-line switch.

      • ignore_certificate_errors

        public boolean ignore_certificate_errors
        Set to true to ignore errors related to invalid SSL certificates. Enabling this setting can lead to potential security vulnerabilities like "man in the middle" attacks. Applications that load content from the internet should not enable this setting. Also configurable using the "ignore-certificate-errors" command-line switch.

      • background_color

        public CefSettings.ColorType background_color
        Opaque background color used for accelerated content. By default the background color will be white. Only the RGB compontents of the specified value will be used. The alpha component must greater than 0 to enable use of the background color but will be otherwise ignored.

    • Constructor Detail

      • CefSettings

        public CefSettings()

    • Method Detail

      • clone

        public CefSettings clone()
        Overrides:
        clone in class java.lang.Object