Callable

Class

ColdBox Platform Version 2.6.4

FRAMES

coldbox.system.interceptors
Class ColdboxSideBar

WEB-INF.cftags.component
        coldbox.system.FrameworkSupertype
            coldbox.system.Interceptor
                coldbox.system.interceptors.ColdboxSideBar

public class ColdboxSideBar
extends Interceptor
extends Interceptor

The ColdBox Developer Side Bar

Method Summary
`void`	`Configure()` This is the configuration method for your interceptors
`void`	`afterAspectsLoad(RequestContext event)`
`private string`	`getCurrentURL()`
`private any`	`getFileContent(string filePath, [boolean isBinary='false'])` Read a file for its binary or content
`private boolean`	`getIsRender(RequestContext event)` Checks if we can render the sidebar
`private any`	`getPropertyDefault(string propertyName)` Get a property default
`string`	`getRenderedSideBar(RequestContext event)` Render our beautiful sidebar
`private struct`	`getSideBarDefaults()` Get the side bar defaults, lazy loaded
`void`	`onException(RequestContext event)`
`void`	`postRender(RequestContext event)`
`void`	`preProcess(RequestContext event)`
`private void`	`readSideBarXML()` Read the sidebar xml configuration file
`private void`	`setPropertyDefault(string propertyName, any propertyValue)` Insert a property

Methods inherited from class coldbox.system.Interceptor
`appendToBuffer, clearBuffer, getBufferObject, getBufferString, getInterceptorService, getProperty, getproperties, init, propertyExists, setProperty, setproperties, unregister`

Methods inherited from class coldbox.system.FrameworkSupertype
$abort, $dump, $htmlhead, $include, $rethrow, $throw, addAsset, announceInterception, getColdboxOCM, getController, getDatasource, getDebugMode, getHash, getInstance, getInterceptor, getMailSettings, getModel, getModuleSettings, getMyPlugin, getPlugin, getResource, getSetting, getSettingStructure, getSettingsBean, getfwLocale, includeUDF, locateDirectoryPath, locateFilePath, persistVariables, populateModel, relocate, renderExternalView, renderView, runEvent, setDebugMode, setNextEvent, setNextRoute, setSetting, setfwLocale, settingExists

Methods inherited from class coldbox.system.FrameworkSupertype

$abort, $dump, $htmlhead, $include, $rethrow, $throw, addAsset, announceInterception, getColdboxOCM, getController, getDatasource, getDebugMode, getHash, getInstance, getInterceptor, getMailSettings, getModel, getModuleSettings, getMyPlugin, getPlugin, getResource, getSetting, getSettingStructure, getSettingsBean, getfwLocale, includeUDF, locateDirectoryPath, locateFilePath, persistVariables, populateModel, relocate, renderExternalView, renderView, runEvent, setDebugMode, setNextEvent, setNextRoute, setSetting, setfwLocale, settingExists

Methods inherited from class WEB-INF.cftags.component

Method Detail

Configure

public void Configure()

This is the configuration method for your interceptors

afterAspectsLoad

public void afterAspectsLoad(RequestContext event)

Parameters:: event

getCurrentURL

private string getCurrentURL()

getFileContent

private any getFileContent(string filePath, [boolean isBinary='false'])

Read a file for its binary or content.

getIsRender

private boolean getIsRender(RequestContext event)

Checks if we can render the sidebar

getPropertyDefault

private any getPropertyDefault(string propertyName)

Get a property default

getRenderedSideBar

public string getRenderedSideBar(RequestContext event)

Render our beautiful sidebar

getSideBarDefaults

private struct getSideBarDefaults()

Get the side bar defaults, lazy loaded

onException

public void onException(RequestContext event)

Parameters:: event

postRender

public void postRender(RequestContext event)

Parameters:: event

preProcess

public void preProcess(RequestContext event)

Parameters:: event

readSideBarXML

private void readSideBarXML()

Read the sidebar xml configuration file

setPropertyDefault

private void setPropertyDefault(string propertyName, any propertyValue)

Insert a property

Overview

Package