ContentBox Core API 1.6.0

contentbox.model.ui
Class BaseWidget

WEB-INF.cftags.component
        extended by coldbox.system.FrameworkSupertype
            extended by coldbox.system.Plugin
                extended by contentbox.model.ui.BaseWidget
Direct Known Subclasses:
Archives , Categories , CommentForm , ContentStore , EntryInclude , MessageBox , Meta , PageInclude , RSS , RecentComments , RecentEntries , RecentPages , Relocate , Renderview , SearchForm , Viewlet , cb

public class BaseWidget
extends coldbox.system.Plugin

******************************************************************************* 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:
  • inject = id:authorService@cb
true false
 string category


Attributes:
true false
 any categoryService


Attributes:
  • inject = id:categoryService@cb
true false
 any cb


Attributes:
  • inject = id:CBHelper@cb
true false
 any commentService


Attributes:
  • inject = id:commentService@cb
true false
 any contentService


Attributes:
  • inject = id:contentService@cb
true false
 any contentStoreService


Attributes:
  • inject = id:contentStoreService@cb
true false
 any contentVersionService


Attributes:
  • inject = id:contentVersionService@cb
true false
 any entryService


Attributes:
  • inject = id:entryService@cb
true false
 string forgeBoxSlug


Attributes:
true false
 any html


Attributes:
  • inject = coldbox:plugin:HTMLHelper
true false
 string icon


Attributes:
true false
 any pageService


Attributes:
  • inject = id:pageService@cb
true false
 any securityService


Attributes:
  • inject = id:securityService@cb
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

authorService

any authorService

Attributes:
inject - id:authorService@cb
required - false
serializable - true
default -

category

string category

Attributes:
default -
serializable - true
required - false

categoryService

any categoryService

Attributes:
inject - id:categoryService@cb
required - false
serializable - true
default -

cb

any cb

Attributes:
inject - id:CBHelper@cb
required - false
serializable - true
default -

commentService

any commentService

Attributes:
inject - id:commentService@cb
required - false
serializable - true
default -

contentService

any contentService

Attributes:
inject - id:contentService@cb
required - false
serializable - true
default -

contentStoreService

any contentStoreService

Attributes:
inject - id:contentStoreService@cb
required - false
serializable - true
default -

contentVersionService

any contentVersionService

Attributes:
inject - id:contentVersionService@cb
required - false
serializable - true
default -

entryService

any entryService

Attributes:
inject - id:entryService@cb
required - false
serializable - true
default -

forgeBoxSlug

string forgeBoxSlug

Attributes:
default -
serializable - true
required - false

html

any html

Attributes:
inject - coldbox:plugin:HTMLHelper
required - false
serializable - true
default -

icon

string icon

Attributes:
default -
serializable - true
required - false

pageService

any pageService

Attributes:
inject - id:pageService@cb
required - false
serializable - true
default -

securityService

any securityService

Attributes:
inject - id:securityService@cb
required - false
serializable - true
default -

Method Detail

GETAUTHORSERVICE

public any GETAUTHORSERVICE()
get:


GETCATEGORY

public string GETCATEGORY()
get:


GETCATEGORYSERVICE

public any GETCATEGORYSERVICE()
get:


GETCB

public any GETCB()
get:


GETCOMMENTSERVICE

public any GETCOMMENTSERVICE()
get:


GETCONTENTSERVICE

public any GETCONTENTSERVICE()
get:


GETCONTENTSTORESERVICE

public any GETCONTENTSTORESERVICE()
get:


GETCONTENTVERSIONSERVICE

public any GETCONTENTVERSIONSERVICE()
get:


GETENTRYSERVICE

public any GETENTRYSERVICE()
get:


GETFORGEBOXSLUG

public string GETFORGEBOXSLUG()
get:


GETHTML

public any GETHTML()
get:


GETICON

public string GETICON()
get:


GETPAGESERVICE

public any GETPAGESERVICE()
get:


GETSECURITYSERVICE

public any GETSECURITYSERVICE()
get:


SETAUTHORSERVICE

public BaseWidget SETAUTHORSERVICE(any authorService)
set:

Parameters:
authorService

SETCATEGORY

public BaseWidget SETCATEGORY(string category)
set:

Parameters:
category

SETCATEGORYSERVICE

public BaseWidget SETCATEGORYSERVICE(any categoryService)
set:

Parameters:
categoryService

SETCB

public BaseWidget SETCB(any cb)
set:

Parameters:
cb

SETCOMMENTSERVICE

public BaseWidget SETCOMMENTSERVICE(any commentService)
set:

Parameters:
commentService

SETCONTENTSERVICE

public BaseWidget SETCONTENTSERVICE(any contentService)
set:

Parameters:
contentService

SETCONTENTSTORESERVICE

public BaseWidget SETCONTENTSTORESERVICE(any contentStoreService)
set:

Parameters:
contentStoreService

SETCONTENTVERSIONSERVICE

public BaseWidget SETCONTENTVERSIONSERVICE(any contentVersionService)
set:

Parameters:
contentVersionService

SETENTRYSERVICE

public BaseWidget SETENTRYSERVICE(any entryService)
set:

Parameters:
entryService

SETFORGEBOXSLUG

public BaseWidget SETFORGEBOXSLUG(string forgeBoxSlug)
set:

Parameters:
forgeBoxSlug

SETHTML

public BaseWidget SETHTML(any html)
set:

Parameters:
html

SETICON

public BaseWidget SETICON(string icon)
set:

Parameters:
icon

SETPAGESERVICE

public BaseWidget SETPAGESERVICE(any pageService)
set:

Parameters:
pageService

SETSECURITYSERVICE

public BaseWidget SETSECURITYSERVICE(any securityService)
set:

Parameters:
securityService

getPublicMethods

public array getPublicMethods()


renderIt

public any renderIt()
This is the main renderit method you will need to implement in concrete widgets


ContentBox Core API 1.6.0