Package com.foreach.across.modules.adminweb.ui

Class AdminWebLayoutTemplate

java.lang.Object

com.foreach.across.modules.web.template.LayoutTemplateProcessorAdapterBean

com.foreach.across.modules.adminweb.ui.AdminWebLayoutTemplate

All Implemented Interfaces:

com.foreach.across.modules.web.template.NamedWebTemplateProcessor, com.foreach.across.modules.web.template.WebTemplateProcessor

@ConditionalOnBean(org.thymeleaf.spring6.SpringTemplateEngine.class)
@Component
public class AdminWebLayoutTemplate
extends com.foreach.across.modules.web.template.LayoutTemplateProcessorAdapterBean

Represents the admin web layout with top and left navigation. Will also register static paths and admin web root path as javascript data values.

Since:

2.1.0

Author:

Arne Vandamme

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MODEL_ATTR_BREADCRUMB
static final String	MODEL_ATTR_NAVBAR	Model attributes for different navigational components.
static final String	MODEL_ATTR_NAVBAR_RIGHT
static final String	MODEL_ATTR_SIDEBAR
static final String	NAVBAR	Nav positions used in this layout.
static final String	NAVBAR_RIGHT
static final String	SIDEBAR

Constructor Summary

Constructors

Constructor	Description
AdminWebLayoutTemplate()	Create a default template.
AdminWebLayoutTemplate(String name, String layoutTemplate)	Create a new AdminWebLayoutTemplate implementation with a specific name and layout template.

Method Summary

Modifier and Type	Method	Description
void	applyTemplate(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, Object handler, org.springframework.web.servlet.ModelAndView modelAndView)
protected void	buildMenus(com.foreach.across.modules.web.menu.MenuFactory menuFactory)
boolean	isIncludeNavPathAsDataAttribute()	Should the Menu.getPath() value be included as data attribute on nav components.
protected void	registerWebResources(com.foreach.across.modules.web.resource.WebResourceRegistry registry)
void	setIncludeNavPathAsDataAttribute(boolean includeNavPathAsDataAttribute)	Should the Menu.getPath() value be included as data attribute on nav components.

Methods inherited from class com.foreach.across.modules.web.template.LayoutTemplateProcessorAdapterBean

getName, prepareForTemplate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NAVBAR

public static final String NAVBAR

Nav positions used in this layout.

See Also:

• Constant Field Values

NAVBAR_RIGHT

public static final String NAVBAR_RIGHT

See Also:

• Constant Field Values

SIDEBAR

public static final String SIDEBAR

See Also:

• Constant Field Values

MODEL_ATTR_NAVBAR

public static final String MODEL_ATTR_NAVBAR

Model attributes for different navigational components.

See Also:

• Constant Field Values

MODEL_ATTR_NAVBAR_RIGHT

public static final String MODEL_ATTR_NAVBAR_RIGHT

See Also:

• Constant Field Values

MODEL_ATTR_SIDEBAR

public static final String MODEL_ATTR_SIDEBAR

See Also:

• Constant Field Values

MODEL_ATTR_BREADCRUMB

public static final String MODEL_ATTR_BREADCRUMB

See Also:

• Constant Field Values

Constructor Details

AdminWebLayoutTemplate

public AdminWebLayoutTemplate()

Create a default template.

AdminWebLayoutTemplate

public AdminWebLayoutTemplate(String name,
 String layoutTemplate)

Create a new AdminWebLayoutTemplate implementation with a specific name and layout template.

Parameters:

name - of this layout

layoutTemplate - view template to use

Method Details

registerWebResources

protected void registerWebResources(com.foreach.across.modules.web.resource.WebResourceRegistry registry)

Overrides:

registerWebResources in class com.foreach.across.modules.web.template.LayoutTemplateProcessorAdapterBean

buildMenus

protected void buildMenus(com.foreach.across.modules.web.menu.MenuFactory menuFactory)

Overrides:

buildMenus in class com.foreach.across.modules.web.template.LayoutTemplateProcessorAdapterBean

applyTemplate

public void applyTemplate(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 Object handler,
 org.springframework.web.servlet.ModelAndView modelAndView)

Specified by:

applyTemplate in interface com.foreach.across.modules.web.template.WebTemplateProcessor

Overrides:

applyTemplate in class com.foreach.across.modules.web.template.LayoutTemplateProcessorAdapterBean

setIncludeNavPathAsDataAttribute

public void setIncludeNavPathAsDataAttribute(boolean includeNavPathAsDataAttribute)

Should the Menu.getPath() value be included as data attribute on nav components. By default this will be enabled if AcrossDevelopmentMode is active.

isIncludeNavPathAsDataAttribute

public boolean isIncludeNavPathAsDataAttribute()

Should the Menu.getPath() value be included as data attribute on nav components. By default this will be enabled if AcrossDevelopmentMode is active.