Userview Theme Plugin

Usages

Used for providing a different look and feel for a Userview. Please refer to Userview Theme.
A useable Userview Theme plugin must extends org.joget.apps.userview.model.UserviewV5Theme or org.joget.apps.userview.model.UserviewTheme abstract class.
Since version 5.0, It is encourage to use org.joget.apps.userview.model.UserviewV5Theme instead of org.joget.apps.userview.model.UserviewTheme abstract class for Userview Theme plugin development as the new theme provided more flexibility to control how you want your theme to display to user.

Abstract Class

org.joget.apps.userview.model.UserviewV5Theme

Under wflow-core module
Extended org.joget.plugin.base.ExtDefaultPlugin. Please refer to Plugin Base Abstract Class and Interface.
Implemented org.joget.plugin.property.model.PropertyEditable. Please refer to Plugin Base Abstract Class and Interface.
A base abstract class to develop a Userview Theme plugin for version v5.0 onward.
Please refer to V5 Predefined Theme Template on template options.
Only need to override the function accordingly to change part of the display.

Method Detail

Overridable Methods

handleContentError

handlePageNotFound

getLayout

getHeader

getFooter

getContentContainer

getMenus

getJsCssLib

getCss

getJs

getMetas

getHead

getFavIconLink

getLoginForm

decorateCategoryLabel

Deprecated Methods

getCss

getJavascript

getHeader

getFooter

getPageTop

getPageBottom

getBeforeContent

org.joget.apps.userview.model.UserviewTheme

Under wflow-core module
Extended org.joget.plugin.base.ExtDefaultPlugin. Please refer to Plugin Base Abstract Class and Interface.
Implemented org.joget.plugin.property.model.PropertyEditable. Please refer to Plugin Base Abstract Class and Interface.
A base abstract class to develop a Userview Theme plugin.

Method Detail

Abstract Methods

getCss

getJavascript

getHeader

getFooter

getPageTop

getPageBottom

getBeforeContent

V5 Predefined Theme Template

Defined Variables

Name	Template	Default Value	Data Type	Description
base_link
body_classes
body_id
build_number
categories_container_id
categories_container_classes
category_classes
combine_single_menu_category
content
content_container
content_id
context_path
css
current_category_classes
current_menu_classes
embed
fav_icon_link
first_category_classes
first_menu_classes
footer
head
header
hide_nav
home_page_link
is_logged_in
is_login_page
joget_header
joget_footer
js
js_css_lib
last_category_classes
last_menu_classes
locale
login_error_classes
login_exception
login_form_footer
login_link
logout_link
main_container_id
menus
menu_classes
menus_container_classes
metas
nav_id
nav_classes
params
title
right_to_left
sidebar_id
user
username
userview

Space shortcuts

Page tree

Userview Theme Plugin

Usages

Abstract Class

org.joget.apps.userview.model.UserviewV5Theme

Method Detail

Overridable Methods

handleContentError

handlePageNotFound

getLayout

getHeader

getFooter

getContentContainer

getMenus

getJsCssLib

getCss

getJs

getMetas

getHead

getFavIconLink

getLoginForm

decorateCategoryLabel

Deprecated Methods

getCss

getJavascript

getHeader

getFooter

getPageTop

getPageBottom

getBeforeContent

org.joget.apps.userview.model.UserviewTheme

Method Detail

Abstract Methods

getCss

getJavascript

getHeader

getFooter

getPageTop

getPageBottom

getBeforeContent

V5 Predefined Theme Template

Defined Variables

Templates

/templates/userview/pageNotFound.ftl

/templates/userview/layout.ftl

/templates/userview/header.ftl

/templates/userview/footer.ftl

/templates/userview/contentContainer.ftl

/templates/userview/menus.ftl

/templates/userview/head.ftl

/templates/userview/login.ftl

How to use and override V5 template

Plugin Properties Options

Tutorials

Related Community Plugins