Synnefo » Pithos Android Client

package android.webkit;

import android.graphics.Bitmap;

import android.net.http.SslError;

import android.os.Message;

import android.view.KeyEvent;

public class WebViewClient {

    /**

     * Give the host application a chance to take over the control when a new

     * url is about to be loaded in the current WebView. If WebViewClient is not

     * provided, by default WebView will ask Activity Manager to choose the

     * proper handler for the url. If WebViewClient is provided, return true

     * means the host application handles the url, while return false means the

     * current WebView handles the url.

     * 

     * @param view The WebView that is initiating the callback.

     * @param url The url to be loaded.

     * @return True if the host application wants to leave the current WebView

     *         and handle the url itself, otherwise return false.

     */

    public boolean shouldOverrideUrlLoading(WebView view, String url) {

        return false;

    }

    /**

     * Notify the host application that a page has started loading. This method

     * is called once for each main frame load so a page with iframes or

     * framesets will call onPageStarted one time for the main frame. This also

     * means that onPageStarted will not be called when the contents of an

     * embedded frame changes, i.e. clicking a link whose target is an iframe.

     * 

     * @param view The WebView that is initiating the callback.

     * @param url The url to be loaded.

     * @param favicon The favicon for this page if it already exists in the

     *            database.

     */

    public void onPageStarted(WebView view, String url, Bitmap favicon) {

    }

    /**

     * Notify the host application that a page has finished loading. This method

     * is called only for main frame. When onPageFinished() is called, the

     * rendering picture may not be updated yet. To get the notification for the

     * new Picture, use {@link WebView.PictureListener#onNewPicture}.

     * 

     * @param view The WebView that is initiating the callback.

     * @param url The url of the page.

     */

    public void onPageFinished(WebView view, String url) {

    }

    /**

     * Notify the host application that the WebView will load the resource

     * specified by the given url.

     * 

     * @param view The WebView that is initiating the callback.

     * @param url The url of the resource the WebView will load.

     */

    public void onLoadResource(WebView view, String url) {

    }

    /**

     * Notify the host application that there have been an excessive number of

     * HTTP redirects. As the host application if it would like to continue

     * trying to load the resource. The default behavior is to send the cancel

     * message.

     * 

     * @param view The WebView that is initiating the callback.

     * @param cancelMsg The message to send if the host wants to cancel

     * @param continueMsg The message to send if the host wants to continue

     */

    public void onTooManyRedirects(WebView view, Message cancelMsg,

            Message continueMsg) {

        cancelMsg.sendToTarget();

    }

    // These ints must match up to the hidden values in EventHandler.

    /** Generic error */

    public static final int ERROR_UNKNOWN = -1;

    /** Server or proxy hostname lookup failed */

    public static final int ERROR_HOST_LOOKUP = -2;

    /** Unsupported authentication scheme (not basic or digest) */

    public static final int ERROR_UNSUPPORTED_AUTH_SCHEME = -3;

    /** User authentication failed on server */

    public static final int ERROR_AUTHENTICATION = -4;

    /** User authentication failed on proxy */

    public static final int ERROR_PROXY_AUTHENTICATION = -5;

    /** Failed to connect to the server */

    public static final int ERROR_CONNECT = -6;

    /** Failed to read or write to the server */

    public static final int ERROR_IO = -7;

    /** Connection timed out */

    public static final int ERROR_TIMEOUT = -8;

    /** Too many redirects */

    public static final int ERROR_REDIRECT_LOOP = -9;

    /** Unsupported URI scheme */

    public static final int ERROR_UNSUPPORTED_SCHEME = -10;

    /** Failed to perform SSL handshake */

    public static final int ERROR_FAILED_SSL_HANDSHAKE = -11;

    /** Malformed URL */

    public static final int ERROR_BAD_URL = -12;

    /** Generic file error */

    public static final int ERROR_FILE = -13;

    /** File not found */

    public static final int ERROR_FILE_NOT_FOUND = -14;

    /** Too many requests during this load */

    public static final int ERROR_TOO_MANY_REQUESTS = -15;

    /**

     * Report an error to the host application. These errors are unrecoverable

     * (i.e. the main resource is unavailable). The errorCode parameter

     * corresponds to one of the ERROR_* constants.

     * @param view The WebView that is initiating the callback.

     * @param errorCode The error code corresponding to an ERROR_* value.

     * @param description A String describing the error.

     * @param failingUrl The url that failed to load.

     */

    public void onReceivedError(WebView view, int errorCode,

            String description, String failingUrl) {

    }

    /**

     * As the host application if the browser should resend data as the

     * requested page was a result of a POST. The default is to not resend the

     * data.

     * 

     * @param view The WebView that is initiating the callback.

     * @param dontResend The message to send if the browser should not resend

     * @param resend The message to send if the browser should resend data

     */

    public void onFormResubmission(WebView view, Message dontResend,

            Message resend) {

        dontResend.sendToTarget();

    }

    /**

     * Notify the host application to update its visited links database.

     * 

     * @param view The WebView that is initiating the callback.

     * @param url The url being visited.

     * @param isReload True if this url is being reloaded.

     */

    public void doUpdateVisitedHistory(WebView view, String url,

            boolean isReload) {

    }

    /**

     * Notify the host application to handle a ssl certificate error request

     * (display the error to the user and ask whether to proceed or not). The

     * host application has to call either handler.cancel() or handler.proceed()

     * as the connection is suspended and waiting for the response. The default

     * behavior is to cancel the load.

     * 

     * @param view The WebView that is initiating the callback.

     * @param handler An SslErrorHandler object that will handle the user's

     *            response.

     * @param error The SSL error object.

     * @hide - hide this because it contains a parameter of type SslError,

     * which is located in a hidden package.

     */

    public void onReceivedSslError(WebView view, SslErrorHandler handler,

            SslError error) {

        handler.cancel();

    }

    /**

     * Notify the host application to handle an authentication request. The

     * default behavior is to cancel the request.

     * 

     * @param view The WebView that is initiating the callback.

     * @param handler The HttpAuthHandler that will handle the user's response.

     * @param host The host requiring authentication.

     * @param realm A description to help store user credentials for future

     *            visits.

     */

    public void onReceivedHttpAuthRequest(WebView view,

            HttpAuthHandler handler, String host, String realm) {

        handler.cancel();

    }

    /**

     * Give the host application a chance to handle the key event synchronously.

     * e.g. menu shortcut key events need to be filtered this way. If return

     * true, WebView will not handle the key event. If return false, WebView

     * will always handle the key event, so none of the super in the view chain

     * will see the key event. The default behavior returns false.

     * 

     * @param view The WebView that is initiating the callback.

     * @param event The key event.

     * @return True if the host application wants to handle the key event

     *         itself, otherwise return false

     */

    public boolean shouldOverrideKeyEvent(WebView view, KeyEvent event) {

        return false;

    }

    /**

     * Notify the host application that a key was not handled by the WebView.

     * Except system keys, WebView always consumes the keys in the normal flow

     * or if shouldOverrideKeyEvent returns true. This is called asynchronously

     * from where the key is dispatched. It gives the host application an chance

     * to handle the unhandled key events.

     * 

     * @param view The WebView that is initiating the callback.

     * @param event The key event.

     */

    public void onUnhandledKeyEvent(WebView view, KeyEvent event) {

    }

    /**

     * Notify the host application that the scale applied to the WebView has

     * changed.

     * 

     * @param view he WebView that is initiating the callback.

     * @param oldScale The old scale factor

     * @param newScale The new scale factor

     */

    public void onScaleChanged(WebView view, float oldScale, float newScale) {

    }

}