com.communote.server.web.fe.portal.controller

Class EnhancedPageSection

java.lang.Object

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

com.communote.server.web.fe.portal.controller.EnhancedPageSection

All Implemented Interfaces:

Orderable

Direct Known Subclasses:

BookmarkletToolsPageSection

public class EnhancedPageSection
extends StaticPageSection

Descriptor for sections which defines some additional content elements. These elements can for instance be used to create a 2 column layout with an image on the left and an description (provided by the content member) on the right side.

Author:

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

Field Summary

Fields inherited from class com.communote.server.web.commons.controller.StaticPageSection

DEFAULT_ORDER

Constructor Summary

Constructors

Constructor and Description
EnhancedPageSection(String id)

Method Summary

Modifier and Type	Method and Description
void	addActionLink(String labelMessageKey, String url) Add an action link.
List<Pair<String,String>>	getActionLinks(Locale locale, javax.servlet.http.HttpServletRequest request) A list of pairs were each entry represents an action link.
String	getImageLink(javax.servlet.http.HttpServletRequest request) Render and return the URL that should be set as link behind the image.
String	getImageUrl(javax.servlet.http.HttpServletRequest request) Render and return the URL pointing to the image of the section.
boolean	hasActionLinks()
boolean	hasImageUrl()
void	setImageLink(String imageLink) Set a relative or absolute URL which should be added as a link behind the image.
void	setImageUrl(String imageUrl) Set the URL of an image for the section.

Methods inherited from class com.communote.server.web.commons.controller.StaticPageSection

addContentTemplateParameter, getContent, getContentTemplateName, getContentTemplateParameter, getId, getOrder, getShortTitle, getTitle, isContentTemplate, isShortTitleAvailable, setContent, setContentMessageKey, setContentTemplateName, setOrder, setShortTitle, setShortTitleMessageKey, setTitle, setTitleMessageKey

Methods inherited from class java.lang.Object

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

Constructor Detail

EnhancedPageSection

public EnhancedPageSection(String id)

Method Detail

addActionLink

public void addActionLink(String labelMessageKey,
                          String url)

Add an action link.

Parameters:

labelMessageKey - the message key of the label of the link

url - the relative or absolute URL of the link

getActionLinks

public List<Pair<String,String>> getActionLinks(Locale locale,
                                                javax.servlet.http.HttpServletRequest request)

A list of pairs were each entry represents an action link. The left side of the pair contains the localized label of the link and the right the rendered URL.

Parameters:

locale - the locale for rendering the link label

request - the current request

Returns:

the action links, can be empty

getImageLink

public String getImageLink(javax.servlet.http.HttpServletRequest request)

Render and return the URL that should be set as link behind the image.

Parameters:

request - the current request

Returns:

the rendered URL or the empty string if no link was set

getImageUrl

public String getImageUrl(javax.servlet.http.HttpServletRequest request)

Render and return the URL pointing to the image of the section.

Parameters:

request - the current request

Returns:

the rendered URL of the image or the empty string if no imageUrl was set

hasActionLinks

public boolean hasActionLinks()

Returns:

whether action links were added

hasImageUrl

public boolean hasImageUrl()

Returns:

whether an image URL is set

setImageLink

public void setImageLink(String imageLink)

Set a relative or absolute URL which should be added as a link behind the image.

Parameters:

imageLink - the URL of the link

setImageUrl

public void setImageUrl(String imageUrl)

Set the URL of an image for the section.

Parameters:

imageUrl - relative or absolute URL pointing to an image