ContentBox Core API 1.6.0

contentbox.widgets
Class Renderview

WEB-INF.cftags.component
        extended by coldbox.system.FrameworkSupertype
            extended by coldbox.system.Plugin
                extended by contentbox.model.ui.BaseWidget
                    extended by contentbox.widgets.Renderview

public class Renderview
extends BaseWidget

Renders any view in your ColdBox application

Constructor Summary
init([any controller])
 
Method Summary
 any renderIt(string view, [boolean cache='false'], [any cacheTimeout], [any cacheLastAccessTimeout], [any cacheSuffix], [any module], [string args=''])
          Render the widget out
 
Methods inherited from class contentbox.model.ui.BaseWidget
GETAUTHORSERVICE, GETCATEGORY, GETCATEGORYSERVICE, GETCB, GETCOMMENTSERVICE, GETCONTENTSERVICE, GETCONTENTSTORESERVICE, GETCONTENTVERSIONSERVICE, GETENTRYSERVICE, GETFORGEBOXSLUG, GETHTML, GETICON, GETPAGESERVICE, GETSECURITYSERVICE, SETAUTHORSERVICE, SETCATEGORY, SETCATEGORYSERVICE, SETCB, SETCOMMENTSERVICE, SETCONTENTSERVICE, SETCONTENTSTORESERVICE, SETCONTENTVERSIONSERVICE, SETENTRYSERVICE, SETFORGEBOXSLUG, SETHTML, SETICON, SETPAGESERVICE, SETSECURITYSERVICE, getPublicMethods
 
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, getInterceptor, getMailService, getMailSettings, getMemento, getModel, getModuleSettings, getMyPlugin, getNewMail, getPlugin, getResource, getSetting, getSettingStructure, getSettingsBean, getValidationManager, getfwLocale, includeUDF, loadGlobalUDFLibraries, locateDirectoryPath, locateFilePath, persistVariables, populateModel, relocate, renderExternalView, renderLayout, renderView, runEvent, setDebugMode, setNextEvent, setNextRoute, setSetting, setfwLocale, settingExists, validateModel
 
Methods inherited from class WEB-INF.cftags.component
None
 

Constructor Detail

init

public init([any controller])

Parameters:
controller
Method Detail

renderIt

public any renderIt(string view, [boolean cache='false'], [any cacheTimeout], [any cacheLastAccessTimeout], [any cacheSuffix], [any module], [string args=''])
Render the widget out

Overrides:
renderIt in class BaseWidget
Parameters:
view - The named path of the view to render
cache - Cache the contents of the render view or not, by default it is false
cacheTimeout - The cache timeout in minutes
cacheLastAccessTimeout - The cache idle timeout in minutes
cacheSuffix - A suffix for the cache entry
module - The name of the module to render the view from
args - The arguments to pass to the view, this should be a comma delimitted list of name value pairs. Ex: widget=true,name=Test

ContentBox Core API 1.6.0