Branding

Identifier:

org.eclipse.rap.ui.branding

Since:

RAP 1.0

Description:

A branding adds customizations and styling to the UI of a RAP application. It can be used to set the title and icon displayed in the browser, or to apply a custom theme and styling. A branding is associated with a name and can be activated by using this name as the servlet name in the URL.

Brandings can reside in a separate bundle, i.e. it is possible to brand applications without modifying their containing bundles.

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 #REQUIRED

defaultEntrypointId CDATA #IMPLIED

themeId IDREF #IMPLIED

title CDATA #IMPLIED

favicon CDATA #IMPLIED

body CDATA #IMPLIED

exitConfirmationClass CDATA #IMPLIED

id - The identifier of the branding.
servletName - The servlet name part of the URL under which the application should be available. As an example, setting this attribute to "foo" will make your application available at http://<host>:<port>/foo.
defaultEntrypointId - A default entrypoint for this branding. This entrypoint is started when the application is accessed without a startup parameter like this: http://<host>:<port>/<servletName>.
The value can be either the extension id of an application extension or the id of a registered entrypoint.
themeId - The theme to be used with this branding. If omitted, the default theme is used.
title - The title of the application. This title is usually displayed as the browser window title or in the browser tab.
Effectively sets the <title> element of the HTML head.
favicon - The icon to be displayed with this application. The favicon is usually shown next to the browser's address bar or in the browser tab.
The icon should be in the .ico format for compatibility with all browsers.
body - A file that contains HTML markup to be added to the body of the RAP startup page. The file may contain any valid HTML.
exitConfirmationClass - A class that defines the exit confirmation behavior of this application. This can be used to display a dialog that prevent users from unintentionally leaving the RAP application, losing all their application state.
The argument must be a class that implements the interface IExitConfirmation.

NOTE: Exit confirmations are not supported by some browsers.

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

Any additional header element to be added to the HTML page.

<!ELEMENT meta (attribute)*>

<!ATTLIST meta

name CDATA #IMPLIED

content CDATA #IMPLIED

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

name - The name attribute of the META element.
content - The content attribute of the META element.

<!ELEMENT link (attribute)*>

<!ATTLIST link

rel CDATA #IMPLIED

href CDATA #IMPLIED

HTML LINK elements, used to link the webpage with external resources such as CSS style sheets.

rel - The rel attribute of the LINK tag.
href - The href attribute of the LINK tag.

<!ELEMENT attribute EMPTY>

<!ATTLIST attribute

name CDATA #REQUIRED

value CDATA #IMPLIED

Additional attributes to be added to HTML elements.

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

<!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 or application extension.

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

<!ATTLIST presentationFactory

id IDREF #REQUIRED

defaultLayoutId IDREF #IMPLIED

name CDATA #IMPLIED

viewActionsVisible (true | false)

id - The id of the PresentationFactory to load.
defaultLayoutId - The id of the default Layout to load.
name -
viewActionsVisible - Sets the default vibility for a view's contribution items (actions/commands). The default value is false. When set to true, all items are visible by default. Otherwise all items are invisible and can be configured via the configuration menu.

<!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.example.tea.teabranding"
         servletName="tea"
         defaultEntrypointId="org.example.tea.application"
         themeId="org.example.tea.teatheme"
         title="Tea Portal"
         favicon="icons/favicon.ico"
         body="body.html"
         exitConfirmationClass="org.example.tea.ExitConfirmation">
   </branding>
</extension>

API Information:

There is no API available for branding.

Copyright (c) 2007, 2010 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 http://www.eclipse.org/legal/epl-v10.html