To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Immutable, in-memory implementation of Theme used for the built-in themes registered directly by ThemeManager (for example the "admin" and "admin2" admin themes), as distinct from themes discovered from an installed repository app. Wraps the theme's identity, its preview image, any extra configuration fields, and the HtmlTemplater used to render pages in this theme.
Implements: Theme
Properties
| Property | Returns | Description |
|---|---|---|
| defaultTemplate | String | Path of the template to use as the outer page wrapper when a page in this theme does not select its own template, for example "theme/page". |
| editorName | String | Name of the content editor to use for pages in this theme. Always returns null for this implementation, meaning callers fall back to the platform default editor (the plain text editor). |
| extraFields | Map<String,ExtraField> | Additional, theme-specific configuration fields keyed by field name. Empty for the built-in themes registered by ThemeManager, which supply an empty map. |
| htmlTemplater | HtmlTemplater | The templating engine used to render pages in this theme, for example a Velocity, simple or component based HtmlTemplater. |
| name | String | The theme's unique, path-safe identifier, used to look it up in ThemeManager and to select it as a website's or branch's active theme. Never null. |
| previewImage | String | Path or URL to the image used to preview this theme, for example in a theme picker. May be null if no preview image was configured. |
| title | String | Human-readable display label for this theme, for example "Admin theme". Not guaranteed unique, use getName for a stable identifier. |
Methods
getName()
Returns: String
The theme's unique, path-safe identifier, used to look it up in ThemeManager and to select it as a website's or branch's active theme. Never null.
getPreviewImage()
Returns: String
Path or URL to the image used to preview this theme, for example in a theme picker. May be null if no preview image was configured.
getTitle()
Returns: String
Human-readable display label for this theme, for example "Admin theme". Not guaranteed unique, use getName for a stable identifier.
getExtraFields()
Returns: Map<String,ExtraField>
Additional, theme-specific configuration fields keyed by field name. Empty for the built-in themes registered by ThemeManager, which supply an empty map.
getHtmlTemplater()
Returns: HtmlTemplater
The templating engine used to render pages in this theme, for example a Velocity, simple or component based HtmlTemplater.
getDefaultTemplate()
Returns: String
Path of the template to use as the outer page wrapper when a page in this theme does not select its own template, for example "theme/page".
getEditorName()
Returns: String
Name of the content editor to use for pages in this theme. Always returns null for this implementation, meaning callers fall back to the platform default editor (the plain text editor).
applyEmailTemplate()
Returns: boolean
Whether BatchEmailService should wrap an email's body in this theme's page template before sending. Always returns true for this implementation.
© 2025 Kademi Ltd