org.cef.browser

Class CefRequestContext

java.lang.Object

org.cef.browser.CefRequestContext

public abstract class CefRequestContext
extends java.lang.Object

A request context provides request handling for a set of related browser objects. A request context is specified when creating a new browser object via the CefClient.createBrowser method. Browser objects with different request contexts will never be hosted in the same render process. Browser objects with the same request context may or may not be hosted in the same render process depending on the process model. Browser objects created indirectly via the JavaScript window.open function or targeted links will share the same render process and the same request context as the source browser. When running in single-process mode there is only a single render process (the main process) and so all browsers created in single-process mode will share the same request context. This will be the first request context passed into the CefClient.createBrowser method and all other request context objects will be ignored.

Method Summary

Modifier and Type	Method and Description
abstract boolean	canSetPreference(java.lang.String name) Returns true if the preference with the specified |name| can be modified using setPreference.
static CefRequestContext	createContext(CefRequestContextHandler handler) Creates a new context object with the specified handler.
abstract void	dispose()
abstract java.util.Map<java.lang.String,java.lang.Object>	getAllPreferences(boolean includeDefaults) Returns all preferences as a dictionary.
static CefRequestContext	getGlobalContext() Returns the global context object.
abstract CefRequestContextHandler	getHandler() Returns the handler for this context if any.
abstract java.lang.Object	getPreference(java.lang.String name) Returns the value for the preference with the specified |name|.
abstract boolean	hasPreference(java.lang.String name) Returns true if a preference with the specified |name| exists.
abstract boolean	isGlobal() Returns true if this object is the global context.
abstract java.lang.String	setPreference(java.lang.String name, java.lang.Object value) Set the |value| associated with preference |name|.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

canSetPreference

public abstract boolean canSetPreference(java.lang.String name)

Returns true if the preference with the specified |name| can be modified using setPreference. As one example preferences set via the command-line usually cannot be modified. This method must be called on the browser process UI thread, otherwise it will always return false.

createContext

public static final CefRequestContext createContext(CefRequestContextHandler handler)

Creates a new context object with the specified handler.

dispose

public abstract void dispose()

getAllPreferences

public abstract java.util.Map<java.lang.String,java.lang.Object> getAllPreferences(boolean includeDefaults)

Returns all preferences as a dictionary. If |includeDefaults| is true then preferences currently at their default value will be included. The returned object can be modified but modifications will not persist. This method must be called on the browser process UI thread, otherwise it will always return null.

getGlobalContext

public static final CefRequestContext getGlobalContext()

Returns the global context object.

getHandler

public abstract CefRequestContextHandler getHandler()

Returns the handler for this context if any.

getPreference

public abstract java.lang.Object getPreference(java.lang.String name)

Returns the value for the preference with the specified |name|. Returns NULL if the preference does not exist. This method must be called on the browser process UI thread, otherwise it will always return null.

hasPreference

public abstract boolean hasPreference(java.lang.String name)

Returns true if a preference with the specified |name| exists.

This method must be called on the browser process UI thread, otherwise it will always return false. It is easiest to ensure the correct calling thread by using a callback method invoked by the browser process UI thread, such as CefLifeSpanHandler.onAfterCreated(CefBrowser), to configure the preferences.

isGlobal

public abstract boolean isGlobal()

Returns true if this object is the global context.

setPreference

public abstract java.lang.String setPreference(java.lang.String name,
                                               java.lang.Object value)

Set the |value| associated with preference |name|. Returns null if the value is set successfully, an error string otherwise. If |value| is NULL the preference will be restored to its default value. If setting the preference fails then a detailed description of the problem will be returned. This method must be called on the browser process UI thread, otherwise it will always return an error string.