JSObject (JxBrowser 6.23.1 API)

java.lang.Object
- com.teamdev.jxbrowser.chromium.JSValue
- - com.teamdev.jxbrowser.chromium.JSObject

Direct Known Subclasses:

JSArray, JSBooleanObject, JSFunction, JSNumberObject, JSStringObject
```
public class JSObject
extends JSValue
```
Represents a JavaScript object. Provides access to the object's properties and functions. JavaScript object is alive until its JavaScript execution context exist. Once execution context is disposed, all JavaScript objects available in scope of this context will be automatically disposed. If you try to access already disposed object, you will get IllegalStateException.
表示一个JavaScript对象。提供对对象的属性和功能的访问。在存在JavaScript执行上下文之前，JavaScript对象一直处于活动状态。处置执行上下文后，将自动处置该上下文范围内可用的所有JavaScript对象。如果尝试访问已处置的对象，则将得到IllegalStateException。

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Object`	`asJavaObject()` Casts the current JavaScript object to `java.lang.Object` type. 将当前的JavaScript对象转换为java.lang.Object类型。
`JSObject`	`asObject()` Casts the current JavaScript object to `JSObject` type. 将当前的JavaScript对象转换为JSObject类型。
`JSContext`	`getContext()` Returns JavaScript execution context associated with the current JavaScript object. 返回与当前JavaScript对象关联的JavaScript执行上下文。
`java.util.List<java.lang.String>`	`getOwnPropertyNames()` Returns a list containing the names of the properties of this object, excluding properties from prototype objects. 返回一个列表，其中包含此对象的属性名称，但原型对象中的属性除外。
`JSValue`	`getProperty(java.lang.String name)` Returns value of specified JavaScript object's property with the given `name`. 返回具有给定名称的指定JavaScript对象的属性的值。
`java.util.List<java.lang.String>`	`getPropertyNames()` Returns a list containing the names of the properties of this object, including properties from prototype objects. 返回一个列表，其中包含该对象的属性名称，包括原型对象的属性。
`boolean`	`hasProperty(java.lang.String name)` Checks whether JavaScript object has property or function with the given `name`. 检查JavaScript对象是否具有具有给定名称的属性或函数。
`boolean`	`isJavaObject()` Indicates whether JavaScript value is a Java object. 指示JavaScript值是否为Java对象。
`boolean`	`isObject()` Indicates whether JavaScript value is an object. 指示JavaScript值是否为对象。
`boolean`	`removeProperty(java.lang.String name)` Removes property with the given `name` in the current JavaScript object and returns `true` if the property was successfully removed. 在当前JavaScript对象中删除具有给定名称的属性，如果成功删除该属性，则返回true。
`boolean`	`setProperty(int index, java.lang.Object value)` Sets a new property with the given `index` or modifies existing one in the current JavaScript object and returns `true` if the property with the given `index` was created or updated successfully. 使用给定索引设置一个新属性，或修改当前JavaScript对象中现有的索引，如果具有给定索引的属性已成功创建或更新，则返回true。
`boolean`	`setProperty(java.lang.String name, java.lang.Object value)` Sets a new property with the given `name` or modifies existing one in the current JavaScript object and returns `true` if the property with the given `name` was created or updated successfully. 使用给定名称设置新属性或修改当前JavaScript对象中的现有属性，如果具有给定名称的属性已成功创建或更新，则返回true。
`java.lang.String`	`toJSONString()` Returns text representation of JavaScript object. 返回JavaScript对象的文本表示形式。
`java.lang.String`	`toString()`

Methods inherited from class com.teamdev.jxbrowser.chromium.JSValue
asArray, asBoolean, asBooleanObject, asFunction, asNumber, asNumberObject, asString, asStringObject, getBooleanValue, getNumberValue, getStringValue, isArray, isBoolean, isBooleanObject, isFunction, isNull, isNumber, isNumberObject, isString, isStringObject, isUndefined

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - getPropertyNames
```
public java.util.List<java.lang.String> getPropertyNames()
```
    Returns a list containing the names of the properties of this object, including properties from prototype objects.
    返回一个列表，其中包含该对象的属性名称，包括原型对象的属性。
    
    Returns:
    
    a list containing the names of the properties of this object. 包含此对象属性名称的列表。
    
    Throws:
    
    java.lang.IllegalStateException - when object is already disposed or invalid.
  - getOwnPropertyNames
```
public java.util.List<java.lang.String> getOwnPropertyNames()
```
    Returns a list containing the names of the properties of this object, excluding properties from prototype objects.
    返回一个列表，其中包含此对象的属性名称，但原型对象中的属性除外。
    
    Returns:
    
    a list containing the names of the own properties of this object. 一个包含此对象自身属性名称的列表。
    
    Throws:
    
    java.lang.IllegalStateException - when object is already disposed or invalid.
  - hasProperty
```
public boolean hasProperty(java.lang.String name)
```
    Checks whether JavaScript object has property or function with the given name.
    检查JavaScript对象是否具有具有给定名称的属性或函数。
    
    Parameters:
    
    name - string that represents name of the property or function. Cannot be null or empty. -表示属性或函数名称的字符串。不能为空。
    
    Returns:
    
    true if object has property with given name. 如果对象具有给定的属性。
    
    Throws:
    
    java.lang.IllegalArgumentException - when name is null or empty.
    
    java.lang.IllegalStateException - when object is already disposed or invalid.
  - getProperty
```
public JSValue getProperty(java.lang.String name)
```
    Returns value of specified JavaScript object's property with the given name. The name parameter represents name of the current JavaScript object property or function.
    返回具有给定名称的指定JavaScript对象的属性的值。 name参数表示当前JavaScript对象属性或函数的名称。
    
    Parameters:
    
    name - string that represents name of the property or function. Cannot be null or empty. -表示属性或函数名称的字符串。不能为空。
    
    Returns:
    
    value of the JavaScript object's property with the given name. If object doesn't have this key, the return value represent 'undefined' value. See JSValue.isUndefined(). 具有给定的JavaScript对象属性的值。如果对象没有此键，则返回值表示“未定义”值。请参阅。
    
    Throws:
    
    java.lang.IllegalArgumentException - when name is null or empty.
    
    java.lang.IllegalStateException - when object is already disposed or invalid.
  - setProperty
```
public boolean setProperty(java.lang.String name,
                           java.lang.Object value)
```
    Sets a new property with the given name or modifies existing one in the current JavaScript object and returns true if the property with the given name was created or updated successfully.
    The name parameter represents JavaScript object's property name. Via the property name you can access its value. The value can be one of the following types: String, Boolean, Integer, Long, Short, Byte, Double, Float, Object[], int, boolean, long, short, byte, double, float, Object, JSONString, JSFunctionCallback.
    
    As a property value you can set an instance of java.lang.Object type. In this case the Java object will be automatically converted/wrapped into JavaScript object. You can access and invoke all Java object's public methods and fields (including the inherited ones) directly from JavaScript code.
    
    Important security note: injecting Java objects is a powerful feature that might present a security risk for your application. JavaScript code can access public fields and methods of the injected Java object including Java Reflection API (e.g. Object.getClass() method). An untrusted JavaScript code on the loaded web page could allow an attacker to execute any Java code with permissions of Java process. For example, if you inject File object into JavaScript code, JavaScript will get access to the local file system.
    
    使用给定名称设置新属性或修改当前JavaScript对象中的现有属性，如果具有给定名称的属性已成功创建或更新，则返回true。 name参数表示JavaScript对象的属性名称。通过属性名称，您可以访问其值。该值可以是以下类型之一：字符串，布尔值，整数，长整数，短整数，字节，双精度，浮点数，对象[]，整数，布尔值，长整数，短整数，字节，双精度数，浮点数，对象，JSONString，JSFunctionCallback。作为属性值，您可以设置java.lang.Object类型的实例。在这种情况下，Java对象将自动转换/包装为JavaScript对象。您可以直接从JavaScript代码访问和调用所有Java对象的公共方法和字段（包括继承的）。重要的安全说明：注入Java对象是一项强大的功能，可能会给您的应用程序带来安全风险。 JavaScript代码可以访问注入的Java对象的公共字段和方法，包括Java Reflection API（例如Object.getClass（）方法）。加载的网页上不受信任的JavaScript代码可能使攻击者能够在Java进程的许可下执行任何Java代码。例如，如果将File对象注入JavaScript代码，则JavaScript将可以访问本地文件系统。
    
    Parameters:
    
    name - string that represents name of the property. Cannot be null or empty. -代表属性名称的字符串。不能为空。
    
    value - a new value associated with the property with the given name. Cannot be null or JSObject with a different JavaScript context. -与具有给定的属性相关联的新值。不能为或具有其他JavaScript上下文。
    
    Returns:
    
    true when property with name was created or updated successfully. 创建或更新属性成功的时间。
    
    Throws:
    
    java.lang.IllegalArgumentException - when name is null or empty.
    
    java.lang.IllegalArgumentException - when value is null or represents JSObject with a different JavaScript context.
    
    java.lang.IllegalStateException - when object is already disposed or invalid.
  - setProperty
```
public boolean setProperty(int index,
                           java.lang.Object value)
```
    Sets a new property with the given index or modifies existing one in the current JavaScript object and returns true if the property with the given index was created or updated successfully.
    The index parameter represents JavaScript object's property index. Via the property index you can access its value. The value can be one of the following types: String, Boolean, Integer, Long, Short, Byte, Double, Float, Object[], int, boolean, long, short, byte, double, float, Object, JSONString, JSFunctionCallback.
    
    As a property value you can set an instance of java.lang.Object type. In this case the Java object will be automatically converted/wrapped into JavaScript object. You can call Java object's public methods directly from JavaScript code.
    
    使用给定索引设置一个新属性，或修改当前JavaScript对象中现有的索引，如果具有给定索引的属性已成功创建或更新，则返回true。 index参数代表JavaScript对象的属性索引。通过属性索引，您可以访问其值。该值可以是以下类型之一：字符串，布尔值，整数，长整数，短整数，字节，双精度，浮点数，对象[]，整数，布尔值，长整数，短整数，字节，双精度数，浮点数，对象，JSONString，JSFunctionCallback。作为属性值，您可以设置java.lang.Object类型的实例。在这种情况下，Java对象将自动转换/包装为JavaScript对象。您可以直接从JavaScript代码调用Java对象的公共方法。
    
    Parameters:
    
    index - int that represents index of the property. -表示属性索引的int。
    
    value - a new value associated with the property with the given index. Cannot be null or JSObject with a different JavaScript context. -与具有给定的属性相关联的新值。不能为或具有其他JavaScript上下文。
    
    Returns:
    
    true when property with index was created or updated successfully. 创建或更新属性成功的时间。
    
    Throws:
    
    java.lang.IllegalArgumentException - when index is negative.
    
    java.lang.IllegalArgumentException - when value is null or represents JSObject with a different JavaScript context.
    
    java.lang.IllegalStateException - when object is already disposed or invalid.
    
    Since:
    
    6.7
  - removeProperty
```
public boolean removeProperty(java.lang.String name)
```
    Removes property with the given name in the current JavaScript object and returns true if the property was successfully removed. Once you remove key, it will not be available in the current JavaScript object anymore.
    在当前JavaScript对象中删除具有给定名称的属性，如果成功删除该属性，则返回true。删除密钥后，该密钥将不再在当前的JavaScript对象中可用。
    
    Parameters:
    
    name - string that represents name of the property or function. Cannot be null or empty. -表示属性或函数名称的字符串。不能为空。
    
    Returns:
    
    true if the property was successfully removed. 如果该属性已成功删除。
    
    Throws:
    
    java.lang.IllegalArgumentException - when name is null or empty.
    
    java.lang.IllegalStateException - when object is already disposed or invalid.
  - getContext
```
public JSContext getContext()
```
    Returns JavaScript execution context associated with the current JavaScript object.
    返回与当前JavaScript对象关联的JavaScript执行上下文。
    
    Returns:
    
    JavaScript execution context associated with the current JavaScript object. 与当前JavaScript对象关联的JavaScript执行上下文。
  - toJSONString
```
public java.lang.String toJSONString()
```
    Returns text representation of JavaScript object. The equivalent of JSON.stringify() without parameters.
    返回JavaScript对象的文本表示形式。等效于不带参数的JSON.stringify（）。
    
    Returns:
    
    text representation of JavaScript object (including arrays), equivalent to JSON.stringify() output. JavaScript对象（包括数组）的文本表示形式，等效于JSON.stringify（）输出。
    
    Throws:
    
    java.lang.IllegalStateException - when object has circular fields aka 'obj.field = obj'
    
    java.lang.IllegalStateException - when object has been already disposed
  - isObject
```
public boolean isObject()
```
    Description copied from class: JSValue
    Indicates whether JavaScript value is an object. If this method returns true, then the value can be casted to JSObject type. For example:
```
 if (value.isObject()) {
     JSObject object = value.asObject();
 }
 
```
    指示JavaScript值是否为对象。如果此方法返回true，则可以将值强制转换为JSObject类型。例如：如果（value.isObject（））{ JSObject对象= value.asObject（）; }
    
    Overrides:
    
    isObject in class JSValue
    
    Returns:
    
    true when JavaScript value is an object. 当JavaScript值是一个对象时。
  - isJavaObject
```
public boolean isJavaObject()
```
    Description copied from class: JSValue
    Indicates whether JavaScript value is a Java object. If this method returns true, then the value can be casted to Object type. For example:
```
 if (value.isJavaObject()) {
     Object object = value.asJavaObject();
 }
 
```
    指示JavaScript值是否为Java对象。如果此方法返回true，则可以将值强制转换为Object类型。例如：如果（value.isJavaObject（））{ 对象object = value.asJavaObject（）; }
    
    Overrides:
    
    isJavaObject in class JSValue
    
    Returns:
    
    true when JavaScript value is an object. 当JavaScript值是一个对象时。
  - asObject
```
public JSObject asObject()
```
    Description copied from class: JSValue
    
    Casts the current JavaScript object to JSObject type. If the current object doesn't represent an object (e.g. it's a primitive value), the IllegalStateException error is thrown.
    将当前的JavaScript对象转换为JSObject类型。如果当前对象不代表对象（例如，它是原始值），则抛出IllegalStateException错误。
    
    Overrides:
    
    asObject in class JSValue
  - asJavaObject
```
public java.lang.Object asJavaObject()
```
    Description copied from class: JSValue
    
    Casts the current JavaScript object to java.lang.Object type. If the current object doesn't represent a Java object, the IllegalStateException error is thrown.
    将当前的JavaScript对象转换为java.lang.Object类型。如果当前对象不代表Java对象，则抛出IllegalStateException错误。
    
    Overrides:
    
    asJavaObject in class JSValue
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class JSObject

Method Summary

Methods inherited from class com.teamdev.jxbrowser.chromium.JSValue

Methods inherited from class java.lang.Object

Method Detail

getPropertyNames

getOwnPropertyNames

hasProperty

getProperty

setProperty

setProperty

removeProperty

getContext

toJSONString

isObject

isJavaObject

asObject

asJavaObject

toString