contentbox.widgets

Class Viewlet

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

    A widget that executes any internal ColdBox event and return its results

    Constructor Summary
    init([any controller])
    Method Summary
    any renderIt(string event, [boolean private='false'], [string args=''], [string title=''], [string titleLevel='2'])
         Execute an internal coldbox event viewlet.
     
    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

    renderIt

    public any renderIt(string event, [boolean private='false'], [string args=''], [string title=''], [string titleLevel='2'])

    Execute an internal coldbox event viewlet

    Overrides:
    renderIt in class BaseWidget
    Parameters:
    event - The ColdBox event to execute
    private - Private event or not
    args - Event arguments to pass to the viewlet execution, this should be a comma delimitted list of name value pairs. Ex: widget=true,name=Test
    title - The title to show before the dropdown or list, defaults to H2
    titleLevel - The H{level} to use, by default we use H2