ColdBox Platform Version 3.7.0

coldbox.system.mvc.core
Class Renderer

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

public class Renderer
extends FrameworkSupertype

******************************************************************************* 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.


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()
 void SETAPPMAPPING(any appMapping)
 void SETEVENT(any event)
 void SETISDISCOVERYCACHING(any isDiscoveryCaching)
 void SETLAYOUTSCONVENTION(any layoutsConvention)
          set: *********************************** PROPERTIES ********************************************
 void SETLOCKNAME(any lockName)
 void SETPRC(any prc)
 void SETRC(any rc)
 void SETRENDEREDHELPERS(any renderedHelpers)
 void 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
 

Constructor Detail

init

public init(any controller)
*********************************** CONSTRUCTOR ********************************************

Parameters:
controller
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 void SETAPPMAPPING(any appMapping)

Parameters:
appMapping

SETEVENT

public void SETEVENT(any event)

Parameters:
event

SETISDISCOVERYCACHING

public void SETISDISCOVERYCACHING(any isDiscoveryCaching)

Parameters:
isDiscoveryCaching

SETLAYOUTSCONVENTION

public void SETLAYOUTSCONVENTION(any layoutsConvention)
set: *********************************** PROPERTIES ********************************************

Parameters:
layoutsConvention

SETLOCKNAME

public void SETLOCKNAME(any lockName)

Parameters:
lockName

SETPRC

public void SETPRC(any prc)

Parameters:
prc

SETRC

public void SETRC(any rc)

Parameters:
rc

SETRENDEREDHELPERS

public void SETRENDEREDHELPERS(any renderedHelpers)

Parameters:
renderedHelpers

SETVIEWSCONVENTION

public void 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

ColdBox Platform Version 3.7.0