com.teamdev.jxbrowser.chromium

Class JSFunction

java.lang.Object

com.teamdev.jxbrowser.chromium.JSValue

com.teamdev.jxbrowser.chromium.JSObject

com.teamdev.jxbrowser.chromium.JSFunction

public class JSFunction
extends JSObject

Represents a JavaScript function. JavaScript function always belongs to a JSObject instance.

表示一个JavaScript函数。 JavaScript函数始终属于JSObject实例。

Method Summary

Modifier and Type	Method and Description
JSFunction	asFunction() Casts the current JavaScript object to JSFunction type. 将当前的JavaScript对象转换为JSFunction类型。
JSValue	invoke(JSObject instance, java.lang.Object... args) Executes JavaScript function and returns result of execution as JSValue. 执行JavaScript函数并以JSValue返回执行结果。
java.util.concurrent.Future<JSValue>	invokeAsync(JSObject instance, java.lang.Object... args) Executes JavaScript function and returns result of execution as Future<JSValue>. 执行JavaScript函数并以Future 返回执行结果。
boolean	isFunction() Indicates whether JavaScript value is a function. 指示JavaScript值是否为函数。
java.lang.String	toString()

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

asJavaObject, asObject, getContext, getOwnPropertyNames, getProperty, getPropertyNames, hasProperty, isJavaObject, isObject, removeProperty, setProperty, setProperty, toJSONString

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

asArray, asBoolean, asBooleanObject, asNumber, asNumberObject, asString, asStringObject, getBooleanValue, getNumberValue, getStringValue, isArray, isBoolean, isBooleanObject, isNull, isNumber, isNumberObject, isString, isStringObject, isUndefined

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

invoke

public JSValue invoke(JSObject instance,
                      java.lang.Object... args)

Executes JavaScript function and returns result of execution as JSValue. This method blocks current thread execution until JavaScript function finishes its execution. If JavaScript function raises an exception, then JSFunctionException with error message that describes the reason of the exception will be thrown. Same error message will be printed in JavaScript Console. To get messages from JavaScript Console use ConsoleListener.

执行JavaScript函数并以JSValue返回执行结果。此方法将阻止当前线程执行，直到JavaScript函数完成执行为止。如果JavaScript函数引发异常，则将引发JSFunctionException，并显示描述异常原因的错误消息。同样的错误消息将在JavaScript控制台中打印。要从JavaScript控制台获取消息，请使用ConsoleListener。

Parameters:

instance - JavaScript object the underlying function is invoked from. Pass null to invoke function as a global function. -调用底层函数的JavaScript对象。将调用函数作为全局函数传递。

args - input arguments. -输入参数。

Returns:

result of JavaScript function execution. Never returns null. JavaScript函数执行的结果。永不归还。

Throws:

JSFunctionException - when exception occurs during function execution.

java.lang.IllegalArgumentException - when instance is a valid JavaScript object, but it belongs to a different JavaScript execution context. The instance must be running in the same execution context as the current function.

java.lang.IllegalArgumentException - when args parameters contain unsupported type.

java.lang.IllegalStateException - when instance is already disposed or its JavaScript execution context isn't available anymore.

invokeAsync

public java.util.concurrent.Future<JSValue> invokeAsync(JSObject instance,
                                                        java.lang.Object... args)

Executes JavaScript function and returns result of execution as Future<JSValue>. This method doesn't blocks current thread execution and is invoked asynchronously changing result state depending on JavaScript function execution status. If JavaScript function executes successfully, the result status will be set to "Done" and might be checked invoking the Future.isDone() method of the result instance. If JavaScript function execution has failed due to some reason, then the result status will be set to "Done" and might be checked invoking the Future.isDone() method of the result instance. In this case invoking the Future.get() method will throw the ExecutionException containing information about the failure. The error message that describes the reason of the exception will be printed in JavaScript Console. To get messages from JavaScript Console use ConsoleListener.

执行JavaScript函数并以Future 返回执行结果。此方法不阻止当前线程执行，而是根据JavaScript函数执行状态异步调用以更改结果状态。如果JavaScript函数成功执行，则结果状态将设置为“完成”，并且可以调用结果实例的Future.isDone（）方法进行检查。如果由于某种原因JavaScript函数执行失败，则结果状态将设置为“完成”，并可以调用结果实例的Future.isDone（）方法进行检查。在这种情况下，调用Future.get（）方法将抛出ExecutionException，其中包含有关失败的信息。描述异常原因的错误消息将在JavaScript控制台中打印。要从JavaScript控制台获取消息，请使用ConsoleListener。

Parameters:

instance - JavaScript object the underlying function is invoked from. Pass null to invoke function as a global function. -调用底层函数的JavaScript对象。将调用函数作为全局函数传递。

args - input arguments. -输入参数。

Returns:

Future<JSValue> instance that might contain result of JavaScript function execution. Never returns null. 实例可能包含JavaScript函数执行的结果。永不归还。

Throws:

java.lang.IllegalStateException - when current context is is already disposed

java.lang.IllegalArgumentException - when the JavaScript context of the given instance is not the same as current context

Since:

6.9

isFunction

public boolean isFunction()

Description copied from class: JSValue

Indicates whether JavaScript value is a function. If this method returns true, then the value can be casted to JSFunction type. For example:

 if (value.isFunction()) {
     JSFunction function = value.asFunction();
 }
 

指示JavaScript值是否为函数。如果此方法返回true，则可以将值强制转换为JSFunction类型。例如： 如果（value.isFunction（））{ JSFunction函数= value.asFunction（）; }

Overrides:

isFunction in class JSValue

Returns:

true when JavaScript value is a function. 当JavaScript值是一个函数时。

asFunction

public JSFunction asFunction()

Description copied from class: JSValue

Casts the current JavaScript object to JSFunction type. If the current object doesn't represent a function, the IllegalStateException error is thrown.

将当前的JavaScript对象转换为JSFunction类型。如果当前对象不代表函数，则抛出IllegalStateException错误。

Overrides:

asFunction in class JSValue

toString

public java.lang.String toString()

Overrides:

toString in class JSObject