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>


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



<!ELEMENT attribute EMPTY>

<!ATTLIST attribute

name  CDATA #REQUIRED

value CDATA #IMPLIED>

Attributes are used to provide additional informations for HTML tags.



<!ELEMENT link (attribute)*>

<!ATTLIST link

rel CDATA #IMPLIED>

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



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



<!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.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 http://www.eclipse.org/legal/epl-v10.html