APIdia Launch Partner
Top Description Methods
com.sun.javafx.scene.web

public Interface Debugger

Known Direct Implementers
javafx.scene.web.WebEngine.DebuggerImpl
Imports
javafx.util.Callback

An object that can be used to debug a web page loaded into a WebEngine.

Method Summary

Modifier and TypeMethod and Description
public Callback<String, Void>

Returns:

the message callback object registered with the debugger, or null if there is no such object.
getMessageCallback
()

Returns the message callback object registered with the debugger.

public boolean

Returns:

true if the debugger is enabled, false otherwise.
isEnabled
()

Determines whether the debugger is enabled.

public void
sendMessage(String
the message to be sent to the debugger. May not be null.
message
)

Sends a message to the debugger.

public void
setEnabled(boolean
specifies whether the debugger should be enabled or disabled.
enabled
)

Enables or disables the debugger.

public void
setMessageCallback(Callback<String, Void>
the message callback object to be registered with the debugger. May be null.
callback
)

Registers a message callback object with the debugger.

Method Detail

getMessageCallbackback to summary
public Callback<String, Void> getMessageCallback()

Returns the message callback object registered with the debugger. The debugger calls the message callback object's Callback#call method to deliver a message to the debugger frontend. The message passed to the message callback is a text string in the format specified by the WebKit Remote Debugging Protocol.

Returns:Callback<String, Void>

the message callback object registered with the debugger, or null if there is no such object.

isEnabledback to summary
public boolean isEnabled()

Determines whether the debugger is enabled. A debugger's sendMessage method may only be called while the debugger is enabled. The message callback object registered with a debugger is only called while the debugger is enabled.

Returns:boolean

true if the debugger is enabled, false otherwise.

sendMessageback to summary
public void sendMessage(String message)

Sends a message to the debugger. The message is a text string in the format specified by the WebKit Remote Debugging Protocol.

This method may only be called while the debugger is enabled.

Parameters
message:String

the message to be sent to the debugger. May not be null.

Exceptions
IllegalStateException:
if the debugger is not enabled.
NullPointerException:
if message is null.
setEnabledback to summary
public void setEnabled(boolean enabled)

Enables or disables the debugger. A debugger's sendMessage method may only be called while the debugger is enabled. The message callback object registered with a debugger is only called while the debugger is enabled.

This method has no effect if the enabled parameter is true and the debugger is already enabled, or if the enabled parameter is false and the debugger is already disabled.

Parameters
enabled:boolean

specifies whether the debugger should be enabled or disabled.

setMessageCallbackback to summary
public void setMessageCallback(Callback<String, Void> callback)

Registers a message callback object with the debugger. The debugger calls the message callback object's Callback#call method to deliver a message to the debugger frontend. The message passed to the message callback is a text string in the format specified by the WebKit Remote Debugging Protocol.

Parameters
callback:Callback<String, Void>

the message callback object to be registered with the debugger. May be null.