com.communote.server.api.core.note

Class NoteRenderContext

java.lang.Object

com.communote.server.api.core.note.NoteRenderContext

public class NoteRenderContext
extends Object

Describes the context in which a note is rendered.

Author:

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

Constructor Summary

Constructors

Constructor and Description
NoteRenderContext(NoteRenderMode mode, Locale locale) Creates a new render context.

Method Summary

Modifier and Type	Method and Description
Locale	getLocale()
NoteRenderMode	getMode() Return the mode for rendering a note.
Map<String,String>	getModeOptions() Return options which should apply for the render mode of this context.
javax.servlet.http.HttpServletRequest	getRequest()
void	setModeOptions(Map<String,String> options) Sets options which should apply for the render mode of this context.
void	setRequest(javax.servlet.http.HttpServletRequest request) Set the request that triggered the render action.

Methods inherited from class java.lang.Object

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

Constructor Detail

NoteRenderContext

public NoteRenderContext(NoteRenderMode mode,
                         Locale locale)

Creates a new render context.

Parameters:

mode - the mode for rendering a note

locale - the locale of the user for whom the notes are rendered. Must not be null.

Method Detail

getLocale

public Locale getLocale()

Returns:

the locale of the user for whom the notes are rendered

getMode

public NoteRenderMode getMode()

Return the mode for rendering a note.

Returns:

the mode

getModeOptions

public Map<String,String> getModeOptions()

Return options which should apply for the render mode of this context. The options can contain settings which are only relevant for a specific note rendering pre-processor, for instance to activate some custom behavior.

Returns:

key value pairs of settings which should apply for the render mode of this context. Never null.

getRequest

public javax.servlet.http.HttpServletRequest getRequest()

Returns:

the request that triggered the rendering. This can be null if no servlet request caused the rendering (e.g. when sending an e-mail).

setModeOptions

public void setModeOptions(Map<String,String> options)

Sets options which should apply for the render mode of this context. The options can contain settings which are only relevant for a specific note rendering pre-processor, for instance to activate some custom behavior.

Parameters:

options - the settings to set

setRequest

public void setRequest(javax.servlet.http.HttpServletRequest request)

Set the request that triggered the render action.

Parameters:

request - the request