HtmlUnit

https://htmlunit.org/
Admin
HtmlUnit is a Java-based headless browser library that enables programmatic automation of web...
Tokens:1,641,787
Snippets:10,600
Trust Score:7.7
Update:6 months ago
Show doc for...
Tokens:
Raw
### Start WebSocket Client

Source: https://htmlunit.org/apidocs/org/htmlunit/websocket/JettyWebSocketAdapter.html

Starts the WebSocket client. This method may throw an exception if an error occurs during startup.

```java
public void start()
           throws Exception
```

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

### Start Rendering

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/host/media/OfflineAudioContext.html

Initiates the rendering process for the audio context.

```java
public void startRendering()
```

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

### Get the Start Offset within the Start Container

Source: https://htmlunit.org/apidocs/org/htmlunit/html/impl/SimpleRange.html

Retrieve the offset within the starting node of a range using `getStartOffset()`. This value specifies the position within the `startContainer` where the range begins.

```java
public int getStartOffset()
```

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

### start Method

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/host/media/AudioBufferSourceNode.html

Schedules playback of the audio data contained in the buffer or begins playback immediately.

```java
public void start()
```

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

### Get Selection Start Position

Source: https://htmlunit.org/apidocs/org/htmlunit/html/impl/SelectionDelegate.html

Returns the start position of the selected text in the owner element. This method is part of the SelectionDelegate interface.

```java
int getSelectionStart()
```

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

### Initialize WebClient and Load Page

Source: https://htmlunit.org/window-frame.html

Creates a new WebClient instance and loads the main page of API documentation. Ensure the URL is valid and accessible.

```java
final WebClient client = new WebClient();
final HtmlPage mainPage = client.getPage("https://www.htmlunit.org/apidocs/index.html");
```

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

### Get Selection Start Position

Source: https://htmlunit.org/apidocs/org/htmlunit/html/HtmlSelectableTextInput.html

Returns the starting position of the selected text within this element. Specified by `getSelectionStart` in the `SelectableTextInput` interface.

```java
public int getSelectionStart()
```

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

### Get Selection Start

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/host/html/HTMLInputElement.html

Retrieves the value of the 'selectionStart' attribute.

```java
public Integer getSelectionStart()
```

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

### Initialize WebClientOptions Constructor

Source: https://htmlunit.org/apidocs/org/htmlunit/WebClientOptions.html

Creates a new instance of WebClientOptions. No specific setup is required beyond instantiation.

```java
public WebClientOptions()

```

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

### Constructor

Source: https://htmlunit.org/apidocs/org/htmlunit/httpclient/HtmlUnitUsernamePasswordCredentials.html

Initializes a new instance with a username and password.

```java
public HtmlUnitUsernamePasswordCredentials(String userName,
                                           char[] password)
```

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

### GET /element/start

Source: https://htmlunit.org/apidocs/org/htmlunit/html/HtmlOrderedList.html

Retrieves the value of the 'start' attribute for an HTML element.

```APIDOC
## GET /element/start

### Description
Returns the value of the attribute 'start'. Refer to the HTML 4.01 documentation for details on the use of this attribute.

### Method
GET

### Response
#### Success Response (200)
- **start** (String) - The value of the attribute 'start' or an empty string if that attribute isn't defined.
```

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

### Get the Start Container Node of a Range

Source: https://htmlunit.org/apidocs/org/htmlunit/html/impl/SimpleRange.html

Obtain the Node within which the range begins using `getStartContainer()`. This method is crucial for identifying the starting point of a selected range.

```java
public DomNode getStartContainer()
```

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

### static void installFix(Scriptable window, BrowserVersion browserVersion)

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/NativeFunctionToStringFunction.html

Installs a wrapper in place of the native toString function on the Function prototype to ensure desired formatting.

```APIDOC
## static void installFix(org.htmlunit.corejs.javascript.Scriptable window, BrowserVersion browserVersion)

### Description
Install the wrapper in place of the native toString function on Function's prototype.

### Parameters
#### Request Body
- **window** (org.htmlunit.corejs.javascript.Scriptable) - Required - The scope where the fix should be applied.
- **browserVersion** (BrowserVersion) - Required - The simulated browser version.
```

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

### Start WebSocket Client

Source: https://htmlunit.org/apidocs/org/htmlunit/websocket/WebSocketAdapter.html

Initializes the client. Throws an Exception if an error occurs.

```java
void	start()
    throws Exception
```

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

### Load Start Event Handler

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/host/svg/SVGElement.html

Allows setting and getting the onloadstart event handler.

```APIDOC
## setOnloadstart

### Description
Sets the `onloadstart` event handler.

### Method
public void setOnloadstart(Object loadstart)

### Parameters
#### Path Parameters
- **loadstart** (Object) - Required - the `onloadstart` event handler
```

```APIDOC
## getOnloadstart

### Description
Returns the `onloadstart` event handler.

### Method
public org.htmlunit.corejs.javascript.Function getOnloadstart()

### Returns
- **org.htmlunit.corejs.javascript.Function** - the `onloadstart` event handler
```

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

### Select Start Event Handler

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/host/svg/SVGElement.html

Allows setting and getting the onselectstart event handler.

```APIDOC
## setOnselectstart

### Description
Sets the `onselectstart` event handler for this element.

### Method
public void setOnselectstart(Object onselectstart)

### Parameters
#### Path Parameters
- **onselectstart** (Object) - Required - the `onselectstart` event handler for this element
```

```APIDOC
## getOnselectstart

### Description
Returns the `onselectstart` event handler for this element.

### Method
public org.htmlunit.corejs.javascript.Function getOnselectstart()

### Returns
- **org.htmlunit.corejs.javascript.Function** - the `onselectstart` event handler for this element
```

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

### Initialize WebClient and Load Page

Source: https://htmlunit.org/apidocs/org/htmlunit/WebClient.html

Demonstrates the standard initialization of a WebClient and loading a page via URL. Note that WebClient instances are not thread-safe.

```java
  final WebClient webClient = new WebClient();  
  final HtmlPage startPage = webClient.getPage("http://htmlunit.sf.net");  
assertEquals("HtmlUnit - Welcome to HtmlUnit", startPage.getTitleText()); 
```

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

### Get Range Containers

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/host/dom/AbstractRange.html

Public methods to retrieve the start and end nodes of the range.

```java
public Object getStartContainer()
```

```java
public Object getEndContainer()
```

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

### POST /start

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/host/media/AudioBufferSourceNode.html

Schedules playback of the audio data contained in the buffer or begins playback immediately.

```APIDOC
## POST /start

### Description
Schedules playback of the audio data contained in the buffer, or to begin playback immediately.

### Method
POST
```

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

### Manage Range Offsets

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/host/dom/AbstractRange.html

Methods to get and set the start and end offsets of the range.

```java
protected int internGetStartOffset()
```

```java
protected void internSetStartOffset(int startOffset)
```

```java
protected int internGetEndOffset()
```

```java
protected void internSetEndOffset(int endOffset)
```

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

### InputDeviceCapabilities Constructor

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/host/media/InputDeviceCapabilities.html

Initializes a new instance of the InputDeviceCapabilities class.

```APIDOC
## Constructor: InputDeviceCapabilities

### Description
Initializes a new instance of the InputDeviceCapabilities class.

### Signature
`public InputDeviceCapabilities()`
```

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

### Deploy Site Documentation

Source: https://htmlunit.org/packagingARelease.html

Deploy the generated site documentation to the web server. Tests are skipped during this deployment process.

```bash
mvn -Dmaven.test.skip=true site:deploy
```

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

### Manage Range Containers

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/host/dom/AbstractRange.html

Methods to get and set the start and end containers of the range.

```java
protected Node internGetStartContainer()
```

```java
protected void internSetStartContainer(Node startContainer)
```

```java
protected Node internGetEndContainer()
```

```java
protected void internSetEndContainer(Node endContainer)
```

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

### GET /jobs/waitForJobsStartingBefore

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/background/JavaScriptJobManager.html

Blocks until all jobs scheduled to start before a specific delay have finished executing.

```APIDOC
## GET /jobs/waitForJobsStartingBefore

### Description
Blocks until all jobs scheduled to start executing before (now + delayMillis) have finished executing.

### Parameters
#### Query Parameters
- **delayMillis** (long) - Required - The delay which determines the background tasks to wait for (in milliseconds).
- **timeoutMillis** (long) - Optional - The maximum amount of time to wait (in milliseconds).
- **filter** (JavaScriptJobFilter) - Optional - The JavaScriptJobFilter to apply.

### Response
#### Success Response (200)
- **count** (int) - The number of background JavaScript jobs still executing or waiting to be executed.
```

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

### Initialize WebClient

Source: https://htmlunit.org/webclient.html

Instantiate a WebClient using a try-with-resources block to ensure proper resource management.

```java
try (final WebClient webClient = new WebClient()) {
    // now you have a running browser, and you can start doing real things
    // like going to a web page
    final HtmlPage page = webClient.getPage("https://www.htmlunit.org/");
}
```

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

### DomTreeWalker getCurrentNode Method

Source: https://htmlunit.org/apidocs/org/htmlunit/platform/dom/traversal/DomTreeWalker.html

Gets the current node in the traversal. This is the node from which subsequent traversals will start.

```java
public DomNode getCurrentNode()
```

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

### Initialize MediaSource

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/host/media/MediaSource.html

Constructs a new MediaSource object. This is the default constructor.

```java
public MediaSource() {
}
```

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

### Initialize File Instance

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/host/file/File.html

Creates a new File instance with the specified bits, name, and properties.

```java
public void jsConstructor(org.htmlunit.corejs.javascript.NativeArray fileBits,
                          String fileName,
                          org.htmlunit.corejs.javascript.ScriptableObject properties)
```

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

### Animation Event Handlers

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/host/html/HTMLElement.html

Methods for getting and setting animation event handlers (cancel, end, iteration, start).

```APIDOC
## GET /onanimationcancel

### Description
Returns the `onanimationcancel` event handler.

### Method
GET

### Endpoint
/onanimationcancel

### Response
#### Success Response (200)
- **onanimationcancel** (Function) - the `onanimationcancel` event handler

#### Response Example
```json
{
  "onanimationcancel": "function() { ... }"
}
```

## POST /onanimationcancel

### Description
Sets the `onanimationcancel` event handler.

### Method
POST

### Endpoint
/onanimationcancel

### Parameters
#### Request Body
- **onanimationcancel** (Object) - the `onanimationcancel` event handler

### Request Example
```json
{
  "onanimationcancel": "function() { ... }"
}
```

## GET /onanimationend

### Description
Returns the `onanimationend` event handler.

### Method
GET

### Endpoint
/onanimationend

### Response
#### Success Response (200)
- **onanimationend** (Function) - the `onanimationend` event handler

#### Response Example
```json
{
  "onanimationend": "function() { ... }"
}
```

## POST /onanimationend

### Description
Sets the `onanimationend` event handler.

### Method
POST

### Endpoint
/onanimationend

### Parameters
#### Request Body
- **onanimationend** (Object) - the `onanimationend` event handler

### Request Example
```json
{
  "onanimationend": "function() { ... }"
}
```

## GET /onanimationiteration

### Description
Returns the `onanimationiteration` event handler.

### Method
GET

### Endpoint
/onanimationiteration

### Response
#### Success Response (200)
- **onanimationiteration** (Function) - the `onanimationiteration` event handler

#### Response Example
```json
{
  "onanimationiteration": "function() { ... }"
}
```

## POST /onanimationiteration

### Description
Sets the `onanimationiteration` event handler.

### Method
POST

### Endpoint
/onanimationiteration

### Parameters
#### Request Body
- **onanimationiteration** (Object) - the `onanimationiteration` event handler

### Request Example
```json
{
  "onanimationiteration": "function() { ... }"
}
```

## GET /onanimationstart

### Description
Returns the `onanimationstart` event handler.

### Method
GET

### Endpoint
/onanimationstart

### Response
#### Success Response (200)
- **onanimationstart** (Function) - the `onanimationstart` event handler

#### Response Example
```json
{
  "onanimationstart": "function() { ... }"
}
```

## POST /onanimationstart

### Description
Sets the `onanimationstart` event handler.

### Method
POST

### Endpoint
/onanimationstart

### Parameters
#### Request Body
- **onanimationstart** (Object) - the `onanimationstart` event handler

### Request Example
```json
{
  "onanimationstart": "function() { ... }"
}
```
```

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

### POST /startRendering

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/host/media/OfflineAudioContext.html

Initiates the rendering process for the OfflineAudioContext.

```APIDOC
## POST /startRendering

### Description
Starts the rendering process for the audio context.

### Method
POST

### Endpoint
/startRendering
```

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

### Get Loaded Property

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/host/event/ProgressEvent.html

Retrieves the loaded property from an event. No specific setup is required beyond having an event object.

```java
public
Object
getLoaded()
```

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

### AwtRenderingBackend Constructor

Source: https://htmlunit.org/apidocs/org/htmlunit/platform/canvas/rendering/AwtRenderingBackend.html

Initializes a new instance of the AwtRenderingBackend class.

```APIDOC
## AwtRenderingBackend Constructor

### Description
Constructor. Initializes a new instance of the AwtRenderingBackend class.

### Parameters
- **imageWidth** (int) - Required - The width of the rendering canvas.
- **imageHeight** (int) - Required - The height of the rendering canvas.
```

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

### Get Image Data

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/host/canvas/CanvasRenderingContext2D.html

Returns the ImageData object for a specified rectangular area. Requires starting x, y coordinates and width/height.

```Java
public ImageData getImageData(
                              int sx,
                              int sy,
                              int sw,
                              int sh)
```

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

### Get Top Property

Source: https://htmlunit.org/apidocs/org/htmlunit/Screen.html

Retrieves the value of the 'top' property. No specific setup is required beyond having an instance of the relevant class.

```java
public int getTop()
```

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

### Initialize MediaKeys Constructor

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/host/media/MediaKeys.html

Default constructor for the MediaKeys class. No specific setup is required beyond instantiation.

```java
public MediaKeys()
```

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

### SelectionDelegate Interface

Source: https://htmlunit.org/apidocs/org/htmlunit/html/impl/SelectionDelegate.html

The SelectionDelegate interface provides methods to get and set the start and end positions of selected text within an element.

```APIDOC
## SelectionDelegate Interface

### Description
Contains selection-related functionality used by elements. This interface defines methods for retrieving and modifying the start and end points of selected text.

### Interface
```java
public interface SelectionDelegate
extends Serializable
```

### Methods
#### getSelectionStart
```java
int getSelectionStart()
```

Returns the start position of the selected text in the owner element.

Returns:
    the start position of the selected text in the owner element

#### setSelectionStart
```java
void setSelectionStart(int selectionStart)
```

Sets the start position of the selected text in the owner element.

Parameters:
    `selectionStart` - the start position of the selected text in the owner element

#### getSelectionEnd
```java
int getSelectionEnd()
```

Returns the end position of the selected text in the owner element.

Returns:
    the end position of the selected text in the owner element

#### setSelectionEnd
```java
void setSelectionEnd(int selectionEnd)
```

Sets the end position of the selected text in the owner element.

Parameters:
    `selectionEnd` - the end position of the selected text in the owner element
```

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

### MediaDeviceInfo Constructor

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/host/media/MediaDeviceInfo.html

Initializes a new instance of the MediaDeviceInfo class.

```APIDOC
## Constructor MediaDeviceInfo

### Description
Initializes a new instance of the MediaDeviceInfo class.

### Method
public MediaDeviceInfo()

### Request Example
new MediaDeviceInfo();
```

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

### GET /navigator/plugins

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/host/class-use/PluginArray.html

Retrieves the list of plugins installed in the browser environment. Note that HtmlUnit returns an empty array as it does not support embedded objects.

```APIDOC
## GET /navigator/plugins

### Description
Returns the list of plugins available in the current browser context. In HtmlUnit, this always returns an empty array because embedded objects are not supported.

### Method
GET

### Endpoint
Navigator.getPlugins()

### Response
#### Success Response (200)
- **PluginArray** (Array) - An empty array representing the installed plugins.
```

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

### MediaKeyStatusMap Constructor

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/host/media/MediaKeyStatusMap.html

Initializes a new instance of the MediaKeyStatusMap class.

```APIDOC
## Constructor: MediaKeyStatusMap

### Description
Initializes a new instance of the MediaKeyStatusMap class.

### Signature
`public MediaKeyStatusMap()`
```

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

### Retrieve Input Type - Java

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/host/event/InputEvent.html

Use this method to get the input type of an object. No specific setup is required beyond having an instance of the object.

```java
public
Object
getInputType()
```

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

### Retrieve Data - Java

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/host/event/InputEvent.html

Use this method to get the data contained within an object. No specific setup is required beyond having an instance of the object.

```java
public
Object
getData()
```

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

### StyleMedia Constructor

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/host/css/StyleMedia.html

Initializes a new instance of the StyleMedia class.

```APIDOC
## StyleMedia Constructor

### Description
Initializes a new instance of the StyleMedia class.

### Method
```java
public StyleMedia()
```
```

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

### Get First Child Node in DOM

Source: https://htmlunit.org/apidocs/org/htmlunit/html/HtmlDomTreeWalker.html

Retrieves the first child node of the current DOM node. Useful for accessing the start of a node's children.

```java
public DomNode firstChild()

```

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

### Build Site and Package Release Artifacts

Source: https://htmlunit.org/packagingARelease.html

Generate site documentation and package the release artifacts (binary and source zip files). This command cleans the project and skips tests.

```bash
mvn -up -U clean site package -Dmaven.test.skip=true
```

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

### Get Blob Bytes by Range

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/host/file/Blob.InMemoryBackend.html

Retrieves a portion of the blob's byte data within the specified start and end positions. Useful for handling large blobs efficiently.

```java
public byte[] getBytes(int start,
                       int end)
```

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

### Constructor: Audio()

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/host/html/Audio.html

Initializes a new instance of the Audio class.

```APIDOC
## Constructor Audio()

### Description
Initializes a new instance of the Audio class.

### Method
Constructor

### Endpoint
public Audio()
```

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

### StyleMedia Constructor

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/host/css/StyleMedia.html

Initializes a new instance of the StyleMedia class. No specific setup is required beyond instantiation.

```java
public StyleMedia() 
```

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

### get Method (Integer Index)

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/host/css/CSSRuleList.html

Retrieves the property value at the given integer index, considering the starting scope. This method is required by the Scriptable interface and overrides the one in ScriptableObject.

```java
public Object get(int index,
                  org.htmlunit.corejs.javascript.Scriptable start)
```

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

### Get the Deepest Common Ancestor Container

Source: https://htmlunit.org/apidocs/org/htmlunit/html/impl/SimpleRange.html

Retrieve the deepest common ancestor node of a range's two boundary points using `getCommonAncestorContainer()`. This method is essential for understanding the hierarchical relationship between the range's start and end points.

```java
public DomNode getCommonAncestorContainer() throws DOMException
```

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

### create

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/host/dom/AbstractList.html

Constructs a new instance with an initial cache value.

```APIDOC
## create

### Description
Constructs a new instance with an initial cache value.

### Method
protected AbstractList create(DomNode parentScope, List<DomNode> initialElements)

### Parameters
- **parentScope** (DomNode) - the parent scope, on which we listen for changes.
- **initialElements** (List<DomNode>) - the initial content for the cache.

### Returns
- The newly created instance.
```

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

### Window initialize Method

Source: https://htmlunit.org/apidocs/org/htmlunit/class-use/WebWindow.html

Initializes a Window object with a WebWindow and Page.

```APIDOC
## Window.initialize(WebWindow webWindow, Page pageToEnclose)

### Description
Initializes this window.

### Method
`void`

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
N/A

#### Response Example
N/A
```

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

### Get browser version

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/host/Window.html

Gets the browser version currently used.

```java
public BrowserVersion getBrowserVersion()
```

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

### WebWindow Initialization API

Source: https://htmlunit.org/apidocs/org/htmlunit/WebClient.html

APIs for initializing WebWindows, both for specific pages and empty windows.

```APIDOC
## initialize

### Description
Initializes a new web window for JavaScript.

### Method
public void initialize(WebWindow webWindow, Page page)

### Parameters
#### Path Parameters
- **webWindow** (WebWindow) - the new WebWindow
- **page** (Page) - the page that will become the enclosing page

## initializeEmptyWindow

### Description
Initializes a new empty window for JavaScript.

### Method
public void initializeEmptyWindow(WebWindow webWindow, Page page)

### Parameters
#### Path Parameters
- **webWindow** (WebWindow) - the new WebWindow
- **page** (Page) - the page that will become the enclosing page
```

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

### Get Style Attribute Name

Source: https://htmlunit.org/apidocs/org/htmlunit/css/StyleAttributes.Definition.html

Gets the name of the style attribute.

```java
public String getAttributeName()
Gets the name of the style attribute.
```

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

### Get Host Class

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/configuration/ClassConfiguration.html

Gets the JavaScript host object class.

```APIDOC
## GET /api/classconfiguration/getHostClass

### Description
Gets the class of the JavaScript host object.

### Method
GET

### Endpoint
/api/classconfiguration/getHostClass

### Response
#### Success Response (200)
- **hostClass** (Class<? extends HtmlUnitScriptable>) - The class of the JavaScript host object.
```

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

### Initialize WebGLProgram Instance

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/host/canvas/WebGLProgram.html

Use this constructor to create a new instance of WebGLProgram. No specific setup is required beyond standard Java environment.

```java
public WebGLProgram()
```

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

### Event Initialization Methods

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/configuration/class-use/JsxFunction.html

Documentation for various event initialization methods.

```APIDOC
## Event Initialization Methods

### Description
Methods for initializing different types of DOM events.

### Methods

#### initCustomEvent(String type, boolean bubbles, boolean cancelable, Object detail)
- **Description**: Initializes a custom event.
- **Parameters**:
  - **type** (String) - The event type.
  - **bubbles** (boolean) - Whether the event bubbles.
  - **cancelable** (boolean) - Whether the event is cancelable.
  - **detail** (Object) - Custom data for the event.
- **Return Type**: void

#### initEvent(String type, boolean bubbles, boolean cancelable)
- **Description**: Initializes a generic event.
- **Parameters**:
  - **type** (String) - The event type.
  - **bubbles** (boolean) - Whether the event bubbles.
  - **cancelable** (boolean) - Whether the event is cancelable.
- **Return Type**: void

#### initKeyboardEvent(String type, boolean bubbles, boolean cancelable, Object view, String key, int location, boolean ctrlKey, boolean altKey, boolean shiftKey, boolean metaKey)
- **Description**: Initializes a keyboard event.
- **Parameters**:
  - **type** (String) - The event type.
  - **bubbles** (boolean) - Whether the event bubbles.
  - **cancelable** (boolean) - Whether the event is cancelable.
  - **view** (Object) - The window associated with the event.
  - **key** (String) - The key value.
  - **location** (int) - The key location.
  - **ctrlKey** (boolean) - Ctrl key pressed.
  - **altKey** (boolean) - Alt key pressed.
  - **shiftKey** (boolean) - Shift key pressed.
  - **metaKey** (boolean) - Meta key pressed.
- **Return Type**: void

#### initMessageEvent(String type, boolean canBubble, boolean cancelable, Object data, String origin, String lastEventId, Window source, Object ports)
- **Description**: Initializes a message event.
- **Parameters**:
  - **type** (String) - The event type.
  - **canBubble** (boolean) - Whether the event can bubble.
  - **cancelable** (boolean) - Whether the event is cancelable.
  - **data** (Object) - The event data.
  - **origin** (String) - The origin of the message.
  - **lastEventId** (String) - The last event ID.
  - **source** (Window) - The source window.
  - **ports** (Object) - Transferable objects.
- **Return Type**: void

#### initMouseEvent(String type, boolean bubbles, boolean cancelable, Object view, int detail, int screenX, int screenY, int clientX, int clientY, boolean ctrlKey, boolean altKey, boolean shiftKey, boolean metaKey, int button, Object relatedTarget)
- **Description**: Initializes a mouse event.
- **Parameters**:
  - **type** (String) - The event type.
  - **bubbles** (boolean) - Whether the event bubbles.
  - **cancelable** (boolean) - Whether the event is cancelable.
  - **view** (Object) - The window associated with the event.
  - **detail** (int) - The mouse click count.
  - **screenX** (int) - Screen X coordinate.
  - **screenY** (int) - Screen Y coordinate.
  - **clientX** (int) - Client X coordinate.
  - **clientY** (int) - Client Y coordinate.
  - **ctrlKey** (boolean) - Ctrl key pressed.
  - **altKey** (boolean) - Alt key pressed.
  - **shiftKey** (boolean) - Shift key pressed.
  - **metaKey** (boolean) - Meta key pressed.
  - **button** (int) - Mouse button.
  - **relatedTarget** (Object) - Related target element.
- **Return Type**: void

#### initUIEvent(String type, boolean bubbles, boolean cancelable, Object view, int detail)
- **Description**: Initializes a UI event.
- **Parameters**:
  - **type** (String) - The event type.
  - **bubbles** (boolean) - Whether the event bubbles.
  - **cancelable** (boolean) - Whether the event is cancelable.
  - **view** (Object) - The window associated with the event.
  - **detail** (int) - The UI event detail.
- **Return Type**: void
```

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

### Setting the Start of a Range

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/host/dom/Range.html

Methods to define the starting point of a range. setStart allows specifying a node and an offset, while setStartAfter and setStartBefore position the start relative to a given node.

```java
public void setStart(Node refNode, int offset)
```

```java
public void setStartAfter(Node refNode)
```

```java
public void setStartBefore(Node refNode)
```

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

### Configure HTTP Proxy with Credentials

Source: https://htmlunit.org/webclient.html

Initialize WebClient with HTTP proxy host and port, then set username and password for proxy authentication using DefaultCredentialsProvider.

```java
@Test
public void homePage_proxy() throws Exception {
    try (final WebClient webClient = new WebClient(BrowserVersion.FIREFOX, PROXY_HOST, PROXY_PORT)) {

        //set proxy username and password 
        final DefaultCredentialsProvider credentialsProvider = (DefaultCredentialsProvider) webClient.getCredentialsProvider();
        credentialsProvider.addCredentials("username", "password");

        final HtmlPage page = webClient.getPage("https://www.htmlunit.org");
        Assert.assertEquals("HtmlUnit - Welcome to HtmlUnit", page.getTitleText());
    }
}
```

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

### Get JavaScript Property Name

Source: https://htmlunit.org/apidocs/org/htmlunit/css/StyleAttributes.Definition.html

Gets the name of the JavaScript property for this attribute.

```java
public String getPropertyName()
Gets the name of the JavaScript property for this attribute.
```

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

### MediaKeySystemAccess Constructor

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/host/media/MediaKeySystemAccess.html

Details of the MediaKeySystemAccess constructor.

```APIDOC
## Constructor Detail
### MediaKeySystemAccess
```java
public MediaKeySystemAccess()
```
```

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

### Get JavaScript Constructor

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/configuration/ClassConfiguration.html

Gets the JavaScript constructor method within the host class.

```APIDOC
## GET /api/classconfiguration/getJsConstructor

### Description
Gets the JavaScript constructor method in `getHostClass()`.

### Method
GET

### Endpoint
/api/classconfiguration/getJsConstructor

### Response
#### Success Response (200)
- **jsConstructor** (Map.Entry<String, Member>) - The JavaScript constructor method and its associated member.
```

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

### apply Method

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/polyfill/Polyfill.html

Compiles the script if needed and executes it to set up the context.

```APIDOC
## POST /api/polyfill/apply

### Description
Compiles the script if needed and executes it to set up the context.

### Method
POST

### Endpoint
`/api/polyfill/apply`

### Parameters
#### Request Body
- **context** (org.htmlunit.corejs.javascript.Context) - Required - The JavaScript context.
- **scriptable** (org.htmlunit.corejs.javascript.Scriptable) - Required - The scriptable object.
```

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

### HtmlUnit JavaScript error example

Source: https://htmlunit.org/submittingJSBugs.html

Example of an EcmaError indicating a TypeError in JavaScript execution.

```text
org.htmlunit.corejs.javascript.EcmaError: TypeError: Cannot call method "getAttribute" of undefined
(http://download.dojotoolkit.org/release-1.4.0/dojo-release-1.4.0/dojo/dojo.js#16(eval)#16)
```

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

### Example of Obscure Abbreviation

Source: https://htmlunit.org/codingConventions.html

An example of poor naming convention using non-standard abbreviations.

```java
cob.getTrh()
```

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

### Window Media and Navigation Methods

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/host/Window.html

Methods for handling media queries and opening new windows.

```APIDOC
## matchMedia

### Description
Returns a new MediaQueryList object representing the parsed results of the specified media query string.

### Parameters
#### Query Parameters
- **mediaQueryString** (String) - Required - The media query string to parse.

### Response
- **MediaQueryList** - The resulting MediaQueryList object.

## open

### Description
Opens a new window.

### Parameters
#### Request Body
- **url** (Object) - Required - The URL to open.
- **name** (Object) - Optional - The name of the window.
- **features** (Object) - Optional - Window features.
- **replace** (Object) - Optional - Whether to replace the current entry in the history.

### Response
- **WindowProxy** - The proxy for the newly opened window.
```

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

### Initialize FileSystemDirectoryReader

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/host/file/FileSystemDirectoryReader.html

Constructor for the FileSystemDirectoryReader class.

```java
public FileSystemDirectoryReader()
```

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

### Get Frame Element

Source: https://htmlunit.org/apidocs/org/htmlunit/html/FrameWindow.html

Gets the DOM node of the frame or iframe element that contains this window.

```java
public BaseFrameElement getFrameElement()
```

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

### Initialize InputDeviceCapabilities

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/host/media/InputDeviceCapabilities.html

Constructor for the InputDeviceCapabilities class.

```java
public InputDeviceCapabilities()
```

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

### Install NativeFunctionToStringFunction Fix

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/NativeFunctionToStringFunction.html

Installs the wrapper to replace the native toString function on the Function prototype.

```java
public static void installFix(org.htmlunit.corejs.javascript.Scriptable window,
                              BrowserVersion browserVersion)
```

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

### Get Default Computed Value

Source: https://htmlunit.org/apidocs/org/htmlunit/css/StyleAttributes.Definition.html

Gets the default value for this attribute based on the provided browser version.

```java
public String getDefaultComputedValue(BrowserVersion browserVersion)
Parameters:
    browserVersion - the browser version
Returns:
    the default value for this attribute
```

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

### AudioDestinationNode Constructor

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/host/media/AudioDestinationNode.html

Initializes a new instance of the AudioDestinationNode class.

```APIDOC
## Constructor AudioDestinationNode

### Description
Creates a new instance of the AudioDestinationNode.

### Method
Constructor

### Request Example
new AudioDestinationNode();
```

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

### Initialize MediaKeyStatusMap

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/host/media/MediaKeyStatusMap.html

Constructor for the MediaKeyStatusMap class.

```java
public MediaKeyStatusMap()
```

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

### Constructor AudioBufferSourceNode

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/host/media/AudioBufferSourceNode.html

Initializes a new instance of the AudioBufferSourceNode class.

```APIDOC
## Constructor AudioBufferSourceNode

### Description
Creates a new instance of the AudioBufferSourceNode.

### Method
Constructor

### Request Example
new AudioBufferSourceNode();
```

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

### Set Selection Start Position

Source: https://htmlunit.org/apidocs/org/htmlunit/html/HtmlTextArea.html

Sets the start position of the selected text. Specified by 'setSelectionStart' in interface 'SelectableTextInput'.

```Java
public void setSelectionStart(int selectionStart)
```

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

### Configure SOCKS Proxy with Credentials

Source: https://htmlunit.org/webclient.html

Initialize WebClient and configure SOCKS proxy settings using ProxyConfig, including host, port, and specifying it as a SOCKS proxy. Credentials can be added if required.

```java
@Test
public void homePage_proxy() throws Exception {
    try (final WebClient webClient = new WebClient(BrowserVersion.FIREFOX) {
        // socks proxy / the true as last parameter marks this as socks proxy
        webClient.getOptions().setProxyConfig(new ProxyConfig(SOCKS_PROXY_HOST, SOCKS_PROXY_PORT, null, true));

        //set proxy username and password if required
        final DefaultCredentialsProvider credentialsProvider = (DefaultCredentialsProvider) webClient.getCredentialsProvider();
        credentialsProvider.addSocksCredentials("username", "password", SOCKS_PROXY_HOST, SOCKS_PROXY_PORT);

        final HtmlPage page = webClient.getPage("https://www.htmlunit.org");
        Assert.assertEquals("HtmlUnit - Welcome to HtmlUnit", page.getTitleText());
    }
}
```

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

### Get Src Property of HTMLScriptElement

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/host/html/HTMLScriptElement.html

Retrieves the value of the 'src' property from an HTMLScriptElement. This is used to get the URL of an external script.

```java
public
String
getSrc()
```

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

### Get Element From Point

Source: https://htmlunit.org/apidocs/org/htmlunit/html/HtmlPage.html

Internal API to get the HTML element at the specified x and y pixel coordinates. Subject to change.

```java
public HtmlElement getElementFromPoint(int x,
                                       int y)
```

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

### Initialize PushSubscriptionOptions

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/host/PushSubscriptionOptions.html

Constructor for the PushSubscriptionOptions class.

```java
public PushSubscriptionOptions()
```

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

### Initialize DownloadingAttachmentHandler

Source: https://htmlunit.org/apidocs/org/htmlunit/attachment/DownloadingAttachmentHandler.html

Constructors for initializing the handler with either a custom directory or the system temporary directory.

```java
public	DownloadingAttachmentHandler(Path	downloadFolder)
                             throws IOException
```

```java
public	DownloadingAttachmentHandler()
                             throws IOException
```

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

### Get Proxy Auto-Config URL

Source: https://htmlunit.org/apidocs/org/htmlunit/ProxyConfig.html

Retrieves the URL for the proxy auto-configuration script. Use this to get the location of a PAC file.

```java
public
StringgetProxyAutoConfigUrl()
```

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

### Get Latitude - Geolocation

Source: https://htmlunit.org/apidocs/org/htmlunit/WebClientOptions.Geolocation.html

Retrieves the latitude coordinate in decimal degrees. Use this method to get the north-south position of the geolocation.

```java
public double getLatitude()
```

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

### BeforeInstallPromptEvent Class

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/host/event/BeforeInstallPromptEvent.html

Details about the BeforeInstallPromptEvent class, its constructors, and methods.

```APIDOC
## Class: BeforeInstallPromptEvent

### Description
A JavaScript object for `BeforeInstallPromptEvent`.

### Class Hierarchy
`java.lang.Object` -> `org.htmlunit.corejs.javascript.ScriptableObject` -> `org.htmlunit.javascript.HtmlUnitScriptable` -> `org.htmlunit.javascript.host.event.Event` -> `org.htmlunit.javascript.host.event.BeforeInstallPromptEvent`

### Constructors
#### BeforeInstallPromptEvent()
- Description: Default constructor for BeforeInstallPromptEvent.

### Methods
#### jsConstructor(String type, org.htmlunit.corejs.javascript.ScriptableObject details)
- Description: JavaScript constructor for BeforeInstallPromptEvent.
- Parameters:
  - **type** (String) - Required - The type of the event.
  - **details** (org.htmlunit.corejs.javascript.ScriptableObject) - Required - The details of the event.
- Returns: void

### Fields Inherited
- From `org.htmlunit.javascript.host.event.Event`: `ALT_MASK`, `AT_TARGET`, `BUBBLING_PHASE`, `CAPTURING_PHASE`, etc.
- From `org.htmlunit.corejs.javascript.ScriptableObject`: `CONST`, `DONTENUM`, `EMPTY`, etc.
- From `org.htmlunit.corejs.javascript.Scriptable`: `NOT_FOUND`

### Implemented Interfaces
`Serializable`, `Cloneable`, `org.htmlunit.corejs.javascript.ConstProperties`, `org.htmlunit.corejs.javascript.debug.DebuggableObject`, `org.htmlunit.corejs.javascript.Scriptable`, `org.htmlunit.corejs.javascript.SymbolScriptable`
```

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

### Get Indexed Property

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/host/html/HTMLSelectElement.html

Retrieves an indexed property, typically an option, from the select element. Implements the get method from the Scriptable interface.

```java
public
Object
get(int
index,
org.htmlunit.corejs.javascript.Scriptable
start)
```

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

### Initialize TextPage instance

Source: https://htmlunit.org/apidocs/org/htmlunit/TextPage.html

Constructor for creating a new TextPage instance.

```java
public TextPage(WebResponse webResponse,
                WebWindow enclosingWindow)
```

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

### Audio Constructor

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/host/html/Audio.html

Initializes a new instance of the Audio class.

```java
public
Audio() {
}
```

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

### Set Selection Start Position

Source: https://htmlunit.org/apidocs/org/htmlunit/html/impl/SelectionDelegate.html

Sets the start position of the selected text in the owner element. This method is part of the SelectionDelegate interface.

```java
void setSelectionStart(int selectionStart)
```

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

### Configure HTTP Proxy with Specific Credentials and Host

Source: https://htmlunit.org/webclient.html

Initialize WebClient with HTTP proxy host and port, then set specific username, password, host, and port for proxy authentication.

```java
@Test
public void homePage_proxy() throws Exception {
    try (final WebClient webClient = new WebClient(BrowserVersion.FIREFOX, PROXY_HOST, PROXY_PORT)) {

        //set proxy username and password 
        final DefaultCredentialsProvider credentialsProvider = (DefaultCredentialsProvider) webClient.getCredentialsProvider();
        credentialsProvider.addCredentials("username", "password", PROXY_HOST, PROXY_PORT);

        final HtmlPage page = webClient.getPage("https://www.htmlunit.org");
        Assert.assertEquals("HtmlUnit - Welcome to HtmlUnit", page.getTitleText());
    }
}
```

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

### JavaScript Name Change Example

Source: https://htmlunit.org/apidocs/org/htmlunit/html/FormFieldWithNameHistory.html

Example showing how a form field name can be updated via JavaScript while maintaining original name context.

```javascript
  theForm.foo.name = 'newName';  
  theForm.foo.value = 'some value';  
```

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

### Initialize Presentation Class

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/host/media/presentation/Presentation.html

Default constructor for the Presentation class.

```java
public Presentation()
```

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

### Get Height Property of HTMLTableCellElement

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/host/html/HTMLTableCellElement.html

Retrieves the value of the 'height' property of the HTMLTableCellElement. Note: This method is named getWidth_js in the source but described as getting height.

```java
public String getHeight_js()

```

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

### Get Node Name for DocumentType

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/host/dom/DocumentType.html

Gets the JavaScript property 'nodeName' for the current DocumentType node. This typically returns the document type's name.

```java
String getNodeName()
```

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

### Constructor: NoOpRenderingBackend

Source: https://htmlunit.org/apidocs/org/htmlunit/platform/canvas/rendering/NoOpRenderingBackend.html

Initializes a new instance of the NoOpRenderingBackend class.

```APIDOC
## Constructor: NoOpRenderingBackend(int imageWidth, int imageHeight)

### Description
Constructor for the `NoOpRenderingBackend`.

### Parameters
* **imageWidth** (int) - The width of the image.
* **imageHeight** (int) - The height of the image.
```

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

### FileList Constructors

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/host/file/FileList.html

Provides details on how to instantiate the FileList class.

```APIDOC
## FileList Constructors

### FileList()

Creates an instance.

### FileList(File[] array)

Creates a new instance.

Parameters:
- **array** (File[]) - the array of files
```

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

### Get Speed - Geolocation

Source: https://htmlunit.org/apidocs/org/htmlunit/WebClientOptions.Geolocation.html

Retrieves the current speed in meters per second. Returns null if the speed is unavailable. Use this to get the current velocity of the device.

```java
public Double getSpeed()
```

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

### Register Inline Snippet Parsing Start

Source: https://htmlunit.org/apidocs/org/htmlunit/html/HtmlPage.html

Internal API called by the HTML parser to indicate the start of parsing an inline HTML snippet. Subject to change.

```java
public void registerInlineSnippetParsingStart()
```

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

### BeforeInstallPromptEvent Constructor

Source: https://htmlunit.org/apidocs/org/htmlunit/javascript/host/event/BeforeInstallPromptEvent.html

Initializes a new instance of the BeforeInstallPromptEvent class.

```java
public BeforeInstallPromptEvent()
```
Tokens:
Raw