Module com.semanticcms.core.servlet

Package com.semanticcms.core.servlet

Class Theme

java.lang.Object

com.semanticcms.core.servlet.Theme

public abstract class Theme
extends Object

A theme is responsible for the overall view of the site.

Constructor Summary

Constructors

Constructor	Description
Theme()

Method Summary

Modifier and Type	Method	Description
void	configureResources(ServletContext servletContext, HttpServletRequest req, HttpServletResponse resp, View view, Page page, Registry requestRegistry)	Configures the request-scope web resources that this theme uses.
abstract void	doTheme(ServletContext servletContext, HttpServletRequest request, HttpServletResponse response, View view, Page page)	Renders the theme.
boolean	equals(Object obj)	Two themes with the same name are considered equal.
abstract String	getDisplay()	Gets the display name for this theme.
abstract String	getName()	Gets the unique name of this theme.
static Theme	getTheme(ServletRequest request)	Gets the current theme on the given request or null when none active.
int	hashCode()	Consistent with equals, hashCode based on name.
final boolean	isDefault()	Checks if this is the default theme.
static void	setTheme(ServletRequest request, Theme theme)	Sets the current theme on the given request or null for none active.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Theme

public Theme()

Method Details

getTheme

public static Theme getTheme(ServletRequest request)

Gets the current theme on the given request or null when none active.

setTheme

public static void setTheme(ServletRequest request,
 Theme theme)

Sets the current theme on the given request or null for none active.

equals

public boolean equals(Object obj)

Two themes with the same name are considered equal.

Overrides:

equals in class Object

hashCode

public int hashCode()

Consistent with equals, hashCode based on name.

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

See Also:

• getDisplay()

getDisplay

public abstract String getDisplay()

Gets the display name for this theme.

getName

public abstract String getName()

Gets the unique name of this theme.

isDefault

public final boolean isDefault()

Checks if this is the default theme.

configureResources

public void configureResources(ServletContext servletContext,
 HttpServletRequest req,
 HttpServletResponse resp,
 View view,
 Page page,
 Registry requestRegistry)

Configures the request-scope web resources that this theme uses.

Implementers should call super.configureResources(…) as a matter of convention, despite this default implementation doing nothing.

doTheme

public abstract void doTheme(ServletContext servletContext,
 HttpServletRequest request,
 HttpServletResponse response,
 View view,
 Page page)
                      throws ServletException,
IOException,
SkipPageException

Renders the theme.

Both the Serialization and Doctype may have been set on the request, and these must be considered in the HTML generation.

When response is committed, this theme method is never called and SkipPageException is thrown instead.

Throws:

ServletException

IOException

SkipPageException

See Also:

• SerializationEE.get(jakarta.servlet.ServletContext, jakarta.servlet.http.HttpServletRequest)
• DoctypeEE.get(jakarta.servlet.ServletContext, jakarta.servlet.ServletRequest)