jcef/org.cef/CefClient

CefClient

open class CefClient : CefClientHandler, CefContextMenuHandler, CefDialogHandler, CefDisplayHandler, CefDownloadHandler, CefDragHandler, CefFocusHandler, CefPermissionHandler, CefJSDialogHandler, CefKeyboardHandler, CefLifeSpanHandler, CefLoadHandler, CefPrintHandler, CefRenderHandler, CefRequestHandler, CefWindowHandler

Client that owns a browser and renderer.

Functions

addContextMenuHandler

open fun addContextMenuHandler(handler: CefContextMenuHandler): CefClient

addDialogHandler

open fun addDialogHandler(handler: CefDialogHandler): CefClient

addDisplayHandler

open fun addDisplayHandler(handler: CefDisplayHandler): CefClient

addDownloadHandler

open fun addDownloadHandler(handler: CefDownloadHandler): CefClient

addDragHandler

open fun addDragHandler(handler: CefDragHandler): CefClient

addFocusHandler

open fun addFocusHandler(handler: CefFocusHandler): CefClient

addJSDialogHandler

open fun addJSDialogHandler(handler: CefJSDialogHandler): CefClient

addKeyboardHandler

open fun addKeyboardHandler(handler: CefKeyboardHandler): CefClient

addLifeSpanHandler

open fun addLifeSpanHandler(handler: CefLifeSpanHandler): CefClient

addLoadHandler

open fun addLoadHandler(handler: CefLoadHandler): CefClient

addMessageRouter

open fun addMessageRouter(messageRouter: CefMessageRouter)

addOnPaintListener

open fun addOnPaintListener(listener: Consumer<CefPaintEvent>)

Add provided listener.

addPermissionHandler

open fun addPermissionHandler(handler: CefPermissionHandler): CefClient

addPrintHandler

open fun addPrintHandler(handler: CefPrintHandler): CefClient

addRequestHandler

open fun addRequestHandler(handler: CefRequestHandler): CefClient

createBrowser

open fun ~~createBrowser~~(url: String, isOffscreenRendered: Boolean, isTransparent: Boolean): CefBrowser

open fun createBrowser(url: String, rendering: CefRendering, isTransparent: Boolean): CefBrowser

open fun ~~createBrowser~~(url: String, isOffscreenRendered: Boolean, isTransparent: Boolean, context: CefRequestContext): CefBrowser

open fun createBrowser(url: String, rendering: CefRendering, isTransparent: Boolean, context: CefRequestContext): CefBrowser

open fun ~~createBrowser~~(url: String, isOffscreenRendered: Boolean, isTransparent: Boolean, context: CefRequestContext, settings: CefBrowserSettings): CefBrowser

open fun createBrowser(url: String, rendering: CefRendering, isTransparent: Boolean, context: CefRequestContext, settings: CefBrowserSettings): CefBrowser

dispose

open fun dispose()

doClose

open fun doClose(browser: CefBrowser): Boolean

Called when a browser has received a request to close.

getAuthCredentials

open fun getAuthCredentials(browser: CefBrowser, origin_url: String, isProxy: Boolean, host: String, port: Int, realm: String, scheme: String, callback: CefAuthCallback): Boolean

Called on the IO thread when the browser needs credentials from the user.

getDeviceScaleFactor

open fun getDeviceScaleFactor(browser: CefBrowser): Double

Retrieve the scale factor of the screen the browser is shown at.

getInfo

open fun getInfo(): String

getNativeRef

open fun getNativeRef(identifer: String): Long

Method is called by the native code to get the reference to an previous stored identifier.

getPdfPaperSize

open fun getPdfPaperSize(browser: CefBrowser, deviceUnitsPerInch: Int): Dimension

Called to retrieve the page size when printToPDF is requested for a browser.

getRect

open fun getRect(browser: CefBrowser): Rectangle

Retrieve the view rectangle.

getResourceRequestHandler

open fun getResourceRequestHandler(browser: CefBrowser, frame: CefFrame, request: CefRequest, isNavigation: Boolean, isDownload: Boolean, requestInitiator: String, disableDefaultHandling: BoolRef): CefResourceRequestHandler

Called on the IO thread before a resource request is initiated.

getScreenInfo

open fun getScreenInfo(browser: CefBrowser, screenInfo: CefScreenInfo): Boolean

Retrieve the screen info.

getScreenPoint

open fun getScreenPoint(browser: CefBrowser, viewPoint: Point): Point

Retrieve the screen point for the specified view point.

getViewRect

open fun getViewRect(browser: CefBrowser): Rectangle

Retrieve the view rectangle.

isNativeBrowserCreationStarted

open fun isNativeBrowserCreationStarted(browser: CefBrowser): Boolean

onAddressChange

open fun onAddressChange(browser: CefBrowser, frame: CefFrame, url: String)

Browser address changed.

onAfterCreated

open fun onAfterCreated(browser: CefBrowser)

Handle creation of a new browser window.

onAfterParentChanged

open fun onAfterParentChanged(browser: CefBrowser)

Called after a browser's native parent window has changed.

onBeforeBrowse

open fun onBeforeBrowse(browser: CefBrowser, frame: CefFrame, request: CefRequest, user_gesture: Boolean, is_redirect: Boolean): Boolean

Called on the UI thread before browser navigation.

onBeforeClose

open fun onBeforeClose(browser: CefBrowser)

Called just before a browser is destroyed.

onBeforeContextMenu

open fun onBeforeContextMenu(browser: CefBrowser, frame: CefFrame, params: CefContextMenuParams, model: CefMenuModel)

Called before a context menu is displayed.

onBeforeDownload

open fun onBeforeDownload(browser: CefBrowser, downloadItem: CefDownloadItem, suggestedName: String, callback: CefBeforeDownloadCallback)

Called before a download begins.

onBeforePopup

open fun onBeforePopup(browser: CefBrowser, frame: CefFrame, target_url: String, target_frame_name: String): Boolean

Called on the IO thread before a new popup window is created.

onBeforeUnloadDialog

open fun onBeforeUnloadDialog(browser: CefBrowser, message_text: String, is_reload: Boolean, callback: CefJSDialogCallback): Boolean

Called to run a dialog asking the user if they want to leave a page.

onCertificateError

open fun onCertificateError(browser: CefBrowser, cert_error: CefLoadHandler.ErrorCode, request_url: String, sslInfo: CefSSLInfo, callback: CefCallback): Boolean

Called on the UI thread to handle requests for URLs with an invalid SSL certificate.

onConsoleMessage

open fun onConsoleMessage(browser: CefBrowser, level: CefSettings.LogSeverity, message: String, source: String, line: Int): Boolean

Display a console message.

onContextMenuCommand

open fun onContextMenuCommand(browser: CefBrowser, frame: CefFrame, params: CefContextMenuParams, commandId: Int, eventFlags: Int): Boolean

Called to execute a command selected from the context menu.

onContextMenuDismissed

open fun onContextMenuDismissed(browser: CefBrowser, frame: CefFrame)

Called when the context menu is dismissed irregardless of whether the menu was empty or a command was selected.

onCursorChange

open fun onCursorChange(browser: CefBrowser, cursorType: Int): Boolean

Handle cursor changes.

onDialogClosed

open fun onDialogClosed(browser: CefBrowser)

Called when the default implementation dialog is closed.

onDownloadUpdated

open fun onDownloadUpdated(browser: CefBrowser, downloadItem: CefDownloadItem, callback: CefDownloadItemCallback)

Called when a download's status or progress information has been updated.

onDragEnter

open fun onDragEnter(browser: CefBrowser, dragData: CefDragData, mask: Int): Boolean

Called when an external drag event enters the browser window.

onFileDialog

open fun onFileDialog(browser: CefBrowser, mode: CefDialogHandler.FileDialogMode, title: String, defaultFilePath: String, acceptFilters: Vector<String>, callback: CefFileDialogCallback): Boolean

Called to run a file chooser dialog.

onFullscreenModeChange

open fun onFullscreenModeChange(browser: CefBrowser, fullscreen: Boolean)

Browser fullscreen mode changed.

onGotFocus

open fun onGotFocus(browser: CefBrowser)

Called when the browser component has received focus.

OnImeCompositionRangeChanged

open fun OnImeCompositionRangeChanged(browser: CefBrowser, selectionRange: CefRange, characterBounds: Array<Rectangle>)

Called when the IME composition range has changed.

onJSDialog

open fun onJSDialog(browser: CefBrowser, origin_url: String, dialog_type: CefJSDialogHandler.JSDialogType, message_text: String, default_prompt_text: String, callback: CefJSDialogCallback, suppress_message: BoolRef): Boolean

Called to run a JavaScript dialog.

onKeyEvent

open fun onKeyEvent(browser: CefBrowser, event: CefKeyboardHandler.CefKeyEvent): Boolean

Called after the renderer and JavaScript in the page has had a chance to handle the event.

onLoadEnd

open fun onLoadEnd(browser: CefBrowser, frame: CefFrame, httpStatusCode: Int)

Called when the browser is done loading a frame.

onLoadError

open fun onLoadError(browser: CefBrowser, frame: CefFrame, errorCode: CefLoadHandler.ErrorCode, errorText: String, failedUrl: String)

Called when the resource load for a navigation fails or is canceled.

onLoadingStateChange

open fun onLoadingStateChange(browser: CefBrowser, isLoading: Boolean, canGoBack: Boolean, canGoForward: Boolean)

Called when the loading state has changed.

onLoadStart

open fun onLoadStart(browser: CefBrowser, frame: CefFrame, transitionType: CefRequest.TransitionType)

Called when the browser begins loading a frame.

onMouseEvent

open fun onMouseEvent(browser: CefBrowser, event: Int, screenX: Int, screenY: Int, modifier: Int, button: Int)

Implement this method to handle mouse events on Windows.

onOpenURLFromTab

open fun onOpenURLFromTab(browser: CefBrowser, frame: CefFrame, target_url: String, user_gesture: Boolean): Boolean

Called on the UI thread before OnBeforeBrowse in certain limited cases where navigating a new or different browser might be desirable.

onPaint

open fun onPaint(browser: CefBrowser, popup: Boolean, dirtyRects: Array<Rectangle>, buffer: ByteBuffer, width: Int, height: Int)

Handle painting.

onPopupShow

open fun onPopupShow(browser: CefBrowser, show: Boolean)

Show or hide the popup window.

onPopupSize

open fun onPopupSize(browser: CefBrowser, size: Rectangle)

Size the popup window.

onPreKeyEvent

open fun onPreKeyEvent(browser: CefBrowser, event: CefKeyboardHandler.CefKeyEvent, is_keyboard_shortcut: BoolRef): Boolean

Called before a keyboard event is sent to the renderer.

onPrintDialog

open fun onPrintDialog(browser: CefBrowser, hasSelection: Boolean, callback: CefPrintDialogCallback): Boolean

Called to show the print dialog.

onPrintJob

open fun onPrintJob(browser: CefBrowser, documentName: String, pdfFilePath: String, callback: CefPrintJobCallback): Boolean

Called to send the print job to the printer.

onPrintReset

open fun onPrintReset(browser: CefBrowser)

Called to reset client state related to printing.

onPrintSettings

open fun onPrintSettings(browser: CefBrowser, settings: CefPrintSettings, getDefaults: Boolean)

Called to get print settings.

onPrintStart

open fun onPrintStart(browser: CefBrowser)

Called when printing has started.

onRenderProcessTerminated

open fun onRenderProcessTerminated(browser: CefBrowser, status: CefRequestHandler.TerminationStatus)

Called on the browser process UI thread when the render process terminates unexpectedly.

onRequestMediaAccessPermission

open fun onRequestMediaAccessPermission(browser: CefBrowser, frame: CefFrame, requesting_url: String, requested_permissions: Int, callback: CefMediaAccessCallback): Boolean

Called when a page requests permission to access media.

onResetDialogState

open fun onResetDialogState(browser: CefBrowser)

Called to cancel any pending dialogs and reset any saved dialog state.

onSetFocus

open fun onSetFocus(browser: CefBrowser, source: CefFocusHandler.FocusSource): Boolean

Called when the browser component is requesting focus.

onStatusMessage

open fun onStatusMessage(browser: CefBrowser, value: String)

Received a status message.

onTakeFocus

open fun onTakeFocus(browser: CefBrowser, next: Boolean)

Called when the browser component is about to loose focus.

OnTextSelectionChanged

open fun OnTextSelectionChanged(browser: CefBrowser, selectedText: String, selectionRange: CefRange)

Called when text selection has changed

onTitleChange

open fun onTitleChange(browser: CefBrowser, title: String)

Browser title changed.

onTooltip

open fun onTooltip(browser: CefBrowser, text: String): Boolean

About to display a tooltip.

removeContextMenuHandler

open fun removeContextMenuHandler()

removeDialogHandler

open fun removeDialogHandler()

removeDisplayHandler

open fun removeDisplayHandler()

removeDownloadHandler

open fun removeDownloadHandler()

removeDragHandler

open fun removeDragHandler()

removeFocusHandler

open fun removeFocusHandler()

removeJSDialogHandler

open fun removeJSDialogHandler()

removeKeyboardHandler

open fun removeKeyboardHandler()

removeLifeSpanHandler

open fun removeLifeSpanHandler()

removeLoadHandler

open fun removeLoadHandler()

removeMessageRouter

open fun removeMessageRouter(messageRouter: CefMessageRouter)

removeOnPaintListener

open fun removeOnPaintListener(listener: Consumer<CefPaintEvent>)

Remove provided listener.

removePermissionHandler

open fun removePermissionHandler()

removePrintHandler

open fun removePrintHandler()

removeRequestHandler

open fun removeRequestHandler()

setNativeRef

open fun setNativeRef(identifer: String, nativeRef: Long)

Method is called by the native code to store a reference to an implemented native JNI counterpart.

setOnDisposeCallback

open fun setOnDisposeCallback(onDisposed: Runnable)

setOnPaintListener

open fun setOnPaintListener(listener: Consumer<CefPaintEvent>)

Remove existing listeners and replace with provided listener.

startDragging

open fun startDragging(browser: CefBrowser, dragData: CefDragData, mask: Int, x: Int, y: Int): Boolean

Called when the user starts dragging content in the web view.

stateHasChanged

open fun stateHasChanged(state: CefApp.CefAppState)

Implement this method to get state changes of the CefApp.

updateDragCursor

open fun updateDragCursor(browser: CefBrowser, operation: Int)

Called when the web view wants to update the mouse cursor during a drag &drop operation.