contentbox.widgets

Class Renderview

railo-context.Component
        extended by coldbox.system.FrameworkSupertype
            extended by coldbox.system.Plugin
                extended by contentbox.model.ui.BaseWidget
                    extended by contentbox.widgets.Renderview
Class Attributes:
  • synchronized : false
    •  
  • accessors : false
    •  
  • persistent : false
    •  

    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, getMenuService, getPageService, getPublicMethods, getSecurityService, setAuthorService, setCategory, setCategoryService, setCb, setCommentService, setContentService, setContentStoreService, setContentVersionService, setEntryService, setForgeBoxSlug, setHtml, setIcon, setMenuService, setPageService, setSecurityService
     
    Methods inherited from class coldbox.system.Plugin
    getpluginAuthor, getpluginAuthorURL, getPluginDescription, getPluginName, getpluginPath, getPluginVersion, getRequestCollection, getRequestContext, setpluginAuthor, setpluginAuthorURL, setPluginDescription, setPluginName, setPluginVersion
     
    Methods inherited from class coldbox.system.FrameworkSupertype
    addAsset, announceInterception, getCache, getController, getDatasource, getInstance, getInterceptor, getModel, getModuleConfig, getModuleSettings, getMyPlugin, getPlugin, getRenderer, getSetting, getSettingStructure, includeUDF, loadApplicationHelpers, locateDirectoryPath, locateFilePath, persistVariables, populateModel, renderExternalView, renderLayout, renderView, runEvent, setController, setNextEvent, setSetting, settingExists
     
    Methods inherited from class railo-context.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