|
ContentBox Core API 1.6.0 | ||||
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. *******************************************************************************
Property Summary | ||||
---|---|---|---|---|
Type | Property & Description | Default | Serializable | Required |
any
|
cbHelper
Attributes:
|
|
true
|
false
|
any
|
html
Attributes:
|
|
true
|
false
|
any
|
interceptorService
Attributes:
|
|
true
|
false
|
any
|
layoutCFCRegistry
Attributes: |
|
true
|
false
|
any
|
layoutRegistry
Attributes: |
|
true
|
false
|
struct
|
layoutWidgetCache
Attributes: |
|
true
|
false
|
any
|
layoutsIncludePath
Attributes: |
|
true
|
false
|
any
|
layoutsInvocationPath
Attributes: |
|
true
|
false
|
any
|
layoutsPath
Attributes: |
|
true
|
false
|
any
|
log
Attributes:
|
|
true
|
false
|
any
|
moduleSettings
Attributes:
|
|
true
|
false
|
any
|
settingService
Attributes:
|
|
true
|
false
|
any
|
wirebox
Attributes:
|
|
true
|
false
|
any
|
zipUtil
Attributes:
|
|
true
|
false
|
Constructor Summary | |
---|---|
init()
Constructor |
Method Summary | |
---|---|
any |
GETCBHELPER()
get: |
any |
GETHTML()
get: |
any |
GETINTERCEPTORSERVICE()
get: |
any |
GETLAYOUTCFCREGISTRY()
get: |
any |
GETLAYOUTREGISTRY()
get: |
any |
GETLAYOUTSINCLUDEPATH()
get: |
any |
GETLAYOUTSINVOCATIONPATH()
get: |
any |
GETLAYOUTSPATH()
get: |
struct |
GETLAYOUTWIDGETCACHE()
get: |
any |
GETLOG()
get: |
any |
GETMODULESETTINGS()
get: |
any |
GETSETTINGSERVICE()
get: |
any |
GETWIREBOX()
get: |
any |
GETZIPUTIL()
get: |
LayoutService |
SETCBHELPER(any cbHelper)
set: |
LayoutService |
SETHTML(any html)
set: |
LayoutService |
SETINTERCEPTORSERVICE(any interceptorService)
set: |
LayoutService |
SETLAYOUTCFCREGISTRY(any layoutCFCRegistry)
set: |
LayoutService |
SETLAYOUTREGISTRY(any layoutRegistry)
set: |
LayoutService |
SETLAYOUTSINCLUDEPATH(any layoutsIncludePath)
set: |
LayoutService |
SETLAYOUTSINVOCATIONPATH(any layoutsInvocationPath)
set: |
LayoutService |
SETLAYOUTSPATH(any layoutsPath)
set: |
LayoutService |
SETLAYOUTWIDGETCACHE(struct layoutWidgetCache)
set: |
LayoutService |
SETLOG(any log)
set: |
LayoutService |
SETMODULESETTINGS(any moduleSettings)
set: |
LayoutService |
SETSETTINGSERVICE(any settingService)
set: |
LayoutService |
SETWIREBOX(any wirebox)
set: |
LayoutService |
SETZIPUTIL(any zipUtil)
set: |
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 |
---|
None
|
Constructor Detail |
---|
public init()
Property Detail |
---|
any cbHelper
inject
- provider:CBHelper@cbrequired
- falseserializable
- truedefault
- any html
inject
- coldbox:plugin:HTMLHelperrequired
- falseserializable
- truedefault
- any interceptorService
inject
- coldbox:interceptorServicerequired
- falseserializable
- truedefault
- any layoutCFCRegistry
default
- serializable
- truerequired
- falseany layoutRegistry
default
- serializable
- truerequired
- falsestruct layoutWidgetCache
default
- serializable
- truerequired
- falseany layoutsIncludePath
default
- serializable
- truerequired
- falseany layoutsInvocationPath
default
- serializable
- truerequired
- falseany layoutsPath
default
- serializable
- truerequired
- falseany log
inject
- logbox:logger:{this}required
- falseserializable
- truedefault
- any moduleSettings
inject
- coldbox:setting:modulesrequired
- falseserializable
- truedefault
- any settingService
inject
- id:settingService@cbrequired
- falseserializable
- truedefault
- any wirebox
inject
- wireboxrequired
- falseserializable
- truedefault
- any zipUtil
inject
- zipUtil@cbrequired
- falseserializable
- truedefault
- 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 LayoutService SETCBHELPER(any cbHelper)
cbHelper
public LayoutService SETHTML(any html)
html
public LayoutService SETINTERCEPTORSERVICE(any interceptorService)
interceptorService
public LayoutService SETLAYOUTCFCREGISTRY(any layoutCFCRegistry)
layoutCFCRegistry
public LayoutService SETLAYOUTREGISTRY(any layoutRegistry)
layoutRegistry
public LayoutService SETLAYOUTSINCLUDEPATH(any layoutsIncludePath)
layoutsIncludePath
public LayoutService SETLAYOUTSINVOCATIONPATH(any layoutsInvocationPath)
layoutsInvocationPath
public LayoutService SETLAYOUTSPATH(any layoutsPath)
layoutsPath
public LayoutService SETLAYOUTWIDGETCACHE(struct layoutWidgetCache)
layoutWidgetCache
public LayoutService SETLOG(any log)
log
public LayoutService SETMODULESETTINGS(any moduleSettings)
moduleSettings
public LayoutService SETSETTINGSERVICE(any settingService)
settingService
public LayoutService SETWIREBOX(any wirebox)
wirebox
public LayoutService 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.6.0 | ||||
FRAMES |