contentbox.model.ui

Class BaseWidget

railo-context.Component
        extended by coldbox.system.FrameworkSupertype
            extended by coldbox.system.Plugin
                extended by contentbox.model.ui.BaseWidget
Class Attributes:
  • synchronized : false
  •  
  • accessors : true
  •  
  • persistent : false
  •  
    Direct Known Subclasses:
    Archives , Categories , cb , CommentForm , ContentStore , EntryInclude , Menu , MessageBox , Meta , PageInclude , RecentComments , RecentEntries , RecentPages , RelatedContent , Relocate , Renderview , RSS , SearchForm , SubPageMenu , Viewlet

    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. This is the base class for contentbox widgets

    Property Summary
    type property default serializable required
    any authorService


    • inject = id:authorService@cb
    true false
    string category


    true false
    any categoryService


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


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


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


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


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


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


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


    true false
    any html


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


    true false
    any menuService


    • inject = id:menuService@cb
    true false
    any pageService


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


    • inject = id:securityService@cb
    true false
    Method Summary
    string getAuthorService()
    string getCategory()
    string getCategoryService()
    string getCb()
    string getCommentService()
    string getContentService()
    string getContentStoreService()
    string getContentVersionService()
    string getEntryService()
    string getForgeBoxSlug()
    string getHtml()
    string getIcon()
    string getMenuService()
    string getPageService()
    array getPublicMethods()
    string getSecurityService()
    any renderIt()
         This is the main renderit method you will need to implement in concrete widgets.
    any setAuthorService(any authorService)
    any setCategory(string category)
    any setCategoryService(any categoryService)
    any setCb(any cb)
    any setCommentService(any commentService)
    any setContentService(any contentService)
    any setContentStoreService(any contentStoreService)
    any setContentVersionService(any contentVersionService)
    any setEntryService(any entryService)
    any setForgeBoxSlug(string forgeBoxSlug)
    any setHtml(any html)
    any setIcon(string icon)
    any setMenuService(any menuService)
    any setPageService(any pageService)
    any setSecurityService(any securityService)
     
    Methods inherited from class coldbox.system.Plugin
    getpluginAuthor, getpluginAuthorURL, getPluginDescription, getPluginName, getpluginPath, getPluginVersion, getRequestCollection, getRequestContext, init, setpluginAuthor, setpluginAuthorURL, setPluginDescription, setPluginName, setPluginVersion
     
    Methods inherited from class coldbox.system.FrameworkSupertype
    addAsset, announceInterception, getCache, getController, getDatasource, getInstance, getInterceptor, getModel, getModuleConfig, getModuleSettings, getMyPlugin, getPlugin, getRenderer, getSetting, getSettingStructure, includeUDF, loadApplicationHelpers, locateDirectoryPath, locateFilePath, persistVariables, populateModel, renderExternalView, renderLayout, renderView, runEvent, setController, setNextEvent, setSetting, settingExists
     
    Methods inherited from class railo-context.Component
    None

    Property Detail

    authorService

    property any authorService

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

    category

    property string category

    Attributes:
    required - false
    serializable - true

    categoryService

    property any categoryService

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

    cb

    property any cb

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

    commentService

    property any commentService

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

    contentService

    property any contentService

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

    contentStoreService

    property any contentStoreService

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

    contentVersionService

    property any contentVersionService

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

    entryService

    property any entryService

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

    forgeBoxSlug

    property string forgeBoxSlug

    Attributes:
    required - false
    serializable - true

    html

    property any html

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

    icon

    property string icon

    Attributes:
    required - false
    serializable - true

    menuService

    property any menuService

    Attributes:
    required - false
    inject - id:menuService@cb
    serializable - true

    pageService

    property any pageService

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

    securityService

    property any securityService

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

    Method Detail

    getAuthorService

    public string getAuthorService()


    getCategory

    public string getCategory()


    getCategoryService

    public string getCategoryService()


    getCb

    public string getCb()


    getCommentService

    public string getCommentService()


    getContentService

    public string getContentService()


    getContentStoreService

    public string getContentStoreService()


    getContentVersionService

    public string getContentVersionService()


    getEntryService

    public string getEntryService()


    getForgeBoxSlug

    public string getForgeBoxSlug()


    getHtml

    public string getHtml()


    getIcon

    public string getIcon()


    getMenuService

    public string getMenuService()


    getPageService

    public string getPageService()


    getPublicMethods

    public array getPublicMethods()


    getSecurityService

    public string getSecurityService()


    renderIt

    public any renderIt()

    This is the main renderit method you will need to implement in concrete widgets


    setAuthorService

    public any setAuthorService(any authorService)

    Parameters:
    authorService

    setCategory

    public any setCategory(string category)

    Parameters:
    category

    setCategoryService

    public any setCategoryService(any categoryService)

    Parameters:
    categoryService

    setCb

    public any setCb(any cb)

    Parameters:
    cb

    setCommentService

    public any setCommentService(any commentService)

    Parameters:
    commentService

    setContentService

    public any setContentService(any contentService)

    Parameters:
    contentService

    setContentStoreService

    public any setContentStoreService(any contentStoreService)

    Parameters:
    contentStoreService

    setContentVersionService

    public any setContentVersionService(any contentVersionService)

    Parameters:
    contentVersionService

    setEntryService

    public any setEntryService(any entryService)

    Parameters:
    entryService

    setForgeBoxSlug

    public any setForgeBoxSlug(string forgeBoxSlug)

    Parameters:
    forgeBoxSlug

    setHtml

    public any setHtml(any html)

    Parameters:
    html

    setIcon

    public any setIcon(string icon)

    Parameters:
    icon

    setMenuService

    public any setMenuService(any menuService)

    Parameters:
    menuService

    setPageService

    public any setPageService(any pageService)

    Parameters:
    pageService

    setSecurityService

    public any setSecurityService(any securityService)

    Parameters:
    securityService