|
ContentBox Core API 1.6.0 | ||||
FRAMES |
WEB-INF.cftags.componentcoldbox.system.FrameworkSupertype
coldbox.system.Plugin
contentbox.model.ui.BaseWidget
public class BaseWidget
******************************************************************************* 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. ******************************************************************************* This is the base class for contentbox widgets
Property Summary | ||||
---|---|---|---|---|
Type | Property & Description | Default | Serializable | Required |
any
|
authorService
Attributes:
|
|
true
|
false
|
string
|
category
Attributes: |
|
true
|
false
|
any
|
categoryService
Attributes:
|
|
true
|
false
|
any
|
cb
Attributes:
|
|
true
|
false
|
any
|
commentService
Attributes:
|
|
true
|
false
|
any
|
contentService
Attributes:
|
|
true
|
false
|
any
|
contentStoreService
Attributes:
|
|
true
|
false
|
any
|
contentVersionService
Attributes:
|
|
true
|
false
|
any
|
entryService
Attributes:
|
|
true
|
false
|
string
|
forgeBoxSlug
Attributes: |
|
true
|
false
|
any
|
html
Attributes:
|
|
true
|
false
|
string
|
icon
Attributes: |
|
true
|
false
|
any
|
pageService
Attributes:
|
|
true
|
false
|
any
|
securityService
Attributes:
|
|
true
|
false
|
Method Summary | |
---|---|
any |
GETAUTHORSERVICE()
get: |
string |
GETCATEGORY()
get: |
any |
GETCATEGORYSERVICE()
get: |
any |
GETCB()
get: |
any |
GETCOMMENTSERVICE()
get: |
any |
GETCONTENTSERVICE()
get: |
any |
GETCONTENTSTORESERVICE()
get: |
any |
GETCONTENTVERSIONSERVICE()
get: |
any |
GETENTRYSERVICE()
get: |
string |
GETFORGEBOXSLUG()
get: |
any |
GETHTML()
get: |
string |
GETICON()
get: |
any |
GETPAGESERVICE()
get: |
any |
GETSECURITYSERVICE()
get: |
BaseWidget |
SETAUTHORSERVICE(any authorService)
set: |
BaseWidget |
SETCATEGORY(string category)
set: |
BaseWidget |
SETCATEGORYSERVICE(any categoryService)
set: |
BaseWidget |
SETCB(any cb)
set: |
BaseWidget |
SETCOMMENTSERVICE(any commentService)
set: |
BaseWidget |
SETCONTENTSERVICE(any contentService)
set: |
BaseWidget |
SETCONTENTSTORESERVICE(any contentStoreService)
set: |
BaseWidget |
SETCONTENTVERSIONSERVICE(any contentVersionService)
set: |
BaseWidget |
SETENTRYSERVICE(any entryService)
set: |
BaseWidget |
SETFORGEBOXSLUG(string forgeBoxSlug)
set: |
BaseWidget |
SETHTML(any html)
set: |
BaseWidget |
SETICON(string icon)
set: |
BaseWidget |
SETPAGESERVICE(any pageService)
set: |
BaseWidget |
SETSECURITYSERVICE(any securityService)
set: |
array |
getPublicMethods()
|
any |
renderIt()
This is the main renderit method you will need to implement in concrete widgets |
Methods inherited from class coldbox.system.Plugin |
---|
getPluginDescription, getPluginName, getPluginVersion, getRequestCollection, getRequestContext, getpluginAuthor, getpluginAuthorURL, getpluginPath, init, setPluginDescription, setPluginName, setPluginVersion, setpluginAuthor, setpluginAuthorURL
|
Methods inherited from class coldbox.system.FrameworkSupertype |
---|
$abort, $dump, $htmlhead, $include, $rethrow, $throw, addAsset, announceInterception, getColdboxOCM, getController, getDatasource, getDebugMode, getInterceptor, getMailService, getMailSettings, getMemento, getModel, getModuleSettings, getMyPlugin, getNewMail, getPlugin, getResource, getSetting, getSettingStructure, getSettingsBean, getValidationManager, getfwLocale, includeUDF, loadGlobalUDFLibraries, locateDirectoryPath, locateFilePath, persistVariables, populateModel, relocate, renderExternalView, renderLayout, renderView, runEvent, setDebugMode, setNextEvent, setNextRoute, setSetting, setfwLocale, settingExists, validateModel
|
Methods inherited from class WEB-INF.cftags.component |
---|
None
|
Property Detail |
---|
any authorService
inject
- id:authorService@cbrequired
- falseserializable
- truedefault
- string category
default
- serializable
- truerequired
- falseany categoryService
inject
- id:categoryService@cbrequired
- falseserializable
- truedefault
- any cb
inject
- id:CBHelper@cbrequired
- falseserializable
- truedefault
- any commentService
inject
- id:commentService@cbrequired
- falseserializable
- truedefault
- any contentService
inject
- id:contentService@cbrequired
- falseserializable
- truedefault
- any contentStoreService
inject
- id:contentStoreService@cbrequired
- falseserializable
- truedefault
- any contentVersionService
inject
- id:contentVersionService@cbrequired
- falseserializable
- truedefault
- any entryService
inject
- id:entryService@cbrequired
- falseserializable
- truedefault
- string forgeBoxSlug
default
- serializable
- truerequired
- falseany html
inject
- coldbox:plugin:HTMLHelperrequired
- falseserializable
- truedefault
- string icon
default
- serializable
- truerequired
- falseany pageService
inject
- id:pageService@cbrequired
- falseserializable
- truedefault
- any securityService
inject
- id:securityService@cbrequired
- falseserializable
- truedefault
- Method Detail |
---|
public any GETAUTHORSERVICE()
public string GETCATEGORY()
public any GETCATEGORYSERVICE()
public any GETCB()
public any GETCOMMENTSERVICE()
public any GETCONTENTSERVICE()
public any GETCONTENTSTORESERVICE()
public any GETCONTENTVERSIONSERVICE()
public any GETENTRYSERVICE()
public string GETFORGEBOXSLUG()
public any GETHTML()
public string GETICON()
public any GETPAGESERVICE()
public any GETSECURITYSERVICE()
public BaseWidget SETAUTHORSERVICE(any authorService)
authorService
public BaseWidget SETCATEGORY(string category)
category
public BaseWidget SETCATEGORYSERVICE(any categoryService)
categoryService
public BaseWidget SETCB(any cb)
cb
public BaseWidget SETCOMMENTSERVICE(any commentService)
commentService
public BaseWidget SETCONTENTSERVICE(any contentService)
contentService
public BaseWidget SETCONTENTSTORESERVICE(any contentStoreService)
contentStoreService
public BaseWidget SETCONTENTVERSIONSERVICE(any contentVersionService)
contentVersionService
public BaseWidget SETENTRYSERVICE(any entryService)
entryService
public BaseWidget SETFORGEBOXSLUG(string forgeBoxSlug)
forgeBoxSlug
public BaseWidget SETHTML(any html)
html
public BaseWidget SETICON(string icon)
icon
public BaseWidget SETPAGESERVICE(any pageService)
pageService
public BaseWidget SETSECURITYSERVICE(any securityService)
securityService
public array getPublicMethods()
public any renderIt()
|
ContentBox Core API 1.6.0 | ||||
FRAMES |