box.system.plugins.concurrent.Callable interface"> Callable
Overview  Package   Class 
ColdBox Platform Version 2.6.4
FRAMES  

coldbox.system.plugins
Class Renderer

WEB-INF.cftags.component
        extended by coldbox.system.FrameworkSupertype
            extended by coldbox.system.Plugin
                extended by coldbox.system.plugins.Renderer

public class Renderer

extends Plugin

This service renders layouts, views, framework includes, etc.

Constructor Summary
init(any controller)
          Constructor
 
Method Summary
private string getAppMapping()
          Get appMapping
private string getLayoutsConvention()
          Get layoutsConvention
private string getModulesConvention()
          Get layoutsConvention
private string getViewsConvention()
          Get viewsConvention
private any implicitViewChecks()
          Does implicit view rendering checks
private any locateLayout(any layout)
          Locate the layout to render
private any locateModuleLayout(any layout, [any module=''])
          Locate the view to render using module logic
private any locateModuleView(any view, [any module=''])
          Locate the view to render using module logic
private any locateView(any view)
          Locate the view to render
 Any renderExternalView(string view, [boolean cache='false'], [string cacheTimeout=''], [string cacheLastAccessTimeout=''], [string cacheSuffix=''])
          Renders an external view
 any renderLayout([any layout], [any view=''], [any module=''])
          Renders the current layout + view Combinations if declared
 Any renderView([string view=''], [boolean cache='false'], [string cacheTimeout=''], [string cacheLastAccessTimeout=''], [string cacheSuffix=''], [string module=''])
          Renders the current view
 
Methods inherited from class coldbox.system.Plugin
getPluginDescription, getPluginName, getPluginVersion, getRequestCollection, getRequestContext, getpluginAuthor, getpluginAuthorURL, getpluginPath, setPluginDescription, setPluginName, setPluginVersion, setpluginAuthor, setpluginAuthorURL
 
Methods inherited from class coldbox.system.FrameworkSupertype
$abort, $dump, $htmlhead, $include, $rethrow, $throw, addAsset, announceInterception, getColdboxOCM, getController, getDatasource, getDebugMode, getHash, getInstance, getInterceptor, getMailSettings, getModel, getModuleSettings, getMyPlugin, getPlugin, getResource, getSetting, getSettingStructure, getSettingsBean, getfwLocale, includeUDF, locateDirectoryPath, locateFilePath, persistVariables, populateModel, relocate, runEvent, setDebugMode, setNextEvent, setNextRoute, setSetting, setfwLocale, settingExists
 
Methods inherited from class WEB-INF.cftags.component
 

Constructor Detail

init

public init(any controller)
Constructor

Parameters:
controller
Method Detail

getAppMapping

private string getAppMapping()
Get appMapping

getLayoutsConvention

private string getLayoutsConvention()
Get layoutsConvention

getModulesConvention

private string getModulesConvention()
Get layoutsConvention

getViewsConvention

private string getViewsConvention()
Get viewsConvention

implicitViewChecks

private any implicitViewChecks()
Does implicit view rendering checks

locateLayout

private any locateLayout(any layout)
Locate the layout to render

Parameters:
layout - The layout name

locateModuleLayout

private any locateModuleLayout(any layout, [any module=''])
Locate the view to render using module logic

Parameters:
layout - The layout name
module - The name of the module to explicity look for a layout

locateModuleView

private any locateModuleView(any view, [any module=''])
Locate the view to render using module logic

Parameters:
view - The view name
module - The name of the module to explicity look for a view

locateView

private any locateView(any view)
Locate the view to render

Parameters:
view - The view name

renderExternalView

Public Any renderExternalView(string view, [boolean cache='false'], [string cacheTimeout=''], [string cacheLastAccessTimeout=''], [string cacheSuffix=''])
Renders an external view.

Overrides:
renderExternalView in class FrameworkSupertype
Parameters:
view - The full path to the view. This can be an expanded path or relative. Include extension.
cache - True if you want to cache the view.
cacheTimeout - The cache timeout
cacheLastAccessTimeout - The last access timeout
cacheSuffix - Add a cache suffix to the view cache entry. Great for multi-domain caching or i18n caching.

renderLayout

Public any renderLayout([any layout], [any view=''], [any module=''])
Renders the current layout + view Combinations if declared.

Parameters:
layout - The explicit layout to use in rendering.
view - The name of the view to passthrough as an argument so you can refer to it as arguments.view
module - Explicitly render a layout from this module

renderView

Public Any renderView([string view=''], [boolean cache='false'], [string cacheTimeout=''], [string cacheLastAccessTimeout=''], [string cacheSuffix=''], [string module=''])
Renders the current view.

Overrides:
renderView in class FrameworkSupertype
Parameters:
view - If not passed in, the value in the currentView in the current RequestContext will be used.
cache - True if you want to cache the view.
cacheTimeout - The cache timeout
cacheLastAccessTimeout - The last access timeout
cacheSuffix - Add a cache suffix to the view cache entry. Great for multi-domain caching or i18n caching.
module - Explicitly render a layout from this module
Overview  Package   Class 
ColdBox Platform Version 2.6.4
FRAMES