Package com.aquima.web.api.model.page

Class RendererContext

java.lang.Object

com.aquima.web.api.model.page.RendererContext

All Implemented Interfaces:

IRendererContext

public class RendererContext
extends Object
implements IRendererContext

This internal class represents the render context used during translation of the page model to the page viewmodel.

Since:

9.2

Author:

A.Pragt

Constructor Summary

Constructors

Constructor	Description
RendererContext(IApiRendererFactory factory, PageContent pageContent, String languageCode, String defaultLanguageCode, com.aquima.interactions.foundation.IValueFormatter valueFormatter)
RendererContext(IApiRendererFactory factory, PageContent pageContent, String languageCode, String defaultLanguageCode, com.aquima.interactions.foundation.IValueFormatter valueFormatter, com.aquima.interactions.composer.IRuntimeKeyPrinter printer)

Method Summary

Modifier and Type	Method	Description
String	getDefaultLanguageCode()	This method returns the default language code.
String	getLanguageCode()	This method returns the current language code.
com.aquima.interactions.foundation.IValueFormatter	getValueFormatter()	This method returns the value formatted.
IRendererContext	newInstance(PageContent content)	Creates a new IRendererContext instance with the same underlying configuration as this instance, but which renders elements into the given PageContent.
void	registerElement(ElementModel element)	Registers a view model.
ElementModel	render(com.aquima.interactions.composer.IElement element)	Converts an element to a view model.

Methods inherited from class java.lang.Object

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

Constructor Details

RendererContext

public RendererContext(IApiRendererFactory factory,
 PageContent pageContent,
 String languageCode,
 String defaultLanguageCode,
 com.aquima.interactions.foundation.IValueFormatter valueFormatter)

Parameters:

factory - The renderer factory to use, not null.

pageContent - The target page content, not null.

languageCode - The languagecode to use, not null.

defaultLanguageCode - The default languagecode to use, not null.

valueFormatter - The valueformatter to use, not null.

RendererContext

public RendererContext(IApiRendererFactory factory,
 PageContent pageContent,
 String languageCode,
 String defaultLanguageCode,
 com.aquima.interactions.foundation.IValueFormatter valueFormatter,
 com.aquima.interactions.composer.IRuntimeKeyPrinter printer)

Parameters:

factory - The renderer factory to use, not null.

pageContent - The target page content, not null.

languageCode - The languagecode to use, not null.

defaultLanguageCode - The default languagecode to use, not null.

valueFormatter - The valueformatter to use, not null.

printer - The runtimekey printer to use.

Method Details

render

public ElementModel render(com.aquima.interactions.composer.IElement element)

Description copied from interface: IRendererContext

Converts an element to a view model.

Specified by:

render in interface IRendererContext

Parameters:

element - The element to transform.

Returns:

The transformed model.

registerElement

public void registerElement(ElementModel element)

Description copied from interface: IRendererContext

Registers a view model.

Specified by:

registerElement in interface IRendererContext

Parameters:

element - The view model to register, not null.

getLanguageCode

public String getLanguageCode()

Description copied from interface: IRendererContext

This method returns the current language code.

Specified by:

getLanguageCode in interface IRendererContext

Returns:

The current language code.

getDefaultLanguageCode

public String getDefaultLanguageCode()

Description copied from interface: IRendererContext

This method returns the default language code.

Specified by:

getDefaultLanguageCode in interface IRendererContext

Returns:

The default language code.

getValueFormatter

public com.aquima.interactions.foundation.IValueFormatter getValueFormatter()

Description copied from interface: IRendererContext

This method returns the value formatted.

Specified by:

getValueFormatter in interface IRendererContext

Returns:

The value formatter.

newInstance

public IRendererContext newInstance(PageContent content)

Description copied from interface: IRendererContext

Creates a new IRendererContext instance with the same underlying configuration as this instance, but which renders elements into the given PageContent.

Specified by:

newInstance in interface IRendererContext

Parameters:

content - the PageContent where elements are rendered by the returned instance

Returns:

a new IRendererContext instance