|
ContentBox Core API 1.5.7 | ||||
FRAMES |
WEB-INF.cftags.componentcontentbox.model.ui.LayoutService
public class LayoutService
******************************************************************************* ContentBox - A Modular Content Platform Copyright 2012 by Luis Majano and Ortus Solutions, Corp www.gocontentbox.org | www.luismajano.com | 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. *******************************************************************************
Constructor Summary | |
---|---|
init()
Constructor |
Method Summary | |
---|---|
any |
GETCBHELPER()
|
any |
GETHTML()
|
any |
GETINTERCEPTORSERVICE()
|
any |
GETLAYOUTCFCREGISTRY()
|
any |
GETLAYOUTREGISTRY()
|
any |
GETLAYOUTSINCLUDEPATH()
|
any |
GETLAYOUTSINVOCATIONPATH()
|
any |
GETLAYOUTSPATH()
|
struct |
GETLAYOUTWIDGETCACHE()
|
any |
GETLOG()
|
any |
GETMODULESETTINGS()
|
any |
GETSETTINGSERVICE()
|
any |
GETWIREBOX()
|
any |
GETZIPUTIL()
|
void |
SETCBHELPER(any cbHelper)
|
void |
SETHTML(any html)
|
void |
SETINTERCEPTORSERVICE(any interceptorService)
|
void |
SETLAYOUTCFCREGISTRY(any layoutCFCRegistry)
|
void |
SETLAYOUTREGISTRY(any layoutRegistry)
|
void |
SETLAYOUTSINCLUDEPATH(any layoutsIncludePath)
|
void |
SETLAYOUTSINVOCATIONPATH(any layoutsInvocationPath)
|
void |
SETLAYOUTSPATH(any layoutsPath)
|
void |
SETLAYOUTWIDGETCACHE(struct layoutWidgetCache)
|
void |
SETLOG(any log)
|
void |
SETMODULESETTINGS(any moduleSettings)
|
void |
SETSETTINGSERVICE(any settingService)
|
void |
SETWIREBOX(any wirebox)
|
void |
SETZIPUTIL(any zipUtil)
|
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 |
query |
getLayoutRecord(any layoutName)
Get a layout record from the registry by name |
string |
getLayoutWidgetPath(string widgetName)
Returns path for the requested widget from layout service's layout cache return String |
query |
getLayouts()
Get all registered layouts |
any |
getSettingsConstraints(any layoutName)
|
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 |
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 |
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 WEB-INF.cftags.component |
---|
|
Constructor Detail |
---|
public init()
Method Detail |
---|
public any GETCBHELPER()
public any GETHTML()
public any GETINTERCEPTORSERVICE()
public any GETLAYOUTCFCREGISTRY()
public any GETLAYOUTREGISTRY()
public any GETLAYOUTSINCLUDEPATH()
public any GETLAYOUTSINVOCATIONPATH()
public any GETLAYOUTSPATH()
public struct GETLAYOUTWIDGETCACHE()
public any GETLOG()
public any GETMODULESETTINGS()
public any GETSETTINGSERVICE()
public any GETWIREBOX()
public any GETZIPUTIL()
public void SETCBHELPER(any cbHelper)
cbHelper
public void SETHTML(any html)
html
public void SETINTERCEPTORSERVICE(any interceptorService)
interceptorService
public void SETLAYOUTCFCREGISTRY(any layoutCFCRegistry)
layoutCFCRegistry
public void SETLAYOUTREGISTRY(any layoutRegistry)
layoutRegistry
public void SETLAYOUTSINCLUDEPATH(any layoutsIncludePath)
layoutsIncludePath
public void SETLAYOUTSINVOCATIONPATH(any layoutsInvocationPath)
layoutsInvocationPath
public void SETLAYOUTSPATH(any layoutsPath)
layoutsPath
public void SETLAYOUTWIDGETCACHE(struct layoutWidgetCache)
layoutWidgetCache
public void SETLOG(any log)
log
public void SETMODULESETTINGS(any moduleSettings)
moduleSettings
public void SETSETTINGSERVICE(any settingService)
settingService
public void SETWIREBOX(any wirebox)
wirebox
public void SETZIPUTIL(any zipUtil)
zipUtil
public any activateLayout(any layoutName)
layoutName
public query buildLayoutRegistry()
public any buildSettingsForm(any activeLayout)
activeLayout
public query getActiveLayout()
public query getLayoutRecord(any layoutName)
layoutName
public string getLayoutWidgetPath(string widgetName)
widgetName
- {String}}public query getLayouts()
public any getSettingsConstraints(any layoutName)
layoutName
public string getThemeMaintenanceLayout()
public string getThemePrintLayout(any format, any layout)
format
layout
public string getThemeSearchLayout()
public boolean isActiveLayout(any layoutName)
layoutName
public void onDIComplete()
private any registerLayoutSettings(any name, array settings)
name
settings
public boolean removeLayout(any layoutName)
layoutName
public any saveLayoutSettings(any name, struct settings)
name
settings
public any startupActiveLayout()
public boolean themeMaintenanceViewExists()
private any unregisterLayoutSettings(array settings)
settings
public struct uploadLayout(any fileField)
fileField
|
ContentBox Core API 1.5.7 | ||||
FRAMES |