contentbox.model.ui.admin

Class AdminThemeService

railo-context.Component
        extended by contentbox.model.ui.admin.AdminThemeService
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. Manages ContentBox Admin Themes

    Property Summary
    type property default serializable required
    any settingService


    • inject = settingService@cb
    true false
    struct themes


    true false
    Constructor Summary
    init(any wirebox)
          Constructor.
    Method Summary
    IAdminTheme getCurrentTheme()
         Get the current theme object.
    string getDefaultTheme()
         Get the default admin theme setting.
    array getRegisteredThemes()
         Get an array of registered theme names in alphabetical order.
    array getRegisteredThemesMap()
         Get an array of registered theme names in alphabetical order with their display names.
    string getSettingService()
    IAdminTheme getTheme(any name)
         Get a registered theme instance.
    string getThemes()
    AdminThemeService registerTheme(IAdminTheme theme)
         Register a new admin theme in ContentBox.
    any setSettingService(any settingService)
    any setThemes(struct themes)
    AdminThemeService unregisterTheme(any name)
         UnRegister a theme in ContentBox.
     
    Methods inherited from class railo-context.Component
    None

    Constructor Detail

    init

    public init(any wirebox)

    Constructor

    Parameters:
    wirebox

    Property Detail

    settingService

    property any settingService

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

    themes

    property struct themes

    Attributes:
    required - false
    serializable - true

    Method Detail

    getCurrentTheme

    public IAdminTheme getCurrentTheme()

    Get the current theme object


    getDefaultTheme

    public string getDefaultTheme()

    Get the default admin theme setting


    getRegisteredThemes

    public array getRegisteredThemes()

    Get an array of registered theme names in alphabetical order


    getRegisteredThemesMap

    public array getRegisteredThemesMap()

    Get an array of registered theme names in alphabetical order with their display names


    getSettingService

    public string getSettingService()


    getTheme

    public IAdminTheme getTheme(any name)

    Get a registered theme instance

    Parameters:
    name

    getThemes

    public string getThemes()


    registerTheme

    public AdminThemeService registerTheme(IAdminTheme theme)

    Register a new admin theme in ContentBox

    Parameters:
    theme

    setSettingService

    public any setSettingService(any settingService)

    Parameters:
    settingService

    setThemes

    public any setThemes(struct themes)

    Parameters:
    themes

    unregisterTheme

    public AdminThemeService unregisterTheme(any name)

    UnRegister a theme in ContentBox

    Parameters:
    name