ColdBox Platform Version 2.6.3

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 getviewsConvention()
          Get viewsConvention
 void purgeView(string view)
          Purges a view from the cache, also see the cache manager for purging views.
 Any renderExternalView(string view, [boolean cache='false'], [string cacheTimeout=''], [string cacheLastAccessTimeout=''])
          Renders an external view.
 any renderLayout()
          Renders the current layout + view Combinations if declared.
 Any renderView([string view=''], [boolean cache='false'], [string cacheTimeout=''], [string cacheLastAccessTimeout=''])
          Renders the current view.
 
Methods inherited from class coldbox.system.plugin
getPluginDescription, getPluginName, getPluginVersion, getpluginPath, setPluginDescription, setPluginName, setPluginVersion
 
Methods inherited from class coldbox.system.frameworkSupertype
abort, announceInterception, dump, getColdboxOCM, getDatasource, getDebugMode, getHash, getInstance, getInterceptor, getMailSettings, getModel, getMyPlugin, getPlugin, getResource, getSetting, getSettingStructure, getSettingsBean, getcontroller, getfwLocale, htmlhead, include, includeUDF, locateDirectoryPath, locateFilePath, persistVariables, populateModel, relocate, rethrowit, runEvent, setDebugMode, setNextEvent, setNextRoute, setSetting, setcontroller, settingExists, throw
 
Methods inherited from class WEB-INF.cftags.component
 

Constructor Detail

init

public init(any controller)

Method Detail

getappMapping

private string getappMapping()
Get appMapping


getlayoutsConvention

private string getlayoutsConvention()
Get layoutsConvention


getviewsConvention

private string getviewsConvention()
Get viewsConvention


purgeView

public void purgeView(string view)
Purges a view from the cache, also see the cache manager for purging views.

Parameters:
view - The view to purge from the cache

renderExternalView

Public Any renderExternalView(string view, [boolean cache='false'], [string cacheTimeout=''], [string cacheLastAccessTimeout=''])
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

renderLayout

Public any renderLayout()
Renders the current layout + view Combinations if declared.


renderView

Public Any renderView([string view=''], [boolean cache='false'], [string cacheTimeout=''], [string cacheLastAccessTimeout=''])
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

ColdBox Platform Version 2.6.3