Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The MVC UI has two default themes (Forms theme and Dashboard theme) and has support for custom made themes. A theme is basically a set of files and some configuration that consists of the following components:

 DescriptionLocation
Index fileStringTemplate index file
JAR or
Include Page
_HomeFolder
_HomeFolder
Web resourcesJavaScript, CSS, images, etc.
JAR or
Include Page
_HomeFolder
_HomeFolder
Configuration
Properties in the
Include Page
_PropertiesFileJava
_PropertiesFileJava
file
Include Page
_HomeFolder
_HomeFolder

A theme can be part of a custom plugin JAR (for example the Dashboard plugincomponent) but can also just be a collection of files located in 

Include Page
_HomeFolder
_HomeFolder
.

...

A default Blueriq index page is injected with a template context that features the following properties:

PropertyTypeDescription
themeStringName of the theme currently selected
apiBasePathStringBase path for the web API
webResourcesBasePathStringBase path for web resources
extensionsObject (ExtensionContext)Contains all registered CSS and JavaScript files
 cssExtensionUrlsString[]URLs to all registered CSS files
 jsExtensionUrlsString[]URLs to all registered JavaScript files
sessionIdStringCurrent session id
currentPageJsonStringCurrent page in JSON format
developmentModebooleanIndicates whether or not the application runs in development mode
sessionTimeoutintConfigured session timeout in seconds

When creating a custom theme you need to provide a StringTemplate index file.

...