JxBrowser

https://teamdev.com/jxbrowser/api/8.18.2
Admin
JxBrowser is a Java library that provides a Chromium-based browser component for embedding web...
Tokens:2,135,298
Snippets:23,370
Trust Score:9.9
Update:1 month ago
Show doc for...
Tokens:
Raw
### install

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.extensions.callback/-install-extension-callback/-action/index.html

Initiates the installation of the extension.

```APIDOC
## install()

### Description
Install the extension.

### Method
public void install()

### Endpoint
N/A
```

--------------------------------

### InstallExtensionCallback.Action Method

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.extensions.callback/-install-extension-callback/-action/-install-extension-callback.-action.html

The Action method is invoked when an extension installation is requested. It accepts a Consumer that will receive the installation response.

```APIDOC
## InstallExtensionCallback.Action

### Description
This method is part of the `InstallExtensionCallback` interface and is designed to be implemented by users to handle the response of an extension installation request.

### Method Signature
`public void InstallExtensionCallback.Action(Consumer<InstallExtension.Response> consumer)`

### Parameters
*   **consumer** (`Consumer<InstallExtension.Response>`) - Required - A callback function that will be executed with the result of the extension installation. The `InstallExtension.Response` object contains details about the installation outcome.
```

--------------------------------

### description()

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.cast/-cast-session/description.html

Returns the description of the session. Examples: "Mirroring tab (www.example.com)", "Casting media", "Casting YouTube". The description may be empty when the session just started and Chromium didn't define the cast content yet.

```APIDOC
## description()

### Description
Returns the description of the session. Examples: "Mirroring tab (www.example.com)", "Casting media", "Casting YouTube". The description may be empty when the session just started and Chromium didn't define the cast content yet.

### Method
public abstract String description()

### Throws
ObjectClosedException - when the profile is deleted or its engine is closed
```

--------------------------------

### Extension install(Path crxFile)

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.extensions/-extensions/install.html

Installs a Chrome extension from a specified CRX file. This method handles new installations, updates existing ones, and returns the installed extension. It does not require publisher proof for the CRX file.

```APIDOC
## Extension install(Path crxFile)

### Description
Installs the Chrome extension from the given CRX file. The `crxFile` must lead to a CRX file. No publisher proof is required. If the extension is already installed, this method returns it. If the CRX file contains a newer version of the extension, this method updates the installed extension and returns an instance of the updated extension.

### Method
`public abstract Extension install(Path crxFile)`

### Parameters
#### Path Parameters
- **crxFile** (Path) - Required - The path to the extension CRX package.

### Return
- **Extension** - The installed Chrome extension.

### Throws
- **ExtensionInstallationException** - If the extension installation has failed or if a newer version of the extension is already installed.
- **ObjectClosedException** - When the engine is closed or the profile is deleted.
```

--------------------------------

### StartNavigationCallback

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.navigation.callback/-start-navigation-callback/index.html

This callback is invoked before the engine starts navigation to a resource. You can use the start method to allow navigation or the ignore method to ignore the navigation request. The engine will be blocked until control is returned from the callback. If an exception is thrown, the start method will be invoked.

```APIDOC
## Interface: StartNavigationCallback

### Description
This callback is invoked before the engine starts navigation to a resource. It allows for controlling whether the navigation should proceed or be ignored. The engine remains blocked until the callback returns.

### Methods

#### `on(P params)`

**Description:** Invoked when the callback needs a response of type `R`, determined by the provided callback parameters.

**Parameters:**
- `params` (P) - The parameters for the callback.

**Returns:**
- `R` - The response type for the callback.

**Usage:**
- Use `start()` to allow navigation.
- Use `ignore()` to ignore the navigation request.

**Note:** If an exception is thrown within this method, the `start()` method will be invoked.
```

--------------------------------

### start(MediaReceiver receiver)

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.browser.callback/-start-presentation-callback/-action#content

Starts the presentation on the specified media receiver.

```APIDOC
## start(MediaReceiver receiver)

### Description
Starts the presentation on the specified `receiver`.

### Parameters
* **receiver** (MediaReceiver) - Required - The media receiver to start the presentation on.
```

--------------------------------

### start(MediaReceiver receiver)

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.browser.callback/-start-presentation-callback/-action/index.html

Starts the presentation on the specified media receiver.

```APIDOC
## start(MediaReceiver receiver)

### Description
Starts the presentation on the specified `receiver`.

### Parameters
* **receiver** (MediaReceiver) - Required - The media receiver to start the presentation on.

### Method
`void start(MediaReceiver receiver)`
```

--------------------------------

### Extension install(Path crxFile)

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.extensions/-extensions/install.html#content

Installs a Chrome extension from a specified CRX file. This method handles both new installations and updates for existing extensions. It does not require publisher proof for the CRX file.

```APIDOC
## Extension install(Path crxFile)

### Description
Installs the Chrome extension from the given CRX file. The `crxFile` must lead to a CRX file. No publisher proof is required. If the extension is already installed, this method returns it. If the CRX file contains a newer version of the extension, this method updates the installed extension and returns an instance of the updated extension.

### Method
public abstract

### Parameters
#### Path Parameters
- **crxFile** (Path) - Required - The path to the extension CRX package.

### Return
- **Extension** - The installed Chrome extension.

### Throws
- **ExtensionInstallationException** - If the extension installation has failed or if a newer version of the extension is already installed.
- **ObjectClosedException** - When the engine is closed or the profile is deleted.
```

--------------------------------

### Start Navigation Callback Response

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.navigation.callback/-start-navigation-callback/-response/start.html#content

The `start()` method is used to notify the browser that it should continue loading the URL. This is typically called within a navigation callback to allow or deny navigation.

```APIDOC
## start()

### Description
Notifies the browser that it should continue loading the URL.

### Method
static StartNavigationCallback.Response

### Parameters
None

### Response
Indicates that the navigation should proceed.
```

--------------------------------

### getOnRotationStarted

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.view.javafx/-browser-view/index.html#-1148960858%2FFunctions%2F1215895492

Gets the event handler for the start of a rotation gesture.

```APIDOC
## getOnRotationStarted

### Description
Retrieves the event handler that is called when a rotation gesture on this Node begins.

### Method
GET

### Endpoint
Not Applicable (Java Method)

### Parameters
None

### Response
#### Success Response
- **EventHandler<? super RotateEvent>** - The event handler for the start of a rotation gesture.
```

--------------------------------

### Initialize Engine with Options

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.engine/-engine/index.html#538892539%2FFunctions%2F1215895492

Demonstrates the initialization of the Chromium engine with custom engine options.

```java
Engine.newInstance(engineOptions);
```

--------------------------------

### getOnRotationStarted

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.view.javafx/-browser-view/index.html#-1155578040%2FFunctions%2F1215895492

Gets the event handler for rotation started events.

```APIDOC
## getOnRotationStarted

### Description
Gets the event handler for rotation started events.

### Method
public final EventHandler<? super RotateEvent> getOnRotationStarted()

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response
- **EventHandler<? super RotateEvent>** - The event handler for rotation started events.
```

--------------------------------

### getOnRotationStarted

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.view.javafx/-browser-view/index.html#-115120775%2FFunctions%2F1215895492

Gets the event handler for rotation started events.

```APIDOC
## getOnRotationStarted

### Description
Gets the event handler for rotation started events.

### Method
public final EventHandler<? super RotateEvent> getOnRotationStarted()

### Returns
The EventHandler for RotateEvent.
```

--------------------------------

### proceed()

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.media.callback/-select-media-device-callback/-response/proceed.html#content

Allows Chromium to list the available media input devices. For `getUserMedia()` calls, Chromium will select the most suitable available device and use it for the media stream. For `enumerateDevices()` calls, all available input devices will be included in the resulting device list.

```APIDOC
## proceed()

### Description
Allows Chromium to list the available media input devices. All media input devices of the requested type will be visible to JavaScript. For `getUserMedia()` calls, Chromium will select the most suitable available device and use it for the media stream. For `enumerateDevices()` calls, all available input devices will be included in the resulting device list.

### Method
public static SelectMediaDeviceCallback.Response

### Parameters
None

### Response
None

### Since
8.10.0
```

--------------------------------

### getOnRotationStarted

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.view.javafx/-browser-view/index.html#-1121349364%2FFunctions%2F1215895492

Gets the event handler for rotation started events.

```APIDOC
## getOnRotationStarted

### Description
Gets the event handler for rotation started events.

### Method
GET

### Endpoint
N/A (JavaFX method)

### Parameters
None

### Response
#### Success Response
- **EventHandler<? super RotateEvent>** - The event handler.
```

--------------------------------

### InstallExtensionCallback.Action Constructor

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.extensions.callback/-install-extension-callback/-action/index.html

Constructs a new Action with a consumer to handle the InstallExtension.Response.

```APIDOC
## InstallExtensionCallback.Action(Consumer<InstallExtension.Response> consumer)

### Description
Constructs a new Action with a consumer to handle the InstallExtension.Response.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Method
Constructor

### Endpoint
N/A
```

--------------------------------

### Initialize Engine with Options

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.engine/-engine/index.html#1660404506%2FFunctions%2F1215895492

Demonstrates the primary method for initializing the Chromium engine, allowing configuration through EngineOptions.

```java
public static Engine newInstance(EngineOptions options)
```

--------------------------------

### getOnRotationStarted

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.view.javafx/-browser-view/index.html#-1055076975%2FFunctions%2F1215895492

Gets the event handler for the start of a rotation gesture.

```APIDOC
## getOnRotationStarted

### Description
Retrieves the event handler that is invoked when a rotation gesture on this node begins.

### Method
public final EventHandler<? super RotateEvent> getOnRotationStarted()

### Returns
The `EventHandler` for `RotateEvent` when rotation starts.
```

--------------------------------

### getOnRotationStarted

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.view.javafx/-browser-view/index.html#-1017989623%2FFunctions%2F1215895492

Gets the event handler for rotation started events.

```APIDOC
## getOnRotationStarted

### Description
Gets the event handler for rotation started events.

### Method
public final EventHandler<? super RotateEvent> getOnRotationStarted()

### Endpoint
N/A (Method call)

### Parameters
None

### Response
#### Success Response
- **EventHandler<? super RotateEvent>** - The event handler.
```

--------------------------------

### download()

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.browser.callback/-start-download-callback/-params/download.html

Returns the Download process instance that is about to start.

```APIDOC
## download()

### Description
Returns the `Download` process instance that is about to start.

### Method Signature
public Download download()
```

--------------------------------

### build()

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.ui.event/-touch-started/-builder/build.html

Creates a new TouchStarted instance on top of this builder.

```APIDOC
## build()

### Description
Creates a new TouchStarted instance on top of this builder.

### Method
public

### Return
a new `TouchStarted` instance
```

--------------------------------

### targetTouches()

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.dom.event/-touch-event/target-touches.html

Gets the list of touch points that started on the target element.

```APIDOC
## targetTouches()

### Description
Returns a list of `TouchPoint` objects that represent the touch points that originated on the target element of this `TouchEvent`. The order of the touch points in the returned list is not guaranteed to be preserved.

### Method
public abstract List<TouchPoint> targetTouches()

### Returns
- `List<TouchPoint>`: A list of touch points that started on the target element.
```

--------------------------------

### build()

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.ui.event/-touch-started/-builder/build.html#content

Creates a new TouchStarted instance on top of this builder.

```APIDOC
## build()

### Description
Creates a new TouchStarted instance on top of this builder.

### Method
public TouchStarted build()

### Return
a new `TouchStarted` instance
```

--------------------------------

### extensionCrxFile()

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.extensions.callback/-install-extension-callback/-params/extension-crx-file.html

Gets the absolute path of the CRX file that the extension is about to be installed from. This file is temporary and will be deleted after the installation is completed or canceled. You can copy this file for future use, such as packing the extension into your application bundle.

```APIDOC
## extensionCrxFile()

### Description
Returns the absolute path to the CRX file the extension is about to be installed from. The file will be automatically deleted after the installation is completed or canceled. You can make a copy of the CRX file and store it for future use. For example, you can use the file to pack the extension into the application bundle and install it programmatically using install.

### Method
public String

### Return Value
String - The absolute path to the CRX file.
```

--------------------------------

### Initialize and Close Engine

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.engine/-engine/index.html#542566909%2FFunctions%2F1215895492

Demonstrates the basic lifecycle of an Engine instance, including initialization with options and proper closure to release resources.

```java
Engine engine = Engine.newInstance(engineOptions);
...
engine.close();
```

--------------------------------

### Scroll Event Handlers

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.view.javafx/-browser-view/index.html#-1073910505%2FFunctions%2F1215895492

These functions allow you to get the event handlers for scroll events, including when scrolling starts, finishes, or is in progress.

```APIDOC
## getOnScroll

### Description
Retrieves the event handler for scroll events.

### Method
public final EventHandler<? super ScrollEvent> getOnScroll()

## getOnScrollFinished

### Description
Retrieves the event handler that is invoked when a scroll operation finishes.

### Method
public final EventHandler<? super ScrollEvent> getOnScrollFinished()

## getOnScrollStarted

### Description
Retrieves the event handler that is invoked when a scroll operation starts.

### Method
public final EventHandler<? super ScrollEvent> getOnScrollStarted()
```

--------------------------------

### StartDownloadCallback.Action Constructor

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.browser.callback/-start-download-callback/-action/index.html

Initializes a new instance of the Action class with a consumer to handle the download response.

```APIDOC
## StartDownloadCallback.Action Constructor

### Description
Initializes a new instance of the Action class. The provided consumer will be invoked with the download response.

### Method
Constructor

### Parameters
#### Path Parameters
- **consumer** (Consumer<StartDownload.Response>) - Required - A consumer that accepts the StartDownload.Response object.
```

--------------------------------

### Scroll Event Handlers

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.view.javafx/-browser-view/index.html#-1031479681%2FFunctions%2F1215895492

These functions allow you to get the event handlers for scroll-related events such as scrolling, scrolling started, and scrolling finished.

```APIDOC
## getOnScroll

### Description
Retrieves the event handler for scroll events.

### Method
public final EventHandler<? super ScrollEvent> getOnScroll()

## getOnScrollFinished

### Description
Retrieves the event handler for when scrolling finishes.

### Method
public final EventHandler<? super ScrollEvent> getOnScrollFinished()

## getOnScrollStarted

### Description
Retrieves the event handler for when scrolling starts.

### Method
public final EventHandler<? super ScrollEvent> getOnScrollStarted()
```

--------------------------------

### Scroll Event Handlers

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.view.javafx/-browser-view/index.html#-1017989623%2FFunctions%2F1215895492

These functions allow you to get event handlers for scroll events, including when scrolling starts, finishes, or during the scroll itself.

```APIDOC
## getOnScroll

### Description
Retrieves the event handler for scroll events.

### Method
GET

### Endpoint
N/A (Method Signature)

## getOnScrollFinished

### Description
Retrieves the event handler that is invoked when a scroll operation has finished.

### Method
GET

### Endpoint
N/A (Method Signature)

## getOnScrollStarted

### Description
Retrieves the event handler that is invoked when a scroll operation has started.

### Method
GET

### Endpoint
N/A (Method Signature)
```

--------------------------------

### Engine Initialization and Usage

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.engine/-engine/index.html

Demonstrates how to initialize the Chromium engine with options, perform operations, and properly close the engine to release resources.

```APIDOC
## Engine Initialization and Usage

### Description
This section illustrates the basic lifecycle of the `Engine` object, from initialization with `EngineOptions` to performing operations and finally closing the engine to free up system resources.

### Methods
- `Engine.newInstance(EngineOptions options)`: Initializes and runs the Chromium engine with the given `options`.
- `Engine.newInstance(RenderingMode renderingMode)`: Initializes and runs the Chromium engine in the given `renderingMode`.
- `engine.close()`: Closes this object and releases all resources associated with it.

### Example Usage
```java
// Initialize the engine with options
EngineOptions options = EngineOptions.newBuilder().build();
Engine engine = Engine.newInstance(options);

// Perform operations with the engine...

// Close the engine to release resources
engine.close();
```

### Error Handling
- Any attempt to use an already closed engine will lead to an `IllegalStateException`.
```

--------------------------------

### Create New Browser Instance

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.engine/-engine/index.html#538892539%2FFunctions%2F1215895492

Demonstrates the creation of a new Browser instance within the default profile, which navigates to 'about:blank'.

```java
Browser browser = engine.newBrowser();
```

--------------------------------

### targetTouches

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.dom.event/-touch-event/target-touches.html#content

Gets the touch points that have started on the target element of this event. The result consists of elements from the touches list, with their ordering not preserved.

```APIDOC
## targetTouches

### Description
Retrieves the list of touch points that originated on the target element of the TouchEvent. The order of touch points in the returned list is not guaranteed to be preserved.

### Method
public abstract List<TouchPoint> targetTouches()

### Returns
- `List<TouchPoint>`: A list of touch points that started on the target element.
```

--------------------------------

### newInstance(EngineOptions options)

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.engine/-engine/new-instance.html

Initializes and runs the Chromium engine with the provided EngineOptions. Similar to the other initialization method, this can take several seconds and should not be called on the application UI thread. It handles environment checks, binary extraction, process startup, and IPC setup.

```APIDOC
## newInstance(EngineOptions options)

### Description
Initializes and runs the Chromium engine with the given `options`. Depending on the hardware performance, the initialization process might take several seconds. So, do not call this method in the application UI thread.

### Method
static Engine

### Parameters
#### Path Parameters
- **options** (EngineOptions) - Required - The engine options.

#### Return
a new instance of the `Engine`

#### Throws
- **EnvironmentException**: when the current environment is not supported
- **UserDataDirectoryCreationException**: when the given user data directory does not exist and cannot be created
- **UserDataDirectoryAlreadyInUseException**: when the given user data directory is already in use.
- **IpcSetupFailureException**: when Inter-Process Communication (IPC) setup has been failed
- **ChromiumProcessStartupFailureException**: when startup of the Chromium process has been failed
- **NoLicenseException**: when no license found
- **InvalidLicenseException**: when no valid license found
- **ChromiumBinariesDeliveryException**: when the verification of the Chromium binary files has failed and the binaries cannot be extracted from the resources
- **MissingDependencyException**: when Chromium fails to find the required system libraries. This exception can only be thrown on Linux
- **SandboxNotSupportedException**: when the current environment does not support running the engine in sandbox mode
```

--------------------------------

### Get Default Scaling for Printing

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.print/-scaling/default-scaling.html

Use this method to create a default scaling configuration for printing content. No additional setup is required.

```java
Scaling scaling = Scaling.defaultScaling();
```

--------------------------------

### Scroll Event Handlers

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.view.javafx/-browser-view/index.html#1031636411%2FFunctions%2F1215895492

These functions allow you to get and set event handlers for scroll-related events such as scrolling, scrolling started, and scrolling finished.

```APIDOC
## getOnScroll

### Description
Retrieves the event handler for scroll events.

### Method
GET

### Endpoint
/onScroll

## getOnScrollFinished

### Description
Retrieves the event handler for scroll finished events.

### Method
GET

### Endpoint
/onScrollFinished

## getOnScrollStarted

### Description
Retrieves the event handler for scroll started events.

### Method
GET

### Endpoint
/onScrollStarted
```

--------------------------------

### StartNavigationCallback.Response start()

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.navigation.callback/-start-navigation-callback/-response/start.html

Notifies the browser that it should continue loading the URL.

```APIDOC
## start()

### Description
Notifies the browser that it should continue loading the URL.

### Method
public static StartNavigationCallback.Response start()

### Parameters
None

### Response
Returns a `StartNavigationCallback.Response` object.
```

--------------------------------

### Scroll Event Handlers

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.view.javafx/-browser-view/index.html#-1104262472%2FFunctions%2F1215895492

These functions allow you to get the event handlers for scroll events. You can retrieve handlers for general scrolling, scrolling that has finished, and scrolling that has started.

```APIDOC
## getOnScroll

### Description
Retrieves the event handler for scroll events.

### Method
GET

### Endpoint
N/A (JavaFX method)

### Parameters
None

## getOnScrollFinished

### Description
Retrieves the event handler for when a scroll action has finished.

### Method
GET

### Endpoint
N/A (JavaFX method)

### Parameters
None

## getOnScrollStarted

### Description
Retrieves the event handler for when a scroll action has started.

### Method
GET

### Endpoint
N/A (JavaFX method)

### Parameters
None
```

--------------------------------

### proceed

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.browser.callback/-open-extension-action-popup-callback/-action/index.html

Opens the extension action popup browser and loads its content.

```APIDOC
## proceed

### Description
Initiates the process of opening the extension action popup browser and loading its content. This method should be called after the action has been properly initialized.

### Method
`public void proceed()`

### Parameters
None

### Returns
None
```

--------------------------------

### HttpStatus.value()

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.net/-http-status/index.html#-849285913%2FProperties%2F1215895492

Returns the integer representation of the HTTP status code. This method can be used to get the numerical value of a `HttpStatus` object, for example, when sending it in an HTTP response.

```APIDOC
## HttpStatus.value()

### Description

This method returns the integer representation of the `HttpStatus` code. It provides the numerical value associated with the status code object.

### Method

`public int value()`

### Response

#### Success Response

- **int** (int) - The integer representation of the HTTP status code.

### Request Example

```java
HttpStatus status = HttpStatus.CREATED;
int statusCode = status.value();
System.out.println(statusCode); // Output: 201
```

### Response Example

```
201
```
```

--------------------------------

### proceed

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.browser.callback/-open-extension-action-popup-callback/-action#content

Opens the extension action popup browser and loads its content.

```APIDOC
## proceed()

### Description
Opens the extension action popup browser and loads its content.

### Method
void
```

--------------------------------

### HttpStatus.value()

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.net/-http-status/index.html#-300026368%2FProperties%2F1215895492

Returns the integer representation of the HTTP status code. This method is useful when you need to get the raw integer value of a HttpStatus object, for example, for logging or comparison purposes.

```APIDOC
## HttpStatus.value()

### Description

Returns the `int` representation of the HTTP status code.

### Method Signature

`public int value()`

### Parameters

#### Path Parameters

* None

#### Query Parameters

* None

#### Request Body

* None

### Response

#### Success Response

- **int** (int) - The integer representation of the HTTP status code.

### Example

```java
HttpStatus status = HttpStatus.OK;
int statusCode = status.value();
// statusCode will be 200
```
```

--------------------------------

### Get JxBrowser Version

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser/-version-info/version.html#content

Retrieves the current version of the JxBrowser library as a string. This string can contain digits and letters, for example, "1.0" or "1.1-b1-eap".

```APIDOC
## version

### Description
Returns a string that represents the current JxBrowser version. The string includes digits and letters (e.g. "1.0", "1.1-b1-eap").

### Method Signature
public static String version()

### Returns
- **String**: The current JxBrowser version string.
```

--------------------------------

### SystemProxyConfig.newInstance()

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.net.proxy/-system-proxy-config#content

Creates a new instance of SystemProxyConfig, which represents the system's proxy settings.

```APIDOC
## SystemProxyConfig.newInstance()

### Description
Creates a system proxy configuration. This method initializes a configuration object that reflects the proxy settings currently active on the operating system.

### Method
static SystemProxyConfig

### Parameters
None

### Response
- **SystemProxyConfig**: An instance of SystemProxyConfig representing the system's proxy settings.
```

--------------------------------

### URLRequest.method()

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.net/-url-request/method.html#content

The method() method returns a string representing the HTTP request method used for this URL request. Examples include "GET", "POST", etc.

```APIDOC
## URLRequest.method()

### Description
Returns a string that represents the request method name. For example, "GET", "POST" etc.

### Method
public String method()

### Returns
- **String**: The name of the request method (e.g., "GET", "POST").
```

--------------------------------

### StartDownloadCallback.on

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.browser.callback/-start-download-callback/index.html

This method is invoked when the browser is about to start downloading a file. It provides parameters about the file and a callback to respond with download instructions (download or cancel).

```APIDOC
## StartDownloadCallback.on

### Description
Invoked when the callback needs a response for the given callback parameters. This method is called when the browser is about to start downloading a file. The `params` object contains information about the file to be downloaded, and the `tell` object can be used to either download the file or cancel the download.

### Method Signature
`public abstract void on(P params, R tell)`

### Parameters
#### params (P)
- Type: P (Represents the parameters of the StartDownloadCallback, containing file information)
- Description: Information about the file that is about to be downloaded.

#### tell (R)
- Type: R (Represents the callback action to respond to the download request)
- Description: An object that can be used to either download the file or cancel the download.

### Example Usage (Conceptual)
```java
browser.setStartDownloadCallback(new StartDownloadCallback<StartDownloadCallback.Params, StartDownloadCallback.Action>() {
    @Override
    public void on(StartDownloadCallback.Params params, StartDownloadCallback.Action tell) {
        // Example: To download the file to a specific directory
        // tell.download(new File("/path/to/downloads/"));

        // Example: To cancel the download
        // tell.cancel();
    }
});
```
```

--------------------------------

### newInstance(RenderingMode renderingMode)

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.engine/-engine/new-instance.html

Initializes and runs the Chromium engine in the specified rendering mode. This method performs environment checks, extracts Chromium binaries, starts the native process, and sets up IPC. Due to the potential multi-second initialization time, it should not be called on the application UI thread.

```APIDOC
## newInstance(RenderingMode renderingMode)

### Description
Initializes and runs the Chromium engine in the given `renderingMode`. Depending on the hardware performance, the initialization process might take several seconds. So, do not call this method in the application UI thread.

### Method
static Engine

### Parameters
#### Path Parameters
- **renderingMode** (RenderingMode) - Required - The rendering mode indicating how the content of the web pages will be rendered.

#### Return
a new instance of the `Engine`

#### Throws
- **EnvironmentException**: when the current environment is not supported
- **UserDataDirectoryCreationException**: when the given user data directory does not exist and cannot be created
- **UserDataDirectoryAlreadyInUseException**: when the given user data directory is already in use.
- **IpcSetupFailureException**: when Inter-Process Communication (IPC) setup has been failed
- **ChromiumProcessStartupFailureException**: when startup of the Chromium process has been failed
- **NoLicenseException**: when no license found
- **InvalidLicenseException**: when no valid license found
- **ChromiumBinariesDeliveryException**: when the verification of the Chromium binary files has failed and the binaries cannot be extracted from the resources
- **MissingDependencyException**: when Chromium fails to find the required system libraries. This exception can only be thrown on Linux
- **SandboxNotSupportedException**: when the current environment does not support running the engine in sandbox mode
```

--------------------------------

### Get Session Description

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.cast/-cast-session/description.html#content

Retrieves a human-readable description of the current Cast session. This can include details like the website being mirrored or the media being casted. The description might be empty if the session has just started and the cast content is not yet available.

```APIDOC
## description()

### Description
Returns the description of the session. Examples: "Mirroring tab (www.example.com)", "Casting media", "Casting YouTube". The description may be empty when the session just started and Chromium didn't define the cast content yet.

### Throws
ObjectClosedException - when the profile is deleted or its engine is closed
```

--------------------------------

### SystemProxyConfig.newInstance()

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.net.proxy/-system-proxy-config/new-instance.html

Creates a new instance of SystemProxyConfig that uses the system's proxy settings.

```APIDOC
## SystemProxyConfig.newInstance()

### Description
Creates a system proxy configuration. With this proxy configuration, the proxy settings configured for your operating system are reused.

### Method
static SystemProxyConfig

### Returns
A new SystemProxyConfig instance configured to use system proxy settings.
```

--------------------------------

### newInstance

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.view.javafx/-browser-view/index.html#1035124951%2FFunctions%2F1215895492

Creates a new BrowserView instance.

```APIDOC
## newInstance

### Description
Creates a new `BrowserView` instance that displays the given `browser` instance.

### Method
public static BrowserView newInstance(Browser browser)

### Parameters
- **browser** (Browser) - The `Browser` instance to display in the view.

### Returns
A new `BrowserView` instance.
```

--------------------------------

### StartDownloadCallback.Action Method

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.browser.callback/-start-download-callback/-action/-start-download-callback.-action.html

The Action method is used to register a consumer that will process the response of a download initiation. This allows for custom handling of download events.

```APIDOC
## StartDownloadCallback.Action(Consumer<StartDownload.Response> consumer)

### Description
Registers a consumer to handle the response of a download initiation.

### Method Signature
`public void StartDownloadCallback.Action(Consumer<StartDownload.Response> consumer)`

### Parameters
#### Parameters
- **consumer** (Consumer<StartDownload.Response>) - Required - A consumer object that accepts a `StartDownload.Response` object to process the download initiation result.
```

--------------------------------

### startingFrom(Timestamp start)

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.time/-time-range/starting-from.html#content

Creates a TimeRange object that starts from the specified `start` timestamp and extends to the end of the year 9999.

```APIDOC
## startingFrom(Timestamp start)

### Description
Creates a TimeRange from the `start` point and to `9999-12-31T23:59:59Z`.

### Method
static factory method

### Parameters
#### Path Parameters
- **start** (Timestamp) - Required - the start point in time
```

--------------------------------

### build

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.ui.event/-mouse-released/-builder/build.html#content

Constructs a new MouseReleased instance.

```APIDOC
## build()

### Description
Returns a new MouseReleased instance built from the current state of this builder.

### Method
public

### Return
a new `MouseReleased` instance
```

--------------------------------

### StartDownloadCallback.Action Constructor

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.browser.callback/-start-download-callback/-action#content

Constructs an Action object to handle download responses. It takes a consumer that will be notified with the download response.

```APIDOC
## StartDownloadCallback.Action(Consumer<StartDownload.Response> consumer)

### Description
Initializes a new instance of the `Action` class.

### Parameters
#### Path Parameters
- **consumer** (Consumer<StartDownload.Response>) - The consumer to receive the download response.
```

--------------------------------

### nodeValue (get)

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.dom/-document/index.html#668031969%2FFunctions%2F1215895492

Gets the node value.

```APIDOC
## nodeValue

### Description
Returns a string that represents the node value.

### Method
Not applicable (Java method)

### Parameters
None

### Response
#### Success Response
- **String** - The node value.
```

--------------------------------

### newInstance

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.net.proxy/-system-proxy-config/index.html

Creates a new instance of SystemProxyConfig, which represents the system's proxy settings.

```APIDOC
## newInstance

### Description
Creates a system proxy configuration.

### Method
static SystemProxyConfig

### Signature
public static SystemProxyConfig newInstance()

### Returns
A new SystemProxyConfig object representing the system's proxy settings.
```

--------------------------------

### nodeValue (get)

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.dom/-document/index.html#-1406943402%2FFunctions%2F1215895492

Gets the value of the node.

```APIDOC
## nodeValue

### Description
Returns a string that represents the node value.

### Method Signature
`public abstract String nodeValue()`
```

--------------------------------

### Get Background

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.view.javafx/-browser-view/index.html#-2102337609%2FFunctions%2F1215895492

Gets the background of the view.

```APIDOC
## getBackground

### Description
Gets the background of the view.

### Method
`public final Background getBackground()`
```

--------------------------------

### StartPresentationCallback.Action Constructor

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.browser.callback/-start-presentation-callback/-action#content

Constructs a new Action with a consumer to handle the presentation response.

```APIDOC
## StartPresentationCallback.Action(Consumer<StartPresentation.Response> consumer)

### Description
Constructs a new Action with a consumer that will be invoked with the result of the presentation.

### Parameters
* **consumer** (Consumer<StartPresentation.Response>) - Required - The consumer to handle the presentation response.
```

--------------------------------

### Get Border

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.view.javafx/-browser-view/index.html#-2102337609%2FFunctions%2F1215895492

Gets the border of the view.

```APIDOC
## getBorder

### Description
Gets the border of the view.

### Method
`public final Border getBorder()`
```

--------------------------------

### StartPresentationCallback.Action Constructor

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.browser.callback/-start-presentation-callback/-action/index.html

Initializes a new instance of the StartPresentationCallback.Action class with a consumer for handling the presentation response.

```APIDOC
## StartPresentationCallback.Action Constructor

### Description
Initializes a new instance of the `StartPresentationCallback.Action` class.

### Parameters
* **consumer** (Consumer<StartPresentation.Response>) - Required - A consumer that accepts the `StartPresentation.Response`.

### Method
`StartPresentationCallback.Action(Consumer<StartPresentation.Response> consumer)`
```

--------------------------------

### Get Children

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.view.javafx/-browser-view/index.html#-2102337609%2FFunctions%2F1215895492

Gets the children of the view.

```APIDOC
## getChildren

### Description
Gets the children of the view.

### Method
`public ObservableList<Node> getChildren()`
```

--------------------------------

### Engine.newInstance(EngineOptions)

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.engine/-engine/new-instance.html#content

Initializes and runs the Chromium engine with the provided engine options. This method includes environment validation, Chromium binary management, native process startup, and IPC setup. Avoid calling this method on the application UI thread due to potential initialization delays.

```APIDOC
## Engine.newInstance(EngineOptions options)

### Description
Initializes and runs the Chromium engine with the given `options`. Depending on the hardware performance, the initialization process might take several seconds. So, do not call this method in the application UI thread.

### Method
static

### Parameters
#### Path Parameters
* **options** (EngineOptions) - Required - the engine options

### Throws
* **EnvironmentException** - when the current environment is not supported
* **UserDataDirectoryCreationException** - when the given user data directory does not exist and cannot be created
* **UserDataDirectoryAlreadyInUseException** - when the given user data directory is already in use.
* **IpcSetupFailureException** - when Inter-Process Communication (IPC) setup has been failed
* **ChromiumProcessStartupFailureException** - when startup of the Chromium process has been failed
* **NoLicenseException** - when no license found
* **InvalidLicenseException** - when no valid license found
* **ChromiumBinariesDeliveryException** - when the verification of the Chromium binary files has failed and the binaries cannot be extracted from the resources
* **MissingDependencyException** - when Chromium fails to find the required system libraries. This exception can only be thrown on Linux
* **SandboxNotSupportedException** - when the current environment does not support running the engine in sandbox mode
```

--------------------------------

### Get Blend Mode

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.view.javafx/-browser-view/index.html#-2102337609%2FFunctions%2F1215895492

Gets the blend mode of the view.

```APIDOC
## getBlendMode

### Description
Gets the blend mode of the view.

### Method
`public final BlendMode getBlendMode()`
```

--------------------------------

### InstallExtensionCallback.Action

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.extensions.callback/-install-extension-callback/-action/-install-extension-callback.-action.html#content

The Action interface represents a callback that is invoked after an extension installation attempt. It accepts a Consumer that processes the InstallExtension.Response.

```APIDOC
## InstallExtensionCallback.Action

### Description

This interface defines a callback method `Action` that is executed upon the completion of an extension installation. It allows for custom handling of the installation result by providing a `Consumer` that accepts an `InstallExtension.Response` object.

### Method Signature

`public void InstallExtensionCallback.Action(Consumer<InstallExtension.Response> consumer)`

### Parameters

*   **consumer** (`Consumer<InstallExtension.Response>`) - Required - A functional interface that accepts an `InstallExtension.Response` object. This consumer will be invoked with the result of the extension installation.

### Usage Example

```java
// Assuming you have an implementation of InstallExtensionCallback
InstallExtensionCallback myCallback = new InstallExtensionCallback() {
    @Override
    public void Action(Consumer<InstallExtension.Response> consumer) {
        // Logic to handle the response
        consumer.accept(new InstallExtension.Response(/* ... response details ... */));
    }
};

// Registering the callback (example)
// Browser.getExtensionManager().setInstallExtensionCallback(myCallback);
```
```

--------------------------------

### Get Cache Hint

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.view.javafx/-browser-view/index.html#-2102337609%2FFunctions%2F1215895492

Gets the cache hint for the view.

```APIDOC
## getCacheHint

### Description
Gets the `CacheHint` for the view.

### Method
`public final CacheHint getCacheHint()`
```

--------------------------------

### Create New Browser Instance

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.engine/-engine/index.html#-1954298158%2FFunctions%2F1215895492

Creates a new Browser instance associated with the default profile and navigates it to 'about:blank'.

```java
public abstract Browser newBrowser()
```

--------------------------------

### StartDownloadCallback.Action

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.browser.callback/-start-download-callback/-action/-start-download-callback.-action.html#content

The StartDownloadCallback.Action interface defines a method to handle the start of a download. It accepts a Consumer that will be provided with a StartDownload.Response object.

```APIDOC
## StartDownloadCallback.Action

### Description

This interface represents an action to be performed when a download is about to start. It allows for custom handling of download initiation events.

### Method Signature

`void StartDownloadCallback.Action(Consumer<StartDownload.Response> consumer)`

### Parameters

#### Consumer Parameter

- **consumer** (Consumer<StartDownload.Response>) - Required - A callback function that accepts a `StartDownload.Response` object. This object contains information about the download and allows for control over the download process, such as accepting or canceling it.
```

--------------------------------

### Get Accessible Role

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.view.javafx/-browser-view/index.html#-2102337609%2FFunctions%2F1215895492

Gets the accessible role of the view.

```APIDOC
## getAccessibleRole

### Description
Gets the accessible role of the view.

### Method
`public final AccessibleRole getAccessibleRole()`
```

--------------------------------

### build()

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.ui.event/-key-typed/-builder/build.html

Constructs a new KeyTyped instance using the parameters configured in the builder.

```APIDOC
## build()

### Description
Returns a new KeyTyped instance built from the current state of this builder.

### Method
public

### Return
a new `KeyTyped` instance
```

--------------------------------

### SystemProxyConfig.newInstance()

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.net.proxy/-system-proxy-config/new-instance.html#content

Creates a new instance of SystemProxyConfig. This configuration will use the proxy settings already configured in your operating system.

```APIDOC
## SystemProxyConfig.newInstance()

### Description
Creates a system proxy configuration. With this proxy configuration, the proxy settings configured for your operating system are reused.

### Method
static

### Signature
public static SystemProxyConfig newInstance()

### Returns
A new instance of SystemProxyConfig that uses the operating system's proxy settings.
```

--------------------------------

### textContent (get)

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.dom/-document/index.html#668031969%2FFunctions%2F1215895492

Gets the text content of the current node and its descendants.

```APIDOC
## textContent

### Description
Returns the text content of the current node and its descendants.

### Method
Not applicable (Java method)

### Parameters
None

### Response
#### Success Response
- **String** - The text content of the node and its descendants.
```

--------------------------------

### Engine.newInstance

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.engine/-engine/index.html#538892539%2FFunctions%2F1215895492

Initializes and runs the Chromium engine with the given options or rendering mode.

```APIDOC
## Engine.newInstance

### Description
Initializes and runs the Chromium engine with the given `options` or in the specified `renderingMode`.

### Method
`public static Engine newInstance(EngineOptions options)`
`public static Engine newInstance(RenderingMode renderingMode)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```java
// Using EngineOptions
EngineOptions options = EngineOptions.newBuilder().build();
Engine engine = Engine.newInstance(options);

// Using RenderingMode
Engine engine = Engine.newInstance(RenderingMode.HARDWARE_ACCELERATED);
```

### Response
#### Success Response
Returns an initialized `Engine` instance.

#### Response Example
```java
// Engine instance is returned
```
```

--------------------------------

### Toolkit

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.view.swing/-browser-view/index.html#-1248464619%2FFunctions%2F1215895492

Gets the toolkit for the BrowserView.

```APIDOC
## getToolkit

### Description
Gets the toolkit for the BrowserView.

### Method
GET

### Endpoint
N/A (Method call)

### Returns
- **Toolkit**: The toolkit.
```

--------------------------------

### textContent (get)

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.dom/-document/index.html#-1406943402%2FFunctions%2F1215895492

Gets the text content of the current node and its descendants.

```APIDOC
## textContent

### Description
Returns the text content of the current node and its descendants.

### Method Signature
`public abstract String textContent()`
```

--------------------------------

### StartNavigationCallback

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.navigation.callback#content

Interface for handling events before navigation starts.

```APIDOC
## StartNavigationCallback

### Description
This callback is invoked before the engine starts navigation to a resource.

### Signature
`public interface StartNavigationCallback implements NavigationSyncCallback<P, R>`
```

--------------------------------

### Get Accessible Text

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.view.javafx/-browser-view/index.html#-2102337609%2FFunctions%2F1215895492

Gets the accessible text content of the view.

```APIDOC
## getAccessibleText

### Description
Gets the accessible text content of the view.

### Method
`public final String getAccessibleText()`
```

--------------------------------

### Creating and Closing a Browser Instance

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.browser/-browser/index.html

Demonstrates the basic lifecycle of a Browser instance: creating it using an Engine and closing it when no longer needed to release resources.

```java
Browser browser = engine.newBrowser();
...
browser.close();

```

--------------------------------

### void pack()

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.view.swt/-browser-view/index.html#-2020060589%2FFunctions%2F1215895492

Packs the BrowserView, adjusting its size to fit its content.

```APIDOC
## pack()

### Description
Adjusts the size of the BrowserView to fit its preferred content size.

### Method
POST

### Endpoint
N/A (SDK Method)
```

--------------------------------

### Get Accessible Help

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.view.javafx/-browser-view/index.html#-2102337609%2FFunctions%2F1215895492

Gets the accessible help text for the view.

```APIDOC
## getAccessibleHelp

### Description
Gets the accessible help text for the view.

### Method
`public final String getAccessibleHelp()`
```

--------------------------------

### InstallExtensionCallback

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.extensions.callback/-install-extension-callback/index.html

The InstallExtensionCallback interface is invoked when a user installs an extension from the Chrome Web Store. It provides methods to respond to the installation request, allowing you to either install or cancel the extension.

```APIDOC
## InstallExtensionCallback

### Description
A callback that is invoked when the user installs an extension from Chrome Web Store. Use the `install` method to install the extension. Use the `cancel` method to cancel the installation.

### Type
`public interface InstallExtensionCallback implements ExtensionsAsyncCallback<P, R>`

### Since
8.0.0

## Types
### Action
An action providing a response to the InstallExtensionCallback.
`public final class Action extends AsyncCallbackAction<R>`

### Params
The parameters of the InstallExtensionCallback.
`public interface Params`

## Functions
### on
Invoked when the callback needs a response for the given callback parameters.

#### Signature
`public abstract void on(P params, R tell)`

#### Parameters
* **params** (P) - The parameters for the callback.
* **tell** (R) - The callback to signal the response.
```

--------------------------------

### newInstance

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.net.proxy/-direct-proxy-config/new-instance.html

Creates a direct proxy configuration. With this proxy configuration, no proxy server is used at all.

```APIDOC
## newInstance

### Description
Creates a direct proxy configuration. With this proxy configuration, no proxy server is used at all.

### Method
public static DirectProxyConfig

### Parameters
This method does not take any parameters.

### Returns
A new instance of `DirectProxyConfig`.
```

--------------------------------

### newInstance

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.net.proxy/-direct-proxy-config/new-instance.html#content

Creates a direct proxy configuration. With this proxy configuration, no proxy server is used at all.

```APIDOC
## newInstance

### Description
Creates a direct proxy configuration. With this proxy configuration, no proxy server is used at all.

### Method
static

### Returns
DirectProxyConfig - A new instance of DirectProxyConfig representing a direct proxy configuration.
```

--------------------------------

### TimeRange.between(Timestamp start, Timestamp end)

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.time/-time-range/between.html

Creates a TimeRange object representing the period between a given start and end timestamp. An IllegalArgumentException is thrown if the start timestamp is equal to or after the end timestamp.

```APIDOC
## TimeRange.between(Timestamp start, Timestamp end)

### Description
Creates a `TimeRange` between two points in time. This method is useful for defining a specific duration or interval.

### Method
`static`

### Parameters
#### Path Parameters
- **start** (Timestamp) - Required - The start point in time for the range.
- **end** (Timestamp) - Required - The end point in time for the range.

### Throws
- **IllegalArgumentException** - if `start` is equal or after `end`.
```

--------------------------------

### getBaseline

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.view.swing/-browser-view/index.html#-1352749311%2FFunctions%2F1215895492

Gets the baseline for the BrowserView.

```APIDOC
## getBaseline

### Description
Gets the baseline for the BrowserView.

### Method Signature
public int getBaseline(int width, int height)
```

--------------------------------

### file (get)

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.dom/-input-element/index.html#1365629326%2FFunctions%2F1215895492

Gets the file path associated with a file input element.

```APIDOC
## file (get)

### Description
Returns a string that represents an absolute or relative path to a file if the current ` input` DOM element has the `type` attribute with the 'file' value.

### Method
public abstract String file
```

--------------------------------

### Engine Lifecycle and Event Handling

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.engine/-engine#content

Demonstrates how to create, close, and subscribe to events for an Engine instance.

```APIDOC
## Engine Lifecycle and Event Handling

### Description
This section covers the fundamental operations of creating an `Engine` instance, properly closing it to release resources, and subscribing to engine events like closure and crashes.

### Methods

#### `newInstance(EngineOptions options)`
Initializes and runs the Chromium engine with the given `options`.

#### `newInstance(RenderingMode renderingMode)`
Initializes and runs the Chromium engine in the given `renderingMode`.

#### `close()`
Closes this object and releases all resources associated with it. It is crucial to call this method when the engine is no longer needed to prevent resource leaks.

#### `isClosed()`
Returns `true` if the current object is closed, `false` otherwise.

#### `on(Class<E> eventClass, Observer<E> observer)`
Subscribes the given event `observer` to receive events of the specified `eventClass`. This is used to listen for events such as `EngineClosed` and `EngineCrashed`.

### Event Examples

#### EngineClosed Event
```java
engine.on(EngineClosed.class, event -> {
    // The engine has been closed.
});
```

#### EngineCrashed Event
```java
engine.on(EngineCrashed.class, event -> {
    // The engine has been unexpectedly terminated.
});
```

### Usage Example
```java
// Assuming EngineOptions and RenderingMode are properly defined
Engine engine = Engine.newInstance(engineOptions);
// ... perform operations with the engine ...
engine.close(); // Ensure the engine is closed when done
```
```

--------------------------------

### Get Bounds In Local

Source: https://teamdev.com/jxbrowser/api/8.18.2/java/-jx-browser/com.teamdev.jxbrowser.view.javafx/-browser-view/index.html#-2102337609%2FFunctions%2F1215895492

Gets the bounds of the view in its local coordinate system.

```APIDOC
## getBoundsInLocal

### Description
Gets the bounds of the view in its local coordinate system.

### Method
`public final Bounds getBoundsInLocal()`
```
Tokens:
Raw