ContentBox Core API 1.5.7

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


Method Summary
 any GETAUTHORSERVICE()
 string GETCATEGORY()
 any GETCATEGORYSERVICE()
 any GETCB()
 any GETCOMMENTSERVICE()
 any GETCONTENTSERVICE()
 any GETCONTENTSTORESERVICE()
 any GETCONTENTVERSIONSERVICE()
 any GETENTRYSERVICE()
 string GETFORGEBOXSLUG()
 any GETHTML()
 string GETICON()
 any GETPAGESERVICE()
 any GETSECURITYSERVICE()
 void SETAUTHORSERVICE(any authorService)
 void SETCATEGORY(string category)
 void SETCATEGORYSERVICE(any categoryService)
 void SETCB(any cb)
 void SETCOMMENTSERVICE(any commentService)
 void SETCONTENTSERVICE(any contentService)
 void SETCONTENTSTORESERVICE(any contentStoreService)
 void SETCONTENTVERSIONSERVICE(any contentVersionService)
 void SETENTRYSERVICE(any entryService)
 void SETFORGEBOXSLUG(string forgeBoxSlug)
 void SETHTML(any html)
 void SETICON(string icon)
 void SETPAGESERVICE(any pageService)
 void SETSECURITYSERVICE(any securityService)
 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
 

Method Detail

GETAUTHORSERVICE

public any GETAUTHORSERVICE()


GETCATEGORY

public string GETCATEGORY()


GETCATEGORYSERVICE

public any GETCATEGORYSERVICE()


GETCB

public any GETCB()


GETCOMMENTSERVICE

public any GETCOMMENTSERVICE()


GETCONTENTSERVICE

public any GETCONTENTSERVICE()


GETCONTENTSTORESERVICE

public any GETCONTENTSTORESERVICE()


GETCONTENTVERSIONSERVICE

public any GETCONTENTVERSIONSERVICE()


GETENTRYSERVICE

public any GETENTRYSERVICE()


GETFORGEBOXSLUG

public string GETFORGEBOXSLUG()


GETHTML

public any GETHTML()


GETICON

public string GETICON()


GETPAGESERVICE

public any GETPAGESERVICE()


GETSECURITYSERVICE

public any GETSECURITYSERVICE()


SETAUTHORSERVICE

public void SETAUTHORSERVICE(any authorService)

Parameters:
authorService

SETCATEGORY

public void SETCATEGORY(string category)

Parameters:
category

SETCATEGORYSERVICE

public void SETCATEGORYSERVICE(any categoryService)

Parameters:
categoryService

SETCB

public void SETCB(any cb)

Parameters:
cb

SETCOMMENTSERVICE

public void SETCOMMENTSERVICE(any commentService)

Parameters:
commentService

SETCONTENTSERVICE

public void SETCONTENTSERVICE(any contentService)

Parameters:
contentService

SETCONTENTSTORESERVICE

public void SETCONTENTSTORESERVICE(any contentStoreService)

Parameters:
contentStoreService

SETCONTENTVERSIONSERVICE

public void SETCONTENTVERSIONSERVICE(any contentVersionService)

Parameters:
contentVersionService

SETENTRYSERVICE

public void SETENTRYSERVICE(any entryService)

Parameters:
entryService

SETFORGEBOXSLUG

public void SETFORGEBOXSLUG(string forgeBoxSlug)

Parameters:
forgeBoxSlug

SETHTML

public void SETHTML(any html)

Parameters:
html

SETICON

public void SETICON(string icon)

Parameters:
icon

SETPAGESERVICE

public void SETPAGESERVICE(any pageService)

Parameters:
pageService

SETSECURITYSERVICE

public void SETSECURITYSERVICE(any securityService)

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.5.7