lucee.Componentcontentbox.models.ui.WidgetService
ContentBox - A Modular Content Platform Copyright since 2012 by Ortus Solutions, Corp www.ortussolutions.com/products/contentbox --- Manages ContentBox Widgets
Property Summary | ||||
---|---|---|---|---|
type | property | default | serializable | required |
any
|
coldbox
|
true
|
false
|
|
any
|
log
|
true
|
false
|
|
any
|
moduleService
|
true
|
false
|
|
any
|
moduleSettings
|
true
|
false
|
|
any
|
settingService
|
true
|
false
|
|
any
|
themeService
|
true
|
false
|
|
string
|
widgetsPath
The widgets location path.
|
true
|
false
|
|
any
|
wirebox
|
true
|
false
|
Constructor Summary | |
---|---|
init()
Constructor. |
Method Summary | |
---|---|
string
|
getColdbox()
|
string
|
getLog()
|
string
|
getModuleService()
|
string
|
getModuleSettings()
|
string
|
getSettingService()
|
string
|
getThemeService()
|
any
|
getWidget(any name, string type='core')
Get a widget by name. |
query
|
getWidgetCategories()
Get unique, sorted widget categories from main widget query. |
string
|
getWidgetCategory(any name, string type='core')
Get a widget category. |
any
|
getWidgetFilePath(string name, string type)
Gets widget file path by name and type. |
string
|
getWidgetIcon(any name, string type='core')
Get a widget icon representation. |
any
|
getWidgetRenderArgs([any udf], [any widget], [any type])
Get widget rendering arguments. |
query
|
getWidgets()
Get installed widgets. |
string
|
getWidgetsList()
Get installed widgets as a list of names. |
string
|
getWidgetsPath()
|
string
|
getWirebox()
|
any
|
onDIComplete()
onDIComplete. |
boolean
|
removeWidget(any widgetFile)
Remove widget. |
any
|
ripExtension(any filename)
Rip Extensions from file name. |
any
|
setColdbox(any coldbox)
|
any
|
setLog(any log)
|
any
|
setModuleService(any moduleService)
|
any
|
setModuleSettings(any moduleSettings)
|
any
|
setSettingService(any settingService)
|
any
|
setThemeService(any themeService)
|
any
|
setWidgetsPath(string widgetsPath)
|
any
|
setWirebox(any wirebox)
|
struct
|
uploadWidget(any fileField)
Upload Widget. |
Methods inherited from class lucee.Component |
---|
None |
Constructor Detail |
---|
Constructor
Property Detail |
---|
access
- publicrequired
- falsereturntype
- anyinject
- coldboxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- logbox:logger:{this}serializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- ModuleService@cbserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- coldbox:setting:modulesserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- id:settingService@cbserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- themeService@cbserializable
- trueThe widgets location path
access
- publicrequired
- falsereturntype
- anyserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- wireboxserializable
- trueMethod Detail |
---|
Get a widget by name
name
- truetype
- This can be one of the following: core, theme, moduleGet unique, sorted widget categories from main widget query returns Query
Get a widget category
name
- The name of the widgettype
- This can be one of the following: core, theme, moduleGets widget file path by name and type
name
- {String}type
- {String}Get a widget icon representation
name
- The name of the widgettype
- This can be one of the following: core, theme, moduleGet widget rendering arguments
udf
- The target UDF to render out arguments forwidget
- The widget nametype
- The widget typeGet installed widgets
Get installed widgets as a list of names
onDIComplete
Remove widget
widgetFile
- The location of the widget to removeRip Extensions from file name
filename
- The target to ripcoldbox
log
moduleService
moduleSettings
settingService
themeService
widgetsPath
wirebox
Upload Widget
fileField
- The form file field to use