ContentBox Core API 1.6.0

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

Property Summary
Type Property & Description Default Serializable Required
 any cbHelper


Attributes:
  • inject = provider:CBHelper@cb
true false
 any html


Attributes:
  • inject = coldbox:plugin:HTMLHelper
true false
 any interceptorService


Attributes:
  • inject = coldbox:interceptorService
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:
  • inject = logbox:logger:{this}
true false
 any moduleSettings


Attributes:
  • inject = coldbox:setting:modules
true false
 any settingService


Attributes:
  • inject = id:settingService@cb
true false
 any wirebox


Attributes:
  • inject = wirebox
true false
 any zipUtil


Attributes:
  • inject = zipUtil@cb
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

init

public init()
Constructor

Property Detail

cbHelper

any cbHelper

Attributes:
inject - provider:CBHelper@cb
required - false
serializable - true
default -

html

any html

Attributes:
inject - coldbox:plugin:HTMLHelper
required - false
serializable - true
default -

interceptorService

any interceptorService

Attributes:
inject - coldbox:interceptorService
required - false
serializable - true
default -

layoutCFCRegistry

any layoutCFCRegistry

Attributes:
default -
serializable - true
required - false

layoutRegistry

any layoutRegistry

Attributes:
default -
serializable - true
required - false

layoutWidgetCache

struct layoutWidgetCache

Attributes:
default -
serializable - true
required - false

layoutsIncludePath

any layoutsIncludePath

Attributes:
default -
serializable - true
required - false

layoutsInvocationPath

any layoutsInvocationPath

Attributes:
default -
serializable - true
required - false

layoutsPath

any layoutsPath

Attributes:
default -
serializable - true
required - false

log

any log

Attributes:
inject - logbox:logger:{this}
required - false
serializable - true
default -

moduleSettings

any moduleSettings

Attributes:
inject - coldbox:setting:modules
required - false
serializable - true
default -

settingService

any settingService

Attributes:
inject - id:settingService@cb
required - false
serializable - true
default -

wirebox

any wirebox

Attributes:
inject - wirebox
required - false
serializable - true
default -

zipUtil

any zipUtil

Attributes:
inject - zipUtil@cb
required - false
serializable - true
default -

Method Detail

GETCBHELPER

public any GETCBHELPER()
get:


GETHTML

public any GETHTML()
get:


GETINTERCEPTORSERVICE

public any GETINTERCEPTORSERVICE()
get:


GETLAYOUTCFCREGISTRY

public any GETLAYOUTCFCREGISTRY()
get:


GETLAYOUTREGISTRY

public any GETLAYOUTREGISTRY()
get:


GETLAYOUTSINCLUDEPATH

public any GETLAYOUTSINCLUDEPATH()
get:


GETLAYOUTSINVOCATIONPATH

public any GETLAYOUTSINVOCATIONPATH()
get:


GETLAYOUTSPATH

public any GETLAYOUTSPATH()
get:


GETLAYOUTWIDGETCACHE

public struct GETLAYOUTWIDGETCACHE()
get:


GETLOG

public any GETLOG()
get:


GETMODULESETTINGS

public any GETMODULESETTINGS()
get:


GETSETTINGSERVICE

public any GETSETTINGSERVICE()
get:


GETWIREBOX

public any GETWIREBOX()
get:


GETZIPUTIL

public any GETZIPUTIL()
get:


SETCBHELPER

public LayoutService SETCBHELPER(any cbHelper)
set:

Parameters:
cbHelper

SETHTML

public LayoutService SETHTML(any html)
set:

Parameters:
html

SETINTERCEPTORSERVICE

public LayoutService SETINTERCEPTORSERVICE(any interceptorService)
set:

Parameters:
interceptorService

SETLAYOUTCFCREGISTRY

public LayoutService SETLAYOUTCFCREGISTRY(any layoutCFCRegistry)
set:

Parameters:
layoutCFCRegistry

SETLAYOUTREGISTRY

public LayoutService SETLAYOUTREGISTRY(any layoutRegistry)
set:

Parameters:
layoutRegistry

SETLAYOUTSINCLUDEPATH

public LayoutService SETLAYOUTSINCLUDEPATH(any layoutsIncludePath)
set:

Parameters:
layoutsIncludePath

SETLAYOUTSINVOCATIONPATH

public LayoutService SETLAYOUTSINVOCATIONPATH(any layoutsInvocationPath)
set:

Parameters:
layoutsInvocationPath

SETLAYOUTSPATH

public LayoutService SETLAYOUTSPATH(any layoutsPath)
set:

Parameters:
layoutsPath

SETLAYOUTWIDGETCACHE

public LayoutService SETLAYOUTWIDGETCACHE(struct layoutWidgetCache)
set:

Parameters:
layoutWidgetCache

SETLOG

public LayoutService SETLOG(any log)
set:

Parameters:
log

SETMODULESETTINGS

public LayoutService SETMODULESETTINGS(any moduleSettings)
set:

Parameters:
moduleSettings

SETSETTINGSERVICE

public LayoutService SETSETTINGSERVICE(any settingService)
set:

Parameters:
settingService

SETWIREBOX

public LayoutService SETWIREBOX(any wirebox)
set:

Parameters:
wirebox

SETZIPUTIL

public LayoutService SETZIPUTIL(any zipUtil)
set:

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.6.0