http://openjdk.java.net/projects/openjfx/javafx-web/: OpenJFX JavaFX
  • OpenJFX Mailing List 
/*
 * Copyright (c) 2012, 2014, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package com.sun.javafx.scene.web;

import javafx.util.Callback;


An object that can be used to debug a web page loaded into a WebEngine. 
/**
 * An object that can be used to debug a web page loaded into
 * a {@link WebEngine}.
 */
public interface Debugger {

    
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:true if the debugger is enabled, false otherwise.
/**
     * Determines whether the debugger is enabled.
     * A debugger's {@link #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.
     * @return {@code true} if the debugger is enabled,
     *         {@code false} otherwise.
     */
    boolean isEnabled();

    
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. 
Params:
  • enabled – specifies whether the debugger should be enabled
       or disabled.
/**
     * Enables or disables the debugger.
     * A debugger's {@link #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.
     * <p>
     * This method has no effect
     * if the {@code enabled} parameter is {@code true}
     * and the debugger is already enabled,
     * or if the {@code enabled} parameter is {@code false}
     * and the debugger is already disabled.
     * @param enabled specifies whether the debugger should be enabled
     *        or disabled.
     */
    void setEnabled(boolean enabled);

    
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.

Params:
  • message – the message to be sent to the debugger. May not be null.
Throws:
/**
     * Sends a message to the debugger.
     * The message is a text string in the format specified by
     * the WebKit Remote Debugging Protocol.
     * <p>
     * This method may only be called while the debugger is enabled.
     * @param message the message to be sent to the debugger.
     *        May not be {@code null}.
     * @throws IllegalStateException if the debugger is not enabled.
     * @throws NullPointerException if {@code message} is {@code null}.
     */
    void sendMessage(String message);

    
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:the message callback object registered with the debugger, or null if there is no such object.
/**
     * Returns the message callback object registered with the debugger.
     * The debugger calls the message callback object's
     * {@link 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.
     * @return the message callback object registered with the debugger,
     *         or {@code null} if there is no such object.
     */
    Callback<String,Void> getMessageCallback();

    
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. 
Params:
  • callback – the message callback object to be registered with the debugger. May be null.
/**
     * Registers a message callback object with the debugger.
     * The debugger calls the message callback object's
     * {@link 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.
     * @param callback the message callback object to be registered with
     *        the debugger. May be {@code null}.
     */
    void setMessageCallback(Callback<String,Void> callback);
}