Eclipse RAP Development Guide
Previous Page	Home	Next Page

RAP Developer Guide Reference RAP Extension Points Reference

Branding

Identifier:

org.eclipse.rap.ui.branding

Since:

RAP 1.0

Description:

The branding extension points allows you to have a RCP-like branding functionality but with additional aspects regarding web applications. You can specify values for the used servlet name or the favicon. Additionally you're able to group entrypoints together to one branding which helps you to brand external entrypoints.

Configuration Markup:

<!ELEMENT extension ( branding)+>

<!ATTLIST extension

point CDATA #REQUIRED

id CDATA #IMPLIED

name CDATA #IMPLIED>

<!ELEMENT branding ( additionalHeaders? , associatedEntrypoints? , presentationFactory?)>

<!ATTLIST branding

id CDATA #REQUIRED

servletName CDATA #IMPLIED

defaultEntrypointId IDREF #IMPLIED

themeId IDREF #IMPLIED

title CDATA #IMPLIED

favicon CDATA #IMPLIED

body CDATA #IMPLIED

exitConfirmationClass CDATA #IMPLIED>

id - The identifier of the branding with which it should be associated.
servletName - The name of the servlet on which the application should be available. Defining this attribute will cause your application to be available at https://<host>:<port>/<servletName>.
defaultEntrypointId - To not have an application-wide entrypoint you can define a default entrypoint per branding. Having an URI like https://<host>:<port>/<servletName> will automatically start the server with the entrypoint you defined here.
themeId - To have the right look & feel for your application you can define the theme which should be used here.
title - The title attribute is responsible for the title of the RAP application. This will show up in the browser window or as title of the tab in the browser.
favicon - If you have a logo or something for your web application you put its path here so it can be displayed as icon in the browser near the adressbar or in the favourites. Be sure you specify a file in the .ico format as most browsers don't accept other image types as favicons.
body - You can define any valid html file to be used as body of the RAP startup page. You can put whatever you want in it as long as it does not break the page.
exitConfirmationClass - Allows to show a confirmation dialog when the user tries to close the browser tab or window or to navigate away from the application.
The argument must be a class that implements the interface IExitConfirmation. This setting overrides the attribute exitConfirmation.

NOTE: This is not supported by every browser.

<!ELEMENT additionalHeaders (( meta | link))+>

Any additional header which should be added to the page.

<!ELEMENT meta ( attribute)*>

<!ATTLIST meta

name CDATA #IMPLIED

content CDATA #IMPLIED>

Meta elements are elements used to provide structured metadata about a web page like author, keywords, description.

name - The name attribute of the meta tag.
content - The content attribute of the meta tag.

<!ELEMENT attribute EMPTY>

<!ATTLIST attribute

name CDATA #REQUIRED

value CDATA #IMPLIED>

Attributes are used to provide additional informations for HTML tags.

name - The name of the attribute.
value - The value of the attribute.

<!ELEMENT link ( attribute)*>

<!ATTLIST link

rel CDATA #IMPLIED>

Link elements are elements used link the webpage with external resources like CSS style sheets.

rel - The rel attribute of the meta tag.

<!ELEMENT associatedEntrypoints ( entrypoint)+>

Defines all entrypoints which are allowed to be started with this branding (or servletName). If there are no entrypoints defined in this branding, any entrypoint is allowed to be started.

<!ELEMENT entrypoint EMPTY>

<!ATTLIST entrypoint

id IDREF #IMPLIED>

An element which references to an existing entrypoint defined by org.eclipse.rap.ui.entrypoint.

id - The id of the referenced entrypoint extension.

<!ELEMENT presentationFactory ( stackPresentation* , defaultStackPresentation?)>

<!ATTLIST presentationFactory

id CDATA #REQUIRED

defaultLayoutId CDATA #IMPLIED

name CDATA #IMPLIED>

id - The id of the PresentationFactory to load.
defaultLayoutId - The id of the default Layout to load.
name -

<!ELEMENT stackPresentation EMPTY>

<!ATTLIST stackPresentation

id IDREF #REQUIRED

partId IDREF #REQUIRED>

id - The id of the StackPresentation
partId - The id of the part to couple with the id of the StackPresentation.

<!ELEMENT defaultStackPresentation EMPTY>

<!ATTLIST defaultStackPresentation

id IDREF #REQUIRED>

id - The id of the StackPresentation, which is loaded if no mapping for parts and stackPresentations exists.

Examples:


<extension
    point=
"org.eclipse.rap.ui.branding"
>
  <branding
    id=
"org.eclipse.rap.demo.teabranding"

    servletName=
"tea"

    defaultEntrypointId=
"org.eclipse.rap.demo.anentrypoint"

    themeId=
"org.eclipse.rap.demo.alttheme"

    title=
"It&apos;s tea-time"

    favicon=
"icons/favicon2.ico"

    body=
"body.html"

    exitConfirmationClass=
"org.eclipse.rap.demo.DemoExitConfirmation"

  </branding>
</extension>

Copyright (c) 2007 Innoopract Informationssysteme GmbH and others.
All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-v10.html