Renderer

coldbox.system.mvc.core

Class Renderer

WEB-INF.cftags.component
        coldbox.system.mvc.FrameworkSupertype
            coldbox.system.mvc.core.Renderer

Class Attributes:

accessors : true

serializable : false

******************************************************************************* Copyright Since 2005 ColdBox Framework by Luis Majano and Ortus Solutions, Corp www.coldbox.org | www.luismajano.com | www.ortussolutions.com ******************************************************************************* Author : Luis Majano Description : This is ColdBox's Renderer plugin.

Property Summary
type	property	default	serializable	required
`any`	appMapping		`true`	`false`
`any`	event		`true`	`false`
`any`	explicitView		`true`	`false`
`any`	isDiscoveryCaching		`true`	`false`
`any`	layoutsConvention ********************************* PROPERTIES ******************************************.		`true`	`false`
`any`	lockName		`true`	`false`
`any`	prc		`true`	`false`
`any`	rc		`true`	`false`
`any`	renderedHelpers		`true`	`false`
`any`	viewsConvention		`true`	`false`

Constructor Summary
init(any controller) ********************************* CONSTRUCTOR ******************************************.

Method Summary
`any`	GETAPPMAPPING()
`any`	GETEVENT()
`any`	GETEXPLICITVIEW()
`any`	GETISDISCOVERYCACHING()
`any`	GETLAYOUTSCONVENTION() get: ********************************* PROPERTIES ******************************************.
`any`	GETLOCKNAME()
`any`	GETPRC()
`any`	GETRC()
`any`	GETRENDEREDHELPERS()
`any`	GETVIEWSCONVENTION()
`Renderer`	SETAPPMAPPING(any appMapping)
`Renderer`	SETEVENT(any event)
`Renderer`	SETISDISCOVERYCACHING(any isDiscoveryCaching)
`Renderer`	SETLAYOUTSCONVENTION(any layoutsConvention) set: ********************************* PROPERTIES ******************************************.
`Renderer`	SETLOCKNAME(any lockName)
`Renderer`	SETPRC(any prc)
`Renderer`	SETRC(any rc)
`Renderer`	SETRENDEREDHELPERS(any renderedHelpers)
`Renderer`	SETVIEWSCONVENTION(any viewsConvention)
`private any`	discoverViewPaths(any view)
`private any`	implicitViewChecks() ********************************* PRIVATE ******************************************.
`any`	locateLayout(any layout)
`any`	locateView(any view)
`any`	renderExternalView(any view, [struct args='[runtime expression]'])
`any`	renderLayout([any layout], [any view=''], [struct args='[runtime expression]'], [boolean prePostExempt='false']) ********************************* LAYOUT METHODS ******************************************.
`any`	renderView([any view=''], [struct args='[runtime expression]'], [any collection], [any collectionAs=''], [numeric collectionStartRow='1'], [numeric collectionMaxRows='0'], [any collectionDelim=''], [boolean prePostExempt='false'])
`any`	renderViewCollection([any view], [any viewPath], [any viewHelperPath], [any args], [any collection], [any collectionAs], [numeric collectionStartRow='1'], [numeric collectionMaxRows='0'], [any collectionDelim=''])
`any`	renderViewComposite([any view], [any viewPath], [any viewHelperPath], [any args])
`any`	setExplicitView(any view) ********************************* VIEW METHODS ******************************************.

Methods inherited from class `coldbox.system.mvc.FrameworkSupertype`
GETCONTROLLER, SETCONTROLLER, getModel, getSetting, getSettingStructure, populateModel, runEvent, setNextEvent, setSetting, settingExists

Methods inherited from class `WEB-INF.cftags.component`
None

Constructor Detail

init

public init(any controller)

*********************************** CONSTRUCTOR ********************************************

Parameters:: controller

Property Detail

appMapping

property any appMapping

Attributes:: serializable - true; required - false

event

property any event

Attributes:: serializable - true; required - false

explicitView

property any explicitView

Attributes:: serializable - true; required - false

isDiscoveryCaching

property any isDiscoveryCaching

Attributes:: serializable - true; required - false

layoutsConvention

property any layoutsConvention

*********************************** PROPERTIES ********************************************

Attributes:: serializable - true; required - false

lockName

property any lockName

Attributes:: serializable - true; required - false

prc

property any prc

Attributes:: serializable - true; required - false

rc

property any rc

Attributes:: serializable - true; required - false

renderedHelpers

property any renderedHelpers

Attributes:: serializable - true; required - false

viewsConvention

property any viewsConvention

Attributes:: serializable - true; required - false

Method Detail

GETAPPMAPPING

public any GETAPPMAPPING()

GETEVENT

public any GETEVENT()

GETEXPLICITVIEW

public any GETEXPLICITVIEW()

GETISDISCOVERYCACHING

public any GETISDISCOVERYCACHING()

GETLAYOUTSCONVENTION

public any GETLAYOUTSCONVENTION()

get: *********************************** PROPERTIES ********************************************

GETLOCKNAME

public any GETLOCKNAME()

GETPRC

public any GETPRC()

GETRC

public any GETRC()

GETRENDEREDHELPERS

public any GETRENDEREDHELPERS()

GETVIEWSCONVENTION

public any GETVIEWSCONVENTION()

SETAPPMAPPING

public Renderer SETAPPMAPPING(any appMapping)

Parameters:: appMapping

SETEVENT

public Renderer SETEVENT(any event)

Parameters:: event

SETISDISCOVERYCACHING

public Renderer SETISDISCOVERYCACHING(any isDiscoveryCaching)

Parameters:: isDiscoveryCaching

SETLAYOUTSCONVENTION

public Renderer SETLAYOUTSCONVENTION(any layoutsConvention)

set: *********************************** PROPERTIES ********************************************

Parameters:: layoutsConvention

SETLOCKNAME

public Renderer SETLOCKNAME(any lockName)

Parameters:: lockName

SETPRC

public Renderer SETPRC(any prc)

Parameters:: prc

SETRC

public Renderer SETRC(any rc)

Parameters:: rc

SETRENDEREDHELPERS

public Renderer SETRENDEREDHELPERS(any renderedHelpers)

Parameters:: renderedHelpers

SETVIEWSCONVENTION

public Renderer SETVIEWSCONVENTION(any viewsConvention)

Parameters:: viewsConvention

discoverViewPaths

private any discoverViewPaths(any view)

Parameters:: view

implicitViewChecks

private any implicitViewChecks()

*********************************** PRIVATE ********************************************

locateLayout

public any locateLayout(any layout)

Parameters:: layout

locateView

public any locateView(any view)

Parameters:: view

renderExternalView

public any renderExternalView(any view, [struct args='[runtime expression]'])

Overrides:: renderExternalView in class FrameworkSupertype

Parameters:: view; args

renderLayout

public any renderLayout([any layout], [any view=''], [struct args='[runtime expression]'], [boolean prePostExempt='false'])

*********************************** LAYOUT METHODS ********************************************

Overrides:: renderLayout in class FrameworkSupertype

Parameters:: layout; view; args; prePostExempt

renderView

public any renderView([any view=''], [struct args='[runtime expression]'], [any collection], [any collectionAs=''], [numeric collectionStartRow='1'], [numeric collectionMaxRows='0'], [any collectionDelim=''], [boolean prePostExempt='false'])

Overrides:: renderView in class FrameworkSupertype

Parameters:: view; args; collection; collectionAs; collectionStartRow; collectionMaxRows; collectionDelim; prePostExempt

renderViewCollection

public any renderViewCollection([any view], [any viewPath], [any viewHelperPath], [any args], [any collection], [any collectionAs], [numeric collectionStartRow='1'], [numeric collectionMaxRows='0'], [any collectionDelim=''])

Parameters:: view; viewPath; viewHelperPath; args; collection; collectionAs; collectionStartRow; collectionMaxRows; collectionDelim

renderViewComposite

public any renderViewComposite([any view], [any viewPath], [any viewHelperPath], [any args])

Parameters:: view; viewPath; viewHelperPath; args

setExplicitView

public any setExplicitView(any view)

*********************************** VIEW METHODS ********************************************

Parameters:: view