contentbox.widgets

Class PageInclude

railo-context.Component
        extended by coldbox.system.FrameworkSupertype
            extended by coldbox.system.Plugin
                extended by contentbox.model.ui.BaseWidget
                    extended by contentbox.widgets.PageInclude
Class Attributes:
  • singleton
  •  
  • synchronized : false
  •  
  • accessors : false
  •  
  • persistent : false
  •  

    A widget that can render out ContentBox pages inline

    Constructor Summary
    init([any controller])
    Method Summary
    array getSlugList()
         Return an array of slug lists, the @ignore annotation means the ContentBox widget editors do not use it only used internally.
    any renderIt(string slug, [string defaultValue])
         Renders a ContentBox page by slug name.
     
    Methods inherited from class contentbox.model.ui.BaseWidget
    getAuthorService, getCategory, getCategoryService, getCb, getCommentService, getContentService, getContentStoreService, getContentVersionService, getEntryService, getForgeBoxSlug, getHtml, getIcon, getMenuService, getPageService, getPublicMethods, getSecurityService, setAuthorService, setCategory, setCategoryService, setCb, setCommentService, setContentService, setContentStoreService, setContentVersionService, setEntryService, setForgeBoxSlug, setHtml, setIcon, setMenuService, setPageService, setSecurityService
     
    Methods inherited from class coldbox.system.Plugin
    getpluginAuthor, getpluginAuthorURL, getPluginDescription, getPluginName, getpluginPath, getPluginVersion, getRequestCollection, getRequestContext, 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

    Constructor Detail

    init

    public init([any controller])

    Parameters:
    controller

    Method Detail

    getSlugList

    public array getSlugList()

    Return an array of slug lists, the @ignore annotation means the ContentBox widget editors do not use it only used internally.


    renderIt

    public any renderIt(string slug, [string defaultValue])

    Renders a ContentBox page by slug name

    Overrides:
    renderIt in class BaseWidget
    Parameters:
    slug - The page slug to render
    defaultValue - The string to show if the page does not exist