...
- Predefined variable with value for template usage template.
| Name | Template | Data Type | Default Value | Data TypeDescription | |||||
|---|---|---|---|---|---|---|---|---|---|
| base_link | - | java.lang.String | Base URL of current Userview | ||||||
| body_classes | layout.ftl | java.lang.String | Used by system to add the following CSS classes and current locale code as CSS class to <body> tag. embeded - When userview is in embed mode. rtl - When System setting set display from right to left or language set to Arabic. | ||||||
| body_id | layout.ftl | java.lang.String | Use current userview menu page Id or Custom Id as <body> tag id | ||||||
| build_numberbuild_number | - | java.lang.String | Joget build number | ||||||
| categories_container_id | menus.ftl | java.lang.String | category-container | Id of the container which contains all menu categories | |||||
| categories_container_classes | menus.ftl | java.lang.String | nav nav-tabs nav-stacked main-menu | CSS classes of the container which contains all menu categories | |||||
| category_classes | menus.ftl | java.lang.String | category | CSS classes of menu category | |||||
| combine_single_menu_category | menus.ftl | boolean | false | Flag to display the only menu in a category to replace the category as 1st level menu. | |||||
| content | contentContainer.ftl | java.lang.String | Main content of the current page. Content from the Userview Menu or login form. | ||||||
| content_container | layout.ftl | java.lang.String | Value from theme getContentContainer method | ||||||
| content_id | contentContainer.ftl | java.lang.String | content | Id of content container | |||||
| context_path | login.ftl | java.lang.String | Context Path of the Joget Server URL | ||||||
| css | head.ftl | java.lang.String | Value from theme getCss method | ||||||
| current_category_classes | menus.ftl | java.lang.String | current-category active | Extra CSS classes for current menu category | |||||
| current_menu_classes | menus.ftl | java.lang.String | current active | Extra CSS classes for current menu | |||||
| embed | contentContainer.ftl | boolean | Flag to decide whether userview is needed to display in embed mode | ||||||
| fav_icon_link | head.ftl | java.lang.String | Value from theme getFavIconLink method | ||||||
| first_category_classes | menus.ftl | java.lang.String | first | Extra CSS classes for first menu category | |||||
| first_menu_classes | menus.ftl | java.lang.String | first | Extra CSS classes for first menu in the menu category | |||||
| footer | layout.ftl | java.lang.String | Value from theme getFooter method | ||||||
| head | layout.ftl | java.lang.String | Value from theme getHead method | ||||||
| header | layout.ftl | java.lang.String | Value from theme getHeader method | ||||||
| hide_nav | contentContainer.ftl | boolean | false | Flag to hide navigator | |||||
| home_page_link | pageNotFound.ftl, header.ftl | java.lang.String | URL to the userview home page menu | ||||||
| is_logged_in | header.ftl | boolean | Flag to decide whether there is a logged in user | ||||||
| is_login_page | - | boolean | Whether or not the current page is a login form page | ||||||
| joget_headerjoget_header | head.ftl | java.lang.String | Additional HTML template injected by system to the header | ||||||
| joget_footer | layout.ftl | java.lang.String | Additional HTML template injected by system to the footer | ||||||
| js | head.ftl | java.lang.String | Value from theme getJs method | ||||||
| js_css_lib | head.ftl | java.lang.String | Value from theme getJsCssLib method | ||||||
| last_category_classes | menus.ftl | java.lang.String | last | Extra CSS classes for last menu category | |||||
| last_menu_classes | menus.ftl | java.lang.String | last | Extra CSS classes for last menu in the menu category | |||||
| locale | layout.ftl | java.lang.String | Current language code of the system | ||||||
| login_error_classes | login.ftl | java.lang.String | form-errors alert alert-warning | CSS classes for login error message container | |||||
| login_exception | login.ftl | java.lang.String | To keep exception message when a login attempt failure. | ||||||
| login_form_after | login.ftl | java.lang.String | Value from "Custom HTML (After Login Form)" under Userview Builder - Settings | ||||||
| login_form_before | login.ftl | java.lang.String | Value from "Custom HTML (Before Login Form)" under Userview Builder - Settings | ||||||
| login_form_footer | login.ftl | java.lang.String | HTML template retrieved from DirectoryUtil.getLoginFormFooter(). Used by User Security Implementation. | ||||||
| login_link | header.ftl | java.lang.String | URL to the login form | ||||||
| logout_link | header.ftl | java.lang.String | URL to log out from userview | ||||||
| main_container_id | contentContainer.ftl | java.lang.String | main | CSS classes for the main container | |||||
| menus | contentContainer.ftl | Value from theme getMenus method | |||||||
| menu_classes | menus.ftl | java.lang.String | menu | CSS classes for the menu | |||||
| menus_container_classes | menus.ftl | java.lang.String | menu-container | CSS classes for the container which contains menus | |||||
| metas | head.ftl | java.lang.String | Value from theme getMetas method | ||||||
| nav_id | menus.ftl | java.lang.String | navigation | Id of the navigator container | |||||
| nav_classes | menus.ftl | java.lang.String | nav-collapse sidebar-nav | CSS classes of the navigator container | |||||
| params | - | java.util.Map<java.lang.String, java.lang.Object> | Received Request Parameters | ||||||
| title | head.ftl | java.lang.String | Userview name and the current menu label | title | head.ftl | ||||
| right_to_left | - | boolean | Flag to decide whether or not userview need to display from right to left | ||||||
| sidebar_id | contentContainer.ftl | java.lang.String | sidebar | Id of the sidebar container | |||||
| user | - | org.joget.directory.model.User | Current logged in User object | ||||||
| username | - | java.lang.String | Current logged in username | ||||||
| userview | header.ftl, footer.ftl, menus.ftl, login.ftl | org.joget.apps.userview.model.Userview | Userview object which using this theme |
Templates
- All these template are used by org.joget.apps.userview.model.UserviewV5Theme abstract class.
- Override the abstract class method to set different value for the variables used in template.
- All templates are constructed using FreeMaker syntax.
/templates/userview/pageNotFound.ftl
...
How to use and override V5 template
Reuse the predefined template
- To reuse the predefined template, just override the theme method and set your custom HTML to the available variable of the template
...
- .
- Example: To reuse the header.ftl template in getHeader method.
| Code Block | ||
|---|---|---|
| ||
@Override
public String getHeader(Map<String, Object> data) {
data.put("header_classes", "navbar");
data.put("header_inner_before", "<div class=\"navbar-inner\"><div class=\"container-fluid\">");
data.put("header_inner_after", "</div></div>");
data.put("header_info_after", "<a id=\"mobile_menu\" class=\"btn btn-navbar\"><span class=\"icon-bar\"></span><span class=\"icon-bar\"></span><span class=\"icon-bar\"></span></a>");
data.put("header_link_classes", "brand");
data.put("header_info_classes", "inline-block");
data.put("header_name_classes", "inline-block");
data.put("header_description_classes", "inline-block visible-desktop");
data.put("header_description_span_classes", "brand");
return super.getHeader(data);
} |
Override or replace the predefined template
- To override or replace the predefined template, you just need to create your own template using FreeMaker syntax.
- Example: Using a custom template file in getHeader method.
| Code Block | ||
|---|---|---|
| ||
@Override
public String getHeader(Map<String, Object> data) {
return UserviewUtil.getTemplate(this, data, "/templates/userview/customHeader.ftl");
} |
...
Plugin Properties Options
...