JsObject (JxBrowser 7.17 API)

All Known Subinterfaces:

JsFunction, JsPromise
```
public interface JsObject
```
A JavaScript object.
Allows accessing the object's properties and calling its functions. The JavaScript object is alive while the web page where the object was created is loaded. When the web page is unloaded, all the JavaScript objects will be automatically disposed. Access to the already disposed JavaScript object will lead to the IllegalStateException.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`<T> T`	`call(java.lang.String methodName, java.lang.Object... args)` Executes the function with the given `methodName` and the `args` in the JavaScript object.
`Frame`	`frame()` Returns the `Frame` instance of this JavaScript object.
`boolean`	`hasProperty(java.lang.String name)` Checks whether the JavaScript object has a property or function with the given `name`.
`java.util.List<java.lang.String>`	`ownPropertyNames()` Returns an immutable list of the names of the properties of this JavaScript object, excluding properties from the prototype objects.
`<T> java.util.Optional<T>`	`property(java.lang.String name)` Returns an `Optional` describing the value of the JavaScript object's property with the given `name` or an empty `Optional` if there is no such property or the value is undefined.
`java.util.List<java.lang.String>`	`propertyNames()` Returns an immutable list of the names of the properties of this JavaScript object, including properties from the prototype objects.
`boolean`	`putProperty(java.lang.String name, java.lang.Object value)` Creates a new property with the given `name` or updates the existing one in the current JavaScript object and returns `true` if the property with the given `name` was created or updated successfully.
`boolean`	`removeProperty(java.lang.String name)` Removes a property with the given `name` in the JavaScript object and returns `true` if the property was successfully removed.

- Method Detail
  - frame
```
Frame frame()
```
    Returns the Frame instance of this JavaScript object.
    
    Since:
    
    7.6
  - propertyNames
```
java.util.List<java.lang.String> propertyNames()
```
    Returns an immutable list of the names of the properties of this JavaScript object, including properties from the prototype objects.
    
    Returns:
    
    a list of the names of the properties of this JavaScript object or an empty list if the object does not have any properties
    
    Throws:
    
    java.lang.IllegalStateException - when the JavaScript object is already disposed or invalid
  - ownPropertyNames
```
java.util.List<java.lang.String> ownPropertyNames()
```
    Returns an immutable list of the names of the properties of this JavaScript object, excluding properties from the prototype objects.
    
    Returns:
    
    a list of the names of the own properties of this JavaScript object or an empty list if the object does not have any own properties
    
    Throws:
    
    java.lang.IllegalStateException - when the JavaScript object is already disposed or invalid
  - hasProperty
```
boolean hasProperty(java.lang.String name)
```
    Checks whether the JavaScript object has a property or function with the given name.
    
    Parameters:
    
    name - a string that represents the name of the property or function
    
    Returns:
    
    true if object has property with the given name
    
    Throws:
    
    java.lang.IllegalArgumentException - when name is empty or blank
    
    java.lang.IllegalStateException - when the JavaScript object is already disposed or invalid
  - property
```
<T> java.util.Optional<T> property(java.lang.String name)
```
    Returns an Optional describing the value of the JavaScript object's property with the given name or an empty Optional if there is no such property or the value is undefined. The value can be one of the following types: java.lang.Boolean, java.lang.Double, java.lang.String, JsObject, or EventTarget.
    The following rules are used to convert JavaScript into Java types:
    - JavaScript numbers are converted to java.lang.Double
    - JavaScript string to java.lang.String
    - JavaScript boolean to java.lang.Boolean
    - JavaScript null and undefined to null
    - JavaScript objects get wrapped as JsObject
    - JavaScript DOM Node objects get wrapped as both JsObject and EventTarget
    Type Parameters:
    
    T - one of the following types: java.lang.Boolean, java.lang.Double, java.lang.String, JsObject, or EventTarget
    
    Parameters:
    
    name - a string that represents the name of the property or function
    
    Returns:
    
    an Optional describing the value of the JavaScript object's property with the given name. If the object does not have this property or the property value is null or undefined, the method returns an empty Optional
    
    Throws:
    
    java.lang.IllegalArgumentException - when name is empty or blank
    
    java.lang.IllegalStateException - when the JavaScript object is already disposed or invalid
    
    See Also:
    
    hasProperty(String)
  - putProperty
```
boolean putProperty(java.lang.String name,
                    java.lang.Object value)
```
    Creates a new property with the given name or updates the existing one in the current JavaScript object and returns true if the property with the given name was created or updated successfully.
    The value can be one of the following types: java.lang.Boolean, java.lang.Double, java.lang.String, JsObject, or java.lang.Object.
    As the value you can use an instance of the java.lang.Object. In this case the Java object will be automatically converted/wrapped into a JavaScript object. It allows injecting Java objects into JavaScript and invoking public methods of the injected Java object from JavaScript code. For security reasons, only public methods annotated with JsAccessible or declared in the class annotated with JsAccessible can be accessed from JavaScript. The Java object's fields are not accessible. If JavaScript calls a method that does not exist in the injected Java object or this method is not public or annotated, then the call will throw a JavaScript exception.
    The following rules are used to convert Java into JavaScript types:
    - java.lang.Number is converted to JavaScript Number
    - java.lang.String to JavaScript string
    - java.lang.Boolean to JavaScript boolean
    - Java null to JavaScript null
    - JsObject to an appropriate JavaScript object
    - EventTarget to an appropriate JavaScript DOM Node object
    - java.lang.Object will be wrapped into a JavaScript object
    Parameters:
    
    name - a string that represents the property name
    
    value - a new value associated with the property with the given name
    
    Returns:
    
    true when property was created or updated successfully
    
    Throws:
    
    java.lang.IllegalArgumentException - when name is empty or blank
    
    java.lang.IllegalArgumentException - when value is a JsObject from a different web page or frame
    
    java.lang.IllegalStateException - when the JavaScript object is already disposed or invalid
  - removeProperty
```
boolean removeProperty(java.lang.String name)
```
    Removes a property with the given name in the JavaScript object and returns true if the property was successfully removed. Once you remove the property, it will not be available in the current JavaScript object anymore.
    
    Parameters:
    
    name - a string that represents the name of the property or function
    
    Returns:
    
    true if the property was successfully removed
    
    Throws:
    
    java.lang.IllegalArgumentException - when name is empty or blank
    
    java.lang.IllegalStateException - when the JavaScript object is already disposed or invalid
  - call
```
<T> T call(java.lang.String methodName,
           java.lang.Object... args)
```
    Executes the function with the given methodName and the args in the JavaScript object. This method blocks current thread execution until the function finishes its execution. If the function raises an exception, then JsException with an error message that describes the reason of the exception will be thrown. Same error message will be printed in JavaScript Console.
    
    Type Parameters:
    
    T - the result of the JavaScript function execution
    
    Parameters:
    
    methodName - a string that represents a function name
    
    args - the list of input arguments. The following types are supported: java.lang.Boolean, java.lang.Double, java.lang.String, JsObject, or java.lang.Object
    
    Throws:
    
    JsException - when an error occurs during function execution
    
    java.lang.IllegalArgumentException - when methodName is empty or blank
    
    java.lang.IllegalArgumentException - when args contains an unsupported type
    
    java.lang.IllegalStateException - when the JavaScript object is already disposed or invalid

Interface JsObject

Method Summary

Method Detail

frame

propertyNames

ownPropertyNames

hasProperty

property

putProperty

removeProperty

call