ContentBox Core API 1.6.0

contentbox.widgets
Class Viewlet

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

public class Viewlet
extends BaseWidget

A widget that executes any internal ColdBox event and return its results

Constructor Summary
init([any controller])
 
Method Summary
 any renderIt(string event, [boolean private='false'], [string args=''], [string title=''], [string titleLevel='2'])
          Execute an internal coldbox event viewlet
 
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 event, [boolean private='false'], [string args=''], [string title=''], [string titleLevel='2'])
Execute an internal coldbox event viewlet

Overrides:
renderIt in class BaseWidget
Parameters:
event - The ColdBox event to execute
private - Private event or not
args - Event arguments to pass to the viewlet execution, this should be a comma delimitted list of name value pairs. Ex: widget=true,name=Test
title - The title to show before the dropdown or list, defaults to H2
titleLevel - The H{level} to use, by default we use H2

ContentBox Core API 1.6.0