ContentBox Core API 1.5.7

contentbox.model.ui
Class LayoutService

WEB-INF.cftags.component
        extended by contentbox.model.ui.LayoutService

public class LayoutService
extends WEB-INF.cftags.component

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

init

public init()
Constructor

Method Detail

GETCBHELPER

public any GETCBHELPER()


GETHTML

public any GETHTML()


GETINTERCEPTORSERVICE

public any GETINTERCEPTORSERVICE()


GETLAYOUTCFCREGISTRY

public any GETLAYOUTCFCREGISTRY()


GETLAYOUTREGISTRY

public any GETLAYOUTREGISTRY()


GETLAYOUTSINCLUDEPATH

public any GETLAYOUTSINCLUDEPATH()


GETLAYOUTSINVOCATIONPATH

public any GETLAYOUTSINVOCATIONPATH()


GETLAYOUTSPATH

public any GETLAYOUTSPATH()


GETLAYOUTWIDGETCACHE

public struct GETLAYOUTWIDGETCACHE()


GETLOG

public any GETLOG()


GETMODULESETTINGS

public any GETMODULESETTINGS()


GETSETTINGSERVICE

public any GETSETTINGSERVICE()


GETWIREBOX

public any GETWIREBOX()


GETZIPUTIL

public any GETZIPUTIL()


SETCBHELPER

public void SETCBHELPER(any cbHelper)

Parameters:
cbHelper

SETHTML

public void SETHTML(any html)

Parameters:
html

SETINTERCEPTORSERVICE

public void SETINTERCEPTORSERVICE(any interceptorService)

Parameters:
interceptorService

SETLAYOUTCFCREGISTRY

public void SETLAYOUTCFCREGISTRY(any layoutCFCRegistry)

Parameters:
layoutCFCRegistry

SETLAYOUTREGISTRY

public void SETLAYOUTREGISTRY(any layoutRegistry)

Parameters:
layoutRegistry

SETLAYOUTSINCLUDEPATH

public void SETLAYOUTSINCLUDEPATH(any layoutsIncludePath)

Parameters:
layoutsIncludePath

SETLAYOUTSINVOCATIONPATH

public void SETLAYOUTSINVOCATIONPATH(any layoutsInvocationPath)

Parameters:
layoutsInvocationPath

SETLAYOUTSPATH

public void SETLAYOUTSPATH(any layoutsPath)

Parameters:
layoutsPath

SETLAYOUTWIDGETCACHE

public void SETLAYOUTWIDGETCACHE(struct layoutWidgetCache)

Parameters:
layoutWidgetCache

SETLOG

public void SETLOG(any log)

Parameters:
log

SETMODULESETTINGS

public void SETMODULESETTINGS(any moduleSettings)

Parameters:
moduleSettings

SETSETTINGSERVICE

public void SETSETTINGSERVICE(any settingService)

Parameters:
settingService

SETWIREBOX

public void SETWIREBOX(any wirebox)

Parameters:
wirebox

SETZIPUTIL

public void SETZIPUTIL(any zipUtil)

Parameters:
zipUtil

activateLayout

public any activateLayout(any layoutName)
Activate the current layout in the settings

Parameters:
layoutName

buildLayoutRegistry

public query buildLayoutRegistry()
Build layout registry


buildSettingsForm

public any buildSettingsForm(any activeLayout)

Parameters:
activeLayout

getActiveLayout

public query getActiveLayout()
Get active layout record


getLayoutRecord

public query getLayoutRecord(any layoutName)
Get a layout record from the registry by name

Parameters:
layoutName

getLayoutWidgetPath

public string getLayoutWidgetPath(string widgetName)
Returns path for the requested widget from layout service's layout cache return String

Parameters:
widgetName - {String}}

getLayouts

public query getLayouts()
Get all registered layouts


getSettingsConstraints

public any getSettingsConstraints(any layoutName)

Parameters:
layoutName

getThemeMaintenanceLayout

public string getThemeMaintenanceLayout()
Get the current theme's maintenance layout


getThemePrintLayout

public string getThemePrintLayout(any format, any layout)
Get the current theme's print layouts in ColdBox layout string format

Parameters:
format
layout

getThemeSearchLayout

public string getThemeSearchLayout()
Get the current theme's search layout


isActiveLayout

public boolean isActiveLayout(any layoutName)
Is active layout check

Parameters:
layoutName

onDIComplete

public void onDIComplete()
onDIComplete startup the layouting services


registerLayoutSettings

private any registerLayoutSettings(any name, array settings)

Parameters:
name
settings

removeLayout

public boolean removeLayout(any layoutName)
Remove layout

Parameters:
layoutName

saveLayoutSettings

public any saveLayoutSettings(any name, struct settings)

Parameters:
name
settings

startupActiveLayout

public any startupActiveLayout()
Startup Active Layout procedures


themeMaintenanceViewExists

public boolean themeMaintenanceViewExists()
Does theme have a maintenance view


unregisterLayoutSettings

private any unregisterLayoutSettings(array settings)

Parameters:
settings

uploadLayout

public struct uploadLayout(any fileField)
Upload Layout, returns [error:boolean,messages:string]

Parameters:
fileField

ContentBox Core API 1.5.7