1 /*******************************************************************************
2 * Copyright (c) 2012 EclipseSource and others.
3 * All rights reserved. This program and the accompanying materials
4 * are made available under the terms of the Eclipse Public License v1.0
5 * which accompanies this distribution, and is available at
6 * http://www.eclipse.org/legal/epl-v10.html
7 *
8 * Contributors:
9 * EclipseSource - initial API and implementation
10 ******************************************************************************/
11 package org.eclipse.rap.rwt.client.service;
12
13 /**
14 * The UrlLauncher service allows loading an URL in an external window, application or save dialog.
15 *
16 * @since 2.0
17 * @noimplement This interface is not intended to be implemented by clients.
18 */
19 public interface UrlLauncher extends ClientService {
20
21 /**
22 * Opens the given URL.
23 *
24 * Any HTTP URL or relative URL will be opened in a new window.
25 * Modern browser may block any attempt to open new windows, but will usually prompt the user to
26 * accept or ignore. Even if accepted, the decision may be applied to only this attempt, or only
27 * to future attempts. It could also trigger a document reload, causing a session restart.
28 *
29 * Non-HTTP URLs like "mailto" will not create a new browser window, but require the client
30 * to have a matching protocol handler registered.
31 *
32 * @param url the URL to open
33 */
34 void openURL( String url );
35
36 }