com.foreach.across.modules.webcms.web

Class WebCmsRenderUtilityService

java.lang.Object

com.foreach.across.modules.webcms.web.WebCmsRenderUtilityService

@Service(value="wcmRenderUtils")
public class WebCmsRenderUtilityService
extends Object

Contains utility methods most often used for rendering. This object is also exposed as expression object #wcm on thymeleaf.

Since:

0.0.2

Author:

Arne Vandamme

Constructor Summary

Constructors

Constructor and Description
WebCmsRenderUtilityService()

Method Summary

Modifier and Type	Method and Description
WebCmsComponentModel	component(String componentName) Retrieve a component by name from the default scope.
WebCmsComponentModel	componentFromScope(String componentName, String scopeName) Retrieve a component by name from the specified scope.
WebCmsComponentModel	componentFromScope(String componentName, String scopeName, boolean searchParentScopes) Retrieve a component by name from the specified scope.
String	imageUrl(ImageWebCmsComponentModel imageComponent) Build a url to the original image file of the image configured on a WebCmsImage.
String	imageUrl(ImageWebCmsComponentModel imageComponent, int boxWidth, int boxHeight) Build a url to the image file of the image configured on a WebCmsImage.
String	imageUrl(WebCmsImage image) Build a url to the original image file of a WebCmsImage.
String	imageUrl(WebCmsImage image, int boxWidth, int boxHeight) Build a url to the image file of the WebCmsImage.
WebCmsComponentModel	member(String componentName, WebCmsComponentModel container) Retrieve a container member by name.
List<WebCmsComponentModel>	members(WebCmsComponentModel container) Retrieve the member components of a container.
String	url(WebCmsAsset asset) Retrieve the primary URL for a specific asset.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebCmsRenderUtilityService

public WebCmsRenderUtilityService()

Method Detail

imageUrl

public String imageUrl(ImageWebCmsComponentModel imageComponent)

Build a url to the original image file of the image configured on a WebCmsImage.

Parameters:

imageComponent - that contains the image

Returns:

image url or null if no image was present

imageUrl

public String imageUrl(ImageWebCmsComponentModel imageComponent,
                       int boxWidth,
                       int boxHeight)

Build a url to the image file of the image configured on a WebCmsImage. If possible the resulting image should be scaled down to fit in the box dimensions specified. Note that it depends on the actual WebCmsImageConnector used if this will be the case.

Parameters:

imageComponent - that contains the image

boxWidth - image should be scaled down to this maximum width

boxHeight - image should be scaled down to this maximum height

Returns:

image url or null if no image was present

imageUrl

public String imageUrl(WebCmsImage image)

Build a url to the original image file of a WebCmsImage.

Parameters:

image - to generate the url for

Returns:

image url

imageUrl

public String imageUrl(WebCmsImage image,
                       int boxWidth,
                       int boxHeight)

Build a url to the image file of the WebCmsImage. If possible the resulting image should be scaled down to fit in the box dimensions specified. Note that it depends on the actual WebCmsImageConnector used if this will be the case.

Parameters:

image - to generate the url for

boxWidth - image should be scaled down to this maximum width

boxHeight - image should be scaled down to this maximum height

Returns:

image url

component

public WebCmsComponentModel component(String componentName)

Retrieve a component by name from the default scope. Will search parent scopes.

Parameters:

componentName - name of the component

Returns:

model or null if not found

componentFromScope

public WebCmsComponentModel componentFromScope(String componentName,
                                               String scopeName)

Retrieve a component by name from the specified scope. Will not search parent scopes.

Parameters:

componentName - name of the component

scopeName - scope in which to search for the component

Returns:

model or null if not found

componentFromScope

public WebCmsComponentModel componentFromScope(String componentName,
                                               String scopeName,
                                               boolean searchParentScopes)

Retrieve a component by name from the specified scope. Depending on the value of the searchParentScopes parameter, parent scopes will be searched for the component.

Parameters:

componentName - name of the component

scopeName - scope in which to search for the component

searchParentScopes - should parent scopes be searched

Returns:

model or null if not found

member

public WebCmsComponentModel member(String componentName,
                                   WebCmsComponentModel container)

Retrieve a container member by name. Allows the container itself to be null or not a container model, in both cases the member returned will be null. If the container is a proxy component, the target component will be investigated.

Parameters:

componentName - name of the member component

container - in which to search

Returns:

model of null if not found or container was null

members

public List<WebCmsComponentModel> members(WebCmsComponentModel container)

Retrieve the member components of a container. If the container is null or not a container model, the returned list will always be empty. If the container is a proxy component, the target component will be used instead.

Parameters:

container - for which to fetch the members

Returns:

list of member components

url

public String url(WebCmsAsset asset)

Retrieve the primary URL for a specific asset.

Parameters:

asset - to get the primary URL for

Returns:

url or null