railo-context.Componentcontentbox.model.ui.WidgetService
ContentBox - A Modular Content Platform Copyright 2012 by Luis Majano and Ortus Solutions, Corp www.ortussolutions.com Apache License, Version 2.0 Copyright Since [2012] [Luis Majano and Ortus Solutions,Corp] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Property Summary | ||||
---|---|---|---|---|
type | property | default | serializable | required |
any
|
coldbox
|
true
|
false
|
|
any
|
layoutService
|
true
|
false
|
|
any
|
log
|
true
|
false
|
|
any
|
moduleService
|
true
|
false
|
|
any
|
moduleSettings
|
true
|
false
|
|
any
|
settingService
|
true
|
false
|
|
string
|
widgetsIconsIncludePath
|
true
|
false
|
|
string
|
widgetsIconsPath
|
true
|
false
|
|
string
|
widgetsPath
|
true
|
false
|
Constructor Summary | |
---|---|
init()
Constructor. |
Method Summary | |
---|---|
WidgetService
|
createNewWidget(Widget widget)
Create new core widget. |
string
|
getColdbox()
|
string
|
getLayoutService()
|
string
|
getLog()
|
string
|
getModuleService()
|
string
|
getModuleSettings()
|
string
|
getSettingService()
|
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. |
string
|
getWidgetCode(string name, string type)
Get widget code. |
string
|
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. |
array
|
getWidgetIcons()
Get a list of widget icons available in the system. |
any
|
getWidgetRenderArgs([any udf], [any widget], [any type])
|
query
|
getWidgets()
Get installed widgets. |
string
|
getWidgetsIconsIncludePath()
|
string
|
getWidgetsIconsPath()
|
string
|
getWidgetsList()
Get installed widgets as a list of names. |
string
|
getWidgetsPath()
|
any
|
onDIComplete()
onDIComplete. |
boolean
|
removeWidget(any widgetFile)
Remove widget. |
string
|
ripExtension(any filename)
|
WidgetService
|
saveWidgetCode(string name, string code, string type)
Save widget code. |
any
|
setColdbox(any coldbox)
|
any
|
setLayoutService(any layoutService)
|
any
|
setLog(any log)
|
any
|
setModuleService(any moduleService)
|
any
|
setModuleSettings(any moduleSettings)
|
any
|
setSettingService(any settingService)
|
any
|
setWidgetsIconsIncludePath(string widgetsIconsIncludePath)
|
any
|
setWidgetsIconsPath(string widgetsIconsPath)
|
any
|
setWidgetsPath(string widgetsPath)
|
struct
|
uploadWidget(any fileField)
Upload Widget. |
Methods inherited from class railo-context.Component |
---|
None |
Constructor Detail |
---|
Constructor
Property Detail |
---|
required
- falseinject
- coldboxserializable
- truerequired
- falseinject
- LayoutService@cbserializable
- truerequired
- falseinject
- logbox:logger:{this}serializable
- truerequired
- falseinject
- ModuleService@cbserializable
- truerequired
- falseinject
- coldbox:setting:modulesserializable
- truerequired
- falseinject
- id:settingService@cbserializable
- truerequired
- falseserializable
- truerequired
- falseserializable
- truerequired
- falseserializable
- trueMethod Detail |
---|
Create new core widget
widget
Get a widget by name
name
- truetype
- This can be one of the following: core, layout, 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, layout, moduleGet widget code return String
name
- {String}type
- {String}Gets widget file path by name and type return String
name
- {String}type
- {String}Get a widget icon representation
name
- The name of the widgettype
- This can be one of the following: core, layout, moduleGet a list of widget icons available in the system
udf
widget
type
Get installed widgets
Get installed widgets as a list of names
onDIComplete
Remove widget
widgetFile
filename
Save widget code return WidgetService
name
- {String}code
- {String}type
- {String}coldbox
layoutService
log
moduleService
moduleSettings
settingService
widgetsIconsIncludePath
widgetsIconsPath
widgetsPath
Upload Widget
fileField