BaseWidget

contentbox.models.ui

Class BaseWidget

lucee.Component
    coldbox.system.FrameworkSupertype
      contentbox.models.ui.BaseWidget

Direct Known Subclasses:

Hello , Today , Archives , Categories , cb , CommentForm , ContentStore , EntryInclude , Menu , Meta , PageInclude , RecentComments , RecentEntries , RecentPages , RelatedContent , Relocate , Renderview , RSS , SearchForm , SubPageMenu , Viewlet

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.

Class Attributes:

synchronized : false

accessors : true

persistent : false

Property Summary
type	property	default	serializable	required
`string`	author access = public returntype = any		`true`	`false`
`any`	authorService access = public returntype = any inject = id:authorService@cb		`true`	`false`
`string`	authorURL access = public returntype = any		`true`	`false`
`string`	category access = public returntype = any		`true`	`false`
`any`	categoryService access = public returntype = any inject = id:categoryService@cb		`true`	`false`
`any`	cb access = public returntype = any inject = id:CBHelper@cb		`true`	`false`
`any`	commentService access = public returntype = any inject = id:commentService@cb		`true`	`false`
`any`	contentService access = public returntype = any inject = id:contentService@cb		`true`	`false`
`any`	contentStoreService access = public returntype = any inject = id:contentStoreService@cb		`true`	`false`
`any`	contentVersionService access = public returntype = any inject = id:contentVersionService@cb		`true`	`false`
`any`	controller access = public returntype = any inject = coldbox		`true`	`false`
`string`	description access = public returntype = any		`true`	`false`
`any`	entryService access = public returntype = any inject = id:entryService@cb		`true`	`false`
`string`	forgeBoxSlug access = public returntype = any		`true`	`false`
`any`	html access = public returntype = any inject = HTMLHelper@coldbox		`true`	`false`
`string`	icon access = public returntype = any		`true`	`false`
`any`	log access = public returntype = any inject = logbox:logger:{this}		`true`	`false`
`any`	menuService access = public returntype = any inject = id:menuService@cb		`true`	`false`
`string`	name access = public returntype = any		`true`	`false`
`any`	pageService access = public returntype = any inject = id:pageService@cb		`true`	`false`
`any`	securityService access = public returntype = any inject = id:securityService@cb		`true`	`false`
`string`	version access = public returntype = any		`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`	getLog()
`string`	getMenuService()
`string`	getName()
`string`	getPageService()
`array`	getPublicMethods()
`string`	getSecurityService()
`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`	setLog(any log)
`any`	setMenuService(any menuService)
`any`	setName(string name)
`any`	setPageService(any pageService)
`any`	setSecurityService(any securityService)
`any`	setVersion(string version)

Methods inherited from class `coldbox.system.FrameworkSupertype`
addAsset, announceInterception, getCache, getController, getInstance, getInterceptor, getModel, getModuleConfig, getModuleSettings, getMyPlugin, getPlugin, getRenderer, getRequestCollection, getRequestContext, getSetting, getSettingStructure, includeUDF, loadApplicationHelpers, locateDirectoryPath, locateFilePath, persistVariables, populateModel, relocate, renderExternalView, renderLayout, renderView, runEvent, setController, setNextEvent, setSetting, settingExists

Methods inherited from class coldbox.system.FrameworkSupertype

addAsset, announceInterception, getCache, getController, getInstance, getInterceptor, getModel, getModuleConfig, getModuleSettings, getMyPlugin, getPlugin, getRenderer, getRequestCollection, getRequestContext, getSetting, getSettingStructure, includeUDF, loadApplicationHelpers, locateDirectoryPath, locateFilePath, persistVariables, populateModel, relocate, renderExternalView, renderLayout, renderView, runEvent, setController, setNextEvent, setSetting, settingExists

Methods inherited from class `lucee.Component`
None

Constructor Detail

init

public init()

Base Constructor

Property Detail

author

property string author

Attributes:: access - public; required - false; returntype - any; serializable - true

authorService

property any authorService

Attributes:: access - public; required - false; returntype - any; inject - id:authorService@cb; serializable - true

authorURL

property string authorURL

Attributes:: access - public; required - false; returntype - any; serializable - true

categoryService

property any categoryService

Attributes:: access - public; required - false; returntype - any; inject - id:categoryService@cb; serializable - true

cb

property any cb

Attributes:: access - public; required - false; returntype - any; inject - id:CBHelper@cb; serializable - true

commentService

property any commentService

Attributes:: access - public; required - false; returntype - any; inject - id:commentService@cb; serializable - true

contentService

property any contentService

Attributes:: access - public; required - false; returntype - any; inject - id:contentService@cb; serializable - true

contentStoreService

property any contentStoreService

Attributes:: access - public; required - false; returntype - any; inject - id:contentStoreService@cb; serializable - true

contentVersionService

property any contentVersionService

Attributes:: access - public; required - false; returntype - any; inject - id:contentVersionService@cb; serializable - true

controller

property any controller

Attributes:: access - public; required - false; returntype - any; inject - coldbox; serializable - true

description

property string description

Attributes:: access - public; required - false; returntype - any; serializable - true

entryService

property any entryService

Attributes:: access - public; required - false; returntype - any; inject - id:entryService@cb; serializable - true

forgeBoxSlug

property string forgeBoxSlug

Attributes:: access - public; required - false; returntype - any; serializable - true

html

property any html

Attributes:: access - public; required - false; returntype - any; inject - HTMLHelper@coldbox; serializable - true

icon

property string icon

Attributes:: access - public; required - false; returntype - any; serializable - true

log

property any log

Attributes:: access - public; required - false; returntype - any; inject - logbox:logger:{this}; serializable - true

menuService

property any menuService

Attributes:: access - public; required - false; returntype - any; inject - id:menuService@cb; serializable - true

name

property string name

Attributes:: access - public; required - false; returntype - any; serializable - true

pageService

property any pageService

Attributes:: access - public; required - false; returntype - any; inject - id:pageService@cb; serializable - true

securityService

property any securityService

Attributes:: access - public; required - false; returntype - any; inject - id:securityService@cb; serializable - true

version

property string version

Attributes:: access - public; required - false; returntype - any; serializable - true

Method Detail

getAuthor

public string getAuthor()

getAuthorService

public string getAuthorService()

getAuthorURL

public string getAuthorURL()

getCategory

public string getCategory()

getCategoryService

public string getCategoryService()

getCb

public string getCb()

getCommentService

public string getCommentService()

getContentService

public string getContentService()

getContentStoreService

public string getContentStoreService()

getContentVersionService

public string getContentVersionService()

getDescription

public string getDescription()

getEntryService

public string getEntryService()

getForgeBoxSlug

public string getForgeBoxSlug()

getHtml

public string getHtml()

getIcon

public string getIcon()

getLog

public string getLog()

getMenuService

public string getMenuService()

getName

public string getName()

getPageService

public string getPageService()

getPublicMethods

public array getPublicMethods()

getSecurityService

public string getSecurityService()

getVersion

public string getVersion()

renderIt

public any renderIt()

This is the main renderit method you will need to implement in concrete widgets

setAuthor

public any setAuthor(string author)

Parameters:: author

setAuthorService

public any setAuthorService(any authorService)

Parameters:: authorService

setAuthorURL

public any setAuthorURL(string authorURL)

Parameters:: authorURL

setCategory

public any setCategory(string category)

Parameters:: category

setCategoryService

public any setCategoryService(any categoryService)

Parameters:: categoryService

setCb

public any setCb(any cb)

Parameters:: cb

setCommentService

public any setCommentService(any commentService)

Parameters:: commentService

setContentService

public any setContentService(any contentService)

Parameters:: contentService

setContentStoreService

public any setContentStoreService(any contentStoreService)

Parameters:: contentStoreService

setContentVersionService

public any setContentVersionService(any contentVersionService)

Parameters:: contentVersionService

setDescription

public any setDescription(string description)

Parameters:: description

setEntryService

public any setEntryService(any entryService)

Parameters:: entryService

setForgeBoxSlug

public any setForgeBoxSlug(string forgeBoxSlug)

Parameters:: forgeBoxSlug

setHtml

public any setHtml(any html)

Parameters:: html

setIcon

public any setIcon(string icon)

Parameters:: icon

setLog

public any setLog(any log)

Parameters:: log

setMenuService

public any setMenuService(any menuService)

Parameters:: menuService

setName

public any setName(string name)

Parameters:: name

setPageService

public any setPageService(any pageService)

Parameters:: pageService

setSecurityService

public any setSecurityService(any securityService)

Parameters:: securityService

setVersion

public any setVersion(string version)

Parameters:: version