ContentBox Core API 1.6.0

contentbox.widgets
Class ContentStore

WEB-INF.cftags.component
        extended by coldbox.system.FrameworkSupertype
            extended by coldbox.system.Plugin
                extended by contentbox.model.ui.BaseWidget
                    extended by contentbox.widgets.ContentStore
Direct Known Subclasses:
CustomHTML

public class ContentStore
extends BaseWidget

A widget that renders content store objects

Constructor Summary
init(any controller)
 
Method Summary
 array getSlugList()
          Return an array of slug lists, the @ignore annotation means the ContentBox widget editors do not use it only used internally
 any renderIt(string slug, [string defaultValue])
          Renders a published ContentStore object, if no default value is used, this throws an exception
 
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

getSlugList

public array getSlugList()
Return an array of slug lists, the @ignore annotation means the ContentBox widget editors do not use it only used internally.


renderIt

public any renderIt(string slug, [string defaultValue])
Renders a published ContentStore object, if no default value is used, this throws an exception

Overrides:
renderIt in class BaseWidget
Parameters:
slug - The content store slug to render
defaultValue - The string to show if the contentstore snippet does not exist

ContentBox Core API 1.6.0