MMIR Framework

Class: ContentElement

ContentElement

new ContentElement(group, view, parser, renderer)

mvc/views/contentElement.js, line 4
The ContentElement represents "content" parts of a view; it may itself contain one or more ContentElements. This class holds the name of the content-field (used via the yield-tag in the layouts: content, header, footer, dialogs, ...) and its definition as HTML-String.
Name Type Description
group Array | Object an array or object with properties name {String}, and content {String}
view Object the view that owns this ContentElement-element
parser mmir.parser.ParserUtils for the the content (optional) if supplied this object must have a function parse({String}) (see templateParseUtil)
renderer mmir.parser.RenderUtils for the the content (optional) if supplied, a parser must also be supplied; the renderer must have a function parse({String}) (see templateRenderUtil)

Methods

getController(){mmir.Controller}

mvc/views/contentElement.js, line 1029
Gets the controller for this ContentElement.
Returns:
Type Description
mmir.Controller the Controller of the owning view

getDefinition(){String}

mvc/views/contentElement.js, line 1079
Deprecated
See:
Returns:
Type Description
String the raw text from which this content element was parsed

getEnd(){Number}

mvc/views/contentElement.js, line 1093
Returns:
Type Description
Number the end position for this content Element within #getRawText

getName(){String}

mvc/views/contentElement.js, line 1007
Gets the name of a mmir.ContentElement object (content, header, footer, dialogs, ...).
Returns:
Type Description
String Name - used by yield tags in layout

getRawText(){String}

mvc/views/contentElement.js, line 1069
See:
Returns:
Type Description
String the raw text from which this content element was parsed

getStart(){Number}

mvc/views/contentElement.js, line 1086
Returns:
Type Description
Number the start position for this content Element within #getRawText

getView(){mmir.View}

mvc/views/contentElement.js, line 1018
Gets the owner for this ContentElement, i.e. the mmir.View object.
Returns:
Type Description
mmir.View the owning View

hasDynamicContent(){Boolean}

mvc/views/contentElement.js, line 1108
Returns:
Type Description
Boolean returns true if this ContentElement conatains dynamic content, i.e. if it needs to be "evaluated" for rendering (otherwise, its plain text representation can be used for rendering)

stringify(){String}

mvc/views/contentElement.js, line 1120
create a String representation for this content element.
Returns:
Type Description
String the string-representation

toHtml(){String}

mvc/views/contentElement.js, line 1042
Gets the definition of a mmir.ContentElement object. TODO remove this?
Returns:
Type Description
String The HTML content.

toStrings(renderingBuffer, data){Array.<String>}

mvc/views/contentElement.js, line 1056
Renders this object into the renderingBuffer.
Name Type Description
renderingBuffer Array of Strings (if null a new buffer will be created)
data Any (optional) the event data with which the rendering was invoked
Returns:
Type Description
Array.<String> of Strings the renderingBuffer with the contents of this object added at the end