|
ContentBox Core API 1.6.0 | ||||
FRAMES |
WEB-INF.cftags.componentcontentbox.model.ui.WidgetService
public class WidgetService
******************************************************************************* ContentBox - A Modular Content Platform Copyright 2012 by Luis Majano and Ortus Solutions, Corp www.gocontentbox.org | www.luismajano.com | 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 & Description | Default | Serializable | Required |
any
|
coldbox
Attributes:
|
|
true
|
false
|
any
|
layoutService
Attributes:
|
|
true
|
false
|
any
|
log
Attributes:
|
|
true
|
false
|
any
|
moduleService
Attributes:
|
|
true
|
false
|
any
|
moduleSettings
Attributes:
|
|
true
|
false
|
any
|
settingService
Attributes:
|
|
true
|
false
|
string
|
widgetsIconsIncludePath
Attributes: |
|
true
|
false
|
string
|
widgetsIconsPath
Attributes: |
|
true
|
false
|
string
|
widgetsPath
Attributes: |
|
true
|
false
|
Constructor Summary | |
---|---|
init()
|
Method Summary | |
---|---|
any |
GETCOLDBOX()
get: |
any |
GETLAYOUTSERVICE()
get: |
any |
GETLOG()
get: |
any |
GETMODULESERVICE()
get: |
any |
GETMODULESETTINGS()
get: |
any |
GETSETTINGSERVICE()
get: |
string |
GETWIDGETSICONSINCLUDEPATH()
get: |
string |
GETWIDGETSICONSPATH()
get: |
string |
GETWIDGETSPATH()
get: |
WidgetService |
SETCOLDBOX(any coldbox)
set: |
WidgetService |
SETLAYOUTSERVICE(any layoutService)
set: |
WidgetService |
SETLOG(any log)
set: |
WidgetService |
SETMODULESERVICE(any moduleService)
set: |
WidgetService |
SETMODULESETTINGS(any moduleSettings)
set: |
WidgetService |
SETSETTINGSERVICE(any settingService)
set: |
WidgetService |
SETWIDGETSICONSINCLUDEPATH(string widgetsIconsIncludePath)
set: |
WidgetService |
SETWIDGETSICONSPATH(string widgetsIconsPath)
set: |
WidgetService |
SETWIDGETSPATH(string widgetsPath)
set: |
WidgetService |
createNewWidget(Widget widget)
Create new core widget |
any |
getWidget(any name, string type='core')
Get a widget by name |
query |
getWidgetCategories()
Get unique, sorted widget categories from main widget query returns Query |
string |
getWidgetCategory(any name, string type='core')
|
string |
getWidgetCode(string name, string type)
Get widget code return String |
string |
getWidgetFilePath(string name, string type)
Gets widget file path by name and type return String |
string |
getWidgetIcon(any name, string type='core')
|
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 |
getWidgetsList()
Get installed widgets as a list of names |
any |
onDIComplete()
onDIComplete |
boolean |
removeWidget(any widgetFile)
Remove widget |
string |
ripExtension(any filename)
|
WidgetService |
saveWidgetCode(string name, string code, string type)
Save widget code return WidgetService |
struct |
uploadWidget(any fileField)
Upload Widget |
Methods inherited from class WEB-INF.cftags.component |
---|
None
|
Constructor Detail |
---|
public init()
Property Detail |
---|
any coldbox
inject
- coldboxrequired
- falseserializable
- truedefault
- any layoutService
inject
- LayoutService@cbrequired
- falseserializable
- truedefault
- any log
inject
- logbox:logger:{this}required
- falseserializable
- truedefault
- any moduleService
inject
- ModuleService@cbrequired
- falseserializable
- truedefault
- any moduleSettings
inject
- coldbox:setting:modulesrequired
- falseserializable
- truedefault
- any settingService
inject
- id:settingService@cbrequired
- falseserializable
- truedefault
- string widgetsIconsIncludePath
default
- serializable
- truerequired
- falsestring widgetsIconsPath
default
- serializable
- truerequired
- falsestring widgetsPath
default
- serializable
- truerequired
- falseMethod Detail |
---|
public any GETCOLDBOX()
public any GETLAYOUTSERVICE()
public any GETLOG()
public any GETMODULESERVICE()
public any GETMODULESETTINGS()
public any GETSETTINGSERVICE()
public string GETWIDGETSICONSINCLUDEPATH()
public string GETWIDGETSICONSPATH()
public string GETWIDGETSPATH()
public WidgetService SETCOLDBOX(any coldbox)
coldbox
public WidgetService SETLAYOUTSERVICE(any layoutService)
layoutService
public WidgetService SETLOG(any log)
log
public WidgetService SETMODULESERVICE(any moduleService)
moduleService
public WidgetService SETMODULESETTINGS(any moduleSettings)
moduleSettings
public WidgetService SETSETTINGSERVICE(any settingService)
settingService
public WidgetService SETWIDGETSICONSINCLUDEPATH(string widgetsIconsIncludePath)
widgetsIconsIncludePath
public WidgetService SETWIDGETSICONSPATH(string widgetsIconsPath)
widgetsIconsPath
public WidgetService SETWIDGETSPATH(string widgetsPath)
widgetsPath
public WidgetService createNewWidget(Widget widget)
widget
public any getWidget(any name, string type='core')
name
type
public query getWidgetCategories()
public string getWidgetCategory(any name, string type='core')
name
type
public string getWidgetCode(string name, string type)
name
- {String}type
- {String}public string getWidgetFilePath(string name, string type)
name
- {String}type
- {String}public string getWidgetIcon(any name, string type='core')
name
type
public array getWidgetIcons()
public any getWidgetRenderArgs([any udf], [any widget], [any type])
udf
widget
type
public query getWidgets()
public string getWidgetsList()
public any onDIComplete()
public boolean removeWidget(any widgetFile)
widgetFile
public string ripExtension(any filename)
filename
public WidgetService saveWidgetCode(string name, string code, string type)
name
- {String}code
- {String}type
- {String}public struct uploadWidget(any fileField)
fileField
|
ContentBox Core API 1.6.0 | ||||
FRAMES |