com.communote.server.web.commons.controller

Class StaticPageSection

java.lang.Object

com.communote.server.web.commons.controller.StaticPageSection

All Implemented Interfaces:

Orderable

Direct Known Subclasses:

EnhancedPageSection

public class StaticPageSection
extends Object
implements Orderable

Holds the details of a section of a static page.

Author:

Communote GmbH - http://www.communote.com/

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_ORDER The default order value

Constructor Summary

Constructors

Constructor and Description
StaticPageSection(String id) Create a new section.

Method Summary

Modifier and Type	Method and Description
void	addContentTemplateParameter(String key, Object value) Add a parameter that is Required for rendering the content template
String	getContent(Locale locale, javax.servlet.http.HttpServletRequest request) The localized content.
String	getContentTemplateName() The name of the template for rendering the content.
Map<String,Object>	getContentTemplateParameter()
String	getId()
int	getOrder()
String	getShortTitle(Locale locale, javax.servlet.http.HttpServletRequest request) Return the localized short title
String	getTitle(Locale locale, javax.servlet.http.HttpServletRequest request) Return the localized title
boolean	isContentTemplate()
boolean	isShortTitleAvailable()
void	setContent(LocalizedMessage content, boolean needsRequest) Set the content.
void	setContentMessageKey(String contentMessageKey) Set the message key which should be used to resolve the localized content
void	setContentTemplateName(String contentTemplateName) Set the name/id of a template that should be rendered as the content of the section
void	setOrder(int order) Set a custom order.
void	setShortTitle(LocalizedMessage shortTitle, boolean needsRequest) Set a shorter version of the title which could for instance be shown in a menu.
void	setShortTitleMessageKey(String shortTitleMessageKey) Set the message key for resolving a localized shorter version of the title which could for instance be shown in a menu.
void	setTitle(LocalizedMessage title, boolean needsRequest) Set the title of the section.
void	setTitleMessageKey(String titleMessageKey) Set the message key for resolving a localized title of the section.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ORDER

public static final int DEFAULT_ORDER

The default order value

See Also:

Constant Field Values

Constructor Detail

StaticPageSection

public StaticPageSection(String id)

Create a new section.

Parameters:

id - the ID of the section which can only contain word characters (see Pattern) and the dash character

Method Detail

addContentTemplateParameter

public void addContentTemplateParameter(String key,
                                        Object value)

Add a parameter that is Required for rendering the content template

Parameters:

key - the key of the parameters

value - the value

getContent

public String getContent(Locale locale,
                         javax.servlet.http.HttpServletRequest request)

The localized content.

Parameters:

locale - the current locale

request - the current request

Returns:

the localized content

getContentTemplateName

public String getContentTemplateName()

The name of the template for rendering the content.

Returns:

the name of the template or null if not template is set

getContentTemplateParameter

public Map<String,Object> getContentTemplateParameter()

Returns:

parameters that are required for rendering the content template

getId

public String getId()

Returns:

the ID of the page

getOrder

public int getOrder()

Specified by:

getOrder in interface Orderable

Returns:

the order value for sorting the sections. Returns by default 100

getShortTitle

public String getShortTitle(Locale locale,
                            javax.servlet.http.HttpServletRequest request)

Return the localized short title

Parameters:

locale - the locale to use for internationalization

request - the current request

Returns:

the localized short title or the value of #getTitle(Locale) if no short title is set

getTitle

public String getTitle(Locale locale,
                       javax.servlet.http.HttpServletRequest request)

Return the localized title

Parameters:

locale - the locale to use for internationalization

request - the current request

Returns:

the localized title or an empty string if not title is set

isContentTemplate

public boolean isContentTemplate()

Returns:

whether a content template was set.

isShortTitleAvailable

public boolean isShortTitleAvailable()

Returns:

whether a short title was set

setContent

public void setContent(LocalizedMessage content,
                       boolean needsRequest)

Set the content. The content set with this method takes precedence over the one set with setContentMessageKey(String) but if also a content template is set, the template will be used.

Parameters:

content - the localizable content

needsRequest - whether the localized message needs the request object to create the message. If true the request will be passed as argument to the toString method of the localized message

setContentMessageKey

public void setContentMessageKey(String contentMessageKey)

Set the message key which should be used to resolve the localized content

Parameters:

contentMessageKey - the message key of the content

setContentTemplateName

public void setContentTemplateName(String contentTemplateName)

Set the name/id of a template that should be rendered as the content of the section

Parameters:

contentTemplateName - the name of the template to render

setOrder

public void setOrder(int order)

Set a custom order. The higher the value the earlier the section will be rendered.

Parameters:

order - the order to set

setShortTitle

public void setShortTitle(LocalizedMessage shortTitle,
                          boolean needsRequest)

Set a shorter version of the title which could for instance be shown in a menu. The title set with this method takes precedence over the one set with setShortTitleMessageKey(String).

Parameters:

shortTitle - the short title

needsRequest - whether the localized message needs the request object to create the message. If true the request will be passed as argument to the toString method of the localized message

setShortTitleMessageKey

public void setShortTitleMessageKey(String shortTitleMessageKey)

Set the message key for resolving a localized shorter version of the title which could for instance be shown in a menu.

Parameters:

shortTitleMessageKey - the message key of the short title

setTitle

public void setTitle(LocalizedMessage title,
                     boolean needsRequest)

Set the title of the section. The title set with this method takes precedence over the one set with setTitleMessageKey(String).

Parameters:

title - the title of the section

needsRequest - whether the localized message needs the request object to create the message. If true the request will be passed as argument to the toString method of the localized message

setTitleMessageKey

public void setTitleMessageKey(String titleMessageKey)

Set the message key for resolving a localized title of the section.

Parameters:

titleMessageKey - the message key of the title