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. The branding is associated with EntryPoint or IApplication implementation.

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? , presentationFactory?)>

<!ATTLIST branding

id      CDATA #REQUIRED

themeId IDREF #IMPLIED

title   CDATA #IMPLIED

favicon CDATA #IMPLIED

body    CDATA #IMPLIED>


<!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.



<!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.



<!ELEMENT attribute EMPTY>

<!ATTLIST attribute

name  CDATA #REQUIRED

value CDATA #IMPLIED>

Additional attributes to be added to HTML elements.



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

<!ATTLIST presentationFactory

id                 IDREF #REQUIRED

defaultLayoutId    IDREF #IMPLIED

name               CDATA #IMPLIED

viewActionsVisible (true | false) >


<!ELEMENT stackPresentation EMPTY>

<!ATTLIST stackPresentation

id     IDREF #REQUIRED

partId IDREF #REQUIRED>


<!ELEMENT defaultStackPresentation EMPTY>

<!ATTLIST defaultStackPresentation

id IDREF #REQUIRED>


Examples:

<extension
    point="org.eclipse.rap.ui.branding">
  <branding
      id="org.example.tea.teabranding"
      themeId="org.example.tea.teatheme"
      title="Tea Portal"
      favicon="icons/favicon.ico"
      body="body.html"
  </branding>
</extension>

API Information:
There is no API available for branding.


Copyright (c) 2007, 2015 EclipseSource 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