com.communote.server.core.template.velocity

Class NoteTemplateTool

java.lang.Object

com.communote.server.core.template.velocity.NoteTemplateTool

@DefaultKey(value="templateTool")
public class NoteTemplateTool
extends Object

Velocity tool with useful functions for note template rendering.

Author:

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

Constructor Summary

Constructors

Constructor and Description
NoteTemplateTool()

Method Summary

Modifier and Type	Method and Description
String	blogAsJson(MinimalBlogData blog, boolean xmlEncode) Create a JSON with blog details.
String	formatDate(String dateStyle, String timeStyle, Number timestamp, NoteRenderContext renderContext) Render a date localized date.
boolean	isHtml(NoteRenderContext renderContext) Helper for checking whether the current render mode is the HTML mode.
boolean	isPlain(NoteRenderContext renderContext) Helper for checking whether the current render mode is the PLAIN_TEXT mode.
boolean	isPortal(NoteRenderContext renderContext) Helper for checking whether the current render mode is the PORTAL mode.
boolean	isRepost(NoteRenderContext renderContext) Helper for checking whether the current render mode is one of the repost modes.
boolean	isRepostHtml(NoteRenderContext renderContext) Helper for checking whether the current render mode is one of the repost HTML mode.
boolean	isRepostPlain(NoteRenderContext renderContext) Helper for checking whether the current render mode is the REPOST_PLAIN_TEXT mode.
String	userAsJson(UserData user, boolean xmlEncode) Create a JSON with user details.

Methods inherited from class java.lang.Object

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

Constructor Detail

NoteTemplateTool

public NoteTemplateTool()

Method Detail

blogAsJson

public String blogAsJson(MinimalBlogData blog,
                         boolean xmlEncode)

Create a JSON with blog details.

Parameters:

blog - the blog to process

xmlEncode - whether characters that are reserved in XML should be encoded in the returned string

Returns:

the JSON object as string

formatDate

public String formatDate(String dateStyle,
                         String timeStyle,
                         Number timestamp,
                         NoteRenderContext renderContext)

Render a date localized date.

Parameters:

dateStyle - style string as it is supported by DateTool

timeStyle - style string as it is supported by DateTool

timestamp - the number of milliseconds since epoch

renderContext - the current render context

Returns:

the date string

isHtml

public boolean isHtml(NoteRenderContext renderContext)

Helper for checking whether the current render mode is the HTML mode.

Parameters:

renderContext - the render context

Returns:

true if the mode is the HTML mode

isPlain

public boolean isPlain(NoteRenderContext renderContext)

Helper for checking whether the current render mode is the PLAIN_TEXT mode.

Parameters:

renderContext - the render context

Returns:

true if the mode is the PLAIN_TEXT mode

isPortal

public boolean isPortal(NoteRenderContext renderContext)

Helper for checking whether the current render mode is the PORTAL mode.

Parameters:

renderContext - the render context

Returns:

true if the mode is the PORTAL mode

isRepost

public boolean isRepost(NoteRenderContext renderContext)

Helper for checking whether the current render mode is one of the repost modes.

Parameters:

renderContext - the render context

Returns:

true if the mode is REPOST or REPOST_PLAIN_TEXT mode

isRepostHtml

public boolean isRepostHtml(NoteRenderContext renderContext)

Helper for checking whether the current render mode is one of the repost HTML mode.

Parameters:

renderContext - the render context

Returns:

true if the mode is the REPOST mode

isRepostPlain

public boolean isRepostPlain(NoteRenderContext renderContext)

Helper for checking whether the current render mode is the REPOST_PLAIN_TEXT mode.

Parameters:

renderContext - the render context

Returns:

true if the mode is the REPOST_PLAIN_TEXT mode

userAsJson

public String userAsJson(UserData user,
                         boolean xmlEncode)

Create a JSON with user details.

Parameters:

user - the user to process

xmlEncode - whether characters that are reserved in XML should be encoded in the returned string

Returns:

the JSON object as string