lucee.Componentcoldbox.system.FrameworkSupertype
contentbox.models.ui.BaseWidget
ContentBox - A Modular Content Platform Copyright since 2012 by Ortus Solutions, Corp www.ortussolutions.com/products/contentbox --- This is the base class for contentbox widgets which gives them access to ContentBox and ColdBox.
Property Summary | ||||
---|---|---|---|---|
type | property | default | serializable | required |
string
|
author
|
true
|
false
|
|
any
|
authorService
|
true
|
false
|
|
string
|
authorURL
|
true
|
false
|
|
string
|
category
|
true
|
false
|
|
any
|
categoryService
|
true
|
false
|
|
any
|
cb
|
true
|
false
|
|
any
|
commentService
|
true
|
false
|
|
any
|
contentService
|
true
|
false
|
|
any
|
contentStoreService
|
true
|
false
|
|
any
|
contentVersionService
|
true
|
false
|
|
any
|
controller
|
true
|
false
|
|
string
|
description
|
true
|
false
|
|
any
|
entryService
|
true
|
false
|
|
string
|
forgeBoxSlug
|
true
|
false
|
|
any
|
html
|
true
|
false
|
|
string
|
icon
|
true
|
false
|
|
any
|
log
|
true
|
false
|
|
any
|
menuService
|
true
|
false
|
|
string
|
name
|
true
|
false
|
|
any
|
pageService
|
true
|
false
|
|
any
|
securityService
|
true
|
false
|
|
any
|
siteService
|
true
|
false
|
|
string
|
version
|
true
|
false
|
Constructor Summary | |
---|---|
init()
Base Constructor. |
Method Summary | |
---|---|
string
|
getAuthor()
|
string
|
getAuthorService()
|
string
|
getAuthorURL()
|
string
|
getCategory()
|
string
|
getCategoryService()
|
string
|
getCb()
|
string
|
getCommentService()
|
string
|
getContentService()
|
string
|
getContentStoreService()
|
string
|
getContentVersionService()
|
string
|
getDescription()
|
string
|
getEntryService()
|
string
|
getForgeBoxSlug()
|
string
|
getHtml()
|
string
|
getIcon()
|
string
|
getMenuService()
|
string
|
getName()
|
string
|
getPageService()
|
array
|
getPublicMethods()
Get this widget's public methods'. |
string
|
getSecurityService()
|
any
|
getSite()
Detect if we are in admin mode or in the UI, and retrieve the site accordingly. |
string
|
getSiteService()
|
string
|
getVersion()
|
any
|
renderIt()
This is the main renderit method you will need to implement in concrete widgets. |
any
|
setAuthor(string author)
|
any
|
setAuthorService(any authorService)
|
any
|
setAuthorURL(string authorURL)
|
any
|
setCategory(string category)
|
any
|
setCategoryService(any categoryService)
|
any
|
setCb(any cb)
|
any
|
setCommentService(any commentService)
|
any
|
setContentService(any contentService)
|
any
|
setContentStoreService(any contentStoreService)
|
any
|
setContentVersionService(any contentVersionService)
|
any
|
setDescription(string description)
|
any
|
setEntryService(any entryService)
|
any
|
setForgeBoxSlug(string forgeBoxSlug)
|
any
|
setHtml(any html)
|
any
|
setIcon(string icon)
|
any
|
setMenuService(any menuService)
|
any
|
setName(string name)
|
any
|
setPageService(any pageService)
|
any
|
setSecurityService(any securityService)
|
any
|
setSiteService(any siteService)
|
any
|
setVersion(string version)
|
Methods inherited from class coldbox.system.FrameworkSupertype |
---|
announce, announceInterception, async, back, externalView, forAttribute, getCache, getCachebox, getColdBoxSetting, getController, getDateTimeHelper, getEnv, getFlash, getFlow, getInstance, getIsoTime, getJsonUtil, getLog, getLogBox, getModuleConfig, getModuleSettings, getRenderer, getRequestCollection, getRequestContext, getRootWireBox, getSetting, getSystemProperty, getSystemSetting, getUserSessionIdentifier, getWirebox, ifNull, ifPresent, inDebugMode, includeUDF, isDevelopment, isProduction, isTesting, layout, listen, loadApplicationHelpers, locateDirectoryPath, locateFilePath, persistVariables, populate, populateModel, relocate, renderExternalView, renderLayout, renderview, runEvent, runRoute, setCachebox, setController, setEnv, setFlash, setFlow, setJsonUtil, setLog, setLogBox, setSetting, setWirebox, settingExists, throwIf, throwUnless, toJson, unless, view, when |
Methods inherited from class lucee.Component |
---|
None |
Constructor Detail |
---|
Base Constructor
Property Detail |
---|
access
- publicrequired
- falsereturntype
- anyserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- authorService@contentboxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyserializable
- trueaccess
- publicrequired
- falsereturntype
- anyserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- categoryService@contentboxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- CBHelper@contentboxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- commentService@contentboxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- contentService@contentboxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- contentStoreService@contentboxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- contentVersionService@contentboxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- coldboxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- entryService@contentboxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- HTMLHelper@coldboxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- logbox:logger:{this}serializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- menuService@contentboxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- pageService@contentboxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- securityService@contentboxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- siteService@contentboxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyserializable
- trueMethod Detail |
---|
Get this widget's public methods'
Detect if we are in admin mode or in the UI, and retrieve the site accordingly
This is the main renderit method you will need to implement in concrete widgets
author
authorService
authorURL
category
categoryService
cb
commentService
contentService
contentStoreService
contentVersionService
description
entryService
forgeBoxSlug
html
icon
menuService
name
pageService
securityService
siteService
version