ColdBox Platform Version 3.7.0

coldbox.system.mvc
Class FrameworkSupertype

WEB-INF.cftags.component
        extended by coldbox.system.mvc.FrameworkSupertype
Direct Known Subclasses:
EventHandler , Renderer

public class FrameworkSupertype
extends WEB-INF.cftags.component

******************************************************************************* 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 : Manage Event Handlers


Method Summary
 any GETCONTROLLER()
 void SETCONTROLLER(any controller)
 any getModel([any name], [any dsl], [any initArguments='[runtime expression]'])
          Get a model object
 any getSetting(any name, [boolean fwSetting='false'], [any defaultValue])
          Get a setting from the system
 any getSettingStructure([boolean fwSetting='false'], [boolean deepCopyFlag='false'])
          Get all the settings structure
 any populateModel(any model, [any scope=''], [boolean trustedSetter='false'], [any include=''], [any exclude=''], [boolean ignoreEmpty='false'])
          Populate a model object from the request Collection
 any renderExternalView(any view, [struct args='[runtime expression]'])
          Rendering all kinds of external views
 any renderLayout([any layout], [any view], [any args])
          Rendering layouts
 any renderView(any view, [struct args='[runtime expression]'], [any collection], [any collectionAs])
          Rendering all kinds of views
 any runEvent([any event], [boolean postProcessExempt='false'], [boolean private='false'], [boolean defaultEvent='false'], [struct eventArgument='[runtime expression]'])
          Run an internal ColdBox event
 any setNextEvent([any event], [any URL], [any URI], [any queryString], [boolean addToken], [boolean ssl], [any baseURL], [boolean postProcessExempt], [numeric statusCode])
          Relocate the user to another location
 boolean setSetting(any name, any value)
          Set a new setting in the system
 boolean settingExists(any name, [boolean fwSetting='false'])
          Verify a setting from the system
 
Methods inherited from class WEB-INF.cftags.component
 

Method Detail

GETCONTROLLER

public any GETCONTROLLER()


SETCONTROLLER

public void SETCONTROLLER(any controller)

Parameters:
controller

getModel

public any getModel([any name], [any dsl], [any initArguments='[runtime expression]'])
Get a model object

Parameters:
name
dsl
initArguments

getSetting

public any getSetting(any name, [boolean fwSetting='false'], [any defaultValue])
Get a setting from the system

Parameters:
name
fwSetting
defaultValue

getSettingStructure

public any getSettingStructure([boolean fwSetting='false'], [boolean deepCopyFlag='false'])
Get all the settings structure

Parameters:
fwSetting
deepCopyFlag

populateModel

public any populateModel(any model, [any scope=''], [boolean trustedSetter='false'], [any include=''], [any exclude=''], [boolean ignoreEmpty='false'])
Populate a model object from the request Collection

Parameters:
model
scope
trustedSetter
include
exclude
ignoreEmpty

renderExternalView

public any renderExternalView(any view, [struct args='[runtime expression]'])
Rendering all kinds of external views

Parameters:
view
args

renderLayout

public any renderLayout([any layout], [any view], [any args])
Rendering layouts

Parameters:
layout
view
args

renderView

public any renderView(any view, [struct args='[runtime expression]'], [any collection], [any collectionAs])
Rendering all kinds of views

Parameters:
view
args
collection
collectionAs

runEvent

public any runEvent([any event], [boolean postProcessExempt='false'], [boolean private='false'], [boolean defaultEvent='false'], [struct eventArgument='[runtime expression]'])
Run an internal ColdBox event

Parameters:
event
postProcessExempt
private
defaultEvent
eventArgument

setNextEvent

public any setNextEvent([any event], [any URL], [any URI], [any queryString], [boolean addToken], [boolean ssl], [any baseURL], [boolean postProcessExempt], [numeric statusCode])
Relocate the user to another location

Parameters:
event
URL
URI
queryString
addToken
ssl
baseURL
postProcessExempt
statusCode

setSetting

public boolean setSetting(any name, any value)
Set a new setting in the system

Parameters:
name
value

settingExists

public boolean settingExists(any name, [boolean fwSetting='false'])
Verify a setting from the system

Parameters:
name
fwSetting

ColdBox Platform Version 3.7.0