contentbox.model.ui

Class LayoutService

railo-context.Component
        extended by contentbox.model.ui.LayoutService
Class Attributes:
  • threadsafe
  •  
  • singleton
  •  
  • synchronized : false
  •  
  • accessors : true
  •  
  • persistent : false
  •  

    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


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


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


    • inject = coldbox: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


    • inject = logbox:logger:{this}
    true false
    any moduleSettings


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


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


    • inject = wirebox
    true false
    any zipUtil


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

    init

    public init()

    Constructor


    Property Detail

    cbHelper

    property any cbHelper

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

    html

    property any html

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

    interceptorService

    property any interceptorService

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

    layoutCFCRegistry

    property any layoutCFCRegistry

    Attributes:
    required - false
    serializable - true

    layoutRegistry

    property any layoutRegistry

    Attributes:
    required - false
    serializable - true

    layoutsIncludePath

    property any layoutsIncludePath

    Attributes:
    required - false
    serializable - true

    layoutsInvocationPath

    property any layoutsInvocationPath

    Attributes:
    required - false
    serializable - true

    layoutsPath

    property any layoutsPath

    Attributes:
    required - false
    serializable - true

    layoutWidgetCache

    property struct layoutWidgetCache

    Attributes:
    required - false
    serializable - true

    log

    property any log

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

    moduleSettings

    property any moduleSettings

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

    settingService

    property any settingService

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

    wirebox

    property any wirebox

    Attributes:
    required - false
    inject - wirebox
    serializable - true

    zipUtil

    property any zipUtil

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

    Method Detail

    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


    getCbHelper

    public string getCbHelper()


    getHtml

    public string getHtml()


    getInterceptorService

    public string getInterceptorService()


    getLayoutCFCRegistry

    public string getLayoutCFCRegistry()


    getLayoutRecord

    public query getLayoutRecord(any layoutName)

    Get a layout record from the registry by name

    Parameters:
    layoutName

    getLayoutRegistry

    public string getLayoutRegistry()


    getLayouts

    public query getLayouts()

    Get all registered layouts


    getLayoutsIncludePath

    public string getLayoutsIncludePath()


    getLayoutsInvocationPath

    public string getLayoutsInvocationPath()


    getLayoutsPath

    public string getLayoutsPath()


    getLayoutWidgetCache

    public string getLayoutWidgetCache()


    getLayoutWidgetPath

    public string getLayoutWidgetPath(string widgetName)

    Returns path for the requested widget from layout service's layout cache return String

    Parameters:
    widgetName - {String}}

    getLog

    public string getLog()


    getModuleSettings

    public string getModuleSettings()


    getSettingsConstraints

    public any getSettingsConstraints(any layoutName)

    Parameters:
    layoutName

    getSettingService

    public string getSettingService()


    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


    getWirebox

    public string getWirebox()


    getZipUtil

    public string getZipUtil()


    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

    setCbHelper

    public any setCbHelper(any cbHelper)

    Parameters:
    cbHelper

    setHtml

    public any setHtml(any html)

    Parameters:
    html

    setInterceptorService

    public any setInterceptorService(any interceptorService)

    Parameters:
    interceptorService

    setLayoutCFCRegistry

    public any setLayoutCFCRegistry(any layoutCFCRegistry)

    Parameters:
    layoutCFCRegistry

    setLayoutRegistry

    public any setLayoutRegistry(any layoutRegistry)

    Parameters:
    layoutRegistry

    setLayoutsIncludePath

    public any setLayoutsIncludePath(any layoutsIncludePath)

    Parameters:
    layoutsIncludePath

    setLayoutsInvocationPath

    public any setLayoutsInvocationPath(any layoutsInvocationPath)

    Parameters:
    layoutsInvocationPath

    setLayoutsPath

    public any setLayoutsPath(any layoutsPath)

    Parameters:
    layoutsPath

    setLayoutWidgetCache

    public any setLayoutWidgetCache(struct layoutWidgetCache)

    Parameters:
    layoutWidgetCache

    setLog

    public any setLog(any log)

    Parameters:
    log

    setModuleSettings

    public any setModuleSettings(any moduleSettings)

    Parameters:
    moduleSettings

    setSettingService

    public any setSettingService(any settingService)

    Parameters:
    settingService

    setWirebox

    public any setWirebox(any wirebox)

    Parameters:
    wirebox

    setZipUtil

    public any setZipUtil(any zipUtil)

    Parameters:
    zipUtil

    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