Namespace mmir.parser.RenderUtils
RenderUtils
Defined in: templateRenderUtils.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
A Utility class for rendering parsed (eHTML) templates, or more specifically ParsingResult objects.
|
| Field Attributes | Field Name and Description |
|---|---|
| <private> | |
| <private> |
Renders a ContentElement object into the renderingBuffer.
|
| <private> |
Prepares JavaScript source code for usage in rendering the template (view/partial etc.
|
| <private> |
Prepares the layout:
after loading a layout file, this methods prepares the layout
for rendering content into it
(i.e.
|
| Method Attributes | Method Name and Description |
|---|---|
| <private> |
createInternalData(eventData)
HELPER for creating the data-object
|
| <private> |
evaluate(evalStatement, data, element, containingContentElement)
|
| <private> |
getContentForYield(name, contentForArray)
|
| <private> |
getRenderingBuffer(renderingBuffer)
HELPER creates a new rendering buffer if neccessary
|
| <private> |
renderComment(elem, renderingMode, rawTemplateText, renderingBuffer)
|
|
renderContentElement(htmlContentString, data, renderingBuffer)
Renders a single ContentElement object.
|
|
| <private> |
Render a View
Renders the contents into a layout definition (i.e.
|
| <private> |
renderElement(elem, contentForArray, renderingMode, rawTemplateText, renderingBuffer, data, containingContentElement)
|
| <private> |
renderEscape(elem, renderingMode, rawTemplateText, renderingBuffer)
|
| <private> |
renderFor(elem, renderingMode, rawTemplateText, renderingBuffer, data, containingContentElement)
|
| <private> |
renderHelper(elem, renderingMode, rawTemplateText, renderingBuffer, data, containingContentElement)
|
| <private> |
renderIf(elem, renderingMode, rawTemplateText, renderingBuffer, data, containingContentElement)
|
| <private> |
renderIncludeScript(elem, renderingMode, rawTemplateText, renderingBuffer, data)
|
| <private> |
renderIncludeStyle(elem, renderingMode, rawTemplateText, renderingBuffer, data)
|
|
renderJS(rawJSSourceCode, replacementObjectsList, isForcePrefix)
Prepares JavaScript source code for usage in rendering the template (view/partial etc.
|
|
|
renderLayout(parseResult, contentForArray)
Renders a layout in preparation for displaying content:
This function should be used to preperare the layout content, so that its
views can be rendered into it (needs to be done only once, after the layout is loaded).
|
|
| <private> |
renderLocalize(elem, renderingMode, rawTemplateText, renderingBuffer, data)
|
| <private> |
renderPartial(elem, renderingMode, rawTemplateText, renderingBuffer, data, containingContentElement)
|
| <private> |
renderRaw(elem, renderingMode, rawTemplateText, renderingBuffer)
|
| <private> |
renderScriptBlock(elem, renderingMode, rawTemplateText, renderingBuffer, data, containingContentElement)
|
| <private> |
renderScriptStatement(elem, renderingMode, rawTemplateText, renderingBuffer, data, containingContentElement)
|
| <private> |
renderVarDeclaration(elem, renderingMode, rawTemplateText, renderingBuffer, data, containingContentElement)
|
| <private> |
renderVarReference(elem, renderingMode, rawTemplateText, renderingBuffer, data, containingContentElement)
|
|
renderViewContent(htmlContentString, YieldDeclaration[]}, contentForObjectsArray, data)
Renders a view.
|
|
|
renderViewDialogs(htmlContentString, YieldDeclaration[]}, contentForObjectsArray, data)
Renders the dialog content for a view.
|
|
| <private> |
renderYield(elem, contentForArray, renderingMode, rawTemplateText, renderingBuffer, data)
|
| <private> |
sortAscByStart(parsedElem1, parsedElem2)
helper for sorting an Arrays.
|
Namespace Detail
mmir.parser.RenderUtils
A Utility class for rendering parsed (eHTML) templates, or more specifically ParsingResult objects.
mmir.parser.RenderUtils.render(parseResult, contentElementList);
Field Detail
<private>
{mmir.LanguageManager}
localizer
<private>
{Array}
renderContentElementImpl
Renders a ContentElement object into the renderingBuffer.
<private>
renderJSSourceImpl
Prepares JavaScript source code for usage in rendering the template (view/partial etc.).
The replacement-list contains information which parts of the raw JavaScript code should be
modified (e.g. indices [start,end] for replacing text in the source code).
The function returns the modified JavaScript source code as a String.
If the mode is
RENDER_MODE_JS_SOURCE_FORCE_VAR_PREFIX, the variable-names that correspond
to replacementObjectsList are check: if a name does not start with @, then the name will prepended with @ before
rendering.
<private>
renderLayoutImpl
Prepares the layout:
after loading a layout file, this methods prepares the layout
for rendering content into it
(i.e. "prepare layout definition for later view-renderings").
NOTE: this does not actually render the layout for "viewing"
(see renderContent(..))!
Method Detail
<private>
createInternalData(eventData)
HELPER for creating the data-object
- Parameters:
- eventData
<private>
evaluate(evalStatement, data, element, containingContentElement)
- Parameters:
- evalStatement
- data
- element
- containingContentElement
<private>
getContentForYield(name, contentForArray)
- Parameters:
- name
- contentForArray
getInstance()
- Deprecated:
- instead, use RenderUtils object directly (i.e. omit getInstance() call)
<private>
{Array}
getRenderingBuffer(renderingBuffer)
HELPER creates a new rendering buffer if neccessary
- Parameters:
- renderingBuffer
- Returns:
- {Array} rendering buffer
<private>
renderComment(elem, renderingMode, rawTemplateText, renderingBuffer)
- Parameters:
- elem
- renderingMode
- rawTemplateText
- renderingBuffer
{String}
renderContentElement(htmlContentString, data, renderingBuffer)
Renders a single ContentElement object.
During rendering, the view's template-expressions are evaluated, and the results rendered into the returned String.
- Parameters:
- {String} htmlContentString
- the original view-template text
- {Object} data Optional
- a JSON object which's fields will be available during rendering/evaluation of the template expressions
- {String[]} renderingBuffer Optional
- if provided, the partial rendering results will be appended to this Array
- Returns:
- {String} the evalutated and rendered ContentElement; if renderingBuffer was provided and not empty, the result will be prepended with the concatenated contents of the Array's Strings
<private>
renderContentImpl()
Render a View
Renders the contents into a layout definition (i.e. "render for viewing").
<private>
renderElement(elem, contentForArray, renderingMode, rawTemplateText, renderingBuffer, data, containingContentElement)
- Parameters:
- elem
- contentForArray
- renderingMode
- rawTemplateText
- renderingBuffer
- data
- containingContentElement
<private>
renderEscape(elem, renderingMode, rawTemplateText, renderingBuffer)
- Parameters:
- elem
- renderingMode
- rawTemplateText
- renderingBuffer
<private>
renderFor(elem, renderingMode, rawTemplateText, renderingBuffer, data, containingContentElement)
- Parameters:
- elem
- renderingMode
- rawTemplateText
- renderingBuffer
- data
- containingContentElement
<private>
renderHelper(elem, renderingMode, rawTemplateText, renderingBuffer, data, containingContentElement)
- Parameters:
- elem
- renderingMode
- rawTemplateText
- renderingBuffer
- data
- containingContentElement
<private>
renderIf(elem, renderingMode, rawTemplateText, renderingBuffer, data, containingContentElement)
- Parameters:
- elem
- renderingMode
- rawTemplateText
- renderingBuffer
- data
- containingContentElement
<private>
renderIncludeScript(elem, renderingMode, rawTemplateText, renderingBuffer, data)
- Parameters:
- elem
- renderingMode
- rawTemplateText
- renderingBuffer
- data
<private>
renderIncludeStyle(elem, renderingMode, rawTemplateText, renderingBuffer, data)
- Parameters:
- elem
- renderingMode
- rawTemplateText
- renderingBuffer
- data
renderJS(rawJSSourceCode, replacementObjectsList, isForcePrefix)
Prepares JavaScript source code for usage in rendering the template (view/partial etc.).
The replacement-list contains information which parts of the raw JavaScript code should be
modified (e.g. indices [start,end] for replacing text in the source code).
The function returns the modified JavaScript source code as a String.
If the mode is
isForcePrefix == true, the variable-names that correspond
to replacementObjectsList are check: if a name does not start with @, then the name will prepended with @ before
rendering.
- Parameters:
- {String} rawJSSourceCode
- the original JavaScript source code
- {mmir.parser.ParsingResult[]} replacementObjectsList
- {Boolean} isForcePrefix Optional
{String}
renderLayout(parseResult, contentForArray)
Renders a layout in preparation for displaying content:
This function should be used to preperare the layout content, so that its
views can be rendered into it (needs to be done only once, after the layout is loaded).
- Parameters:
- {mmir.parser.ParsingResult} parseResult
- the parsed view template
- {ContentElement[]} contentForArray Optional
- Returns:
- {String} the prepared layout content
<private>
renderLocalize(elem, renderingMode, rawTemplateText, renderingBuffer, data)
- Parameters:
- elem
- renderingMode
- rawTemplateText
- renderingBuffer
- data
<private>
renderPartial(elem, renderingMode, rawTemplateText, renderingBuffer, data, containingContentElement)
- Parameters:
- elem
- renderingMode
- rawTemplateText
- renderingBuffer
- data
- containingContentElement
<private>
renderRaw(elem, renderingMode, rawTemplateText, renderingBuffer)
- Parameters:
- elem
- renderingMode
- rawTemplateText
- renderingBuffer
<private>
renderScriptBlock(elem, renderingMode, rawTemplateText, renderingBuffer, data, containingContentElement)
- Parameters:
- elem
- renderingMode
- rawTemplateText
- renderingBuffer
- data
- containingContentElement
<private>
renderScriptStatement(elem, renderingMode, rawTemplateText, renderingBuffer, data, containingContentElement)
- Parameters:
- elem
- renderingMode
- rawTemplateText
- renderingBuffer
- data
- containingContentElement
<private>
renderVarDeclaration(elem, renderingMode, rawTemplateText, renderingBuffer, data, containingContentElement)
- Parameters:
- elem
- renderingMode
- rawTemplateText
- renderingBuffer
- data
- containingContentElement
<private>
renderVarReference(elem, renderingMode, rawTemplateText, renderingBuffer, data, containingContentElement)
- Parameters:
- elem
- renderingMode
- rawTemplateText
- renderingBuffer
- data
- containingContentElement
{String}
renderViewContent(htmlContentString, YieldDeclaration[]}, contentForObjectsArray, data)
Renders a view.
During rendering, the view's template-expressions are evaluated, and the results rendered into the returned String.
- Parameters:
- {String} htmlContentString
- the original view-content of the layout-template text, see Layout#getBodyContents
- YieldDeclaration[]}
- yieldDeclarationsArray a list of yield-declarations of the layout
- {ContentElement[]} contentForObjectsArray
- a list of content-for objects of the view. This list must supply a corresponding objecet for each entry in the yieldDeclarationsArray.
- {Object} data Optional
- a JSON object which's fields will be available during rendering/evaluation of the template expressions
- Returns:
- {String} the evalutated and rendered view-content
{String}
renderViewDialogs(htmlContentString, YieldDeclaration[]}, contentForObjectsArray, data)
Renders the dialog content for a view.
During rendering, the view's template-expressions are evaluated, and the results rendered into the returned String.
- Parameters:
- {String} htmlContentString
- the original dialog-content of the layout-template text, see Layout#getDialogsContents
- YieldDeclaration[]}
- yieldDeclarationsArray a list of yield-declarations of the layout
- {ContentElement[]} contentForObjectsArray
- a list of content-for objects of the view. This list must supply a corresponding objecet for each entry in the yieldDeclarationsArray.
- {Object} data Optional
- a JSON object which's fields will be available during rendering/evaluation of the template expressions
- Returns:
- {String} the evalutated and rendered dialog-content
<private>
renderYield(elem, contentForArray, renderingMode, rawTemplateText, renderingBuffer, data)
- Parameters:
- elem
- contentForArray
- renderingMode
- rawTemplateText
- renderingBuffer
- data
<private>
sortAscByStart(parsedElem1, parsedElem2)
helper for sorting an Arrays.
Notes:
1. all array elements must have a function {Number} getStart()
2. the array will be sorted ascending by getStart(), e.g. sort by occurrence in the raw template-text
Usage example:
theArray.sort(sortAscByStart);
- Parameters:
- parsedElem1
- parsedElem2