WebClient (Eclipse Remote Application Platform API Reference)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Remote Application Platform

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.rap.rwt.client
Class WebClient

java.lang.Object
  org.eclipse.rap.rwt.client.WebClient

All Implemented Interfaces:: java.io.Serializable, Client

public class WebClient
extends java.lang.Object
implements Client
extends java.lang.Object
implements Client

The default RWT web client.

Since:: 2.0
See Also:: Serialized Form

Field Summary
`static java.lang.String`	`BODY_HTML` Entrypoint property name for custom HTML code to be placed inside the `body` of the startup page.
`static java.lang.String`	`FAVICON` Entrypoint property name for the website icon (a.k.a favicon or shortcut icon) that will be displayed by the web browser.
`static java.lang.String`	`HEAD_HTML` Entrypoint property name for additional HTML elements to be added to the <head> section of the startup page.
`static java.lang.String`	`PAGE_TITLE` Entrypoint property name for the title that will be displayed in the browser window.
`static java.lang.String`	`THEME_ID` Entrypoint property name for a custom theme to be used with the entrypoint.

Constructor Summary
`WebClient()`

Method Summary





<T extends ClientService> 


T

getService(java.lang.Class<T> type)
Returns this client's implementation of a given service, if available.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

THEME_ID

public static final java.lang.String THEME_ID

Entrypoint property name for a custom theme to be used with the entrypoint. The value must be the id of a registered theme. If omitted, the default theme will be used.

See Also:: RWT.DEFAULT_THEME_ID, Application.addEntryPoint(String, Class, Map), Application.addEntryPoint(String, EntryPointFactory, Map), Constant Field Values

HEAD_HTML

public static final java.lang.String HEAD_HTML

Entrypoint property name for additional HTML elements to be added to the <head> section of the startup page. The value must contain a valid HTML snippet that consists only of HTML elements that are permissible sub-elements of head such as meta or link.

Warning: the property value will not be validated by the framework. Invalid HTML can break the application entirely or lead to problems that are hard to identify. It's the responsibility of the developer to ensure the correctness of the resulting page.

See Also:: Application.addEntryPoint(String, Class, Map), Application.addEntryPoint(String, EntryPointFactory, Map), Constant Field Values

BODY_HTML

public static final java.lang.String BODY_HTML

Entrypoint property name for custom HTML code to be placed inside the body of the startup page. The value must be proper HTML 4.0 in order not to break the surrounding page.

See Also:: Application.addEntryPoint(String, Class, Map), Application.addEntryPoint(String, EntryPointFactory, Map), Constant Field Values

PAGE_TITLE

public static final java.lang.String PAGE_TITLE

Entrypoint property name for the title that will be displayed in the browser window. The value must be the title string without any HTML markup.

See Also:: Application.addEntryPoint(String, Class, Map), Application.addEntryPoint(String, EntryPointFactory, Map), Constant Field Values

FAVICON

public static final java.lang.String FAVICON

Entrypoint property name for the website icon (a.k.a favicon or shortcut icon) that will be displayed by the web browser. The value must contain a valid path where the image can be accessed on the server.

Note: if this property is provided, the image resource must be registered to be available. Favicons are usually expected to be 16x16 px in size. If the icon has to work with legacy browsers, use a file in the ICO format.

See Also:: Application.addResource(String, ResourceLoader), Application.addEntryPoint(String, Class, Map), Application.addEntryPoint(String, EntryPointFactory, Map), Constant Field Values

Constructor Detail

WebClient

public WebClient()

Method Detail

getService

public <T extends ClientService> T getService(java.lang.Class<T> type)

Description copied from interface: Client

Returns this client's implementation of a given service, if available.

Specified by:: getService in interface Client

Parameters:: type - the type of the requested service, must be a subtype of ClientService
Returns:: the requested service if provided by this client, otherwise null
See Also:: ClientService