railo-context.Componentcontentbox.model.ui.LayoutService
ContentBox - A Modular Content Platform Copyright 2012 by Luis Majano and Ortus Solutions, Corp www.ortussolutions.com Apache License, Version 2.0 Copyright Since [2012] [Luis Majano and Ortus Solutions,Corp] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Property Summary | ||||
---|---|---|---|---|
type | property | default | serializable | required |
any
|
cbHelper
|
true
|
false
|
|
any
|
html
|
true
|
false
|
|
any
|
interceptorService
|
true
|
false
|
|
any
|
layoutCFCRegistry
|
true
|
false
|
|
any
|
layoutRegistry
|
true
|
false
|
|
any
|
layoutsIncludePath
|
true
|
false
|
|
any
|
layoutsInvocationPath
|
true
|
false
|
|
any
|
layoutsPath
|
true
|
false
|
|
struct
|
layoutWidgetCache
|
true
|
false
|
|
any
|
log
|
true
|
false
|
|
any
|
moduleSettings
|
true
|
false
|
|
any
|
settingService
|
true
|
false
|
|
any
|
wirebox
|
true
|
false
|
|
any
|
zipUtil
|
true
|
false
|
Constructor Summary | |
---|---|
init()
Constructor. |
Method Summary | |
---|---|
any
|
activateLayout(any layoutName)
Activate the current layout in the settings. |
query
|
buildLayoutRegistry()
Build layout registry. |
any
|
buildSettingsForm(any activeLayout)
|
query
|
getActiveLayout()
Get active layout record. |
string
|
getCbHelper()
|
string
|
getHtml()
|
string
|
getInterceptorService()
|
string
|
getLayoutCFCRegistry()
|
query
|
getLayoutRecord(any layoutName)
Get a layout record from the registry by name. |
string
|
getLayoutRegistry()
|
query
|
getLayouts()
Get all registered layouts. |
string
|
getLayoutsIncludePath()
|
string
|
getLayoutsInvocationPath()
|
string
|
getLayoutsPath()
|
string
|
getLayoutWidgetCache()
|
string
|
getLayoutWidgetPath(string widgetName)
Returns path for the requested widget from layout service's layout cache. |
string
|
getLog()
|
string
|
getModuleSettings()
|
any
|
getSettingsConstraints(any layoutName)
|
string
|
getSettingService()
|
string
|
getThemeMaintenanceLayout()
Get the current theme's maintenance layout. |
string
|
getThemePrintLayout(any format, any layout)
Get the current theme's print layouts in ColdBox layout string format. |
string
|
getThemeSearchLayout()
Get the current theme's search layout. |
string
|
getWirebox()
|
string
|
getZipUtil()
|
boolean
|
isActiveLayout(any layoutName)
Is active layout check. |
void
|
onDIComplete()
onDIComplete startup the layouting services. |
private any
|
registerLayoutSettings(any name, array settings)
|
boolean
|
removeLayout(any layoutName)
Remove layout. |
any
|
saveLayoutSettings(any name, struct settings)
|
any
|
setCbHelper(any cbHelper)
|
any
|
setHtml(any html)
|
any
|
setInterceptorService(any interceptorService)
|
any
|
setLayoutCFCRegistry(any layoutCFCRegistry)
|
any
|
setLayoutRegistry(any layoutRegistry)
|
any
|
setLayoutsIncludePath(any layoutsIncludePath)
|
any
|
setLayoutsInvocationPath(any layoutsInvocationPath)
|
any
|
setLayoutsPath(any layoutsPath)
|
any
|
setLayoutWidgetCache(struct layoutWidgetCache)
|
any
|
setLog(any log)
|
any
|
setModuleSettings(any moduleSettings)
|
any
|
setSettingService(any settingService)
|
any
|
setWirebox(any wirebox)
|
any
|
setZipUtil(any zipUtil)
|
any
|
startupActiveLayout()
Startup Active Layout procedures. |
boolean
|
themeMaintenanceViewExists()
Does theme have a maintenance view. |
private any
|
unregisterLayoutSettings(array settings)
|
struct
|
uploadLayout(any fileField)
Upload Layout, returns [error:boolean,messages:string]. |
Methods inherited from class railo-context.Component |
---|
None |
Constructor Detail |
---|
Constructor
Property Detail |
---|
required
- falseinject
- provider:CBHelper@cbserializable
- truerequired
- falseinject
- coldbox:plugin:HTMLHelperserializable
- truerequired
- falseinject
- coldbox:interceptorServiceserializable
- truerequired
- falseserializable
- truerequired
- falseserializable
- truerequired
- falseserializable
- truerequired
- falseserializable
- truerequired
- falseserializable
- truerequired
- falseserializable
- truerequired
- falseinject
- logbox:logger:{this}serializable
- truerequired
- falseinject
- coldbox:setting:modulesserializable
- truerequired
- falseinject
- id:settingService@cbserializable
- truerequired
- falseinject
- wireboxserializable
- truerequired
- falseinject
- zipUtil@cbserializable
- trueMethod Detail |
---|
Activate the current layout in the settings
layoutName
Build layout registry
activeLayout
Get active layout record
Get a layout record from the registry by name
layoutName
Get all registered layouts
Returns path for the requested widget from layout service's layout cache return String
widgetName
- {String}}layoutName
Get the current theme's maintenance layout
Get the current theme's print layouts in ColdBox layout string format
format
layout
Get the current theme's search layout
Is active layout check
layoutName
onDIComplete startup the layouting services
name
settings
Remove layout
layoutName
name
settings
cbHelper
html
interceptorService
layoutCFCRegistry
layoutRegistry
layoutsIncludePath
layoutsInvocationPath
layoutsPath
layoutWidgetCache
log
moduleSettings
settingService
wirebox
zipUtil
Startup Active Layout procedures
Does theme have a maintenance view
settings
Upload Layout, returns [error:boolean,messages:string]
fileField